open telemetry

.zed/settings.json

@@ -1,4 +1,8 @@
 {
+    "code_actions_on_format": {
+        "source.organizeImports.biome": true,
+        "source.fixAll.biome": true
+    },
     "formatter": {
         "external": {
             "command": "bunx",

package.json

@@ -8,6 +8,7 @@
     "scripts": {
         "build": "turbo build",
         "build:sdk": "turbo build --filter=surrealdb",
+        "build:opentelemetry": "turbo build --filter=@surrealdb/opentelemetry",
         "build:wasm": "turbo build --filter=@surrealdb/wasm",
         "build:node": "turbo build --filter=@surrealdb/node --",
         "test": "bun run build:sdk && cd packages/tests && bun test --preload ./global.ts",

packages/sdk/build.ts

@@ -4,8 +4,8 @@ import { rolldown } from "rolldown";
 const bundle = await rolldown({
     input: "./src/index.ts",
 });
-await bundle.write({ format: "esm", file: "./dist/surrealdb.mjs" });
-await bundle.write({ format: "cjs", file: "./dist/surrealdb.cjs" });
+await bundle.write({ format: "esm", file: "./dist/surrealdb.mjs", inlineDynamicImports: true });
+await bundle.write({ format: "cjs", file: "./dist/surrealdb.cjs", inlineDynamicImports: true });
 
 // Server-side bundle (Node/Bun/Deno)
 const serverBundle = await rolldown({

packages/sdk/src/api/surreal.ts

@@ -128,6 +128,13 @@ export class Surreal extends SurrealSession implements EventPublisher<SurrealEve
         return this.#connection.ready();
     }
 
+    /**
+     * Returns the url of the database used for the current connection
+     */
+    get url(): URL | undefined {
+        return this.#connection.state?.url;
+    }
+
     // =========================================================== //
     //                                                             //
     //                     Connection Methods                      //

packages/sdk/src/engine/websocket.ts

@@ -6,6 +6,7 @@ import {
     UnexpectedConnectionError,
     UnexpectedServerResponseError,
 } from "../errors";
+import { getCurrentTraceparent } from "../telemetry";
 import type { LiveAction, LiveMessage, RpcRequest, RpcResponse } from "../types";
 import { LIVE_ACTIONS } from "../types/live";
 import type { ConnectionState, EngineEvents, SurrealEngine } from "../types/surreal";
@@ -139,9 +140,11 @@ export class WebSocketEngine extends RpcEngine implements SurrealEngine {
         }
     }
 
-    override send<Method extends string, Params extends unknown[] | undefined, Result>(
+    override async send<Method extends string, Params extends unknown[] | undefined, Result>(
         request: RpcRequest<Method, Params>,
     ): Promise<Result> {
+        const traceparent = await getCurrentTraceparent();
+
         return new Promise((resolve, reject) => {
             if (!this.#active) {
                 reject(new ConnectionUnavailableError());
@@ -150,7 +153,7 @@ export class WebSocketEngine extends RpcEngine implements SurrealEngine {
 
             const id = this._context.uniqueId();
             const call: Call<Result> = {
-                request: { id, ...request },
+                request: { id, ...request, traceparent },
                 resolve,
                 reject,
             };

packages/sdk/src/telemetry/index.ts

@@ -0,0 +1,11 @@
+export const getCurrentTraceparent = async (): Promise<string | undefined> => {
+    try {
+        const api = await import("@opentelemetry/api");
+        const carrier: Record<string, string> = {};
+        api.propagation.inject(api.context.active(), carrier);
+
+        return carrier.traceparent;
+    } catch {
+        return undefined;
+    }
+};

packages/sdk/src/types/rpc.ts

@@ -23,6 +23,7 @@ export type RpcRequest<
     session?: Session;
     params?: Params;
     txn?: Uuid;
+    traceparent?: string;
 };
 
 export type RpcResponse<Result = unknown> = RpcSuccessResponse<Result> | RpcErrorResponse;

packages/telemetry/build.ts

@@ -0,0 +1,34 @@
+import { rolldown } from "rolldown";
+
+// Primary
+const bundle = await rolldown({
+    input: "./src/index.ts",
+    external: [/^@opentelemetry\//],
+});
+await bundle.write({
+    format: "esm",
+    file: "./dist/surrealdb-telemetry.mjs",
+});
+
+// TS Declarations
+const task = Bun.spawn(
+    [
+        "bunx",
+        "dts-bundle-generator",
+        "-o",
+        "./dist/surrealdb-telemetry.d.ts",
+        "./src/index.ts",
+        "--no-check",
+        "--export-referenced-types",
+        "false",
+    ],
+    {
+        stdout: "inherit",
+        stderr: "inherit",
+        async onExit(_, exitCode) {
+            if (exitCode !== 0) process.exit(exitCode);
+        },
+    },
+);
+
+await task.exited;

packages/telemetry/package.json

@@ -0,0 +1,43 @@
+{
+    "name": "@surrealdb/opentelemetry",
+    "version": "0.1.0",
+    "type": "module",
+    "license": "Apache-2.0",
+    "description": "OpenTelemetry instrumentation for `surrealdb` database client for SurrealDB",
+    "homepage": "https://github.com/surrealdb/surrealdb.js",
+    "keywords": [
+        "surrealdb",
+        "surrealdb.js",
+        "otel",
+        "telemetry"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/surrealdb/surrealdb.js.git"
+    },
+    "scripts": {
+        "build": "bun run build.ts",
+        "deploy": "bun run ../../scripts/publish.ts"
+    },
+    "peerDependencies": {
+        "@opentelemetry/api": "^1.9.0",
+        "@opentelemetry/instrumentation": "^0.211.0",
+        "@opentelemetry/semantic-conventions": "^1.39.0"
+    },
+    "devDependencies": {
+        "surrealdb": "^2.0.0-0"
+    },
+    "main": "./dist/surrealdb-telemetry.mjs",
+    "types": "./dist/surrealdb-telemetry.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/surrealdb-telemetry.mjs",
+            "types": "./dist/surrealdb-telemetry.d.ts"
+        }
+    },
+    "files": [
+        "dist",
+        "LICENCE",
+        "SECURITY.md"
+    ]
+}

packages/telemetry/src/constants.ts

@@ -0,0 +1,3 @@
+export { name as PACKAGE_NAME, version as PACKAGE_VERSION } from "../package.json";
+
+export const SERVER_SYSTEM_NAME = "surrealdb";

packages/telemetry/src/index.ts

@@ -0,0 +1 @@
+export { SurrealDBInstrumentation } from "./instrumentation";