@codefresh-io/cf-telemetry 2.3.0-alpha.5 → 2.3.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 (8) hide show
  1. package/README.md +30 -3
  2. package/dist/init.d.mts +1 -1
  3. package/dist/init.d.ts +6 -1
  4. package/dist/init.js +7 -4
  5. package/dist/init.js.map +1 -1
  6. package/dist/init.mjs +1 -1
  7. package/dist/init.mjs.map +1 -1
  8. package/package.json +1 -1
package/README.md CHANGED
@@ -4,9 +4,9 @@ Base utils for monitoring.
4
4
 
5
5
  Includes:
6
6
 
7
- * [Logs](./src/logs/README.md).
8
- * [MongoDB](./src/metrics/mongodb/README.md) client monitoring.
9
- * [OpenTelemetry](./src/otel/README.md) auto instrumentation.
7
+ * [Logs](./src/logs/README.md), fast and well-structured.
8
+ * [MongoDB](./src/metrics/mongodb/README.md) client monitoring helper.
9
+ * [OpenTelemetry](./src/otel/README.md) auto instrumentation, API and helpers.
10
10
  * [Prometheus](./src/metrics/prometheus/README.md) server and custom metrics.
11
11
  * [Pyroscope](./src/profiles/README.md) to profile CPU and memory.
12
12
 
@@ -23,6 +23,33 @@ 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
27
+
28
+ > [!IMPORTANT]
29
+ > Please read this section carefully to understand how this library handles application lifecycle events and how it affects application lifecycle.
30
+
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.
44
+
45
+ ```TS
46
+ import { terminate } from '@codefresh-io/cf-telemetry/init'
47
+
48
+ // ...your application logic
49
+ await terminate(); // Ensure graceful termination of instrumentation
50
+ process.exit(0); // Now it's safe to exit the process
51
+ ```
52
+
26
53
  ## Environment variables
27
54
 
28
55
  | Variable | Required | Default value | Description |
package/dist/init.d.mts CHANGED
@@ -1 +1 @@
1
- import './init.js';
1
+ export * from './init.js';
package/dist/init.d.ts CHANGED
@@ -1 +1,6 @@
1
- export {};
1
+ /**
2
+ * Initializes telemetry services.
3
+ * Should be called once as early as possible in the application lifecycle.
4
+ */
5
+ export declare const init: () => void;
6
+ export declare const terminate: () => Promise<void>;
package/dist/init.js CHANGED
@@ -33,6 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
33
33
  };
34
34
  })();
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.terminate = exports.init = void 0;
36
37
  // ↓ Should be imported first
37
38
  const otel = __importStar(require("./otel"));
38
39
  // ↑ Should be imported first
@@ -62,6 +63,7 @@ const init = () => {
62
63
  console.error('Failed to initialize telemetry services', error);
63
64
  }
64
65
  };
66
+ exports.init = init;
65
67
  const terminate = async () => {
66
68
  const logger = new logs.Logger(global_config_1.globalConfig.libLogScope);
67
69
  try {
@@ -75,8 +77,9 @@ const terminate = async () => {
75
77
  logger.error('Failed to terminate telemetry services', exception);
76
78
  }
77
79
  };
78
- init();
79
- process.on('SIGINT', terminate);
80
- process.on('SIGTERM', terminate);
81
- process.once('beforeExit', terminate);
80
+ exports.terminate = terminate;
81
+ process.on('SIGINT', exports.terminate);
82
+ process.on('SIGTERM', exports.terminate);
83
+ process.once('beforeExit', exports.terminate);
84
+ (0, exports.init)();
82
85
  //# 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,6CAA+B;AAC/B,6BAA6B;AAE7B,mDAA+C;AAC/C,6CAA+B;AAC/B,iEAAmD;AACnD,qDAAuC;AAEvC,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B;;;GAGG;AACH,MAAM,IAAI,GAAG,GAAS,EAAE;IACtB,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,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;AAEF,MAAM,SAAS,GAAG,KAAK,IAAmB,EAAE;IAC1C,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,4BAAY,CAAC,WAAW,CAAC,CAAC;IACzD,IAAI,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9C,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,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE,SAAS,CAAC,CAAC;IACpE,CAAC;AACH,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC;AAEP,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAChC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AACjC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC"}
1
+ {"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAA6B;AAC7B,6CAA+B;AAC/B,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,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;AAfW,QAAA,IAAI,QAef;AAEK,MAAM,SAAS,GAAG,KAAK,IAAmB,EAAE;IACjD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,4BAAY,CAAC,WAAW,CAAC,CAAC;IACzD,IAAI,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9C,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,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE,SAAS,CAAC,CAAC;IACpE,CAAC;AACH,CAAC,CAAC;AAXW,QAAA,SAAS,aAWpB;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"}
package/dist/init.mjs CHANGED
@@ -1,2 +1,2 @@
1
- import './init.js';
1
+ export * from './init.js';
2
2
  //# sourceMappingURL=init.mjs.map
package/dist/init.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"init.mjs","sourceRoot":"","sources":["../src/init.mts"],"names":[],"mappings":"AAAA,OAAO,WAAW,CAAC"}
1
+ {"version":3,"file":"init.mjs","sourceRoot":"","sources":["../src/init.mts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@codefresh-io/cf-telemetry",
3
- "version": "2.3.0-alpha.5",
3
+ "version": "2.3.0",
4
4
  "exports": {
5
5
  "./init": {
6
6
  "import": "./dist/init.mjs",