@aztec/telemetry-client 0.0.0-test.0

package/dest/attributes.d.ts

@@ -0,0 +1,99 @@
+/**
+ * @overview This file contains the custom attributes used in telemetry events.
+ * Attribute names exist in a global namespace, alongside metric names. Use this file to ensure that attribute names are unique.
+ *
+ * To define a new attribute follow these steps:
+ * 1. Make sure it's not a semantic attribute that's already been defined by {@link @opentelemetry/semantic-conventions | OpenTelemetry} (e.g. `service.name`)
+ * 2. Come up with a unique name for it so that it doesn't clash with other attributes or metrics.
+ * 3. Prefix the attribute name with `aztec` to make it clear that it's a custom attribute.
+ * 4. Add a description of what the attribute represents and examples of what it might contain.
+ * 5. Start using it.
+ *
+ * @note Attributes and metric names exist in a hierarchy of namespaces. If a name has been used as a namespace, then it can not be used as a name for an attribute or metric.
+ * @example If `aztec.circuit.name` has been defined as an attribute then `aztec.circuit` alone can not be re-used for a metric or attribute because it is already a namespace.
+ * @see {@link https://opentelemetry.io/docs/specs/semconv/general/attribute-naming/}
+ */
+/** The Aztec network identifier */
+export declare const NETWORK_NAME = "aztec.network_name";
+/**
+ * The name of the protocol circuit being run (e.g. public-kernel-setup or base-rollup)
+ * @see {@link @aztec/stdlib/stats:CircuitName}
+ */
+export declare const PROTOCOL_CIRCUIT_NAME = "aztec.circuit.protocol_circuit_name";
+/**
+ * The type of protocol circuit being run: server or client
+ */
+export declare const PROTOCOL_CIRCUIT_TYPE = "aztec.circuit.protocol_circuit_type";
+/**
+ * For an app circuit, the contract:function being run (e.g. Token:transfer)
+ */
+export declare const APP_CIRCUIT_NAME = "aztec.circuit.app_circuit_name";
+/**
+ * The type of app circuit being run: server or client
+ */
+export declare const APP_CIRCUIT_TYPE = "aztec.circuit.app_circuit_type";
+/** The block archive */
+export declare const BLOCK_ARCHIVE = "aztec.block.archive";
+/** The block number */
+export declare const BLOCK_NUMBER = "aztec.block.number";
+/** The slot number */
+export declare const SLOT_NUMBER = "aztec.slot.number";
+/** The parent's block number */
+export declare const BLOCK_PARENT = "aztec.block.parent";
+/** How many txs are being processed to build this block */
+export declare const BLOCK_CANDIDATE_TXS_COUNT = "aztec.block.candidate_txs_count";
+/** How many actual txs were included in this block */
+export declare const BLOCK_TXS_COUNT = "aztec.block.txs_count";
+/** The block size */
+export declare const BLOCK_SIZE = "aztec.block.size";
+/** How many blocks are included in this epoch */
+export declare const EPOCH_SIZE = "aztec.epoch.size";
+/** The proposer of a block */
+export declare const BLOCK_PROPOSER = "aztec.block.proposer";
+/** The epoch number */
+export declare const EPOCH_NUMBER = "aztec.epoch.number";
+/** The tx hash */
+export declare const TX_HASH = "aztec.tx.hash";
+/** Generic attribute representing whether the action was successful or not */
+export declare const OK = "aztec.ok";
+/** Generic status attribute */
+export declare const STATUS = "aztec.status";
+/** Generic error type attribute */
+export declare const ERROR_TYPE = "aztec.error_type";
+/** The type of the transaction */
+export declare const L1_TX_TYPE = "aztec.l1.tx_type";
+/** The L1 address of the entity that sent a transaction to L1 */
+export declare const L1_SENDER = "aztec.l1.sender";
+/** The phase of the transaction */
+export declare const TX_PHASE_NAME = "aztec.tx.phase_name";
+/** The reason for disconnecting a peer */
+export declare const P2P_GOODBYE_REASON = "aztec.p2p.goodbye.reason";
+/** The proving job type */
+export declare const PROVING_JOB_TYPE = "aztec.proving.job_type";
+/** The proving job id */
+export declare const PROVING_JOB_ID = "aztec.proving.job_id";
+export declare const MERKLE_TREE_NAME = "aztec.merkle_tree.name";
+/** The prover-id in a root rollup proof. */
+export declare const ROLLUP_PROVER_ID = "aztec.rollup.prover_id";
+/** Whether the proof submission was timed out (delayed more than 20 min) */
+export declare const PROOF_TIMED_OUT = "aztec.proof.timed_out";
+export declare const P2P_ID = "aztec.p2p.id";
+export declare const P2P_REQ_RESP_PROTOCOL = "aztec.p2p.req_resp.protocol";
+export declare const P2P_REQ_RESP_BATCH_REQUESTS_COUNT = "aztec.p2p.req_resp.batch_requests_count";
+export declare const POOL_NAME = "aztec.pool.name";
+export declare const SEQUENCER_STATE = "aztec.sequencer.state";
+export declare const SIMULATOR_PHASE = "aztec.simulator.phase";
+export declare const TARGET_ADDRESS = "aztec.address.target";
+export declare const SENDER_ADDRESS = "aztec.address.sender";
+export declare const MANA_USED = "aztec.mana.used";
+/** Whether a sync process is the initial run, which is usually slower than iterative ones. */
+export declare const INITIAL_SYNC = "aztec.initial_sync";
+/** Identifier for the tables in a world state DB */
+export declare const WS_DB_DATA_TYPE = "aztec.world_state.db_type";
+/** Identifier for component database (e.g. archiver, tx pool) */
+export declare const DB_DATA_TYPE = "aztec.db_type";
+export declare const REVERTIBILITY = "aztec.revertibility";
+export declare const GAS_DIMENSION = "aztec.gas_dimension";
+export declare const WORLD_STATE_REQUEST_TYPE = "aztec.world_state_request";
+export declare const NODEJS_EVENT_LOOP_STATE = "nodejs.eventloop.state";
+//# sourceMappingURL=attributes.d.ts.map

