@aztec-labs/telemetry-client 6.0.0-nightly.20260829

package/src/wrappers/fetch.ts

@@ -0,0 +1,50 @@
+import { defaultFetch } from '@aztec-labs/foundation/json-rpc/client';
+import type { Logger } from '@aztec-labs/foundation/log';
+import { makeBackoff, retry } from '@aztec-labs/foundation/retry';
+import { SpanKind, SpanStatusCode, context, propagation } from '@opentelemetry/api';
+
+import { getTelemetryClient } from '../start.js';
+import { ATTR_JSONRPC_METHOD, ATTR_JSONRPC_REQUEST_ID } from '../vendor/attributes.js';
+
+/**
+ * Makes a fetch function that retries based on the given attempts and propagates trace information.
+ * @param retries - Sequence of intervals (in seconds) to retry, or a factory function returning an iterator for custom/indefinite backoff.
+ * @param noRetry - Whether to stop retries on server errors.
+ * @param log - Optional logger for logging attempts.
+ * @returns A fetch function.
+ */
+export function makeTracedFetch(
+  retries: number[] | (() => Generator<number>),
+  defaultNoRetry: boolean,
+  fetch = defaultFetch,
+  log?: Logger,
+) {
+  return (host: string, body: unknown, extraHeaders: Record<string, string> = {}, noRetry?: boolean) => {
+    const telemetry = getTelemetryClient();
+    return telemetry.getTracer('fetch').startActiveSpan(`JsonRpcClient`, { kind: SpanKind.CLIENT }, async span => {
+      try {
+        if (body && typeof body === 'object' && 'id' in body && typeof body.id === 'number') {
+          span.setAttribute(ATTR_JSONRPC_REQUEST_ID, body.id);
+        }
+        if (body && typeof body === 'object' && 'method' in body && typeof body.method === 'string') {
+          span.setAttribute(ATTR_JSONRPC_METHOD, body.method);
+        }
+        const headers = { ...extraHeaders };
+        propagation.inject(context.active(), headers);
+        const backoff = typeof retries === 'function' ? retries() : makeBackoff(retries);
+        return await retry(
+          () => fetch(host, body, headers, noRetry ?? defaultNoRetry),
+          `JsonRpcClient request to ${host}`,
+          backoff,
+          log,
+          false,
+        );
+      } catch (err: any) {
+        span.setStatus({ code: SpanStatusCode.ERROR, message: err?.message ?? String(err) });
+        throw err;
+      } finally {
+        span.end();
+      }
+    });
+  };
+}

package/src/wrappers/index.ts

@@ -0,0 +1,2 @@
+export * from './fetch.js';
+export * from './json_rpc_server.js';

package/src/wrappers/json_rpc_server.ts

@@ -0,0 +1,26 @@
+import { type SafeJsonRpcServerOptions, createSafeJsonRpcServer } from '@aztec-labs/foundation/json-rpc/server';
+import type { ApiSchemaFor } from '@aztec-labs/stdlib/schemas';
+
+import { getOtelJsonRpcServerMetricsMiddleware } from '../json_rpc_server_metrics.js';
+import { getOtelJsonRpcDiagnosticsMiddleware, getOtelJsonRpcPropagationMiddleware } from '../otel_propagation.js';
+
+export function createTracedJsonRpcServer<T extends object = any>(
+  handler: T,
+  schema: ApiSchemaFor<T>,
+  options: SafeJsonRpcServerOptions = {},
+) {
+  const otelDiagnostics = getOtelJsonRpcDiagnosticsMiddleware();
+  const diagnostic = options.diagnostic
+    ? (ctx: Parameters<typeof otelDiagnostics>[0], next: Parameters<typeof otelDiagnostics>[1]) =>
+        options.diagnostic!(ctx, () => otelDiagnostics(ctx, next))
+    : otelDiagnostics;
+  return createSafeJsonRpcServer(handler, schema, {
+    ...options,
+    diagnostic,
+    middlewares: [
+      getOtelJsonRpcServerMetricsMiddleware(),
+      ...(options.middlewares ?? []),
+      getOtelJsonRpcPropagationMiddleware(),
+    ],
+  });
+}