@temporalio/workflow 1.9.3 → 1.10.1

package/lib/logs.d.ts

@@ -34,6 +34,13 @@ export interface LoggerSinksInternal extends Sinks {
  * This logger is replay-aware and will omit log messages on workflow replay. Messages emitted by this logger are
  * funnelled through a sink that forwards them to the logger registered on {@link Runtime.logger}.
  *
+ * Attributes from the current Workflow Execution context are automatically included as metadata on every log
+ * entries. An extra `sdkComponent` metadata attribute is also added, with value `workflow`; this can be used for
+ * fine-grained filtering of log entries further downstream.
+ *
+ * To customize log attributes, register a {@link WorkflowOutboundCallsInterceptor} that intercepts the
+ * `getLogAttributes()` method.
+ *
  * Notice that since sinks are used to power this logger, any log attributes must be transferable via the
  * {@link https://nodejs.org/api/worker_threads.html#worker_threads_port_postmessage_value_transferlist | postMessage}
  * API.

package/lib/logs.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.workflowLogAttributes = exports.executeWithLifecycleLogging = exports.log = void 0;
 const interceptors_1 = require("@temporalio/common/lib/interceptors");
+const common_1 = require("@temporalio/common");
 const stack_helpers_1 = require("./stack-helpers");
 const sinks_1 = require("./sinks");
 const errors_1 = require("./errors");
@@ -19,6 +20,13 @@ const LogTimestamp = Symbol.for('log_timestamp');
  * This logger is replay-aware and will omit log messages on workflow replay. Messages emitted by this logger are
  * funnelled through a sink that forwards them to the logger registered on {@link Runtime.logger}.
  *
+ * Attributes from the current Workflow Execution context are automatically included as metadata on every log
+ * entries. An extra `sdkComponent` metadata attribute is also added, with value `workflow`; this can be used for
+ * fine-grained filtering of log entries further downstream.
+ *
+ * To customize log attributes, register a {@link WorkflowOutboundCallsInterceptor} that intercepts the
+ * `getLogAttributes()` method.
+ *
  * Notice that since sinks are used to power this logger, any log attributes must be transferable via the
  * {@link https://nodejs.org/api/worker_threads.html#worker_threads_port_postmessage_value_transferlist | postMessage}
  * API.
@@ -35,6 +43,7 @@ exports.log = Object.fromEntries(['trace', 'debug', 'info', 'warn', 'error'].map
             return loggerSink[level](message, {
                 // Inject the call time in nanosecond resolution as expected by the worker logger.
                 [LogTimestamp]: activator.getTimeOfDay(),
+                sdkComponent: common_1.SdkComponent.workflow,
                 ...getLogAttributes(workflowLogAttributes(activator.info)),
                 ...attrs,
             });
@@ -42,24 +51,24 @@ exports.log = Object.fromEntries(['trace', 'debug', 'info', 'warn', 'error'].map
     ];
 }));
 function executeWithLifecycleLogging(fn) {
-    exports.log.debug('Workflow started');
+    exports.log.debug('Workflow started', { sdkComponent: common_1.SdkComponent.worker });
     const p = fn().then((res) => {
-        exports.log.debug('Workflow completed');
+        exports.log.debug('Workflow completed', { sdkComponent: common_1.SdkComponent.worker });
         return res;
     }, (error) => {
         // Avoid using instanceof checks in case the modules they're defined in loaded more than once,
         // e.g. by jest or when multiple versions are installed.
         if (typeof error === 'object' && error != null) {
             if ((0, errors_1.isCancellation)(error)) {
-                exports.log.debug('Workflow completed as cancelled');
+                exports.log.debug('Workflow completed as cancelled', { sdkComponent: common_1.SdkComponent.worker });
                 throw error;
             }
             else if (error instanceof interfaces_1.ContinueAsNew) {
-                exports.log.debug('Workflow continued as new');
+                exports.log.debug('Workflow continued as new', { sdkComponent: common_1.SdkComponent.worker });
                 throw error;
             }
         }
-        exports.log.warn('Workflow failed', { error });
+        exports.log.warn('Workflow failed', { error, sdkComponent: common_1.SdkComponent.worker });
         throw error;
     });
     // Avoid showing this interceptor in stack trace query

package/lib/logs.js.map

@@ -1 +1 @@
-{"version":3,"file":"logs.js","sourceRoot":"","sources":["../src/logs.ts"],"names":[],"mappings":";;;AAAA,sEAA0E;AAC1E,mDAAiD;AACjD,mCAA4D;AAC5D,qCAA0C;AAC1C,6CAA2D;AAC3D,2DAA8D;AAiC9D,MAAM,UAAU,GAAG,IAAA,kBAAU,GAAuB,CAAC,iBAAiB,CAAC;AAEvE;;;GAGG;AACH,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;AAEjD;;;;;;;;;;;;GAYG;AACU,QAAA,GAAG,GAAmB,MAAM,CAAC,WAAW,CAClD,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAiC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;IACzF,OAAO;QACL,KAAK;QACL,CAAC,OAAe,EAAE,KAA+B,EAAE,EAAE;YACnD,MAAM,SAAS,GAAG,IAAA,2CAAuB,EAAC,2DAA2D,CAAC,CAAC;YACvG,MAAM,gBAAgB,GAAG,IAAA,kCAAmB,EAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5G,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE;gBAChC,kFAAkF;gBAClF,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,YAAY,EAAE;gBACxC,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAC1D,GAAG,KAAK;aACT,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC,CAAC,CACI,CAAC;AAET,SAAgB,2BAA2B,CAAC,EAA0B;IACpE,WAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC9B,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CACjB,CAAC,GAAG,EAAE,EAAE;QACN,WAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAChC,OAAO,GAAG,CAAC;IACb,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;QACR,8FAA8F;QAC9F,wDAAwD;QACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAC/C,IAAI,IAAA,uBAAc,EAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,WAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;gBAC7C,MAAM,KAAK,CAAC;YACd,CAAC;iBAAM,IAAI,KAAK,YAAY,0BAAa,EAAE,CAAC;gBAC1C,WAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;gBACvC,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QACD,WAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACvC,MAAM,KAAK,CAAC;IACd,CAAC,CACF,CAAC;IACF,sDAAsD;IACtD,IAAA,8BAAc,EAAC,CAAC,CAAC,CAAC;IAClB,OAAO,CAAC,CAAC;AACX,CAAC;AA1BD,kEA0BC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CAAC,IAAkB;IACtD,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,YAAY,EAAE,IAAI,CAAC,YAAY;KAChC,CAAC;AACJ,CAAC;AARD,sDAQC"}
+{"version":3,"file":"logs.js","sourceRoot":"","sources":["../src/logs.ts"],"names":[],"mappings":";;;AAAA,sEAA0E;AAC1E,+CAAkD;AAClD,mDAAiD;AACjD,mCAA4D;AAC5D,qCAA0C;AAC1C,6CAA2D;AAC3D,2DAA8D;AAiC9D,MAAM,UAAU,GAAG,IAAA,kBAAU,GAAuB,CAAC,iBAAiB,CAAC;AAEvE;;;GAGG;AACH,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,GAAG,GAAmB,MAAM,CAAC,WAAW,CAClD,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAiC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;IACzF,OAAO;QACL,KAAK;QACL,CAAC,OAAe,EAAE,KAA+B,EAAE,EAAE;YACnD,MAAM,SAAS,GAAG,IAAA,2CAAuB,EAAC,2DAA2D,CAAC,CAAC;YACvG,MAAM,gBAAgB,GAAG,IAAA,kCAAmB,EAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5G,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE;gBAChC,kFAAkF;gBAClF,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,YAAY,EAAE;gBACxC,YAAY,EAAE,qBAAY,CAAC,QAAQ;gBACnC,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAC1D,GAAG,KAAK;aACT,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC,CAAC,CACI,CAAC;AAET,SAAgB,2BAA2B,CAAC,EAA0B;IACpE,WAAG,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAE,YAAY,EAAE,qBAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACrE,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CACjB,CAAC,GAAG,EAAE,EAAE;QACN,WAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAE,YAAY,EAAE,qBAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,OAAO,GAAG,CAAC;IACb,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;QACR,8FAA8F;QAC9F,wDAAwD;QACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAC/C,IAAI,IAAA,uBAAc,EAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,WAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,EAAE,YAAY,EAAE,qBAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBACpF,MAAM,KAAK,CAAC;YACd,CAAC;iBAAM,IAAI,KAAK,YAAY,0BAAa,EAAE,CAAC;gBAC1C,WAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,YAAY,EAAE,qBAAY,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC9E,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QACD,WAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,qBAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1E,MAAM,KAAK,CAAC;IACd,CAAC,CACF,CAAC;IACF,sDAAsD;IACtD,IAAA,8BAAc,EAAC,CAAC,CAAC,CAAC;IAClB,OAAO,CAAC,CAAC;AACX,CAAC;AA1BD,kEA0BC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CAAC,IAAkB;IACtD,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,YAAY,EAAE,IAAI,CAAC,YAAY;KAChC,CAAC;AACJ,CAAC;AARD,sDAQC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/workflow",
-  "version": "1.9.3",
+  "version": "1.10.1",
   "description": "Temporal.io SDK Workflow sub-package",
   "keywords": [
     "temporal",
@@ -22,8 +22,8 @@
   "types": "lib/index.d.ts",
   "scripts": {},
   "dependencies": {
-    "@temporalio/common": "1.9.3",
-    "@temporalio/proto": "1.9.3"
+    "@temporalio/common": "1.10.1",
+    "@temporalio/proto": "1.10.1"
   },
   "devDependencies": {
     "source-map": "^0.7.4"
@@ -35,5 +35,5 @@
     "src",
     "lib"
   ],
-  "gitHead": "e7e46639c1ba23b86f367a051fb54d736c5f21ce"
+  "gitHead": "a39419f4f9398bd69cc313700af75aea268f80b1"
 }

package/src/logs.ts

@@ -1,4 +1,5 @@
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
+import { SdkComponent } from '@temporalio/common';
 import { untrackPromise } from './stack-helpers';
 import { type Sink, type Sinks, proxySinks } from './sinks';
 import { isCancellation } from './errors';
@@ -50,6 +51,13 @@ const LogTimestamp = Symbol.for('log_timestamp');
  * This logger is replay-aware and will omit log messages on workflow replay. Messages emitted by this logger are
  * funnelled through a sink that forwards them to the logger registered on {@link Runtime.logger}.
  *
+ * Attributes from the current Workflow Execution context are automatically included as metadata on every log
+ * entries. An extra `sdkComponent` metadata attribute is also added, with value `workflow`; this can be used for
+ * fine-grained filtering of log entries further downstream.
+ *
+ * To customize log attributes, register a {@link WorkflowOutboundCallsInterceptor} that intercepts the
+ * `getLogAttributes()` method.
+ *
  * Notice that since sinks are used to power this logger, any log attributes must be transferable via the
  * {@link https://nodejs.org/api/worker_threads.html#worker_threads_port_postmessage_value_transferlist | postMessage}
  * API.
@@ -67,6 +75,7 @@ export const log: WorkflowLogger = Object.fromEntries(
         return loggerSink[level](message, {
           // Inject the call time in nanosecond resolution as expected by the worker logger.
           [LogTimestamp]: activator.getTimeOfDay(),
+          sdkComponent: SdkComponent.workflow,
           ...getLogAttributes(workflowLogAttributes(activator.info)),
           ...attrs,
         });
@@ -76,10 +85,10 @@ export const log: WorkflowLogger = Object.fromEntries(
 ) as any;
 
 export function executeWithLifecycleLogging(fn: () => Promise<unknown>): Promise<unknown> {
-  log.debug('Workflow started');
+  log.debug('Workflow started', { sdkComponent: SdkComponent.worker });
   const p = fn().then(
     (res) => {
-      log.debug('Workflow completed');
+      log.debug('Workflow completed', { sdkComponent: SdkComponent.worker });
       return res;
     },
     (error) => {
@@ -87,14 +96,14 @@ export function executeWithLifecycleLogging(fn: () => Promise<unknown>): Promise
       // e.g. by jest or when multiple versions are installed.
       if (typeof error === 'object' && error != null) {
         if (isCancellation(error)) {
-          log.debug('Workflow completed as cancelled');
+          log.debug('Workflow completed as cancelled', { sdkComponent: SdkComponent.worker });
           throw error;
         } else if (error instanceof ContinueAsNew) {
-          log.debug('Workflow continued as new');
+          log.debug('Workflow continued as new', { sdkComponent: SdkComponent.worker });
           throw error;
         }
       }
-      log.warn('Workflow failed', { error });
+      log.warn('Workflow failed', { error, sdkComponent: SdkComponent.worker });
       throw error;
     }
   );