package/dest/attributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributes.d.ts","sourceRoot":"","sources":["../src/attributes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,mCAAmC;AACnC,eAAO,MAAM,YAAY,uBAAuB,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,wCAAwC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,qBAAqB,wCAAwC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,gBAAgB,mCAAmC,CAAC;AAEjE;;GAEG;AACH,eAAO,MAAM,gBAAgB,mCAAmC,CAAC;AAEjE,wBAAwB;AACxB,eAAO,MAAM,aAAa,wBAAwB,CAAC;AACnD,uBAAuB;AACvB,eAAO,MAAM,YAAY,uBAAuB,CAAC;AACjD,sBAAsB;AACtB,eAAO,MAAM,WAAW,sBAAsB,CAAC;AAC/C,gCAAgC;AAChC,eAAO,MAAM,YAAY,uBAAuB,CAAC;AACjD,2DAA2D;AAC3D,eAAO,MAAM,yBAAyB,oCAAoC,CAAC;AAC3E,sDAAsD;AACtD,eAAO,MAAM,eAAe,0BAA0B,CAAC;AACvD,qBAAqB;AACrB,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAC7C,iDAAiD;AACjD,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAC7C,8BAA8B;AAC9B,eAAO,MAAM,cAAc,yBAAyB,CAAC;AACrD,uBAAuB;AACvB,eAAO,MAAM,YAAY,uBAAuB,CAAC;AACjD,kBAAkB;AAClB,eAAO,MAAM,OAAO,kBAAkB,CAAC;AACvC,8EAA8E;AAC9E,eAAO,MAAM,EAAE,aAAa,CAAC;AAC7B,+BAA+B;AAC/B,eAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,mCAAmC;AACnC,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAC7C,kCAAkC;AAClC,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAC7C,iEAAiE;AACjE,eAAO,MAAM,SAAS,oBAAoB,CAAC;AAC3C,mCAAmC;AACnC,eAAO,MAAM,aAAa,wBAAwB,CAAC;AACnD,0CAA0C;AAC1C,eAAO,MAAM,kBAAkB,6BAA6B,CAAC;AAC7D,2BAA2B;AAC3B,eAAO,MAAM,gBAAgB,2BAA2B,CAAC;AACzD,yBAAyB;AACzB,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,gBAAgB,2BAA2B,CAAC;AACzD,4CAA4C;AAC5C,eAAO,MAAM,gBAAgB,2BAA2B,CAAC;AACzD,4EAA4E;AAC5E,eAAO,MAAM,eAAe,0BAA0B,CAAC;AAEvD,eAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,eAAO,MAAM,qBAAqB,gCAAgC,CAAC;AACnE,eAAO,MAAM,iCAAiC,4CAA4C,CAAC;AAC3F,eAAO,MAAM,SAAS,oBAAoB,CAAC;AAE3C,eAAO,MAAM,eAAe,0BAA0B,CAAC;AAEvD,eAAO,MAAM,eAAe,0BAA0B,CAAC;AACvD,eAAO,MAAM,cAAc,yBAAyB,CAAC;AACrD,eAAO,MAAM,cAAc,yBAAyB,CAAC;AACrD,eAAO,MAAM,SAAS,oBAAoB,CAAC;AAE3C,8FAA8F;AAC9F,eAAO,MAAM,YAAY,uBAAuB,CAAC;AAEjD,oDAAoD;AACpD,eAAO,MAAM,eAAe,8BAA8B,CAAC;AAE3D,iEAAiE;AACjE,eAAO,MAAM,YAAY,kBAAkB,CAAC;AAE5C,eAAO,MAAM,aAAa,wBAAwB,CAAC;AAEnD,eAAO,MAAM,aAAa,wBAAwB,CAAC;AAEnD,eAAO,MAAM,wBAAwB,8BAA8B,CAAC;AAEpE,eAAO,MAAM,uBAAuB,2BAA2B,CAAC"}

