@comprehend/telemetry-node 0.1.3 → 0.2.0

package/dist/wire-protocol.d.ts

@@ -1,15 +1,40 @@
-import { HrTime } from "@opentelemetry/api";
-export type ObservationInputMessage = InitMessage | NewObservedEntityMessage | NewObservedInteractionMessage | ObservationMessage;
-export type ObservationOutputMessage = InitAck | ObservedAck | ObservationsAck;
+export type HrTime = [number, number];
+export type ObservationInputMessage = InitMessage | StartProcessContextMessage | EndContextMessage | NewObservedEntityMessage | NewObservedInteractionMessage | ObservationMessage | TimeSeriesMetricsMessage | CumulativeMetricsMessage | TraceSpansMessage | DatabaseQueryMessage;
+export type ObservationOutputMessage = InitAck | ContextAck | CustomMetricChange | ObservedAck | ObservationsAck | TimeSeriesMetricsAck | CumulativeMetricsAck | TraceSpansAck | DatabaseQueryAck;
 export interface InitMessage {
     event: "init";
-    protocolVersion: 1;
+    protocolVersion: 2;
     token: string;
 }
+export interface InitAck {
+    type: "ack-authorized";
+    customMetrics: CustomMetricSpecification[];
+}
+export interface StartProcessContextMessage {
+    event: "context-start";
+    seq: number;
+    timestamp: HrTime;
+    ingestionId: string;
+    type: "process";
+    serviceEntityHash: string;
+    resources: {
+        [key: string]: AttributeType;
+    };
+}
+export interface EndContextMessage {
+    event: "context-end";
+    seq: number;
+    timestamp: HrTime;
+    ingestionId: string;
+}
+export interface ContextAck {
+    type: "ack-context";
+    seq: number;
+}
 export interface NewObservedEntityMessage {
     event: "new-entity";
-    type: string;
     hash: string;
+    type: string;
 }
 export interface NewObservedServiceMessage extends NewObservedEntityMessage {
     type: "service";
@@ -36,12 +61,16 @@ export interface NewObservedHttpServiceMessage extends NewObservedEntityMessage
     host: string;
     port: number;
 }
+export interface ObservedAck {
+    type: "ack-observed";
+    hash: string;
+}
 export interface NewObservedInteractionMessage {
     event: "new-interaction";
-    type: string;
     hash: string;
     from: string;
     to: string;
+    type: string;
 }
 export interface NewObservedHttpRequestMessage extends NewObservedInteractionMessage {
     type: "http-request";
@@ -51,28 +80,23 @@ export interface NewObservedDatabaseConnectionMessage extends NewObservedInterac
     connection?: string;
     user?: string;
 }
-export interface NewObservedDatabaseQueryMessage extends NewObservedInteractionMessage {
-    type: "db-query";
-    query: string;
-    selects?: string[];
-    inserts?: string[];
-    updates?: string[];
-    deletes?: string[];
-}
 export interface ObservationMessage {
     event: "observations";
     seq: number;
     observations: Array<Observation>;
 }
