@comprehend/telemetry-node 0.2.1 → 0.2.3

package/README.md

@@ -121,7 +121,7 @@ This collects `process.cpu.time`, `process.cpu.utilization`, and `process.memory
 
 ### Kubernetes / container resources
 
-When running in containers or Kubernetes, the `NodeSDK` default resource detectors (`env`, `process`, `host`) do not include container or pod attributes. To populate `container.id`, `k8s.pod.name`, `k8s.namespace.name`, and similar, add the container resource detector explicitly via `resourceDetectors`:
+When running in containers or Kubernetes, the `NodeSDK` default resource detectors (`env`, `process`, `host`) do not include container or pod attributes. Configure `resourceDetectors` explicitly to add them — note that doing so replaces the defaults, so include the built-in detectors too:
 
 ```bash
 npm install @opentelemetry/resource-detector-container
@@ -129,16 +129,20 @@ npm install @opentelemetry/resource-detector-container
 
 ```typescript
 import { NodeSDK } from '@opentelemetry/sdk-node';
-import { envDetector, hostDetector, processDetector } from '@opentelemetry/resources';
+import { envDetector, hostDetector, processDetector, serviceInstanceIdDetector } from '@opentelemetry/resources';
 import { containerDetector } from '@opentelemetry/resource-detector-container';
 
 const sdk = new NodeSDK({
     // ...
-    resourceDetectors: [envDetector, processDetector, hostDetector, containerDetector],
+    resourceDetectors: [envDetector, processDetector, hostDetector, containerDetector, serviceInstanceIdDetector],
 });
 ```
 
-Note that passing `resourceDetectors` replaces the defaults, so make sure to include the built-in detectors alongside `containerDetector`. The container detector reads `container.id` from `/proc/self/cgroup`. For other k8s attributes (pod name, namespace, node), use the Kubernetes Downward API to inject them as `OTEL_RESOURCE_ATTRIBUTES`:
+**`serviceInstanceIdDetector`** generates a random UUID (`service.instance.id`) at process startup. This gives each deployment instance a unique identity that changes on every restart, which is useful for distinguishing runs in environments where `container.id` is not available (see below).
+
+**`containerDetector`** reads `container.id` from `/proc/self/cgroup`. This works reliably with Docker-based runtimes but not on modern containerd-based Kubernetes clusters (which is the default since k8s 1.24), where the cgroup format does not expose the container ID in the expected location. Add it anyway — it will populate `container.id` when available and is a no-op otherwise.
+
+For k8s identity attributes that cannot be read from the host (pod name, namespace, node), use the Kubernetes Downward API to inject them as `OTEL_RESOURCE_ATTRIBUTES`:
 
 ```yaml
 env:

package/dist/ComprehendDevSpanProcessor.js

@@ -7,7 +7,7 @@ const utils_1 = require("@noble/hashes/utils");
 const api_1 = require("@opentelemetry/api");
 const sqlDbSystems = new Set([
     'mysql', 'postgresql', 'mssql', 'oracle', 'db2', 'sqlite', 'hsqldb', 'h2',
-    'informix', 'cockroachdb', 'redshift', 'tidb', 'trino', 'greenplum'
+    'informix', 'cockroachdb', 'redshift', 'tidb', 'trino', 'greenplum', 'clickhouse'
 ]);
 class ComprehendDevSpanProcessor {
     constructor(connection) {
@@ -174,9 +174,9 @@ class ComprehendDevSpanProcessor {
             : {
                 scrubbed: '',
                 user: undefined,
-                host: (attrs['net.peer.name'] ?? attrs['net.peer.ip']),
-                port: attrs['net.peer.port']?.toString(),
-                name: attrs['db.name'],
+                host: (attrs['server.address'] ?? attrs['net.peer.name'] ?? attrs['net.peer.ip']),
+                port: (attrs['server.port'] ?? attrs['net.peer.port'])?.toString(),
+                name: (attrs['db.namespace'] ?? attrs['db.name']),
             };
         const hash = hashIdString(`database:${system}:${parsed.host ?? ''}:${parsed.port ?? ''}:${parsed.name ?? ''}`);
         let observedDatabase = this.observedDatabases.find(db => db.hash === hash);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comprehend/telemetry-node",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Integration of comprehend.dev with OpenTelemetry in Node.js and similar environemnts.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/ComprehendDevSpanProcessor.ts

@@ -64,7 +64,7 @@ interface ObservedDatabaseConnection {
 
 const sqlDbSystems = new Set([
     'mysql', 'postgresql', 'mssql', 'oracle', 'db2', 'sqlite', 'hsqldb', 'h2',
-    'informix', 'cockroachdb', 'redshift', 'tidb', 'trino', 'greenplum'
+    'informix', 'cockroachdb', 'redshift', 'tidb', 'trino', 'greenplum', 'clickhouse'
 ]);
 
 export class ComprehendDevSpanProcessor implements SpanProcessor {
@@ -257,9 +257,9 @@ export class ComprehendDevSpanProcessor implements SpanProcessor {
             : {
                 scrubbed: '',
                 user: undefined,
-                host: (attrs['net.peer.name'] ?? attrs['net.peer.ip']) as string | undefined,
-                port: (attrs['net.peer.port'] as number | undefined)?.toString(),
-                name: attrs['db.name'] as string | undefined,
+                host: (attrs['server.address'] ?? attrs['net.peer.name'] ?? attrs['net.peer.ip']) as string | undefined,
+                port: (attrs['server.port'] ?? attrs['net.peer.port'] as number | undefined)?.toString(),
+                name: (attrs['db.namespace'] ?? attrs['db.name']) as string | undefined,
             };
 
         const hash = hashIdString(`database:${system}:${parsed.host ?? ''}:${parsed.port ?? ''}:${parsed.name ?? ''}`);