package/dest/attributes.js

@@ -0,0 +1,67 @@
+/**
+ * @overview This file contains the custom attributes used in telemetry events.
+ * Attribute names exist in a global namespace, alongside metric names. Use this file to ensure that attribute names are unique.
+ *
+ * To define a new attribute follow these steps:
+ * 1. Make sure it's not a semantic attribute that's already been defined by {@link @opentelemetry/semantic-conventions | OpenTelemetry} (e.g. `service.name`)
+ * 2. Come up with a unique name for it so that it doesn't clash with other attributes or metrics.
+ * 3. Prefix the attribute name with `aztec` to make it clear that it's a custom attribute.
+ * 4. Add a description of what the attribute represents and examples of what it might contain.
+ * 5. Start using it.
+ *
+ * @note Attributes and metric names exist in a hierarchy of namespaces. If a name has been used as a namespace, then it can not be used as a name for an attribute or metric.
+ * @example If `aztec.circuit.name` has been defined as an attribute then `aztec.circuit` alone can not be re-used for a metric or attribute because it is already a namespace.
+ * @see {@link https://opentelemetry.io/docs/specs/semconv/general/attribute-naming/}
+ */ /** The Aztec network identifier */ export const NETWORK_NAME = 'aztec.network_name';
+/**
+ * The name of the protocol circuit being run (e.g. public-kernel-setup or base-rollup)
+ * @see {@link @aztec/stdlib/stats:CircuitName}
+ */ export const PROTOCOL_CIRCUIT_NAME = 'aztec.circuit.protocol_circuit_name';
+/**
+ * The type of protocol circuit being run: server or client
+ */ export const PROTOCOL_CIRCUIT_TYPE = 'aztec.circuit.protocol_circuit_type';
+/**
+ * For an app circuit, the contract:function being run (e.g. Token:transfer)
+ */ export const APP_CIRCUIT_NAME = 'aztec.circuit.app_circuit_name';
+/**
+ * The type of app circuit being run: server or client
+ */ export const APP_CIRCUIT_TYPE = 'aztec.circuit.app_circuit_type';
+/** The block archive */ export const BLOCK_ARCHIVE = 'aztec.block.archive';
+/** The block number */ export const BLOCK_NUMBER = 'aztec.block.number';
+/** The slot number */ export const SLOT_NUMBER = 'aztec.slot.number';
+/** The parent's block number */ export const BLOCK_PARENT = 'aztec.block.parent';
+/** How many txs are being processed to build this block */ export const BLOCK_CANDIDATE_TXS_COUNT = 'aztec.block.candidate_txs_count';
+/** How many actual txs were included in this block */ export const BLOCK_TXS_COUNT = 'aztec.block.txs_count';
+/** The block size */ export const BLOCK_SIZE = 'aztec.block.size';
+/** How many blocks are included in this epoch */ export const EPOCH_SIZE = 'aztec.epoch.size';
+/** The proposer of a block */ export const BLOCK_PROPOSER = 'aztec.block.proposer';
+/** The epoch number */ export const EPOCH_NUMBER = 'aztec.epoch.number';
+/** The tx hash */ export const TX_HASH = 'aztec.tx.hash';
+/** Generic attribute representing whether the action was successful or not */ export const OK = 'aztec.ok';
+/** Generic status attribute */ export const STATUS = 'aztec.status';
+/** Generic error type attribute */ export const ERROR_TYPE = 'aztec.error_type';
+/** The type of the transaction */ export const L1_TX_TYPE = 'aztec.l1.tx_type';
+/** The L1 address of the entity that sent a transaction to L1 */ export const L1_SENDER = 'aztec.l1.sender';
+/** The phase of the transaction */ export const TX_PHASE_NAME = 'aztec.tx.phase_name';
+/** The reason for disconnecting a peer */ export const P2P_GOODBYE_REASON = 'aztec.p2p.goodbye.reason';
+/** The proving job type */ export const PROVING_JOB_TYPE = 'aztec.proving.job_type';
+/** The proving job id */ export const PROVING_JOB_ID = 'aztec.proving.job_id';
+export const MERKLE_TREE_NAME = 'aztec.merkle_tree.name';
+/** The prover-id in a root rollup proof. */ export const ROLLUP_PROVER_ID = 'aztec.rollup.prover_id';
+/** Whether the proof submission was timed out (delayed more than 20 min) */ export const PROOF_TIMED_OUT = 'aztec.proof.timed_out';
+export const P2P_ID = 'aztec.p2p.id';
+export const P2P_REQ_RESP_PROTOCOL = 'aztec.p2p.req_resp.protocol';
+export const P2P_REQ_RESP_BATCH_REQUESTS_COUNT = 'aztec.p2p.req_resp.batch_requests_count';
+export const POOL_NAME = 'aztec.pool.name';
+export const SEQUENCER_STATE = 'aztec.sequencer.state';
+export const SIMULATOR_PHASE = 'aztec.simulator.phase';
+export const TARGET_ADDRESS = 'aztec.address.target';
+export const SENDER_ADDRESS = 'aztec.address.sender';
+export const MANA_USED = 'aztec.mana.used';
+/** Whether a sync process is the initial run, which is usually slower than iterative ones. */ export const INITIAL_SYNC = 'aztec.initial_sync';
+/** Identifier for the tables in a world state DB */ export const WS_DB_DATA_TYPE = 'aztec.world_state.db_type';
+/** Identifier for component database (e.g. archiver, tx pool) */ export const DB_DATA_TYPE = 'aztec.db_type';
+export const REVERTIBILITY = 'aztec.revertibility';
+export const GAS_DIMENSION = 'aztec.gas_dimension';
+export const WORLD_STATE_REQUEST_TYPE = 'aztec.world_state_request';
+export const NODEJS_EVENT_LOOP_STATE = 'nodejs.eventloop.state';

