@comprehend/telemetry-node 0.2.3 → 0.2.5

package/.claude/settings.local.json

@@ -2,8 +2,8 @@
   "permissions": {
     "allow": [
       "Bash(npm test:*)",
-      "Bash(pnpm run test:*)"
+      "Bash(grep:*)"
     ],
     "deny": []
   }
-}
+}

package/.idea/telemetry-node.iml

@@ -3,7 +3,6 @@
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
       <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/dist" />
       <excludeFolder url="file://$MODULE_DIR$/temp" />
       <excludeFolder url="file://$MODULE_DIR$/tmp" />
     </content>

package/README.md

@@ -119,16 +119,30 @@ hostMetrics.start();
 
 This collects `process.cpu.time`, `process.cpu.utilization`, and `process.memory.usage`. The `metricGroups` option limits collection to process-level metrics only, avoiding the overhead of system-wide CPU, memory, and network data gathering.
 
+### Service instance identity
+
+Include `serviceInstanceIdDetector` in your `resourceDetectors` to give each running process a unique identity that changes on every restart. This lets comprehend.dev distinguish between different instances of the same service and track restarts over time:
+
+```typescript
+import { envDetector, hostDetector, processDetector, serviceInstanceIdDetector } from '@opentelemetry/resources';
+
+const sdk = new NodeSDK({
+    // ...
+    resourceDetectors: [envDetector, processDetector, hostDetector, serviceInstanceIdDetector],
+});
+```
+
+`serviceInstanceIdDetector` generates a random UUID (`service.instance.id`) at process startup. Note that specifying `resourceDetectors` explicitly replaces the `NodeSDK` defaults, so include the built-in detectors (`envDetector`, `processDetector`, `hostDetector`) alongside it.
+
 ### Kubernetes / container resources
 
-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:
+When running in containers or Kubernetes, add `containerDetector` to your `resourceDetectors`:
 
 ```bash
 npm install @opentelemetry/resource-detector-container
 ```
 
 ```typescript
-import { NodeSDK } from '@opentelemetry/sdk-node';
 import { envDetector, hostDetector, processDetector, serviceInstanceIdDetector } from '@opentelemetry/resources';
 import { containerDetector } from '@opentelemetry/resource-detector-container';
 
@@ -138,8 +152,6 @@ const sdk = new NodeSDK({
 });
 ```
 
-**`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`:

package/dist/ComprehendDevSpanProcessor.js

