@codefresh-io/cf-telemetry 2.3.0-alpha.6 → 3.0.0

package/README.md

@@ -4,9 +4,9 @@ Base utils for monitoring.
 
 Includes:
 
-* [Logs](./src/logs/README.md).
-* [MongoDB](./src/metrics/mongodb/README.md) client monitoring.
-* [OpenTelemetry](./src/otel/README.md) auto instrumentation.
+* [Logs](./src/logs/README.md), fast and well-structured.
+* [MongoDB](./src/metrics/mongodb/README.md) client monitoring helper.
+* [OpenTelemetry](./src/otel/README.md) auto instrumentation, API and helpers.
 * [Prometheus](./src/metrics/prometheus/README.md) server and custom metrics.
 * [Pyroscope](./src/profiles/README.md) to profile CPU and memory.
 
@@ -23,6 +23,33 @@ import '@codefresh-io/cf-telemetry/init'
 // ↓ Keep one blank line below to prevent automatic import reordering
 ```
 
+### Lifecycle notices
+
+> [!IMPORTANT]
+> Please read this section carefully to understand how this library handles application lifecycle events and how it affects application lifecycle.
+
+This library registers listeners for `SIGINT`, `SIGTERM` and `beforeExit` events to gracefully terminate instrumentation, which may include flushing logs, metrics, and profiles.
+
+#### Effect on application lifecycle
+
+As this library registers listeners for `SIGINT` and `SIGTERM` events, Node.js' default handlers for such signals will be removed: Node.js will no longer exit on non-Windows platforms on such signals. [More details in the doc](https://nodejs.org/api/process.html#signal-events).
+
+**Please make sure you add your own exit handlers for these signals.**
+
+#### Instrumentation shutdown
+
+None of the events above happens if `proces.exit()` is called directly. This means that if you call `process.exit()` in your application, the library will not be able to gracefully terminate instrumentation. This may lead to loss of logs, metrics, and other telemetry data.
+
+Please ensure calling `terminate()` method of this library before calling `process.exit()` to ensure graceful termination of instrumentation.
+
+```TS
+import { terminate } from '@codefresh-io/cf-telemetry/init'
+
+// ...your application logic
+await terminate();    // Ensure graceful termination of instrumentation
+process.exit(0);      // Now it's safe to exit the process
+```
+
 ## Environment variables
 
 | Variable               | Required | Default value                                                     | Description                                 |

package/dist/otel/config.d.ts

@@ -1,3 +1,4 @@
 export declare const config: {
     readonly enabled: boolean;
+    readonly allowHttpInstrumentation: boolean;
 };

package/dist/otel/config.js

@@ -3,5 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
 exports.config = {
     enabled: process.env['CF_TELEMETRY_OTEL_ENABLE'] === 'true',
+    allowHttpInstrumentation: process.env['CF_TELEMETRY_OTEL_ALLOW_HTTP_INSTRUMENTATION'] === 'true',
 };
 //# sourceMappingURL=config.js.map

package/dist/otel/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/otel/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,KAAK,MAAM;CACnD,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/otel/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,KAAK,MAAM;IAC3D,wBAAwB,EAAE,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,KAAK,MAAM;CACxF,CAAC"}

package/dist/otel/disable-http-instrumentation.d.ts

@@ -0,0 +1 @@
+export declare const disableHttpInstrumentation: () => void;

package/dist/otel/disable-http-instrumentation.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.disableHttpInstrumentation = void 0;
+const disableHttpInstrumentation = () => {
+    const disabledOtelInstrumentations = new Set(process.env['OTEL_NODE_DISABLED_INSTRUMENTATIONS']
+        ?.split(',')
+        .reduce((acc, instrumentation) => {
+        const trimmed = instrumentation.trim();
+        if (trimmed)
+            acc.push(trimmed);
+        return acc;
+    }, []));
+    disabledOtelInstrumentations.add('http');
+    process.env['OTEL_NODE_DISABLED_INSTRUMENTATIONS'] = [...disabledOtelInstrumentations].join(',');
+};
+exports.disableHttpInstrumentation = disableHttpInstrumentation;
+//# sourceMappingURL=disable-http-instrumentation.js.map

package/dist/otel/disable-http-instrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"disable-http-instrumentation.js","sourceRoot":"","sources":["../../src/otel/disable-http-instrumentation.ts"],"names":[],"mappings":";;;AAAO,MAAM,0BAA0B,GAAG,GAAS,EAAE;IACnD,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAC1C,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC;QAChD,EAAE,KAAK,CAAC,GAAG,CAAC;SACX,MAAM,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,OAAO;YAAE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAc,CAAC,CACrB,CAAC;IACF,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,GAAG,CAAC,GAAG,4BAA4B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnG,CAAC,CAAC;AAZW,QAAA,0BAA0B,8BAYrC"}

package/dist/otel/sdk.js

@@ -9,6 +9,15 @@ const sdk_node_1 = require("@opentelemetry/sdk-node");
 const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
 const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
 const global_config_1 = require("../global-config");
+const config_1 = require("./config");
+const disable_http_instrumentation_1 = require("./disable-http-instrumentation");
+/**
+ * HTTP instrumentation is disabled by default because of potential security issues.
+ * In particular, it adds span attributes with request query parameters (`url.full` and `url.query`),
+ * which may contain sensitive information.
+ */
+if (config_1.config.allowHttpInstrumentation !== true)
+    (0, disable_http_instrumentation_1.disableHttpInstrumentation)();
 exports.sdk = new sdk_node_1.NodeSDK({
     serviceName: global_config_1.globalConfig.serviceName,
     autoDetectResources: true,

package/dist/otel/sdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../src/otel/sdk.ts"],"names":[],"mappings":";;;AAAA,0FAAwF;AACxF,kFAAqG;AACrG,sFAA4E;AAC5E,wDAAkE;AAClE,sDAAkD;AAClD,kEAAmE;AACnE,8EAA8F;AAC9F,oDAAgD;AAEnC,QAAA,GAAG,GAAG,IAAI,kBAAO,CAAC;IAC7B,WAAW,EAAE,4BAAY,CAAC,WAAW;IACrC,mBAAmB,EAAE,IAAI;IACzB,QAAQ,EAAE,IAAA,kCAAsB,EAAC;QAC/B,CAAC,wCAAiB,CAAC,EAAE,4BAAY,CAAC,WAAW;QAC7C,CAAC,2CAAoB,CAAC,EAAE,4BAAY,CAAC,cAAc;KACpD,CAAC;IACF,cAAc,EAAE;QACd,IAAI,mCAAkB,CAAC,IAAI,4CAAiB,EAAE,CAAC;QAC/C,wDAAwD;QACxD,IAAI,6CAAoB,CAAC,+CAAsB,CAAC;KACjD;IACD,gBAAgB,EAAE,CAAC,IAAA,wDAA2B,EAAC;YAC7C,qCAAqC,EAAE;gBACrC,YAAY,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;oBAC/B,IAAI,WAAW,IAAI,QAAQ;wBAAE,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC;gBAC7F,CAAC;aACF;SACF,CAAC,CAAC;CACJ,CAAC,CAAC"}
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../src/otel/sdk.ts"],"names":[],"mappings":";;;AAAA,0FAAwF;AACxF,kFAAqG;AACrG,sFAA4E;AAC5E,wDAAkE;AAClE,sDAAkD;AAClD,kEAAmE;AACnE,8EAA8F;AAC9F,oDAAgD;AAChD,qCAAkC;AAClC,iFAA4E;AAE5E;;;;GAIG;AACH,IAAI,eAAM,CAAC,wBAAwB,KAAK,IAAI;IAAE,IAAA,yDAA0B,GAAE,CAAC;AAE9D,QAAA,GAAG,GAAG,IAAI,kBAAO,CAAC;IAC7B,WAAW,EAAE,4BAAY,CAAC,WAAW;IACrC,mBAAmB,EAAE,IAAI;IACzB,QAAQ,EAAE,IAAA,kCAAsB,EAAC;QAC/B,CAAC,wCAAiB,CAAC,EAAE,4BAAY,CAAC,WAAW;QAC7C,CAAC,2CAAoB,CAAC,EAAE,4BAAY,CAAC,cAAc;KACpD,CAAC;IACF,cAAc,EAAE;QACd,IAAI,mCAAkB,CAAC,IAAI,4CAAiB,EAAE,CAAC;QAC/C,wDAAwD;QACxD,IAAI,6CAAoB,CAAC,+CAAsB,CAAC;KACjD;IACD,gBAAgB,EAAE,CAAC,IAAA,wDAA2B,EAAC;YAC7C,qCAAqC,EAAE;gBACrC,YAAY,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;oBAC/B,IAAI,WAAW,IAAI,QAAQ;wBAAE,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC;gBAC7F,CAAC;aACF;SACF,CAAC,CAAC;CACJ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codefresh-io/cf-telemetry",
-  "version": "2.3.0-alpha.6",
+  "version": "3.0.0",
   "exports": {
     "./init": {
       "import": "./dist/init.mjs",