package/dest/bench.d.ts

@@ -0,0 +1,29 @@
+import type { Context, ValueType } from '@opentelemetry/api';
+import type { AttributesType, Meter, TelemetryClient, Tracer } from './telemetry.js';
+export type BenchmarkMetricsType = {
+    name: string;
+    metrics: {
+        name: string;
+        type: 'gauge' | 'counter' | 'histogram';
+        description?: string;
+        unit?: string;
+        valueType?: ValueType;
+        points: BenchmarkDataPoint[];
+    }[];
+}[];
+export declare class BenchmarkTelemetryClient implements TelemetryClient {
+    private meters;
+    getMeter(name: string): Meter;
+    getTracer(): Tracer;
+    stop(): Promise<void>;
+    flush(): Promise<void>;
+    isEnabled(): boolean;
+    getMeters(): BenchmarkMetricsType;
+    clear(): void;
+}
+export type BenchmarkDataPoint = {
+    value: number;
+    attributes?: AttributesType;
+    context?: Context;
+};
+//# sourceMappingURL=bench.d.ts.map

package/dest/bench.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bench.d.ts","sourceRoot":"","sources":["../src/bench.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA2B,OAAO,EAA6B,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAGjH,OAAO,KAAK,EACV,cAAc,EAGd,KAAK,EAIL,eAAe,EACf,MAAM,EAEP,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;QACxC,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,SAAS,CAAC;QACtB,MAAM,EAAE,kBAAkB,EAAE,CAAC;KAC9B,EAAE,CAAC;CACL,EAAE,CAAC;AAEJ,qBAAa,wBAAyB,YAAW,eAAe;IAC9D,OAAO,CAAC,MAAM,CAA4B;IAE1C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;IAM7B,SAAS,IAAI,MAAM;IAInB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,SAAS;IAIT,SAAS,IAAI,oBAAoB;IAIjC,KAAK;CAGN;AAgDD,MAAM,MAAM,kBAAkB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,cAAc,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC"}

