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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/dest/attributes.d.ts +3 -2
  2. package/dest/attributes.d.ts.map +1 -1
  3. package/dest/attributes.js +1 -1
  4. package/dest/config.d.ts +3 -1
  5. package/dest/config.d.ts.map +1 -1
  6. package/dest/config.js +17 -9
  7. package/dest/lmdb_metrics.d.ts +2 -2
  8. package/dest/lmdb_metrics.d.ts.map +1 -1
  9. package/dest/metrics.d.ts +18 -1
  10. package/dest/metrics.d.ts.map +1 -1
  11. package/dest/metrics.js +97 -0
  12. package/dest/monitored_batch_span_processor.d.ts +29 -0
  13. package/dest/monitored_batch_span_processor.d.ts.map +1 -0
  14. package/dest/monitored_batch_span_processor.js +75 -0
  15. package/dest/otel.d.ts +6 -1
  16. package/dest/otel.d.ts.map +1 -1
  17. package/dest/otel.js +73 -4
  18. package/dest/otel_propagation.d.ts +3 -1
  19. package/dest/otel_propagation.d.ts.map +1 -1
  20. package/dest/otel_propagation.js +49 -1
  21. package/dest/start.d.ts +1 -1
  22. package/dest/start.d.ts.map +1 -1
  23. package/dest/start.js +1 -1
  24. package/dest/telemetry.d.ts +2 -2
  25. package/dest/telemetry.d.ts.map +1 -1
  26. package/dest/wrappers/fetch.d.ts +3 -3
  27. package/dest/wrappers/fetch.d.ts.map +1 -1
  28. package/dest/wrappers/fetch.js +3 -2
  29. package/dest/wrappers/l2_block_stream.d.ts +2 -2
  30. package/dest/wrappers/l2_block_stream.d.ts.map +1 -1
  31. package/package.json +3 -3
  32. package/src/attributes.ts +2 -1
  33. package/src/config.ts +24 -9
  34. package/src/metrics.ts +101 -0
  35. package/src/monitored_batch_span_processor.ts +100 -0
  36. package/src/otel.ts +52 -3
  37. package/src/otel_propagation.ts +42 -1
  38. package/src/start.ts +6 -1
  39. package/src/telemetry.ts +0 -1
  40. package/src/wrappers/fetch.ts +9 -3
  41. package/src/wrappers/l2_block_stream.ts +1 -4
package/src/metrics.ts CHANGED
@@ -308,6 +308,12 @@ export const ARCHIVER_SYNC_PER_BLOCK: MetricDefinition = {
308
308
  unit: 'ms',
309
309
  valueType: ValueType.INT,
310
310
  };
