azify-logger 1.0.49 → 1.0.50

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azify-logger",
-  "version": "1.0.49",
+  "version": "1.0.50",
   "description": "Azify Logger Client - Centralized logging for OpenSearch",
   "main": "index.js",
   "types": "index.d.ts",
@@ -94,6 +94,7 @@
     "index.d.ts",
     "init.js",
     "register.js",
+    "register.d.ts",
     "store.js",
     "store.d.ts",
     "register-otel.js",

package/register.d.ts

@@ -0,0 +1,19 @@
+import { Logger } from 'bunyan';
+
+export interface RegisterOptions {
+  loggerUrl?: string;
+  serviceName?: string;
+  environment?: string;
+}
+
+/**
+ * Registers azify-logger with Bunyan
+ * @param logger - Bunyan logger instance
+ * @param options - Configuration options
+ * @example
+ * const register = require('azify-logger/register');
+ * register(myLogger, { loggerUrl: 'http://localhost:3001' });
+ */
+declare function register(logger: Logger, options?: RegisterOptions): void;
+
+export = register;

package/store.d.ts

@@ -25,6 +25,8 @@ export function captureOriginTraceMeta(): {
   originRequestId?: string
 }
 
+export function mergeOriginTraceIntoStructuredLog<T>(payload: T): T
+
 export function addCurrentTraceToBullJobPayload<T>(data: T): T
 
 export function traceAttachmentForBullJob(): Record<string, unknown>

package/store.js

@@ -82,6 +82,36 @@ function captureOriginTraceMeta() {
   }
 }
 
+function isPlainObjectForLog(v) {
+  return v != null && typeof v === 'object' && !Array.isArray(v)
+}
+
+function mergeOriginTraceIntoStructuredLog(payload) {
+  if (!isPlainObjectForLog(payload)) {
+    return payload
+  }
+  const origin = captureOriginTraceMeta()
+  const meta = payload.meta
+  if (isPlainObjectForLog(meta)) {
+    const mergedMeta = { ...meta }
+    if (origin.originTraceId != null && mergedMeta.originTraceId === undefined) {
+      mergedMeta.originTraceId = origin.originTraceId
+    }
+    if (origin.originRequestId != null && mergedMeta.originRequestId === undefined) {
+      mergedMeta.originRequestId = origin.originRequestId
+    }
+    return { ...payload, meta: mergedMeta }
+  }
+  const out = { ...payload }
+  if (origin.originTraceId != null && out.originTraceId === undefined) {
+    out.originTraceId = origin.originTraceId
+  }
+  if (origin.originRequestId != null && out.originRequestId === undefined) {
+    out.originRequestId = origin.originRequestId
+  }
+  return out
+}
+
 function mergeTraceIntoJobPayload(data, traceContext) {
   if (!traceContext || !traceContext.traceId) return data
   const base = data && typeof data === 'object' && !Array.isArray(data) ? data : {}
@@ -147,16 +177,42 @@ function attachTraceToBullJobData(data, traceRecord) {
   }
 }
 
+function mergeOriginTraceMetaIntoJobPayload(data) {
+  if (!data || typeof data !== 'object' || Array.isArray(data)) {
+    return data
+  }
+  const origin = captureOriginTraceMeta()
+  const hasOriginToApply =
+    (origin.originTraceId != null && data.originTraceId === undefined) ||
+    (origin.originRequestId != null && data.originRequestId === undefined)
+  if (!hasOriginToApply) {
+    return data
+  }
+  const base = { ...data }
+  if (origin.originTraceId != null && base.originTraceId === undefined) {
+    base.originTraceId = origin.originTraceId
+  }
+  if (origin.originRequestId != null && base.originRequestId === undefined) {
+    base.originRequestId = origin.originRequestId
+  }
+  return base
+}
+
 function addCurrentTraceToBullJobPayload(data) {
+  const withOrigin = mergeOriginTraceMetaIntoJobPayload(data)
   const trace = captureTraceForJobEnqueue()
-  if (!trace) return data
-  return attachTraceToBullJobData(data, trace)
+  if (!trace) return withOrigin
+  return attachTraceToBullJobData(withOrigin, trace)
 }
 
 function traceAttachmentForBullJob() {
   const trace = captureTraceForJobEnqueue()
-  if (!trace) return {}
-  return { [AZIFY_JOB_TRACE_FIELD]: trace }
+  const origin = captureOriginTraceMeta()
+  const out = { ...origin }
+  if (trace) {
+    out[AZIFY_JOB_TRACE_FIELD] = trace
+  }
+  return out
 }
 
 function prepareBullJobTraceContext(data) {
@@ -220,6 +276,7 @@ module.exports = {
   addCurrentTraceToBullJobPayload,
   traceAttachmentForBullJob,
   captureOriginTraceMeta,
+  mergeOriginTraceIntoStructuredLog,
   toTraceIdHex
 }