package/dest/bench.js

@@ -0,0 +1,98 @@
+import { NoopTracer } from './noop.js';
+export class BenchmarkTelemetryClient {
+    meters = [];
+    getMeter(name) {
+        const meter = new InMemoryPlainMeter(name);
+        this.meters.push(meter);
+        return meter;
+    }
+    getTracer() {
+        return new NoopTracer();
+    }
+    stop() {
+        return Promise.resolve();
+    }
+    flush() {
+        return Promise.resolve();
+    }
+    isEnabled() {
+        return true;
+    }
+    getMeters() {
+        return this.meters;
+    }
+    clear() {
+        this.meters.forEach((meter)=>meter.clear());
+    }
+}
+class InMemoryPlainMeter {
+    name;
+    metrics;
+    constructor(name){
+        this.name = name;
+        this.metrics = [];
+    }
+    clear() {
+        this.metrics.forEach((metric)=>metric.clear());
+    }
+    createGauge(name, options) {
+        return this.createMetric('gauge', name, options);
+    }
+    createObservableGauge(name, options) {
+        return this.createMetric('gauge', name, options);
+    }
+    createHistogram(name, options) {
+        return this.createMetric('histogram', name, options);
+    }
+    createUpDownCounter(name, options) {
+        return this.createMetric('counter', name, options);
+    }
+    createObservableUpDownCounter(name, options) {
+        return this.createMetric('counter', name, options);
+    }
+    createMetric(type, name, options) {
+        const metric = new InMemoryPlainMetric(type, name, options);
+        this.metrics.push(metric);
+        return metric;
+    }
+    addBatchObservableCallback(_callback, _observables) {}
+    removeBatchObservableCallback(_callback, _observables) {}
+}
+class InMemoryPlainMetric {
+    type;
+    name;
+    points;
+    description;
+    unit;
+    valueType;
+    constructor(type, name, options){
+        this.type = type;
+        this.name = name;
+        this.points = [];
+        this.description = options?.description;
+        this.unit = options?.unit;
+        this.valueType = options?.valueType;
+    }
+    add(value, attributes, context) {
+        this.points.push({
+            value,
+            attributes,
+            context
+        });
+    }
+    record(value, attributes, context) {
+        this.points.push({
+            value,
+            attributes,
+            context
+        });
+    }
+    addCallback() {}
+    removeCallback() {}
+    getPoints() {
+        return this.points;
+    }
+    clear() {
+        this.points.splice(0, this.points.length);
+    }
+}

package/dest/config.d.ts

@@ -0,0 +1,12 @@
+import { type ConfigMappingsType } from '@aztec/foundation/config';
+export interface TelemetryClientConfig {
+    metricsCollectorUrl?: URL;
+    tracesCollectorUrl?: URL;
+    logsCollectorUrl?: URL;
+    otelCollectIntervalMs: number;
+    otelExportTimeoutMs: number;
+    otelExcludeMetrics?: string[];
+}
+export declare const telemetryClientConfigMappings: ConfigMappingsType<TelemetryClientConfig>;
+export declare function getConfigEnvVars(): TelemetryClientConfig;
+//# sourceMappingURL=config.d.ts.map

package/dest/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,kBAAkB,EAAyB,MAAM,0BAA0B,CAAC;AAE1F,MAAM,WAAW,qBAAqB;IACpC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC1B,kBAAkB,CAAC,EAAE,GAAG,CAAC;IACzB,gBAAgB,CAAC,EAAE,GAAG,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED,eAAO,MAAM,6BAA6B,EAAE,kBAAkB,CAAC,qBAAqB,CAwCnF,CAAC;AAEF,wBAAgB,gBAAgB,IAAI,qBAAqB,CAExD"}

package/dest/config.js

