@aztec/telemetry-client 0.76.4 → 0.77.0-testnet-ignition.21

package/src/telemetry.ts

@@ -12,35 +12,35 @@ import {
   type UpDownCounter as OtelUpDownCounter,
   type Span,
   SpanStatusCode,
-  Tracer,
+  type Tracer,
 } from '@opentelemetry/api';
 import { isPromise } from 'node:util/types';
 
-import * as Attributes from './attributes.js';
-import * as Metrics from './metrics.js';
+import type * as Attributes from './attributes.js';
+import type * as Metrics from './metrics.js';
 import { getTelemetryClient } from './start.js';
 
-export { Span, SpanStatusCode, ValueType } from '@opentelemetry/api';
+export { type Span, SpanStatusCode, ValueType } from '@opentelemetry/api';
 
 type ValuesOf<T> = T extends Record<string, infer U> ? U : never;
 
 /** Global registry of attributes */
-type Attributes = Partial<Record<ValuesOf<typeof Attributes>, AttributeValue>>;
-export { Attributes };
+type AttributesType = Partial<Record<ValuesOf<typeof Attributes>, AttributeValue>>;
+export type { AttributesType };
 
 /** Global registry of metrics */
-type Metrics = (typeof Metrics)[keyof typeof Metrics];
-export { Metrics };
+type MetricsType = (typeof Metrics)[keyof typeof Metrics];
+export type { MetricsType };
 
-export type Gauge = OtelGauge<Attributes>;
-export type Histogram = OtelHistogram<Attributes>;
-export type UpDownCounter = OtelUpDownCounter<Attributes>;
-export type ObservableGauge = OtelObservableGauge<Attributes>;
-export type ObservableUpDownCounter = OtelObservableUpDownCounter<Attributes>;
-export type ObservableResult = OtelObservableResult<Attributes>;
-export type BatchObservableResult = OtelBatchObservableResult<Attributes>;
+export type Gauge = OtelGauge<AttributesType>;
+export type Histogram = OtelHistogram<AttributesType>;
+export type UpDownCounter = OtelUpDownCounter<AttributesType>;
+export type ObservableGauge = OtelObservableGauge<AttributesType>;
+export type ObservableUpDownCounter = OtelObservableUpDownCounter<AttributesType>;
+export type ObservableResult = OtelObservableResult<AttributesType>;
+export type BatchObservableResult = OtelBatchObservableResult<AttributesType>;
 
-export { Tracer };
+export type { Tracer };
 
 // INTERNAL NOTE: this interface is the same as opentelemetry's Meter, but with proper types
 /**
@@ -52,23 +52,23 @@ export interface Meter {
    * @param name - The name of the gauge
    * @param options - The options for the gauge
    */
-  createGauge(name: Metrics, options?: MetricOptions): Gauge;
+  createGauge(name: MetricsType, options?: MetricOptions): Gauge;
 
   /**
    * Creates a new gauge instrument. A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.
    * @param name - The name of the gauge
    * @param options - The options for the gauge
    */
-  createObservableGauge(name: Metrics, options?: MetricOptions): ObservableGauge;
+  createObservableGauge(name: MetricsType, options?: MetricOptions): ObservableGauge;
 
   addBatchObservableCallback(
-    callback: BatchObservableCallback<Attributes>,
-    observables: Observable<Attributes>[],
+    callback: BatchObservableCallback<AttributesType>,
+    observables: Observable<AttributesType>[],
   ): void;
 
   removeBatchObservableCallback(
-    callback: BatchObservableCallback<Attributes>,
-    observables: Observable<Attributes>[],
+    callback: BatchObservableCallback<AttributesType>,
+    observables: Observable<AttributesType>[],
   ): void;
 
   /**
@@ -76,21 +76,21 @@ export interface Meter {
    * @param name - The name of the histogram
    * @param options - The options for the histogram
    */
