@codefresh-io/cf-telemetry 3.12.0-alpha.3 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +16 -16
  2. package/dist/init.js +0 -2
  3. package/dist/init.js.map +1 -1
  4. package/dist/otel/sdk/instrumentation-configs/index.js +1 -5
  5. package/dist/otel/sdk/instrumentation-configs/index.js.map +1 -1
  6. package/package.json +2 -2
  7. package/dist/otel/sdk/instrumentation-configs/ioredis.d.ts +0 -2
  8. package/dist/otel/sdk/instrumentation-configs/ioredis.js +0 -7
  9. package/dist/otel/sdk/instrumentation-configs/ioredis.js.map +0 -1
  10. package/dist/otel/sdk/instrumentation-configs/redis.d.ts +0 -2
  11. package/dist/otel/sdk/instrumentation-configs/redis.js +0 -7
  12. package/dist/otel/sdk/instrumentation-configs/redis.js.map +0 -1
package/README.md CHANGED
@@ -23,24 +23,11 @@ import '@codefresh-io/cf-telemetry/init'
23
23
  // ↓ Keep one blank line below to prevent automatic import reordering
24
24
  ```
25
25
 
26
- ### Lifecycle notices
26
+ ### Lifecycle notice
27
27
 
28
- > [!IMPORTANT]
29
- > Please read this section carefully to understand how this library handles application lifecycle events and how it affects application lifecycle.
28
+ This library only registers terminate listener `beforeExit` event to gracefully terminate instrumentation, which may include flushing logs, metrics, and profiles.
30
29
 
31
- This library registers listeners for `SIGINT`, `SIGTERM` and `beforeExit` events to gracefully terminate instrumentation, which may include flushing logs, metrics, and profiles.
32
-
33
- #### Effect on application lifecycle
34
-
35
- 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).
36
-
37
- **Please make sure you add your own exit handlers for these signals.**
38
-
39
- #### Instrumentation shutdown
40
-
41
- 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.
42
-
43
- Please ensure calling `terminate()` method of this library before calling `process.exit()` to ensure graceful termination of instrumentation.
30
+ Please ensure calling `terminate()` method of this library before calling `process.exit()`, or to include it in your application logic that handles `SIGINT`/`SIGTERM` signals, to ensure graceful termination of instrumentation.
44
31
 
45
32
  ```TS
46
33
  import { terminate } from '@codefresh-io/cf-telemetry/init'
@@ -50,6 +37,19 @@ await terminate(); // Ensure graceful termination of instrumentation
50
37
  process.exit(0); // Now it's safe to exit the process