@@ -0,0 +1,39 @@
+import { getConfigFromMappings } from '@aztec/foundation/config';
+export const telemetryClientConfigMappings = {
+    metricsCollectorUrl: {
+        env: 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT',
+        description: 'The URL of the telemetry collector for metrics',
+        parseEnv: (val)=>val && new URL(val)
+    },
+    tracesCollectorUrl: {
+        env: 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT',
+        description: 'The URL of the telemetry collector for traces',
+        parseEnv: (val)=>val && new URL(val)
+    },
+    logsCollectorUrl: {
+        env: 'OTEL_EXPORTER_OTLP_LOGS_ENDPOINT',
+        description: 'The URL of the telemetry collector for logs',
+        parseEnv: (val)=>val && new URL(val)
+    },
+    otelCollectIntervalMs: {
+        env: 'OTEL_COLLECT_INTERVAL_MS',
+        description: 'The interval at which to collect metrics',
+        defaultValue: 60000,
+        parseEnv: (val)=>parseInt(val)
+    },
+    otelExportTimeoutMs: {
+        env: 'OTEL_EXPORT_TIMEOUT_MS',
+        description: 'The timeout for exporting metrics',
+        defaultValue: 30000,
+        parseEnv: (val)=>parseInt(val)
+    },
+    otelExcludeMetrics: {
+        env: 'OTEL_EXCLUDE_METRICS',
+        description: 'A list of metric prefixes to exclude from export',
+        parseEnv: (val)=>val ? val.split(',').map((s)=>s.trim()).filter((s)=>s.length > 0) : [],
+        defaultValue: []
+    }
+};
+export function getConfigEnvVars() {
+    return getConfigFromMappings(telemetryClientConfigMappings);
+}

package/dest/event_loop_monitor.d.ts

@@ -0,0 +1,18 @@
+import { type Meter } from './telemetry.js';
+/**
+ * Detector for custom Aztec attributes
+ */
+export declare class EventLoopMonitor {
+    private meter;
+    private eventLoopDelayGauges;
+    private eventLoopUilization;
+    private eventLoopTime;
+    private started;
+    private lastELU;
+    private eventLoopDelay;
+    constructor(meter: Meter);
+    start(): void;
+    stop(): void;
+    private measure;
+}
+//# sourceMappingURL=event_loop_monitor.d.ts.map

package/dest/event_loop_monitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event_loop_monitor.d.ts","sourceRoot":"","sources":["../src/event_loop_monitor.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,KAAK,KAAK,EAIX,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,qBAAa,gBAAgB;IAmBf,OAAO,CAAC,KAAK;IAlBzB,OAAO,CAAC,oBAAoB,CAQ1B;IAEF,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,aAAa,CAAgB;IAErC,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,OAAO,CAAmC;IAClD,OAAO,CAAC,cAAc,CAAoB;gBAEtB,KAAK,EAAE,KAAK;IAgChC,KAAK,IAAI,IAAI;IAab,IAAI,IAAI,IAAI;IAaZ,OAAO,CAAC,OAAO,CAyBb;CACH"}

package/dest/event_loop_monitor.js

