@codefresh-io/cf-telemetry 2.0.0-alpha.23 → 2.0.0-alpha.24

package/README.md

@@ -4,20 +4,28 @@ Base utils for monitoring.
 
 Includes:
 
-* [Logger](./src/logger/README.md).
+* [Logs](./src/logs/README.md).
+* [MongoDB](./src/metrics/mongodb/README.md) client monitoring.
+* [OpenTelemetry](./src/otel/README.md) auto instrumentation.
 * [Prometheus](./src/metrics/prometheus/README.md) server and custom metrics.
-* [MongoDB](./src//metrics/mongodb/README.md) client monitoring.
 * [Pyroscope](./src/profiles/README.md) to profile CPU and memory.
 
 ## Usage
 
-Call `init()` function at the very bootstrap of the app.
+Add `import '@codefresh-io/cf-telemetry/init'` statement at the very beginning of the application lifecycle.
 
 Please refer to the separate docs above for further configuration and usage details.
 
 ```TS
 // index.ts
-import { init } from '@codefresh-io/cf-telemetry';
-
-await init();
+// ↓ Should be imported first
+import '@codefresh-io/cf-telemetry/init'
+// ↓ Keep one blank line below to prevent automatic import reordering
 ```
+
+## Environment variables
+
+| Variable               | Required | Default value                                                     | Description                                 |
+|------------------------| -------- |-------------------------------------------------------------------|---------------------------------------------|
+| `CF_TELEMETRY_SERVICE_NAME` | optional | `unknown_service:node` | Sets service name for OpenTelemetry and Pyroscope. |
+| `CF_TELEMETRY_SERVICE_VERSION` | optional | `unknown` | Sets service version for OpenTelemetry and Pyroscope. |

package/dist/global-config.d.ts

@@ -1,4 +1,4 @@
 export declare const globalConfig: {
     readonly serviceName: string;
-    readonly serviceVersion: string | undefined;
+    readonly serviceVersion: string;
 };

package/dist/global-config.js

@@ -4,6 +4,6 @@ exports.globalConfig = void 0;
 /* eslint-disable @typescript-eslint/prefer-nullish-coalescing */
 exports.globalConfig = {
     serviceName: process.env['CF_TELEMETRY_SERVICE_NAME'] || 'unknown_service:node',
-    serviceVersion: process.env['CF_TELEMETRY_SERVICE_VERSION'],
+    serviceVersion: process.env['CF_TELEMETRY_SERVICE_VERSION'] || 'unknown',
 };
 //# sourceMappingURL=global-config.js.map

package/dist/global-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"global-config.js","sourceRoot":"","sources":["../src/global-config.ts"],"names":[],"mappings":";;;AAAA,iEAAiE;AACpD,QAAA,YAAY,GAAG;IAC1B,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,IAAI,sBAAsB;IAC/E,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC;CACnD,CAAC"}
+{"version":3,"file":"global-config.js","sourceRoot":"","sources":["../src/global-config.ts"],"names":[],"mappings":";;;AAAA,iEAAiE;AACpD,QAAA,YAAY,GAAG;IAC1B,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,IAAI,sBAAsB;IAC/E,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,IAAI,SAAS;CAChE,CAAC"}

package/dist/metrics/prometheus/client.js

@@ -7,12 +7,9 @@ exports.register = exports.client = void 0;
 const prom_client_1 = __importDefault(require("prom-client"));
 exports.client = prom_client_1.default;
 const config_1 = require("./config");
-const DEFAULT_LABELS = {};
 const register = prom_client_1.default.register;
 exports.register = register;
-register.setDefaultLabels(DEFAULT_LABELS);
-if (config_1.config.useOpenMetrics) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    (prom_client_1.default.register).setContentType(prom_client_1.default.Registry.OPENMETRICS_CONTENT_TYPE);
-}
+register.setDefaultLabels(config_1.config.defaultLabels);
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+(prom_client_1.default.register).setContentType(config_1.config.contentType);
 //# sourceMappingURL=client.js.map

package/dist/metrics/prometheus/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/metrics/prometheus/client.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AAc/B,iBAdK,qBAAM,CAcL;AAbR,qCAAkC;AAElC,MAAM,cAAc,GAA2B,EAAE,CAAC;AAElD,MAAM,QAAQ,GAAG,qBAAM,CAAC,QAAQ,CAAC;AAU/B,4BAAQ;AATV,QAAQ,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;AAE1C,IAAI,eAAM,CAAC,cAAc,EAAE,CAAC;IAC1B,8DAA8D;IAC9D,CAAC,qBAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,qBAAM,CAAC,QAAQ,CAAC,wBAA+B,CAAC,CAAC;AACpF,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/metrics/prometheus/client.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AAS/B,iBATK,qBAAM,CASL;AARR,qCAAkC;AAElC,MAAM,QAAQ,GAAG,qBAAM,CAAC,QAAQ,CAAC;AAO/B,4BAAQ;AANV,QAAQ,CAAC,gBAAgB,CAAC,eAAM,CAAC,aAAa,CAAC,CAAC;AAChD,8DAA8D;AAC9D,CAAC,qBAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,eAAM,CAAC,WAAkB,CAAC,CAAC"}

package/dist/metrics/prometheus/config.d.ts

@@ -3,5 +3,6 @@ export declare const config: {
     readonly shouldCollectProcessMetrics: boolean;
     readonly host: string;
     readonly port: number;
-    readonly useOpenMetrics: boolean;
+    readonly contentType: "text/plain; version=0.0.4; charset=utf-8" | "application/openmetrics-text; version=1.0.0; charset=utf-8";
+    readonly defaultLabels: {};
 };

package/dist/metrics/prometheus/config.js

