@aztec/telemetry-client 0.0.1-commit.b655e406 → 0.0.1-commit.b9865e97

package/src/config.ts

@@ -1,4 +1,9 @@
-import { type ConfigMappingsType, booleanConfigHelper, getConfigFromMappings } from '@aztec/foundation/config';
+import {
+  type ConfigMappingsType,
+  booleanConfigHelper,
+  getConfigFromMappings,
+  numberConfigHelper,
+} from '@aztec/foundation/config';
 
 export interface TelemetryClientConfig {
   metricsCollectorUrl?: URL;
@@ -11,35 +16,36 @@ export interface TelemetryClientConfig {
   otelCollectIntervalMs: number;
   otelExportTimeoutMs: number;
   otelExcludeMetrics: string[];
+  otelIncludeMetrics: string[];
+  otelMinTraceDurationMs: number;
+  otelBspMaxQueueSize: number;
 }
 
 export const telemetryClientConfigMappings: ConfigMappingsType<TelemetryClientConfig> = {
   metricsCollectorUrl: {
     env: 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT',
     description: 'The URL of the telemetry collector for metrics',
-    parseEnv: (val: string) => val && new URL(val),
+    parseEnv: (val: string) => new URL(val),
   },
   tracesCollectorUrl: {
     env: 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT',
     description: 'The URL of the telemetry collector for traces',
-    parseEnv: (val: string) => val && new URL(val),
+    parseEnv: (val: string) => new URL(val),
   },
   logsCollectorUrl: {
     env: 'OTEL_EXPORTER_OTLP_LOGS_ENDPOINT',
     description: 'The URL of the telemetry collector for logs',
-    parseEnv: (val: string) => val && new URL(val),
+    parseEnv: (val: string) => new URL(val),
   },
   otelCollectIntervalMs: {
     env: 'OTEL_COLLECT_INTERVAL_MS',
     description: 'The interval at which to collect metrics',
-    defaultValue: 60000, // Default extracted from otel client
-    parseEnv: (val: string) => parseInt(val),
+    ...numberConfigHelper(60000),
   },
   otelExportTimeoutMs: {
     env: 'OTEL_EXPORT_TIMEOUT_MS',
     description: 'The timeout for exporting metrics',
-    defaultValue: 30000, // Default extracted from otel client
-    parseEnv: (val: string) => parseInt(val),
+    ...numberConfigHelper(30000),
   },
   otelExcludeMetrics: {
     env: 'OTEL_EXCLUDE_METRICS',
@@ -53,11 +59,33 @@ export const telemetryClientConfigMappings: ConfigMappingsType<TelemetryClientCo
         : [],
     defaultValue: [],
   },
+  otelMinTraceDurationMs: {
+    env: 'OTEL_MIN_TRACE_DURATION_MS',
+    description: 'The minimum successful trace duration to export in milliseconds. Set to 0 to export all traces.',
+    ...numberConfigHelper(10),
+  },
+  otelBspMaxQueueSize: {
+    env: 'OTEL_BSP_MAX_QUEUE_SIZE',
+    description: 'The maximum number of completed spans to queue before export.',
+    ...numberConfigHelper(16384),
+  },
+  otelIncludeMetrics: {
+    env: 'OTEL_INCLUDE_METRICS',
+    description: 'A list of metric prefixes to include in export (ignored if OTEL_EXCLUDE_METRICS is set)',
+    parseEnv: (val: string) =>
+      val
+        ? val
+            .split(',')
+            .map(s => s.trim())
+            .filter(s => s.length > 0)
+        : [],
+    defaultValue: [],
+  },
 
   publicMetricsCollectorUrl: {
     env: 'PUBLIC_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT',
     description: 'A URL to publish a subset of metrics for public consumption',
-    parseEnv: (val: string) => val && new URL(val),
+    parseEnv: (val: string) => new URL(val),
   },
   publicMetricsCollectFrom: {
     env: 'PUBLIC_OTEL_COLLECT_FROM',
@@ -86,7 +114,7 @@ export const telemetryClientConfigMappings: ConfigMappingsType<TelemetryClientCo
   publicMetricsOptOut: {
     env: 'PUBLIC_OTEL_OPT_OUT',
     description: 'Whether to opt out of sharing optional telemetry',
-    ...booleanConfigHelper(false),
+    ...booleanConfigHelper(true),
   },
 };
 

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,75 @@
+import type { AttributeValue, MetricOptions } from '@opentelemetry/api';
+
+import type { MetricDefinition } from './metrics.js';
+import type { AllowedAttributeNames, Meter, MetricAttributesType, UpDownCounter } from './telemetry.js';
+
+/** Extracts OpenTelemetry MetricOptions from a MetricDefinition */
+export function toMetricOptions(def: MetricDefinition): MetricOptions {
+  return {
+    description: def.description,
+    unit: def.unit,
+    valueType: def.valueType,
+  };
+}
+
+/** A mapping of attribute keys to their possible values */
+export type AttributeValuesMap = Partial<Record<AllowedAttributeNames, AttributeValue[]>>;
+
+/**
+ * Expands an attribute values map into all combinations of attribute objects.
+ * Example: { status: ['ok', 'fail'], type: ['a', 'b'] } =>
+ *   [{ status: 'ok', type: 'a' }, { status: 'ok', type: 'b' }, { status: 'fail', type: 'a' }, { status: 'fail', type: 'b' }]
+ */
+export function expandAttributeCombinations(attrMap: AttributeValuesMap): MetricAttributesType[] {
+  const keys = Object.keys(attrMap) as AllowedAttributeNames[];
+  if (keys.length === 0) {
+    return [{}];
+  }
+
+  const result: MetricAttributesType[] = [];
+
+  function generate(index: number, current: MetricAttributesType) {
+    if (index === keys.length) {
+      result.push({ ...current });
+      return;
+    }
+    const key = keys[index];
+    for (const value of attrMap[key]!) {
+      current[key] = value;
+      generate(index + 1, current);
+    }
+  }
+
+  generate(0, {});
+  return result;
+}
+
+/**
+ * Creates an UpDownCounter and initializes it to 0.
+ * @param meter - The meter to create the counter on
+ * @param metric - The metric definition
+ * @param attributes - Optional attributes for initialization. Can be:
+ *   - AttributeValuesMap: mapping of attribute keys to arrays of possible values (generates cartesian product)
+ *   - MetricAttributesType[]: explicit array of attribute objects
+ *   - undefined: initializes without attributes
+ */
+export function createUpDownCounterWithDefault(
+  meter: Meter,
+  metric: MetricDefinition,
+  attributes: AttributeValuesMap | MetricAttributesType[] | undefined = undefined,
+): UpDownCounter {
+  const counter = meter.createUpDownCounter(metric);
+  if (attributes === undefined) {
+    counter.add(0);
+  } else if (Array.isArray(attributes)) {
+    for (const attrs of attributes) {
+      counter.add(0, attrs);
+    }
+  } else {
+    const combinations = expandAttributeCombinations(attributes);
+    for (const attrs of combinations) {
+      counter.add(0, attrs);
+    }
+  }
+  return counter;
+}