@@ -0,0 +1,93 @@
+import { monitorEventLoopDelay, performance } from 'node:perf_hooks';
+import * as Attributes from './attributes.js';
+import * as Metrics from './metrics.js';
+import { ValueType } from './telemetry.js';
+/**
+ * Detector for custom Aztec attributes
+ */ export class EventLoopMonitor {
+    meter;
+    eventLoopDelayGauges;
+    eventLoopUilization;
+    eventLoopTime;
+    started;
+    lastELU;
+    eventLoopDelay;
+    constructor(meter){
+        this.meter = meter;
+        this.started = false;
+        this.measure = (obs)=>{
+            const newELU = performance.eventLoopUtilization();
+            const delta = performance.eventLoopUtilization(newELU, this.lastELU);
+            this.lastELU = newELU;
+            // `utilization` [0,1] represents how much the event loop is busy vs waiting for new events to come in
+            // This should be corelated with CPU usage to gauge the performance characteristics of services
+            // 100% utilization leads to high latency because the event loop is _always_ busy, there's no breathing room for events to be processed quickly.
+            // Docs and examples:
+            // - https://nodesource.com/blog/event-loop-utilization-nodejs
+            // - https://youtu.be/WetXnEPraYM
+            obs.observe(this.eventLoopUilization, delta.utilization);
+            this.eventLoopTime.add(Math.floor(delta.idle), {
+                [Attributes.NODEJS_EVENT_LOOP_STATE]: 'idle'
+            });
+            this.eventLoopTime.add(Math.floor(delta.active), {
+                [Attributes.NODEJS_EVENT_LOOP_STATE]: 'active'
+            });
+            obs.observe(this.eventLoopDelayGauges.min, Math.floor(this.eventLoopDelay.min));
+            obs.observe(this.eventLoopDelayGauges.mean, Math.floor(this.eventLoopDelay.mean));
+            obs.observe(this.eventLoopDelayGauges.max, Math.floor(this.eventLoopDelay.max));
+            obs.observe(this.eventLoopDelayGauges.stddev, Math.floor(this.eventLoopDelay.stddev));
+            obs.observe(this.eventLoopDelayGauges.p50, Math.floor(this.eventLoopDelay.percentile(50)));
+            obs.observe(this.eventLoopDelayGauges.p90, Math.floor(this.eventLoopDelay.percentile(90)));
+            obs.observe(this.eventLoopDelayGauges.p99, Math.floor(this.eventLoopDelay.percentile(99)));
+            this.eventLoopDelay.reset();
+        };
+        const nsObsGauge = (name, description)=>meter.createObservableGauge(name, {
+                unit: 'ns',
+                valueType: ValueType.INT,
+                description
+            });
+        this.eventLoopDelayGauges = {
+            min: nsObsGauge(Metrics.NODEJS_EVENT_LOOP_DELAY_MIN, 'Minimum delay of the event loop'),
+            mean: nsObsGauge(Metrics.NODEJS_EVENT_LOOP_DELAY_MEAN, 'Mean delay of the event loop'),
+            max: nsObsGauge(Metrics.NODEJS_EVENT_LOOP_DELAY_MAX, 'Max delay of the event loop'),
+            stddev: nsObsGauge(Metrics.NODEJS_EVENT_LOOP_DELAY_STDDEV, 'Stddev delay of the event loop'),
+            p50: nsObsGauge(Metrics.NODEJS_EVENT_LOOP_DELAY_P50, 'P50 delay of the event loop'),
+            p90: nsObsGauge(Metrics.NODEJS_EVENT_LOOP_DELAY_P90, 'P90 delay of the event loop'),
+            p99: nsObsGauge(Metrics.NODEJS_EVENT_LOOP_DELAY_P99, 'P99 delay of the event loop')
+        };
+        this.eventLoopUilization = meter.createObservableGauge(Metrics.NODEJS_EVENT_LOOP_UTILIZATION, {
+            valueType: ValueType.DOUBLE,
+            description: 'How busy is the event loop'
+        });
+        this.eventLoopTime = meter.createUpDownCounter(Metrics.NODEJS_EVENT_LOOP_TIME, {
+            unit: 'ms',
+            valueType: ValueType.INT,
+            description: 'How much time the event loop has spent in a given state'
+        });
+        this.eventLoopDelay = monitorEventLoopDelay();
+    }
+    start() {
+        if (this.started) {
+            return;
+        }
+        this.lastELU = performance.eventLoopUtilization();
+        this.eventLoopDelay.enable();
+        this.meter.addBatchObservableCallback(this.measure, [
+            this.eventLoopUilization,
+            ...Object.values(this.eventLoopDelayGauges)
+        ]);
+    }
+    stop() {
+        if (!this.started) {
+            return;
+        }
+        this.meter.removeBatchObservableCallback(this.measure, [
+            this.eventLoopUilization,
+            ...Object.values(this.eventLoopDelayGauges)
+        ]);
+        this.eventLoopDelay.disable();
+        this.eventLoopDelay.reset();
+        this.lastELU = undefined;
+    }
+    measure;
+}

package/dest/index.d.ts

@@ -0,0 +1,10 @@
+export * from './telemetry.js';
+export * as Metrics from './metrics.js';
+export * as Attributes from './attributes.js';
+export * from './with_tracer.js';
+export * from './prom_otel_adapter.js';
+export * from './lmdb_metrics.js';
+export * from './wrappers/index.js';
+export * from './start.js';
+export * from './otel_propagation.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC"}

package/dest/index.js