-export interface Observation {
-    type: string;
+export type Observation = HttpClientObservation | HttpServerObservation | CustomObservation;
+interface BaseObservation {
     subject: string;
+    spanId: string;
+    traceId: string;
     timestamp: HrTime;
     errorMessage?: string;
     errorType?: string;
     stack?: string;
+    type: string;
 }
-export interface HttpClientObservation extends Observation {
+export interface HttpClientObservation extends BaseObservation {
     type: "http-client";
     path: string;
     method: string;
@@ -82,7 +106,7 @@ export interface HttpClientObservation extends Observation {
     requestBytes?: number;
     responseBytes?: number;
 }
-export interface HttpServerObservation extends Observation {
+export interface HttpServerObservation extends BaseObservation {
     type: "http-server";
     path: string;
     status: number;
@@ -92,19 +116,135 @@ export interface HttpServerObservation extends Observation {
     responseBytes?: number;
     userAgent?: string;
 }
-export interface DatabaseQueryObservation extends Observation {
-    type: "db-query";
+export type AttributeType = string | number | boolean;
+export interface CustomObservation extends BaseObservation {
+    type: "custom";
+    id: string;
+    attributes: {
+        [key: string]: AttributeType;
+    };
+}
+export interface ObservationsAck {
+    type: "ack-observations";
+    seq: number;
+}
+export interface TimeSeriesMetricsMessage {
+    event: "timeseries";
+    seq: number;
+    data: TimeSeriesDataPoint[];
+}
+export interface TimeSeriesDataPoint {
+    subject: string;
+    type: string;
+    timestamp: HrTime;
+    value: number;
+    unit: string;
+    attributes: {
+        [key: string]: AttributeType;
+    };
+}
+export interface TimeSeriesMetricsAck {
+    type: "ack-timeseries";
+    seq: number;
+}
+export interface CumulativeMetricsMessage {
+    event: "cumulative";
+    seq: number;
+    data: CumulativeDataPoint[];
+}
+export interface CumulativeDataPoint {
+    subject: string;
+    type: string;
+    timestamp: HrTime;
+    value: number;
+    unit: string;
+    attributes: {
+        [key: string]: AttributeType;
+    };
+}
+export interface CumulativeMetricsAck {
+    type: "ack-cumulative";
+    seq: number;
+}
+export interface TraceSpansMessage {
+    event: "tracespans";
+    seq: number;
+    data: TraceSpan[];
+}
+export interface TraceSpan {
+    trace: string;
+    span: string;
+    parent: string;
+    name: string;
+    timestamp: HrTime;
+}
+export interface TraceSpansAck {
+    type: "ack-tracespans";
+    seq: number;
+}
+export interface DatabaseQueryMessage {
+    event: "db-query";
+    seq: number;
+    query: string;
+    from: string;
+    to: string;
+    timestamp: HrTime;
     duration: HrTime;
+    traceId?: string;
+    spanId?: string;
+    errorMessage?: string;
+    errorType?: string;
+    stack?: string;
     returnedRows?: number;
 }
-export interface InitAck {
-    type: "ack-authorized";
+export interface DatabaseQueryAck {
+    type: "ack-db-query";
+    seq: number;
 }
-export interface ObservedAck {
-    type: "ack-observed";
-    hash: string;
+export interface CustomMetricChange {
+    type: "custom-metric-change";
+    customMetrics: CustomMetricSpecification[];
 }
-export interface ObservationsAck {
-    type: "ack-observations";
-    seq: number;
+export type CustomMetricSpecification = CustomCumulativeMetricSpecification | CustomTimeSeriesMetricSpecification | CustomSpanObservationSpecification;
+export interface CustomCumulativeMetricSpecification {
+    type: "cumulative";
+    id: string;
+    attributes: string[];
+    subject: string;
+}
+export interface CustomTimeSeriesMetricSpecification {
+    type: "timeseries";
+    id: string;
+    attributes: string[];
+    subject: string;
+}
+export interface CustomSpanObservationSpecification {
+    type: "span";
+    rule: SpanMatcherRule;
+    subject: string;
 }
+export type SpanMatcherRule = {
+    kind: "type";
+    value: "client" | "server" | "internal";
+} | {
+    kind: "attribute-present";
+    key: string;
+} | {
+    kind: "attribute-absent";
+    key: string;
+} | {
+    kind: "attribute-equals";
+    key: string;
+    value: string;
+} | {
+    kind: "attribute-not-equals";
+    key: string;
+    value: string;
+} | {
+    kind: "all";
+    rules: SpanMatcherRule[];
+} | {
+    kind: "any";
+    rules: SpanMatcherRule[];
+};
+export {};

package/jest.config.js

@@ -8,4 +8,5 @@ module.exports = {
   transform: {
     ...tsJestTransformCfg,
   },
+  testPathIgnorePatterns: ["/node_modules/", "/dist/"],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comprehend/telemetry-node",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Integration of comprehend.dev with OpenTelemetry in Node.js and similar environemnts.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,7 @@
     "test": "jest"
   },
   "keywords": [],
-  "author": "Comprehend AB",
+  "author": "Comprehend.dev AB",
   "license": "LicenseRef-Proprietary-Audit",
   "private": false,
   "dependencies": {
@@ -19,10 +19,12 @@
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/sdk-metrics": "^2.0.0",
     "@opentelemetry/sdk-trace-base": "^2.0.1"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/sdk-metrics": "^2.5.1",
     "@opentelemetry/sdk-trace-base": "^2.0.1",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.14.1",