51
38
  ```
52
39
 
40
+ ```TS
41
+ import { terminate } from '@codefresh-io/cf-telemetry/init'
42
+
43
+ process.on('SIGINT', async () => {
44
+ await terminate(); // Ensure graceful termination of instrumentation
45
+ process.exit(130); // Now it's safe to exit the process
46
+ });
47
+ process.on('SIGTERM', async () => {
48
+ await terminate(); // Ensure graceful termination of instrumentation
49
+ process.exit(143); // Now it's safe to exit the process
50
+ });
51
+ ```
52
+
53
53
  ## Environment variables
54
54
 
55
55
  | Variable | Required | Default value | Description |
package/dist/init.js CHANGED
@@ -82,8 +82,6 @@ const terminate = async (signal) => {
82
82
  }
83
83
  };
84
84
  exports.terminate = terminate;
85
- process.on('SIGINT', exports.terminate);
86
- process.on('SIGTERM', exports.terminate);
87
85
  process.once('beforeExit', exports.terminate);
88
86
  (0, exports.init)();
89
87
  //# sourceMappingURL=init.js.map
package/dist/init.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAA6B;AAC7B,6DAA+C;AAC/C,6BAA6B;AAE7B,mDAA+C;AAC/C,6CAA+B;AAC/B,iEAAmD;AACnD,qDAAuC;AAEvC,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B;;;GAGG;AACI,MAAM,IAAI,GAAG,GAAS,EAAE;IAC7B,IAAI,aAAa;QAAE,OAAO;IAE1B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,4BAAY,CAAC,WAAW,CAAC,CAAC;QACzD,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,4BAAY,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtB,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5C,aAAa,GAAG,IAAI,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;AACH,CAAC,CAAC;AAhBW,QAAA,IAAI,QAgBf;AAEK,MAAM,SAAS,GAAG,KAAK,EAAE,MAAuB,EAAiB,EAAE;IACxE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,4BAAY,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,oBAAoB,MAAM,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvB,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrD,aAAa,GAAG,KAAK,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,SAAS,CAAC,CAAC;IACrE,CAAC;AACH,CAAC,CAAC;AAbW,QAAA,SAAS,aAapB;AAEF,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,iBAAS,CAAC,CAAC;AAChC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,iBAAS,CAAC,CAAC;AACjC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,iBAAS,CAAC,CAAC;AAEtC,IAAA,YAAI,GAAE,CAAC"}
1
+ {"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAA6B;AAC7B,6DAA+C;AAC/C,6BAA6B;AAE7B,mDAA+C;AAC/C,6CAA+B;AAC/B,iEAAmD;AACnD,qDAAuC;AAEvC,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B;;;GAGG;AACI,MAAM,IAAI,GAAG,GAAS,EAAE;IAC7B,IAAI,aAAa;QAAE,OAAO;IAE1B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,4BAAY,CAAC,WAAW,CAAC,CAAC;QACzD,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,4BAAY,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtB,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5C,aAAa,GAAG,IAAI,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;AACH,CAAC,CAAC;AAhBW,QAAA,IAAI,QAgBf;AAEK,MAAM,SAAS,GAAG,KAAK,EAAE,MAAuB,EAAiB,EAAE;IACxE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,4BAAY,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,oBAAoB,MAAM,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvB,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrD,aAAa,GAAG,KAAK,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,SAAS,CAAC,CAAC;IACrE,CAAC;AACH,CAAC,CAAC;AAbW,QAAA,SAAS,aAapB;AAEF,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,iBAAS,CAAC,CAAC;AAEtC,IAAA,YAAI,GAAE,CAAC"}
package/dist/otel/sdk/instrumentation-configs/index.js CHANGED
@@ -4,19 +4,15 @@ exports.instrumentationConfigs = void 0;
4
4
  const amqplib_js_1 = require("./amqplib.js");
5
5
  const graphql_js_1 = require("./graphql.js");
6
6
  const http_js_1 = require("./http.js");
7
- const ioredis_js_1 = require("./ioredis.js");
8
7
  const mongodb_js_1 = require("./mongodb.js");
9
8
  const mongoose_js_1 = require("./mongoose.js");
10
9
  const pg_js_1 = require("./pg.js");
11
- const redis_js_1 = require("./redis.js");
12
10
  exports.instrumentationConfigs = {
13
- '@opentelemetry/instrumentation-amqplib': amqplib_js_1.amqplib,
14
11
  '@opentelemetry/instrumentation-graphql': graphql_js_1.graphql,
15
12
  '@opentelemetry/instrumentation-http': http_js_1.http,
16
- '@opentelemetry/instrumentation-ioredis': ioredis_js_1.ioredis,
17
13
  '@opentelemetry/instrumentation-mongodb': mongodb_js_1.mongodb,
18
14
  '@opentelemetry/instrumentation-mongoose': mongoose_js_1.mongoose,
19
15
  '@opentelemetry/instrumentation-pg': pg_js_1.pg,
20
- '@opentelemetry/instrumentation-redis': redis_js_1.redis,
16
+ '@opentelemetry/instrumentation-amqplib': amqplib_js_1.amqplib,
21
17
  };
22
18
  //# sourceMappingURL=index.js.map
package/dist/otel/sdk/instrumentation-configs/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/otel/sdk/instrumentation-configs/index.ts"],"names":[],"mappings":";;;AACA,6CAAuC;AACvC,6CAAuC;AACvC,uCAAiC;AACjC,6CAAuC;AACvC,6CAAuC;AACvC,+CAAyC;AACzC,mCAA6B;AAC7B,yCAAmC;AAEtB,QAAA,sBAAsB,GAA6B;IAC9D,wCAAwC,EAAE,oBAAO;IACjD,wCAAwC,EAAE,oBAAO;IACjD,qCAAqC,EAAE,cAAI;IAC3C,wCAAwC,EAAE,oBAAO;IACjD,wCAAwC,EAAE,oBAAO;IACjD,yCAAyC,EAAE,sBAAQ;IACnD,mCAAmC,EAAE,UAAE;IACvC,sCAAsC,EAAE,gBAAK;CAC9C,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/otel/sdk/instrumentation-configs/index.ts"],"names":[],"mappings":";;;AACA,6CAAuC;AACvC,6CAAuC;AACvC,uCAAiC;AACjC,6CAAuC;AACvC,+CAAyC;AACzC,mCAA6B;AAEhB,QAAA,sBAAsB,GAA6B;IAC9D,wCAAwC,EAAE,oBAAO;IACjD,qCAAqC,EAAE,cAAI;IAC3C,wCAAwC,EAAE,oBAAO;IACjD,yCAAyC,EAAE,sBAAQ;IACnD,mCAAmC,EAAE,UAAE;IACvC,wCAAwC,EAAE,oBAAO;CAClD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@codefresh-io/cf-telemetry",
3
- "version": "3.12.0-alpha.3",
3
+ "version": "4.0.0",
4
4
  "exports": {
5
5
  "./init": {
6
6
  "import": "./dist/init.mjs",
@@ -66,7 +66,7 @@
66
66
  "dependencies": {
67
67
  "@christiangalsterer/mongodb-driver-prometheus-exporter": "^2.3.0",
68
68
  "@opentelemetry/api": "~1.9.0",
69
- "@opentelemetry/auto-instrumentations-node": "~0.70.1",
69
+ "@opentelemetry/auto-instrumentations-node": "~0.70.0",
70
70
  "@opentelemetry/baggage-span-processor": "~0.5.0",
71
71
  "@opentelemetry/core": "~2.5.1",
72
72
  "@opentelemetry/sdk-metrics": "~2.5.1",
package/dist/otel/sdk/instrumentation-configs/ioredis.d.ts DELETED
@@ -1,2 +0,0 @@
1
- import type { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';
2
- export declare const ioredis: InstrumentationConfigMap['@opentelemetry/instrumentation-ioredis'];
package/dist/otel/sdk/instrumentation-configs/ioredis.js DELETED
@@ -1,7 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ioredis = void 0;
4
- exports.ioredis = {
5
- requireParentSpan: process.env['CF_TELEMETRY_OTEL_IOREDIS_REQUIRE_PARENT_SPAN'] === 'true',
6
- };
7
- //# sourceMappingURL=ioredis.js.map
package/dist/otel/sdk/instrumentation-configs/ioredis.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"ioredis.js","sourceRoot":"","sources":["../../../../src/otel/sdk/instrumentation-configs/ioredis.ts"],"names":[],"mappings":";;;AAEa,QAAA,OAAO,GAAuE;IACzF,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,KAAK,MAAM;CAC3F,CAAC"}
package/dist/otel/sdk/instrumentation-configs/redis.d.ts DELETED
@@ -1,2 +0,0 @@
1
- import type { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';
2
- export declare const redis: InstrumentationConfigMap['@opentelemetry/instrumentation-redis'];
package/dist/otel/sdk/instrumentation-configs/redis.js DELETED
@@ -1,7 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.redis = void 0;
4
- exports.redis = {
5
- requireParentSpan: process.env['CF_TELEMETRY_OTEL_REDIS_REQUIRE_PARENT_SPAN'] === 'true',
6
- };
7
- //# sourceMappingURL=redis.js.map
package/dist/otel/sdk/instrumentation-configs/redis.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../../src/otel/sdk/instrumentation-configs/redis.ts"],"names":[],"mappings":";;;AAEa,QAAA,KAAK,GAAqE;IACrF,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,KAAK,MAAM;CACzF,CAAC"}