@@ -351,6 +351,7 @@ class ComprehendDevSpanProcessor {
                     spanId,
                     traceId,
                     timestamp: span.startTime,
+                    duration: span.duration,
                     attributes: collectedAttrs,
                     ...(errorMessage ? { errorMessage } : {}),
                     ...(errorType ? { errorType } : {}),

package/dist/ComprehendDevSpanProcessor.test.js

@@ -304,6 +304,7 @@ describe('ComprehendDevSpanProcessor', () => {
             expect(customObs).toBeDefined();
             expect(customObs.subject).toBe('custom-server-obs');
             expect(customObs.id).toBe('custom-server-obs');
+            expect(customObs.duration).toBeDefined();
             expect(customObs.attributes).toBeDefined();
         });
         it('should match spans by attribute-present rule', () => {

package/dist/ComprehendMetricsExporter.d.ts

@@ -12,7 +12,7 @@ export declare class ComprehendMetricsExporter implements PushMetricExporter {
     private sendTimeSeriesData;
     private sendCumulativeData;
     private getServiceSubject;
-    selectAggregationTemporality(instrumentType: InstrumentType): AggregationTemporality;
+    selectAggregationTemporality(_instrumentType: InstrumentType): AggregationTemporality;
     forceFlush(): Promise<void>;
     shutdown(): Promise<void>;
 }

package/dist/ComprehendMetricsExporter.js

@@ -141,14 +141,8 @@ class ComprehendMetricsExporter {
         const idString = `service:${name}:${namespace ?? ''}:${environment ?? ''}`;
         return hashIdString(idString);
     }
-    selectAggregationTemporality(instrumentType) {
-        switch (instrumentType) {
-            case sdk_metrics_1.InstrumentType.COUNTER:
-            case sdk_metrics_1.InstrumentType.HISTOGRAM:
-                return sdk_metrics_1.AggregationTemporality.DELTA;
-            default:
-                return sdk_metrics_1.AggregationTemporality.CUMULATIVE;
-        }
+    selectAggregationTemporality(_instrumentType) {
+        return sdk_metrics_1.AggregationTemporality.CUMULATIVE;
     }
     async forceFlush() {
     }

package/dist/ComprehendMetricsExporter.test.js

@@ -234,25 +234,17 @@ describe('ComprehendMetricsExporter', () => {
         });
     });
     describe('Aggregation Temporality', () => {
-        it('should return DELTA for COUNTER', () => {
-            expect(exporter.selectAggregationTemporality(sdk_metrics_1.InstrumentType.COUNTER))
-                .toBe(sdk_metrics_1.AggregationTemporality.DELTA);
-        });
-        it('should return DELTA for HISTOGRAM', () => {
-            expect(exporter.selectAggregationTemporality(sdk_metrics_1.InstrumentType.HISTOGRAM))
-                .toBe(sdk_metrics_1.AggregationTemporality.DELTA);
-        });
-        it('should return CUMULATIVE for OBSERVABLE_GAUGE', () => {
-            expect(exporter.selectAggregationTemporality(sdk_metrics_1.InstrumentType.OBSERVABLE_GAUGE))
-                .toBe(sdk_metrics_1.AggregationTemporality.CUMULATIVE);
-        });
-        it('should return CUMULATIVE for OBSERVABLE_COUNTER', () => {
-            expect(exporter.selectAggregationTemporality(sdk_metrics_1.InstrumentType.OBSERVABLE_COUNTER))
-                .toBe(sdk_metrics_1.AggregationTemporality.CUMULATIVE);
-        });
-        it('should return CUMULATIVE for GAUGE', () => {
-            expect(exporter.selectAggregationTemporality(sdk_metrics_1.InstrumentType.GAUGE))
-                .toBe(sdk_metrics_1.AggregationTemporality.CUMULATIVE);
+        it('should return CUMULATIVE for all instrument types', () => {
+            for (const instrumentType of [
+                sdk_metrics_1.InstrumentType.COUNTER,
+                sdk_metrics_1.InstrumentType.HISTOGRAM,
+                sdk_metrics_1.InstrumentType.OBSERVABLE_GAUGE,
+                sdk_metrics_1.InstrumentType.OBSERVABLE_COUNTER,
+                sdk_metrics_1.InstrumentType.GAUGE,
+            ]) {
+                expect(exporter.selectAggregationTemporality(instrumentType))
+                    .toBe(sdk_metrics_1.AggregationTemporality.CUMULATIVE);
+            }
         });
     });
     describe('Lifecycle', () => {

package/dist/sql-analyzer.js

@@ -23,7 +23,6 @@ function analyzeSQL(sql) {
     let skippingValues = false;
     let lookingForCommaOrEnd = false;
     let valuesDepth = 0;
-    let skippedWhitespace = [];
     for (let token of tokenizeSQL(sql)) {
         switch (token.type) {
             case "whitespace":
@@ -137,31 +136,23 @@ function analyzeSQL(sql) {
             switch (token.type) {
                 case "comment":
                 case "whitespace":
-                    // Collect whitespace/comments while looking for comma or end
-                    skippedWhitespace.push(token);
+                    // Skip whitespace/comments while looking for comma or end
                     break;
                 case "punct":
                     if (token.value === ",") {
-                        // More tuples coming, clear skipped whitespace and continue skipping
-                        skippedWhitespace = [];
+                        // More tuples coming, continue skipping
                         lookingForCommaOrEnd = false;
                         skippingValues = true;
                     }
                     else {
                         // Not a comma, so VALUES clause is done
-                        // Add back the skipped whitespace, then the current token
-                        presentableTokens.push(...skippedWhitespace);
                         presentableTokens.push(token);
-                        skippedWhitespace = [];
                         lookingForCommaOrEnd = false;
                     }
                     break;
                 default:
                     // VALUES clause is done, resume normal processing
-                    // Add back the skipped whitespace, then the current token
-                    presentableTokens.push(...skippedWhitespace);
                     presentableTokens.push(token);
-                    skippedWhitespace = [];
                     lookingForCommaOrEnd = false;
                     break;
             }

package/dist/sql-analyzer.test.js

@@ -482,16 +482,4 @@ describe('SQL Analyzer - bulk INSERT VALUES cardinality reduction', () => {
         expect(result.presentableQuery).toEqual(`INSERT INTO comments (text, author) VALUES
             (...)`);
     });
-    it('preserves whitespace before ON CONFLICT after VALUES clause', () => {
-        const sql = `INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com') ON CONFLICT (email) DO NOTHING`;
-        const result = (0, sql_analyzer_1.analyzeSQL)(sql);
-        expect(result.tableOperations).toEqual({ users: ['INSERT'] });
-        expect(result.presentableQuery).toEqual(`INSERT INTO users (name, email) VALUES (...) ON CONFLICT (email) DO NOTHING`);
-    });
-    it('preserves whitespace before ON CONFLICT with multiple VALUES tuples', () => {
-        const sql = `INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com'), ('Bob', 'bob@example.com') ON CONFLICT (email) DO UPDATE SET name = EXCLUDED.name`;
-        const result = (0, sql_analyzer_1.analyzeSQL)(sql);
-        expect(result.tableOperations).toEqual({ users: ['INSERT'] });
-        expect(result.presentableQuery).toEqual(`INSERT INTO users (name, email) VALUES (...) ON CONFLICT (email) DO UPDATE SET name = EXCLUDED.name`);
-    });
 });

package/dist/wire-protocol.d.ts

@@ -120,6 +120,7 @@ export type AttributeType = string | number | boolean;
 export interface CustomObservation extends BaseObservation {
     type: "custom";
     id: string;
+    duration?: HrTime;
     attributes: {
         [key: string]: AttributeType;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comprehend/telemetry-node",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "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.test.ts

@@ -403,6 +403,7 @@ describe('ComprehendDevSpanProcessor', () => {
             expect(customObs).toBeDefined();
             expect(customObs.subject).toBe('custom-server-obs');
             expect(customObs.id).toBe('custom-server-obs');
+            expect(customObs.duration).toBeDefined();
             expect(customObs.attributes).toBeDefined();
         });
 

package/src/ComprehendDevSpanProcessor.ts

@@ -448,6 +448,7 @@ export class ComprehendDevSpanProcessor implements SpanProcessor {
                     spanId,
                     traceId,
                     timestamp: span.startTime,
+                    duration: span.duration,
                     attributes: collectedAttrs,
                     ...(errorMessage ? { errorMessage } : {}),
                     ...(errorType ? { errorType } : {}),

package/src/ComprehendMetricsExporter.test.ts

@@ -296,29 +296,17 @@ describe('ComprehendMetricsExporter', () => {
     });
 
     describe('Aggregation Temporality', () => {
-        it('should return DELTA for COUNTER', () => {
-            expect(exporter.selectAggregationTemporality(InstrumentType.COUNTER))
-                .toBe(AggregationTemporality.DELTA);
-        });
-
-        it('should return DELTA for HISTOGRAM', () => {
-            expect(exporter.selectAggregationTemporality(InstrumentType.HISTOGRAM))
-                .toBe(AggregationTemporality.DELTA);
-        });
-
-        it('should return CUMULATIVE for OBSERVABLE_GAUGE', () => {
-            expect(exporter.selectAggregationTemporality(InstrumentType.OBSERVABLE_GAUGE))
-                .toBe(AggregationTemporality.CUMULATIVE);
-        });
-
-        it('should return CUMULATIVE for OBSERVABLE_COUNTER', () => {
-            expect(exporter.selectAggregationTemporality(InstrumentType.OBSERVABLE_COUNTER))
-                .toBe(AggregationTemporality.CUMULATIVE);
-        });
-
-        it('should return CUMULATIVE for GAUGE', () => {
-            expect(exporter.selectAggregationTemporality(InstrumentType.GAUGE))
-                .toBe(AggregationTemporality.CUMULATIVE);
+        it('should return CUMULATIVE for all instrument types', () => {
+            for (const instrumentType of [
+                InstrumentType.COUNTER,
+                InstrumentType.HISTOGRAM,
+                InstrumentType.OBSERVABLE_GAUGE,
+                InstrumentType.OBSERVABLE_COUNTER,
+                InstrumentType.GAUGE,
+            ]) {
+                expect(exporter.selectAggregationTemporality(instrumentType))
+                    .toBe(AggregationTemporality.CUMULATIVE);
+            }
         });
     });
 

package/src/ComprehendMetricsExporter.ts

@@ -183,14 +183,8 @@ export class ComprehendMetricsExporter implements PushMetricExporter {
         return hashIdString(idString);
     }
 
-    selectAggregationTemporality(instrumentType: InstrumentType): AggregationTemporality {
-        switch (instrumentType) {
-            case InstrumentType.COUNTER:
-            case InstrumentType.HISTOGRAM:
-                return AggregationTemporality.DELTA;
-            default:
-                return AggregationTemporality.CUMULATIVE;
-        }
+    selectAggregationTemporality(_instrumentType: InstrumentType): AggregationTemporality {
+        return AggregationTemporality.CUMULATIVE;
     }
 
     async forceFlush(): Promise<void> {

package/src/wire-protocol.ts

@@ -162,6 +162,7 @@ export type AttributeType = string | number | boolean;
 export interface CustomObservation extends BaseObservation {
     type: "custom";
     id: string;
+    duration?: HrTime;
     attributes: {
         [key: string]: AttributeType
     };