@@ -1,11 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
+const prom_client_1 = require("prom-client");
+const getContentType = () => {
+    const ContentType = {
+        prometheus: prom_client_1.Registry.PROMETHEUS_CONTENT_TYPE,
+        openmetrics: prom_client_1.Registry.OPENMETRICS_CONTENT_TYPE,
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const contentType = process.env['CF_TELEMETRY_PROMETHEUS_CONTENT_TYPE'] ?? ContentType.openmetrics;
+    const knownTypes = Object.keys(ContentType);
+    if (!knownTypes.includes(contentType)) {
+        throw new Error(`Invalid value in CF_TELEMETRY_PROMETHEUS_CONTENT_TYPE: "${contentType}". Allowed values: "${knownTypes.join('|')}"`);
+    }
+    return ContentType[contentType];
+};
 exports.config = {
     enabled: process.env['CF_TELEMETRY_PROMETHEUS_ENABLE'] === 'true',
     shouldCollectProcessMetrics: process.env['CF_TELEMETRY_PROMETHEUS_ENABLE_PROCESS_METRICS'] === 'true',
     host: process.env['CF_TELEMETRY_PROMETHEUS_HOST'] ?? '0.0.0.0',
     port: Number.parseInt(process.env['CF_TELEMETRY_PROMETHEUS_PORT'] ?? '9100', 10),
-    useOpenMetrics: process.env['CF_TELEMETRY_PROMETHEUS_USE_OPEN_METRICS'] === 'true',
+    contentType: getContentType(),
+    defaultLabels: {},
 };
 //# sourceMappingURL=config.js.map

package/dist/metrics/prometheus/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/metrics/prometheus/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,KAAK,MAAM;IACjE,2BAA2B,EAAE,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,KAAK,MAAM;IACrG,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,IAAI,SAAS;IAC9D,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,IAAI,MAAM,EAAE,EAAE,CAAC;IAChF,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,KAAK,MAAM;CAC1E,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/metrics/prometheus/config.ts"],"names":[],"mappings":";;;AAAA,6CAAuC;AAEvC,MAAM,cAAc,GAAG,GAAG,EAAE;IAC1B,MAAM,WAAW,GAAG;QAClB,UAAU,EAAE,sBAAQ,CAAC,uBAAuB;QAC5C,WAAW,EAAE,sBAAQ,CAAC,wBAAwB;KACtC,CAAC;IACX,8DAA8D;IAC9D,MAAM,WAAW,GAA6B,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAQ,IAAI,WAAW,CAAC,WAAW,CAAC;IACpI,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5C,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,2DAA2D,WAAW,uBAAuB,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACxI,CAAC;IACD,OAAO,WAAW,CAAC,WAAW,CAAC,CAAC;AAClC,CAAC,CAAC;AAEW,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,KAAK,MAAM;IACjE,2BAA2B,EAAE,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,KAAK,MAAM;IACrG,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,IAAI,SAAS;IAC9D,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,IAAI,MAAM,EAAE,EAAE,CAAC;IAChF,WAAW,EAAE,cAAc,EAAE;IAC7B,aAAa,EAAE,EAAE;CACT,CAAC"}

package/dist/profiles/config.d.ts

@@ -1,6 +1,7 @@
 export declare const config: {
     readonly enabled: boolean;
     readonly config: {
-        tags: Record<string, string> | undefined;
+        appName: string;
+        tags: Record<string, string>;
     };
 };

package/dist/profiles/config.js

@@ -1,18 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
+const global_config_1 = require("../global-config");
+const getTags = () => {
+    const rawTags = process.env['CF_TELEMETRY_PYROSCOPE_TAGS'] ?? '';
+    return rawTags.split(',').reduce((acc, pair) => {
+        const [key, value] = pair.split('=');
+        if (!key || !value)
+            return acc;
+        acc[key] = value;
+        return acc;
+    }, {
+        service_version: global_config_1.globalConfig.serviceVersion,
+    });
+};
 exports.config = {
     enabled: process.env['CF_TELEMETRY_PYROSCOPE_ENABLE'] === 'true',
     config: {
-        tags: process.env['CF_TELEMETRY_PYROSCOPE_TAGS']
-            ? process.env['CF_TELEMETRY_PYROSCOPE_TAGS'].split(',').reduce((acc, pair) => {
-                const [key, value] = pair.split('=');
-                if (!key || !value)
-                    return acc;
-                acc[key] = value;
-                return acc;
-            }, {})
-            : undefined,
+        appName: process.env['PYROSCOPE_APPLICATION_NAME'] ?? global_config_1.globalConfig.serviceName,
+        tags: getTags(),
     },
 };
 //# sourceMappingURL=config.js.map

package/dist/profiles/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/profiles/config.ts"],"names":[],"mappings":";;;AAEa,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,KAAK,MAAM;IAChE,MAAM,EAAE;QACN,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC;YAC9C,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBACzE,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK;oBAAE,OAAO,GAAG,CAAC;gBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBACjB,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAA4B,CAAC;YAClC,CAAC,CAAC,SAAS;KACY;CACnB,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/profiles/config.ts"],"names":[],"mappings":";;;AACA,oDAAgD;AAEhD,MAAM,OAAO,GAAG,GAAG,EAAE;IACnB,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,IAAI,EAAE,CAAC;IACjE,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QAC7C,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK;YAAE,OAAO,GAAG,CAAC;QAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACjB,OAAO,GAAG,CAAC;IACb,CAAC,EAAE;QACD,eAAe,EAAE,4BAAY,CAAC,cAAc;KACnB,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEW,QAAA,MAAM,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,KAAK,MAAM;IAChE,MAAM,EAAE;QACN,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,IAAI,4BAAY,CAAC,WAAW;QAC9E,IAAI,EAAE,OAAO,EAAE;KACU;CACnB,CAAC"}

package/package.json

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