@aztec/telemetry-client 4.0.0-nightly.20260107 → 4.0.0-nightly.20260110

package/dest/telemetry.js

@@ -1,6 +1,6 @@
 import { SpanStatusCode } from '@opentelemetry/api';
-import { isPromise } from 'node:util/types';
 import { getTelemetryClient } from './start.js';
+export { toMetricOptions } from './metric-utils.js';
 export { SpanStatusCode, ValueType } from '@opentelemetry/api';
 /**
  * Starts a new span whenever the decorated method is called.
@@ -89,35 +89,51 @@ export { SpanStatusCode, ValueType } from '@opentelemetry/api';
 export function runInSpan(tracer, spanName, callback) {
     return (...args)=>{
         const actualTracer = typeof tracer === 'string' ? getTelemetryClient().getTracer(tracer) : tracer;
-        return actualTracer.startActiveSpan(spanName, (span)=>{
-            let deferSpanEnd = false;
+        return actualTracer.startActiveSpan(spanName, async (span)=>{
             try {
-                const res = callback(span, ...args);
-                if (isPromise(res)) {
-                    deferSpanEnd = true;
-                    return res.catch((err)=>{
-                        span.setStatus({
-                            code: SpanStatusCode.ERROR,
-                            message: String(err)
-                        });
-                        throw err;
-                    }).finally(()=>{
-                        span.end();
-                    });
-                } else {
-                    return res;
-                }
+                const res = await callback(span, ...args);
+                span.setStatus({
+                    code: SpanStatusCode.OK
+                });
+                return res;
             } catch (err) {
                 span.setStatus({
                     code: SpanStatusCode.ERROR,
                     message: String(err)
                 });
+                if (typeof err === 'string' || err && err instanceof Error) {
+                    span.recordException(err);
+                }
                 throw err;
             } finally{
-                if (!deferSpanEnd) {
-                    span.end();
-                }
+                span.end();
             }
         });
     };
 }
+/**
+ * Execute a callback within a span immediately (for one-off traced calls).
+ * Unlike runInSpan which returns a reusable function, this executes right away.
+ */ export function execInSpan(tracer, spanName, callback) {
+    const actualTracer = typeof tracer === 'string' ? getTelemetryClient().getTracer(tracer) : tracer;
+    return actualTracer.startActiveSpan(spanName, async (span)=>{
+        try {
+            const res = await callback(span);
+            span.setStatus({
+                code: SpanStatusCode.OK
+            });
+            return res;
+        } catch (err) {
+            span.setStatus({
+                code: SpanStatusCode.ERROR,
+                message: String(err)
+            });
+            if (typeof err === 'string' || err && err instanceof Error) {
+                span.recordException(err);
+            }
+            throw err;
+        } finally{
+            span.end();
+        }
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/telemetry-client",
-  "version": "4.0.0-nightly.20260107",
+  "version": "4.0.0-nightly.20260110",
   "inherits": [
     "../package.common.json"
   ],
@@ -27,8 +27,8 @@
     "!*.test.*"
   ],
   "dependencies": {
-    "@aztec/foundation": "4.0.0-nightly.20260107",
-    "@aztec/stdlib": "4.0.0-nightly.20260107",
+    "@aztec/foundation": "4.0.0-nightly.20260110",
+    "@aztec/stdlib": "4.0.0-nightly.20260110",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/api-logs": "^0.55.0",
     "@opentelemetry/core": "^1.28.0",

package/src/bench.ts

@@ -2,13 +2,13 @@ import { createLogger } from '@aztec/foundation/log';
 
 import type { BatchObservableCallback, Context, MetricOptions, Observable, ValueType } from '@opentelemetry/api';
 
+import type { MetricDefinition } from './metrics.js';
 import { NoopTracer } from './noop.js';
 import type {
   AttributesType,
   Gauge,
   Histogram,
   Meter,
-  MetricsType,
   ObservableGauge,
   ObservableUpDownCounter,
   TelemetryClient,
@@ -61,6 +61,14 @@ export class BenchmarkTelemetryClient implements TelemetryClient {
     return true;
   }
 
+  getTraceContext(): string | undefined {
+    return undefined;
+  }
+
+  extractPropagatedContext() {
+    return undefined;
+  }
+
   getMeters(): BenchmarkMetricsType {
     return this.meters;
   }
@@ -79,30 +87,34 @@ class InMemoryPlainMeter implements Meter {
     this.metrics.forEach(metric => metric.clear());
   }
 
-  createGauge(name: MetricsType, options?: MetricOptions): Gauge {
-    return this.createMetric('gauge', name, options);
+  createGauge(metric: MetricDefinition): Gauge {
+    return this.createMetric('gauge', metric);
   }
 
-  createObservableGauge(name: MetricsType, options?: MetricOptions): ObservableGauge {
-    return this.createMetric('gauge', name, options);
+  createObservableGauge(metric: MetricDefinition): ObservableGauge {
+    return this.createMetric('gauge', metric);
   }
 
-  createHistogram(name: MetricsType, options?: MetricOptions): Histogram {
-    return this.createMetric('histogram', name, options);
+  createHistogram(metric: MetricDefinition, _extraOptions?: Partial<MetricOptions>): Histogram {
+    return this.createMetric('histogram', metric);
   }
 
-  createUpDownCounter(name: MetricsType, options?: MetricOptions): UpDownCounter {
-    return this.createMetric('counter', name, options);
+  createUpDownCounter(metric: MetricDefinition): UpDownCounter {
+    return this.createMetric('counter', metric);
   }
 
-  createObservableUpDownCounter(name: MetricsType, options?: MetricOptions): ObservableUpDownCounter {
-    return this.createMetric('counter', name, options);
+  createObservableUpDownCounter(metric: MetricDefinition): ObservableUpDownCounter {
+    return this.createMetric('counter', metric);
   }
 
-  private createMetric(type: 'gauge' | 'counter' | 'histogram', name: string, options?: MetricOptions) {
-    const metric = new InMemoryPlainMetric(type, name, options);
-    this.metrics.push(metric);
-    return metric;
+  private createMetric(type: 'gauge' | 'counter' | 'histogram', metric: MetricDefinition) {
+    const m = new InMemoryPlainMetric(type, metric.name, {
+      description: metric.description,
+      unit: metric.unit,
+      valueType: metric.valueType,
+    });
+    this.metrics.push(m);
+    return m;
   }
 
   addBatchObservableCallback(

package/src/l1_metrics.ts

@@ -4,7 +4,7 @@ import { type Chain, type FallbackTransport, type Hex, type HttpTransport, type
 
 import { L1_SENDER } from './attributes.js';
 import { L1_BALANCE_ETH, L1_BLOB_BASE_FEE_WEI, L1_BLOCK_HEIGHT, L1_GAS_PRICE_WEI } from './metrics.js';
-import { type BatchObservableResult, type Meter, type ObservableGauge, ValueType } from './telemetry.js';
+import type { BatchObservableResult, Meter, ObservableGauge } from './telemetry.js';
 
 export class L1Metrics {
   private l1BlockHeight: ObservableGauge;
@@ -18,25 +18,10 @@ export class L1Metrics {
     private client: PublicClient<FallbackTransport<HttpTransport[]>, Chain>,
     addresses: EthAddress[],
   ) {
-    this.l1BlockHeight = meter.createObservableGauge(L1_BLOCK_HEIGHT, {
-      description: 'The latest L1 block seen',
-      valueType: ValueType.INT,
-    });
-    this.l1BalanceEth = meter.createObservableGauge(L1_BALANCE_ETH, {
-      description: 'Eth balance of an address',
-      unit: 'eth',
-      valueType: ValueType.DOUBLE,
-    });
-    this.gasPriceWei = meter.createObservableGauge(L1_GAS_PRICE_WEI, {
-      description: 'L1 gas price',
-      unit: 'wei',
-      valueType: ValueType.DOUBLE,
-    });
-    this.blobBaseFeeWei = meter.createObservableGauge(L1_BLOB_BASE_FEE_WEI, {
-      description: 'L1 blob fee',
-      unit: 'wei',
-      valueType: ValueType.DOUBLE,
-    });
+    this.l1BlockHeight = meter.createObservableGauge(L1_BLOCK_HEIGHT);
+    this.l1BalanceEth = meter.createObservableGauge(L1_BALANCE_ETH);
+    this.gasPriceWei = meter.createObservableGauge(L1_GAS_PRICE_WEI);
+    this.blobBaseFeeWei = meter.createObservableGauge(L1_BLOB_BASE_FEE_WEI);
 
     this.addresses = addresses.map(addr => addr.toString());
   }

package/src/lmdb_metrics.ts

@@ -1,11 +1,5 @@
 import * as Metrics from './metrics.js';
-import {
-  type AttributesType,
-  type BatchObservableResult,
-  type Meter,
-  type ObservableGauge,
-  ValueType,
-} from './telemetry.js';
+import type { AttributesType, BatchObservableResult, Meter, ObservableGauge } from './telemetry.js';
 
 export type LmdbStatsCallback = () => Promise<{
   mappingSize: number;
@@ -25,25 +19,10 @@ export class LmdbMetrics {
     private attributes?: AttributesType,
     private getStats?: LmdbStatsCallback,
   ) {
-    this.dbMapSize = meter.createObservableGauge(Metrics.DB_MAP_SIZE, {
-      description: 'LMDB Map Size',
-      valueType: ValueType.INT,
-      unit: 'By',
-    });
-    this.dbPhysicalFileSize = meter.createObservableGauge(Metrics.DB_PHYSICAL_FILE_SIZE, {
-      description: 'LMDB Physical File Size',
-      valueType: ValueType.INT,
-      unit: 'By',
-    });
-    this.dbUsedSize = meter.createObservableGauge(Metrics.DB_USED_SIZE, {
-      description: 'LMDB Used Size',
-      valueType: ValueType.INT,
-      unit: 'By',
-    });
-    this.dbNumItems = meter.createObservableGauge(Metrics.DB_NUM_ITEMS, {
-      description: 'LMDB Num Items',
-      valueType: ValueType.INT,
-    });
+    this.dbMapSize = meter.createObservableGauge(Metrics.DB_MAP_SIZE);
+    this.dbPhysicalFileSize = meter.createObservableGauge(Metrics.DB_PHYSICAL_FILE_SIZE);
+    this.dbUsedSize = meter.createObservableGauge(Metrics.DB_USED_SIZE);
+    this.dbNumItems = meter.createObservableGauge(Metrics.DB_NUM_ITEMS);
 
     meter.addBatchObservableCallback(this.recordDBMetrics, [
       this.dbMapSize,

package/src/metric-utils.ts

@@ -0,0 +1,12 @@
+import type { MetricOptions } from '@opentelemetry/api';
+
+import type { MetricDefinition } from './metrics.js';
+
+/** Extracts OpenTelemetry MetricOptions from a MetricDefinition */
+export function toMetricOptions(def: MetricDefinition): MetricOptions {
+  return {
+    description: def.description,
+    unit: def.unit,
+    valueType: def.valueType,
+  };
+}