311
+ export const ARCHIVER_SYNC_PER_CHECKPOINT: MetricDefinition = {
312
+ name: 'aztec.archiver.checkpoint.sync_per_item_duration',
313
+ description: 'Duration to sync a checkpoint',
314
+ unit: 'ms',
315
+ valueType: ValueType.INT,
316
+ };
311
317
  export const ARCHIVER_SYNC_BLOCK_COUNT: MetricDefinition = {
312
318
  name: 'aztec.archiver.block.sync_count',
313
319
  description: 'Number of blocks synced from L1',
@@ -357,6 +363,12 @@ export const ARCHIVER_CHECKPOINT_L1_INCLUSION_DELAY: MetricDefinition = {
357
363
  valueType: ValueType.INT,
358
364
  };
359
365
 
366
+ export const ARCHIVER_CHECKPOINT_PROMOTED_COUNT: MetricDefinition = {
367
+ name: 'aztec.archiver.checkpoint_promoted_count',
368
+ description: 'Number of checkpoints promoted from proposed (blob fetch skipped)',
369
+ valueType: ValueType.INT,
370
+ };
371
+
360
372
  export const NODE_RECEIVE_TX_DURATION: MetricDefinition = {
361
373
  name: 'aztec.node.receive_tx.duration',
362
374
  description: 'The duration of the receiveTx method',
@@ -388,6 +400,12 @@ export const SEQUENCER_STATE_TRANSITION_BUFFER_DURATION: MetricDefinition = {
388
400
  unit: 'ms',
389
401
  valueType: ValueType.INT,
390
402
  };
403
+ export const SEQUENCER_STATE_DURATION: MetricDefinition = {
404
+ name: 'aztec.sequencer.state_duration',
405
+ description: 'Wall-clock time spent in each sequencer state, labelled by the state being left',
406
+ unit: 'ms',
407
+ valueType: ValueType.INT,
408
+ };
391
409
  export const SEQUENCER_BLOCK_BUILD_DURATION: MetricDefinition = {
392
410
  name: 'aztec.sequencer.block.build_duration',
393
411
  description: 'Duration to build a block',
@@ -405,6 +423,12 @@ export const SEQUENCER_BLOCK_COUNT: MetricDefinition = {
405
423
  description: 'Number of blocks built by this sequencer',
406
424
  valueType: ValueType.INT,
407
425
  };
426
+ export const SEQUENCER_BLOCK_INTER_BLOCK_TIME: MetricDefinition = {
427
+ name: 'aztec.sequencer.block.inter_block_time',
428
+ description: 'Wall-clock time elapsed between consecutive blocks being built by this sequencer',
429
+ unit: 'ms',
430
+ valueType: ValueType.INT,
431
+ };
408
432
  export const SEQUENCER_CURRENT_SLOT_REWARDS: MetricDefinition = {
409
433
  name: 'aztec.sequencer.current_slot_rewards',
410
434
  description: 'The rewards earned per filled slot',
@@ -477,6 +501,25 @@ export const SEQUENCER_CHECKPOINT_BUILD_DURATION: MetricDefinition = {
477
501
  unit: 'ms',
478
502
  valueType: ValueType.INT,
479
503
  };
504
+ export const SEQUENCER_CHECKPOINT_START_TO_FIRST_BLOCK_DURATION: MetricDefinition = {
505
+ name: 'aztec.sequencer.checkpoint.start_to_first_block_duration',
506
+ description: 'Time from starting checkpoint work to the first block finishing build',
507
+ unit: 'ms',
508
+ valueType: ValueType.INT,
509
+ };
510
+ export const SEQUENCER_CHECKPOINT_LAST_BLOCK_TO_BROADCAST_DURATION: MetricDefinition = {
511
+ name: 'aztec.sequencer.checkpoint.last_block_to_broadcast_duration',
512
+ description: 'Time from the final block finishing build to the checkpoint proposal being broadcast',
513
+ unit: 'ms',
514
+ valueType: ValueType.INT,
515
+ };
516
+ export const SEQUENCER_PIPELINED_CHECKPOINT_BUILD_START_OFFSET_FROM_SLOT_BOUNDARY: MetricDefinition = {
517
+ name: 'aztec.sequencer.pipelined_checkpoint.build_start_offset_from_slot_boundary',
518
+ description:
519
+ 'Absolute offset from the wall-clock slot boundary when a pipelined checkpoint build starts. Use aztec.slot_boundary_side to distinguish before vs after the boundary.',
520
+ unit: 'ms',
521
+ valueType: ValueType.INT,
522
+ };
480
523
  export const SEQUENCER_CHECKPOINT_BLOCK_COUNT: MetricDefinition = {
481
524
  name: 'aztec.sequencer.checkpoint.block_count',
482
525
  description: 'Number of blocks built in a checkpoint',
@@ -499,6 +542,11 @@ export const SEQUENCER_SLASHING_ATTEMPTS_COUNT: MetricDefinition = {
499
542
  description: 'The number of slashing action attempts',
500
543
  valueType: ValueType.INT,
501
544
  };
545
+ export const SLASHER_ROUND_EXECUTED_COUNT: MetricDefinition = {
546
+ name: 'aztec.slasher.round.executed_count',
547
+ description: 'The number of slashing rounds executed',
548
+ valueType: ValueType.INT,
549
+ };
502
550
  export const SEQUENCER_CHECKPOINT_SUCCESS_COUNT: MetricDefinition = {
503
551
  name: 'aztec.sequencer.checkpoint.success_count',
504
552
  description: 'The number of times checkpoint publishing succeeded',
@@ -514,6 +562,11 @@ export const SEQUENCER_PIPELINE_DISCARDS_COUNT: MetricDefinition = {
514
562
  description: 'The number of times a pipeline was discarded',
515
563
  valueType: ValueType.INT,
516
564
  };
565
+ export const SEQUENCER_PIPELINE_PARENT_CHECKPOINT_MISMATCH_COUNT: MetricDefinition = {
566
+ name: 'aztec.sequencer.pipeline.parent_checkpoint_mismatch_count',
567
+ description: 'The number of times a pipelined checkpoint was discarded because the parent did not match expectations',
568
+ valueType: ValueType.INT,
569
+ };
517
570
 
518
571
  // Fisherman fee analysis metrics
519
572
  export const FISHERMAN_FEE_ANALYSIS_WOULD_BE_INCLUDED: MetricDefinition = {
@@ -681,6 +734,24 @@ export const L1_PUBLISHER_TX_TOTAL_FEE: MetricDefinition = {
681
734
  unit: 'eth',
682
735
  valueType: ValueType.DOUBLE,
683
736
  };
737
+ export const PROVER_NODE_ESTIMATED_SUBMISSION_GAS: MetricDefinition = {
738
+ name: 'aztec.prover_node.estimated_submission.gas',
739
+ description: 'Estimated gas for a proof submission tx (proof publishing disabled, not actually sent)',
740
+ unit: 'gas',
741
+ valueType: ValueType.INT,
742
+ };
743
+ export const PROVER_NODE_ESTIMATED_SUBMISSION_GAS_PRICE: MetricDefinition = {
744
+ name: 'aztec.prover_node.estimated_submission.gas_price',
745
+ description: 'Estimated effective gas price for a proof submission tx (proof publishing disabled, not actually sent)',
746
+ unit: 'gwei',
747
+ valueType: ValueType.DOUBLE,
748
+ };
749
+ export const PROVER_NODE_ESTIMATED_SUBMISSION_TOTAL_FEE: MetricDefinition = {
750
+ name: 'aztec.prover_node.estimated_submission.total_fee',
751
+ description: 'Estimated total L1 fee for a proof submission tx (proof publishing disabled, not actually sent)',
752
+ unit: 'eth',
753
+ valueType: ValueType.DOUBLE,
754
+ };
684
755
 
685
756
  export const L1_BLOCK_HEIGHT: MetricDefinition = {
686
757
  name: 'aztec.l1.block_height',
@@ -909,6 +980,12 @@ export const P2P_GOSSIP_AGG_MESSAGE_VALIDATION_DURATION_AVG: MetricDefinition =
909
980
  valueType: ValueType.INT,
910
981
  };
911
982
 
983
+ export const P2P_GOSSIP_SLOW_VALIDATION_COUNT: MetricDefinition = {
984
+ name: 'aztec.p2p.gossip.slow_validation_count',
985
+ description: 'Number of gossip validations that exceeded 75% of the mcache eviction window',
986
+ valueType: ValueType.INT,
987
+ };
988
+
912
989
  export const PUBLIC_PROCESSOR_TX_DURATION: MetricDefinition = {
913
990
  name: 'aztec.public_processor.tx_duration',
914
991
  description: 'Duration to process a public transaction',
@@ -972,6 +1049,17 @@ export const PUBLIC_PROCESSOR_TREE_INSERTION: MetricDefinition = {
972
1049
  unit: 'ms',
973
1050
  valueType: ValueType.INT,
974
1051
  };
1052
+ export const PUBLIC_PROCESSOR_SILENTLY_SKIPPED_COUNT: MetricDefinition = {
1053
+ name: 'aztec.public_processor.silently_skipped_count',
1054
+ description: 'Public txs fully processed then skipped (e.g. blob-field limit); not counted as processed or failed',
1055
+ valueType: ValueType.INT,
1056
+ };
1057
+ export const PUBLIC_PROCESSOR_SILENTLY_SKIPPED_DURATION: MetricDefinition = {
1058
+ name: 'aztec.public_processor.silently_skipped_duration',
1059
+ description: 'Wall-clock time spent processing txs that were then silently skipped',
1060
+ unit: 'ms',
1061
+ valueType: ValueType.INT,
1062
+ };
975
1063
 
976
1064
  export const PUBLIC_EXECUTOR_PREFIX = 'aztec.public_executor.';
977
1065
  export const PUBLIC_EXECUTOR_SIMULATION_COUNT: MetricDefinition = {
@@ -1286,6 +1374,19 @@ export const VALIDATOR_RE_EXECUTION_TX_COUNT: MetricDefinition = {
1286
1374
  unit: 'tx',
1287
1375
  valueType: ValueType.INT,
1288
1376
  };
1377
+ export const VALIDATOR_CHECKPOINT_PROPOSAL_TO_PIPELINED_STATE_DURATION: MetricDefinition = {
1378
+ name: 'aztec.validator.checkpoint_proposal_to_pipelined_state_duration',
1379
+ description: 'Time from receiving a checkpoint proposal to setting proposed checkpoint state for pipelining',
1380
+ unit: 'ms',
1381
+ valueType: ValueType.INT,
1382
+ };
1383
+ export const VALIDATOR_CHECKPOINT_PROPOSAL_RECEIVE_OFFSET_FROM_NEXT_SLOT_BOUNDARY: MetricDefinition = {
1384
+ name: 'aztec.validator.checkpoint.proposal_receive_offset_from_next_slot_boundary',
1385
+ description:
1386
+ 'Absolute offset from the next slot boundary when a foreign checkpoint proposal is received. Use aztec.slot_boundary_side to distinguish before vs after the boundary.',
1387
+ unit: 'ms',
1388
+ valueType: ValueType.INT,
1389
+ };
1289
1390
 
1290
1391
  export const VALIDATOR_FAILED_REEXECUTION_COUNT: MetricDefinition = {
1291
1392
  name: 'aztec.validator.failed_reexecution_count',
@@ -0,0 +1,100 @@
1
+ import type { Logger } from '@aztec/foundation/log';
2
+
3
+ import { type Context, SpanStatusCode } from '@opentelemetry/api';
4
+ import { hrTimeToMilliseconds } from '@opentelemetry/core';
5
+ import type { SpanExporter } from '@opentelemetry/sdk-trace-base';
6
+ import { BatchSpanProcessor, type BufferConfig, type ReadableSpan, type Span } from '@opentelemetry/sdk-trace-node';
7
+
8
+ /** Minimum interval between drop warnings to avoid log spam. */
9
+ const DROP_WARNING_INTERVAL_MS = 30_000;
10
+
11
+ const DEFAULT_MIN_TRACE_DURATION_MS = 10;
12
+
13
+ const DEFAULT_MAX_QUEUE_SIZE = 16384;
14
+
15
+ /** Cap on the per-export batch size, so a large queue can actually be drained instead of dribbling out
16
+ * at the SDK default of 512 spans per scheduled export. Kept <= maxQueueSize per the BatchSpanProcessor contract. */
17
+ const DEFAULT_MAX_EXPORT_BATCH_SIZE = 2048;
18
+
19
+ export type MonitoredBatchSpanProcessorConfig = BufferConfig & {
20
+ minTraceDurationMs?: number;
21
+ };
22
+
23
+ /**
24
+ * Wraps BatchSpanProcessor to emit warnings when spans are dropped due to a full queue.
25
+ * The standard BatchSpanProcessor silently discards spans when its internal queue reaches
26
+ * maxQueueSize, making telemetry data loss invisible to operators.
27
+ */
28
+ export class MonitoredBatchSpanProcessor extends BatchSpanProcessor {
29
+ private readonly maxQueueSize: number;
30
+ private readonly minTraceDurationMs: number;
31
+ private readonly log: Logger;
32
+
33
+ private approxQueueSize = 0;
34
+ private droppedSinceLastWarning = 0;
35
+ private totalDropped = 0;
36
+ private lastWarningTime = 0;
37
+
38
+ constructor(exporter: SpanExporter, log: Logger, config?: MonitoredBatchSpanProcessorConfig) {
39
+ const maxQueueSize = config?.maxQueueSize ?? DEFAULT_MAX_QUEUE_SIZE;
40
+ const maxExportBatchSize = Math.min(config?.maxExportBatchSize ?? DEFAULT_MAX_EXPORT_BATCH_SIZE, maxQueueSize);
41
+ super(exporter, { ...config, maxQueueSize, maxExportBatchSize });
42
+ this.maxQueueSize = maxQueueSize;
43
+ this.minTraceDurationMs = Math.max(0, config?.minTraceDurationMs ?? DEFAULT_MIN_TRACE_DURATION_MS);
44
+ this.log = log;
45
+ }
46
+
47
+ override onStart(span: Span, parentContext: Context): void {
48
+ super.onStart(span, parentContext);
49
+ }
50
+
51
+ override onEnd(span: ReadableSpan): void {
52
+ if (this.shouldDropShortSpan(span)) {
53
+ return;
54
+ }
55
+
56
+ if (this.approxQueueSize >= this.maxQueueSize) {
57
+ this.droppedSinceLastWarning++;
58
+ this.totalDropped++;
59
+ this.maybeLogDropWarning();
60
+ } else {
61
+ this.approxQueueSize++;
62
+ }
63
+ super.onEnd(span);
64
+ }
65
+
66
+ override async forceFlush(): Promise<void> {
67
+ await super.forceFlush();
68
+ this.approxQueueSize = 0;
69
+ }
70
+
71
+ override async shutdown(): Promise<void> {
72
+ if (this.totalDropped > 0) {
73
+ this.log.warn(`BatchSpanProcessor shutting down with ${this.totalDropped} total spans dropped`, {
74
+ totalDropped: this.totalDropped,
75
+ });
76
+ }
77
+ await super.shutdown();
78
+ }
79
+
80
+ private shouldDropShortSpan(span: ReadableSpan): boolean {
81
+ return (
82
+ this.minTraceDurationMs > 0 &&
83
+ span.status.code !== SpanStatusCode.ERROR &&
84
+ hrTimeToMilliseconds(span.duration) < this.minTraceDurationMs
85
+ );
86
+ }
87
+
88
+ private maybeLogDropWarning(): void {
89
+ const now = Date.now();
90
+ if (now - this.lastWarningTime >= DROP_WARNING_INTERVAL_MS) {
91
+ this.log.warn(
92
+ `BatchSpanProcessor dropping spans: queue full (maxQueueSize=${this.maxQueueSize}). ` +
93
+ `${this.droppedSinceLastWarning} dropped since last warning, ${this.totalDropped} total.`,
94
+ { droppedSinceLastWarning: this.droppedSinceLastWarning, totalDropped: this.totalDropped },
95
+ );
96
+ this.droppedSinceLastWarning = 0;
97
+ this.lastWarningTime = now;
98
+ }
99
+ }
100
+ }
package/src/otel.ts CHANGED
@@ -28,12 +28,13 @@ import {
28
28
  type PeriodicExportingMetricReaderOptions,
29
29
  View,
30
30
  } from '@opentelemetry/sdk-metrics';
31
- import { BatchSpanProcessor, NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
31
+ import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
32
32
  import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
33
33
 
34
34
  import type { TelemetryClientConfig } from './config.js';
35
35
  import { toMetricOptions } from './metric-utils.js';
36
36
  import type { MetricDefinition } from './metrics.js';
37
+ import { MonitoredBatchSpanProcessor } from './monitored_batch_span_processor.js';
37
38
  import { NodejsMetricsMonitor } from './nodejs_metrics_monitor.js';
38
39
  import { OtelFilterMetricExporter, PublicOtelFilterMetricExporter } from './otel_filter_metric_exporter.js';
39
40
  import { registerOtelLoggerProvider } from './otel_logger_provider.js';
@@ -95,6 +96,11 @@ export class OpenTelemetryClient implements TelemetryClient {
95
96
  private meters: Map<string, WrappedMeter> = new Map<string, WrappedMeter>();
96
97
  private tracers: Map<string, Tracer> = new Map<string, Tracer>();
97
98
 
99
+ /** Memoized shutdown promise. The telemetry client is shared between the aztec-node and an embedded prover-node,
100
+ * so stop() can be invoked more than once; the providers throw "shutdown may only be called once" and
101
+ * "invalid attempt to force flush after shutdown" if that happens. Guarding here makes stop()/flush() idempotent. */
102
+ private stopPromise: Promise<void> | undefined;
103
+
98
104
  protected constructor(
99
105
  private resource: IResource,
100
106
  private meterProvider: MeterProvider,
@@ -168,6 +174,10 @@ export class OpenTelemetryClient implements TelemetryClient {
168
174
  }
169
175
 
170
176
  public async flush() {
177
+ // Flushing after the providers have been shut down throws "invalid attempt to force flush after shutdown".
178
+ if (this.stopPromise) {
179
+ return;
180
+ }
171
181
  await Promise.all([
172
182
  this.meterProvider.forceFlush(),
173
183
  this.loggerProvider?.forceFlush(),
@@ -175,7 +185,11 @@ export class OpenTelemetryClient implements TelemetryClient {
175
185
  ]);
176
186
  }
177
187
 
178
- public async stop() {
188
+ public stop() {
189
+ return (this.stopPromise ??= this.doStop());
190
+ }
191
+
192
+ private async doStop() {
179
193
  this.nodejsMetricsMonitor?.stop();
180
194
 
181
195
  const flushAndShutdown = async (provider?: { forceFlush: () => Promise<void>; shutdown: () => Promise<void> }) => {
@@ -334,6 +348,36 @@ export class OpenTelemetryClient implements TelemetryClient {
334
348
  true,
335
349
  ),
336
350
  }),
351
+ // L1 gas prices in gwei: priority fees ~0.01-10, base fees ~1-500, spikes to 1000+
352
+ new View({
353
+ instrumentType: InstrumentType.HISTOGRAM,
354
+ instrumentUnit: 'gwei',
355
+ aggregation: new ExplicitBucketHistogramAggregation(
356
+ [0.1, 0.5, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1_000],
357
+ true,
358
+ ),
359
+ }),
360
+ // L1 gas consumption: tx gas 100k-30M, calldata/blob gas varies
361
+ new View({
362
+ instrumentType: InstrumentType.HISTOGRAM,
363
+ instrumentUnit: 'gas',
364
+ aggregation: new ExplicitBucketHistogramAggregation(
365
+ [
366
+ 10_000, 50_000, 100_000, 250_000, 500_000, 1_000_000, 2_000_000, 5_000_000, 10_000_000, 15_000_000,
367
+ 30_000_000,
368
+ ],
369
+ true,
370
+ ),
371
+ }),
372
+ // L1 tx total fee in ETH: typically 0.001 - 1 ETH
373
+ new View({
374
+ instrumentType: InstrumentType.HISTOGRAM,
375
+ instrumentUnit: 'eth',
376
+ aggregation: new ExplicitBucketHistogramAggregation(
377
+ [0.0001, 0.0005, 0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5, 10],
378
+ true,
379
+ ),
380
+ }),
337
381
  ],
338
382
  });
339
383
  }
@@ -343,7 +387,12 @@ export class OpenTelemetryClient implements TelemetryClient {
343
387
  const tracerProvider = new NodeTracerProvider({
344
388
  resource,
345
389
  spanProcessors: config.tracesCollectorUrl
346
- ? [new BatchSpanProcessor(new OTLPTraceExporter({ url: config.tracesCollectorUrl.href }))]
390
+ ? [
391
+ new MonitoredBatchSpanProcessor(new OTLPTraceExporter({ url: config.tracesCollectorUrl.href }), log, {
392
+ maxQueueSize: config.otelBspMaxQueueSize,
393
+ minTraceDurationMs: config.otelMinTraceDurationMs,
394
+ }),
395
+ ]
347
396
  : [],
348
397
  });
349
398
 
@@ -1,3 +1,5 @@
1
+ import type { DiagnosticsMiddleware } from '@aztec/foundation/json-rpc/server';
2
+
1
3
  import { ROOT_CONTEXT, type Span, SpanKind, SpanStatusCode, propagation } from '@opentelemetry/api';
2
4
  import type Koa from 'koa';
3
5
 
@@ -17,7 +19,7 @@ export function getOtelJsonRpcPropagationMiddleware(
17
19
  const context = propagation.extract(ROOT_CONTEXT, ctx.request.headers);
18
20
  const method = (ctx.request.body as any)?.method;
19
21
  return tracer.startActiveSpan(
20
- `JsonRpcServer.${method ?? 'unknown'}`,
22
+ `JsonRpcServer.${method ?? 'batch'}`,
21
23
  { kind: SpanKind.SERVER },
22
24
  context,
23
25
  async (span: Span): Promise<void> => {
@@ -48,3 +50,42 @@ export function getOtelJsonRpcPropagationMiddleware(
48
50
  );
49
51
  };
50
52
  }
53
+
54
+ export function getOtelJsonRpcDiagnosticsMiddleware(): DiagnosticsMiddleware {
55
+ return function otelJsonRpcDiagnostics(ctx, next) {
56
+ const [namespace, method] = splitNamespace(ctx.method);
57
+ const scope = namespace ?? 'UnknownHandler';
58
+ const tracer = getTelemetryClient().getTracer(scope);
59
+ return tracer.startActiveSpan(
60
+ `${scope}.${method}`,
61
+ { kind: SpanKind.INTERNAL, attributes: { [ATTR_JSONRPC_METHOD]: ctx.method } },
62
+ async span => {
63
+ if (ctx.id !== null) {
64
+ span.setAttribute(ATTR_JSONRPC_REQUEST_ID, ctx.id);
65
+ }
66
+
67
+ try {
68
+ await next();
69
+ span.setStatus({ code: SpanStatusCode.OK });
70
+ } catch (err) {
71
+ span.setStatus({ code: SpanStatusCode.ERROR, message: err instanceof Error ? err.message : String(err) });
72
+ if (typeof err === 'string' || err instanceof Error) {
73
+ span.recordException(err);
74
+ }
75
+ throw err;
76
+ } finally {
77
+ span.end();
78
+ }
79
+ },
80
+ );
81
+ };
82
+ }
83
+
84
+ function splitNamespace(fullMethod: string): [namespace: string | undefined, method: string] {
85
+ const idx = fullMethod.indexOf('_');
86
+ if (idx > -1) {
87
+ return [fullMethod.slice(0, idx), fullMethod.slice(idx + 1)];
88
+ } else {
89
+ return [undefined, fullMethod];
90
+ }
91
+ }
package/src/start.ts CHANGED
@@ -19,7 +19,12 @@ export async function initTelemetryClient(
19
19
  return telemetry;
20
20
  }
21
21
 
22
- if (config.metricsCollectorUrl || config.publicMetricsCollectorUrl) {
22
+ if (
23
+ config.metricsCollectorUrl ||
24
+ config.publicMetricsCollectorUrl ||
25
+ config.tracesCollectorUrl ||
26
+ config.logsCollectorUrl
27
+ ) {
23
28
  log.info(`Using OpenTelemetry client with custom collector`);
24
29
  // Lazy load OpenTelemetry to avoid loading heavy deps at startup
25
30
  const { OpenTelemetryClient } = await import('./otel.js');
package/src/telemetry.ts CHANGED
@@ -48,7 +48,6 @@ type BannedMetricAttributeNames = (typeof Attributes)[
48
48
  | 'TX_HASH'
49
49
  | 'PROVING_JOB_ID'
50
50
  | 'P2P_ID'
51
- | 'P2P_REQ_RESP_BATCH_REQUESTS_COUNT'
52
51
  | 'TARGET_ADDRESS'
53
52
  | 'MANA_USED'
54
53
  | 'TOTAL_INSTRUCTIONS'];
@@ -9,12 +9,17 @@ import { ATTR_JSONRPC_METHOD, ATTR_JSONRPC_REQUEST_ID } from '../vendor/attribut
9
9
 
10
10
  /**
11
11
  * Makes a fetch function that retries based on the given attempts and propagates trace information.
12
- * @param retries - Sequence of intervals (in seconds) to retry.
12
+ * @param retries - Sequence of intervals (in seconds) to retry, or a factory function returning an iterator for custom/indefinite backoff.
13
13
  * @param noRetry - Whether to stop retries on server errors.
14
14
  * @param log - Optional logger for logging attempts.
15
15
  * @returns A fetch function.
16
16
  */
17
- export function makeTracedFetch(retries: number[], defaultNoRetry: boolean, fetch = defaultFetch, log?: Logger) {
17
+ export function makeTracedFetch(
18
+ retries: number[] | (() => Generator<number>),
19
+ defaultNoRetry: boolean,
20
+ fetch = defaultFetch,
21
+ log?: Logger,
22
+ ) {
18
23
  return (host: string, body: unknown, extraHeaders: Record<string, string> = {}, noRetry?: boolean) => {
19
24
  const telemetry = getTelemetryClient();
20
25
  return telemetry.getTracer('fetch').startActiveSpan(`JsonRpcClient`, { kind: SpanKind.CLIENT }, async span => {
@@ -27,10 +32,11 @@ export function makeTracedFetch(retries: number[], defaultNoRetry: boolean, fetc
27
32
  }
28
33
  const headers = { ...extraHeaders };
29
34
  propagation.inject(context.active(), headers);
35
+ const backoff = typeof retries === 'function' ? retries() : makeBackoff(retries);
30
36
  return await retry(
31
37
  () => fetch(host, body, headers, noRetry ?? defaultNoRetry),
32
38
  `JsonRpcClient request to ${host}`,
33
- makeBackoff(retries),
39
+ backoff,
34
40
  log,
35
41
  false,
36
42
  );
@@ -11,10 +11,7 @@ import { type Traceable, type Tracer, trackSpan } from '@aztec/telemetry-client'
11
11
  /** Extends an L2BlockStream with a tracer to create a new trace per iteration. */
12
12
  export class TraceableL2BlockStream extends L2BlockStream implements Traceable {
13
13
  constructor(
14
- l2BlockSource: Pick<
15
- L2BlockSource,
16
- 'getBlocks' | 'getBlockHeader' | 'getL2Tips' | 'getCheckpoints' | 'getCheckpointedBlocks'
17
- >,
14
+ l2BlockSource: Pick<L2BlockSource, 'getBlocks' | 'getBlockData' | 'getL2Tips' | 'getCheckpoints'>,
18
15
  localData: L2BlockStreamLocalDataProvider,
19
16
  handler: L2BlockStreamEventHandler,
20
17
  public readonly tracer: Tracer,