-  createHistogram(name: Metrics, options?: MetricOptions): Histogram;
+  createHistogram(name: MetricsType, options?: MetricOptions): Histogram;
 
   /**
    * Creates a new counter instrument. A counter can go up or down with a delta from the previous value.
    * @param name - The name of the counter
    * @param options - The options for the counter
    */
-  createUpDownCounter(name: Metrics, options?: MetricOptions): UpDownCounter;
+  createUpDownCounter(name: MetricsType, options?: MetricOptions): UpDownCounter;
 
   /**
    * Creates a new gauge instrument. A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.
    * @param name - The name of the gauge
    * @param options - The options for the gauge
    */
-  createObservableUpDownCounter(name: Metrics, options?: MetricOptions): ObservableUpDownCounter;
+  createObservableUpDownCounter(name: MetricsType, options?: MetricOptions): ObservableUpDownCounter;
 }
 
 /**
@@ -151,8 +151,8 @@ type SpanDecorator<T extends Traceable, F extends (...args: any[]) => any> = (
  */
 export function trackSpan<T extends Traceable, F extends (...args: any[]) => any>(
   spanName: string | ((this: T, ...args: Parameters<F>) => string),
-  attributes?: Attributes | ((this: T, ...args: Parameters<F>) => Promise<Attributes> | Attributes),
-  extraAttributes?: (this: T, returnValue: Awaited<ReturnType<F>>) => Attributes,
+  attributes?: AttributesType | ((this: T, ...args: Parameters<F>) => Promise<AttributesType> | AttributesType),
+  extraAttributes?: (this: T, returnValue: Awaited<ReturnType<F>>) => AttributesType,
 ): SpanDecorator<T, F> {
   // the return value of trackSpan is a decorator
   return (originalMethod: F, _context: ClassMethodDecoratorContext<T>) => {
@@ -202,7 +202,7 @@ export function trackSpan<T extends Traceable, F extends (...args: any[]) => any
 export function wrapCallbackInSpan<F extends (...args: any[]) => any>(
   tracer: Tracer,
   spanName: string,
-  attributes: Attributes,
+  attributes: AttributesType,
   callback: F,
 ): F {
   const span = tracer.startSpan(spanName, { attributes });

package/src/with_tracer.ts

@@ -1,4 +1,4 @@
-import { type TelemetryClient, type Tracer } from './telemetry.js';
+import type { TelemetryClient, Tracer } from './telemetry.js';
 
 /**
  * A minimal class that enables recording metrics with a telemetry client.

package/src/wrappers/fetch.ts

@@ -1,5 +1,5 @@
 import { defaultFetch } from '@aztec/foundation/json-rpc/client';
-import { type Logger } from '@aztec/foundation/log';
+import type { Logger } from '@aztec/foundation/log';
 import { makeBackoff, retry } from '@aztec/foundation/retry';
 
 import { SpanKind, SpanStatusCode, context, propagation } from '@opentelemetry/api';

package/src/wrappers/json_rpc_server.ts

@@ -1,5 +1,5 @@
 import { type SafeJsonRpcServerOptions, createSafeJsonRpcServer } from '@aztec/foundation/json-rpc/server';
-import { type ApiSchemaFor } from '@aztec/foundation/schemas';
+import type { ApiSchemaFor } from '@aztec/stdlib/schemas';
 
 import { getOtelJsonRpcPropagationMiddleware } from '../otel_propagation.js';
 

package/src/wrappers/l2_block_stream.ts

@@ -1,10 +1,10 @@
+import { createLogger } from '@aztec/foundation/log';
 import {
   type L2BlockSource,
   L2BlockStream,
   type L2BlockStreamEventHandler,
   type L2BlockStreamLocalDataProvider,
-} from '@aztec/circuit-types';
-import { createLogger } from '@aztec/foundation/log';
+} from '@aztec/stdlib/block';
 import { type Traceable, type Tracer, trackSpan } from '@aztec/telemetry-client';
 
 /** Extends an L2BlockStream with a tracer to create a new trace per iteration. */

package/dest/aztec_resource_detector.d.ts

@@ -1,10 +0,0 @@
-import { type DetectorSync, type IResource } from '@opentelemetry/resources';
-/**
- * Detector for custom Aztec attributes
- */
-declare class AztecDetector implements DetectorSync {
-    detect(): IResource;
-}
-export declare const aztecDetector: AztecDetector;
-export {};
-//# sourceMappingURL=aztec_resource_detector.d.ts.map

package/dest/aztec_resource_detector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"aztec_resource_detector.d.ts","sourceRoot":"","sources":["../src/aztec_resource_detector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,SAAS,EAAY,MAAM,0BAA0B,CAAC;AAUvF;;GAEG;AACH,cAAM,aAAc,YAAW,YAAY;IACzC,MAAM,IAAI,SAAS;CAWpB;AAED,eAAO,MAAM,aAAa,eAAsB,CAAC"}

package/dest/aztec_resource_detector.js

@@ -1,20 +0,0 @@
-import { Resource } from '@opentelemetry/resources';
-import { ATTR_K8S_NAMESPACE_NAME, ATTR_K8S_POD_NAME, ATTR_K8S_POD_UID, ATTR_SERVICE_INSTANCE_ID, } from '@opentelemetry/semantic-conventions/incubating';
-import { getConfigEnvVars } from './config.js';
-/**
- * Detector for custom Aztec attributes
- */
-class AztecDetector {
-    detect() {
-        const config = getConfigEnvVars();
-        return new Resource({
-            [ATTR_K8S_POD_UID]: config.k8sPodUid,
-            [ATTR_K8S_POD_NAME]: config.k8sPodName,
-            // this will get set by serviceInstanceIdDetector if not running in K8s
-            [ATTR_SERVICE_INSTANCE_ID]: config.k8sPodUid,
-            [ATTR_K8S_NAMESPACE_NAME]: config.k8sNamespaceName,
-        });
-    }
-}
-export const aztecDetector = new AztecDetector();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfcmVzb3VyY2VfZGV0ZWN0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYXp0ZWNfcmVzb3VyY2VfZGV0ZWN0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFxQyxRQUFRLEVBQUUsTUFBTSwwQkFBMEIsQ0FBQztBQUN2RixPQUFPLEVBQ0wsdUJBQXVCLEVBQ3ZCLGlCQUFpQixFQUNqQixnQkFBZ0IsRUFDaEIsd0JBQXdCLEdBQ3pCLE1BQU0sZ0RBQWdELENBQUM7QUFFeEQsT0FBTyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRS9DOztHQUVHO0FBQ0gsTUFBTSxhQUFhO0lBQ2pCLE1BQU07UUFDSixNQUFNLE1BQU0sR0FBRyxnQkFBZ0IsRUFBRSxDQUFDO1FBRWxDLE9BQU8sSUFBSSxRQUFRLENBQUM7WUFDbEIsQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxTQUFTO1lBQ3BDLENBQUMsaUJBQWlCLENBQUMsRUFBRSxNQUFNLENBQUMsVUFBVTtZQUN0Qyx1RUFBdUU7WUFDdkUsQ0FBQyx3QkFBd0IsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxTQUFTO1lBQzVDLENBQUMsdUJBQXVCLENBQUMsRUFBRSxNQUFNLENBQUMsZ0JBQWdCO1NBQ25ELENBQUMsQ0FBQztJQUNMLENBQUM7Q0FDRjtBQUVELE1BQU0sQ0FBQyxNQUFNLGFBQWEsR0FBRyxJQUFJLGFBQWEsRUFBRSxDQUFDIn0=

package/dest/histogram_utils.d.ts

@@ -1,36 +0,0 @@
-/**
- * Creates a set of buckets that follow linear growth
- * @param start - The start of the range
- * @param end - The end of the range
- * @param count - The number of buckets
- * @returns - An array of bucket boundaries
- */
-export declare function linearBuckets(start: number, end: number, count: number): number[];
-/**
- * Creates an array of exponential buckets that follow the formulas at
- * https://opentelemetry.io/docs/specs/otel/metrics/data-model/#exponential-buckets
- *
- * The formula followed is: bucket[i] = base ** i, where base = 2 ** (2 ** -scale). Naturally base will be very small when scale > 0.
- * This ensures that between each power of 2, there are 2 ** scale intermediate buckets.
- *
- * @example
- * scale = 2, count = 8
- * base = 2 ** (2 ** -2) = 1.189207115
- * |bucket index| value |
- * |------------|-------|
- * |     0      | 1     |
- * |     1      | 1.18  |
- * |     2      | 1.41  |
- * |     3      | 1.68  |
- * |     4      | 2     |
- * |     5      | 2.37  |
- * |     6      | 2.82  |
- * |     7      | 3.36  |
- * |     8      | 4     |
- *
- * @param scale - The "precision" of the buckets. The higher the scale, the more buckets will be created
- * @param count - The total number of buckets
- * @returns - An array of bucket boundaries
- */
-export declare function exponentialBuckets(scale: number, count: number): number[];
-//# sourceMappingURL=histogram_utils.d.ts.map

package/dest/histogram_utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"histogram_utils.d.ts","sourceRoot":"","sources":["../src/histogram_utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAOjF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAOzE"}

package/dest/histogram_utils.js

@@ -1,50 +0,0 @@
-/**
- * Creates a set of buckets that follow linear growth
- * @param start - The start of the range
- * @param end - The end of the range
- * @param count - The number of buckets
- * @returns - An array of bucket boundaries
- */
-export function linearBuckets(start, end, count) {
-    const buckets = [];
-    const step = (end - start) / count;
-    for (let i = 0; i <= count; i++) {
-        buckets.push(Math.floor(start + i * step));
-    }
-    return buckets;
-}
-/**
- * Creates an array of exponential buckets that follow the formulas at
- * https://opentelemetry.io/docs/specs/otel/metrics/data-model/#exponential-buckets
- *
- * The formula followed is: bucket[i] = base ** i, where base = 2 ** (2 ** -scale). Naturally base will be very small when scale > 0.
- * This ensures that between each power of 2, there are 2 ** scale intermediate buckets.
- *
- * @example
- * scale = 2, count = 8
- * base = 2 ** (2 ** -2) = 1.189207115
- * |bucket index| value |
- * |------------|-------|
- * |     0      | 1     |
- * |     1      | 1.18  |
- * |     2      | 1.41  |
- * |     3      | 1.68  |
- * |     4      | 2     |
- * |     5      | 2.37  |
- * |     6      | 2.82  |
- * |     7      | 3.36  |
- * |     8      | 4     |
- *
- * @param scale - The "precision" of the buckets. The higher the scale, the more buckets will be created
- * @param count - The total number of buckets
- * @returns - An array of bucket boundaries
- */
-export function exponentialBuckets(scale, count) {
-    const buckets = [];
-    const base = 2 ** (2 ** -scale);
-    for (let i = 0; i <= count; i++) {
-        buckets.push(base ** i);
-    }
-    return buckets;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGlzdG9ncmFtX3V0aWxzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2hpc3RvZ3JhbV91dGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7O0dBTUc7QUFDSCxNQUFNLFVBQVUsYUFBYSxDQUFDLEtBQWEsRUFBRSxHQUFXLEVBQUUsS0FBYTtJQUNyRSxNQUFNLE9BQU8sR0FBYSxFQUFFLENBQUM7SUFDN0IsTUFBTSxJQUFJLEdBQUcsQ0FBQyxHQUFHLEdBQUcsS0FBSyxDQUFDLEdBQUcsS0FBSyxDQUFDO0lBQ25DLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQztRQUNoQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxHQUFHLENBQUMsR0FBRyxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQzdDLENBQUM7SUFDRCxPQUFPLE9BQU8sQ0FBQztBQUNqQixDQUFDO0FBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0F5Qkc7QUFDSCxNQUFNLFVBQVUsa0JBQWtCLENBQUMsS0FBYSxFQUFFLEtBQWE7SUFDN0QsTUFBTSxPQUFPLEdBQWEsRUFBRSxDQUFDO0lBQzdCLE1BQU0sSUFBSSxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ2hDLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQztRQUNoQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQztJQUMxQixDQUFDO0lBQ0QsT0FBTyxPQUFPLENBQUM7QUFDakIsQ0FBQyJ9

package/src/aztec_resource_detector.ts

@@ -1,28 +0,0 @@
-import { type DetectorSync, type IResource, Resource } from '@opentelemetry/resources';
-import {
-  ATTR_K8S_NAMESPACE_NAME,
-  ATTR_K8S_POD_NAME,
-  ATTR_K8S_POD_UID,
-  ATTR_SERVICE_INSTANCE_ID,
-} from '@opentelemetry/semantic-conventions/incubating';
-
-import { getConfigEnvVars } from './config.js';
-
-/**
- * Detector for custom Aztec attributes
- */
-class AztecDetector implements DetectorSync {
-  detect(): IResource {
-    const config = getConfigEnvVars();
-
-    return new Resource({
-      [ATTR_K8S_POD_UID]: config.k8sPodUid,
-      [ATTR_K8S_POD_NAME]: config.k8sPodName,
-      // this will get set by serviceInstanceIdDetector if not running in K8s
-      [ATTR_SERVICE_INSTANCE_ID]: config.k8sPodUid,
-      [ATTR_K8S_NAMESPACE_NAME]: config.k8sNamespaceName,
-    });
-  }
-}
-
-export const aztecDetector = new AztecDetector();

package/src/histogram_utils.ts

@@ -1,50 +0,0 @@
-/**
- * Creates a set of buckets that follow linear growth
- * @param start - The start of the range
- * @param end - The end of the range
- * @param count - The number of buckets
- * @returns - An array of bucket boundaries
- */
-export function linearBuckets(start: number, end: number, count: number): number[] {
-  const buckets: number[] = [];
-  const step = (end - start) / count;
-  for (let i = 0; i <= count; i++) {
-    buckets.push(Math.floor(start + i * step));
-  }
-  return buckets;
-}
-
-/**
- * Creates an array of exponential buckets that follow the formulas at
- * https://opentelemetry.io/docs/specs/otel/metrics/data-model/#exponential-buckets
- *
- * The formula followed is: bucket[i] = base ** i, where base = 2 ** (2 ** -scale). Naturally base will be very small when scale > 0.
- * This ensures that between each power of 2, there are 2 ** scale intermediate buckets.
- *
- * @example
- * scale = 2, count = 8
- * base = 2 ** (2 ** -2) = 1.189207115
- * |bucket index| value |
- * |------------|-------|
- * |     0      | 1     |
- * |     1      | 1.18  |
- * |     2      | 1.41  |
- * |     3      | 1.68  |
- * |     4      | 2     |
- * |     5      | 2.37  |
- * |     6      | 2.82  |
- * |     7      | 3.36  |
- * |     8      | 4     |
- *
- * @param scale - The "precision" of the buckets. The higher the scale, the more buckets will be created
- * @param count - The total number of buckets
- * @returns - An array of bucket boundaries
- */
-export function exponentialBuckets(scale: number, count: number): number[] {
-  const buckets: number[] = [];
-  const base = 2 ** (2 ** -scale);
-  for (let i = 0; i <= count; i++) {
-    buckets.push(base ** i);
-  }
-  return buckets;
-}