@comprehend/telemetry-node 0.1.0

package/dist/wire-protocol.d.ts

@@ -0,0 +1,110 @@
+import { HrTime } from "@opentelemetry/api";
+export type ObservationInputMessage = InitMessage | NewObservedEntityMessage | NewObservedInteractionMessage | ObservationMessage;
+export type ObservationOutputMessage = InitAck | ObservedAck | ObservationsAck;
+export interface InitMessage {
+    event: "init";
+    protocolVersion: 1;
+    token: string;
+}
+export interface NewObservedEntityMessage {
+    event: "new-entity";
+    type: string;
+    hash: string;
+}
+export interface NewObservedServiceMessage extends NewObservedEntityMessage {
+    type: "service";
+    name: string;
+    namespace?: string;
+    environment?: string;
+}
+export interface NewObservedHttpRouteMessage extends NewObservedEntityMessage {
+    type: "http-route";
+    parent: string;
+    method: string;
+    route: string;
+}
+export interface NewObservedDatabaseMessage extends NewObservedEntityMessage {
+    type: "database";
+    system: string;
+    name?: string;
+    host?: string;
+    port?: number;
+}
+export interface NewObservedHttpServiceMessage extends NewObservedEntityMessage {
+    type: "http-service";
+    protocol: string;
+    host: string;
+    port: number;
+}
+export interface NewObservedInteractionMessage {
+    event: "new-interaction";
+    type: string;
+    hash: string;
+    from: string;
+    to: string;
+}
+export interface NewObservedHttpRequestMessage extends NewObservedInteractionMessage {
+    type: "http-request";
+}
+export interface NewObservedDatabaseConnectionMessage extends NewObservedInteractionMessage {
+    type: "db-connection";
+    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;
+    subject: string;
+    timestamp: HrTime;
+    errorMessage?: string;
+    errorType?: string;
+    stack?: string;
+}
+export interface HttpClientObservation extends Observation {
+    type: "http-client";
+    path: string;
+    method: string;
+    duration: HrTime;
+    status?: number;
+    httpVersion?: string;
+    requestBytes?: number;
+    responseBytes?: number;
+}
+export interface HttpServerObservation extends Observation {
+    type: "http-server";
+    path: string;
+    status: number;
+    duration: HrTime;
+    httpVersion?: string;
+    requestBytes?: number;
+    responseBytes?: number;
+    userAgent?: string;
+}
+export interface DatabaseQueryObservation extends Observation {
+    type: "db-query";
+    duration: HrTime;
+    returnedRows?: number;
+}
+export interface InitAck {
+    type: "ack-authorized";
+}
+export interface ObservedAck {
+    type: "ack-observed";
+    hash: string;
+}
+export interface ObservationsAck {
+    type: "ack-observations";
+    seq: number;
+}

package/dist/wire-protocol.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/jest.config.js

@@ -0,0 +1,11 @@
+const { createDefaultPreset } = require("ts-jest");
+
+const tsJestTransformCfg = createDefaultPreset().transform;
+
+/** @type {import("jest").Config} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    ...tsJestTransformCfg,
+  },
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@comprehend/telemetry-node",
+  "version": "0.1.0",
+  "description": "Integration of comprehend.dev with OpenTelemetry in Node.js and similar environemnts.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "jest"
+  },
+  "keywords": [],
+  "author": "Comprehend AB",
+  "license": "LicenseRef-Proprietary-Audit",
+  "private": false,
+  "dependencies": {
+    "@noble/hashes": "^1.8.0",
+    "ws": "^8.18.2"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/sdk-trace-base": "^2.0.1"
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/sdk-trace-base": "^2.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.14.1",
+    "@types/ws": "^8.18.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
+}