@@ -0,0 +1,9 @@
+export * from './telemetry.js';
+export * as Metrics from './metrics.js';
+export * as Attributes from './attributes.js';
+export * from './with_tracer.js';
+export * from './prom_otel_adapter.js';
+export * from './lmdb_metrics.js';
+export * from './wrappers/index.js';
+export * from './start.js';
+export * from './otel_propagation.js';

package/dest/lmdb_metrics.d.ts

@@ -0,0 +1,16 @@
+import { type Meter } from './telemetry.js';
+export type LmdbStatsCallback = () => Promise<{
+    mappingSize: number;
+    numItems: number;
+    actualSize: number;
+}>;
+export declare class LmdbMetrics {
+    private attributes?;
+    private getStats?;
+    private dbMapSize;
+    private dbUsedSize;
+    private dbNumItems;
+    constructor(meter: Meter, attributes?: Partial<Record<"aztec.network_name" | "aztec.circuit.protocol_circuit_name" | "aztec.circuit.protocol_circuit_type" | "aztec.circuit.app_circuit_name" | "aztec.circuit.app_circuit_type" | "aztec.block.archive" | "aztec.block.number" | "aztec.slot.number" | "aztec.block.parent" | "aztec.block.candidate_txs_count" | "aztec.block.txs_count" | "aztec.block.size" | "aztec.epoch.size" | "aztec.block.proposer" | "aztec.epoch.number" | "aztec.tx.hash" | "aztec.ok" | "aztec.status" | "aztec.error_type" | "aztec.l1.tx_type" | "aztec.l1.sender" | "aztec.tx.phase_name" | "aztec.p2p.goodbye.reason" | "aztec.proving.job_type" | "aztec.proving.job_id" | "aztec.merkle_tree.name" | "aztec.rollup.prover_id" | "aztec.proof.timed_out" | "aztec.p2p.id" | "aztec.p2p.req_resp.protocol" | "aztec.p2p.req_resp.batch_requests_count" | "aztec.pool.name" | "aztec.sequencer.state" | "aztec.simulator.phase" | "aztec.address.target" | "aztec.address.sender" | "aztec.mana.used" | "aztec.initial_sync" | "aztec.world_state.db_type" | "aztec.db_type" | "aztec.revertibility" | "aztec.gas_dimension" | "aztec.world_state_request" | "nodejs.eventloop.state", import("@opentelemetry/api").AttributeValue>> | undefined, getStats?: LmdbStatsCallback | undefined);
+    private recordDBMetrics;
+}
+//# sourceMappingURL=lmdb_metrics.d.ts.map

package/dest/lmdb_metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lmdb_metrics.d.ts","sourceRoot":"","sources":["../src/lmdb_metrics.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,KAAK,EAGX,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAE7G,qBAAa,WAAW;IAKI,OAAO,CAAC,UAAU,CAAC;IAAkB,OAAO,CAAC,QAAQ,CAAC;IAJhF,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,UAAU,CAAkB;gBAExB,KAAK,EAAE,KAAK,EAAU,UAAU,CAAC,4qCAAgB,EAAU,QAAQ,CAAC,+BAAmB;IAmBnG,OAAO,CAAC,eAAe,CAQrB;CACH"}

package/dest/lmdb_metrics.js

@@ -0,0 +1,42 @@
+import * as Metrics from './metrics.js';
+import { ValueType } from './telemetry.js';
+export class LmdbMetrics {
+    attributes;
+    getStats;
+    dbMapSize;
+    dbUsedSize;
+    dbNumItems;
+    constructor(meter, attributes, getStats){
+        this.attributes = attributes;
+        this.getStats = getStats;
+        this.recordDBMetrics = async (observable)=>{
+            if (!this.getStats) {
+                return;
+            }
+            const metrics = await this.getStats();
+            observable.observe(this.dbMapSize, metrics.mappingSize, this.attributes);
+            observable.observe(this.dbNumItems, metrics.numItems, this.attributes);
+            observable.observe(this.dbUsedSize, metrics.actualSize, this.attributes);
+        };
+        this.dbMapSize = meter.createObservableGauge(Metrics.DB_MAP_SIZE, {
+            description: 'LMDB Map 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
+        });
+        meter.addBatchObservableCallback(this.recordDBMetrics, [
+            this.dbMapSize,
+            this.dbUsedSize,
+            this.dbNumItems
+        ]);
+    }
+    recordDBMetrics;
+}