@ms-cloudpack/telemetry 0.4.0 → 0.4.1

package/lib/AppInsights/AppInsightsTelemetryClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppInsightsTelemetryClient.d.ts","sourceRoot":"","sources":["../../src/AppInsights/AppInsightsTelemetryClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAIrE,qBAAa,0BAA2B,YAAW,eAAe;IAChE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAO;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;gBAExC,OAAO,EAAE,gBAAgB;IAoBrC,IAAW,WAAW,IAAI,mBAAmB,CAE5C;IAED,IAAW,QAAQ,IAAI,IAAI,CAE1B;IAED;;;;OAIG;IACI,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIxD;;OAEG;IACU,QAAQ;IAMrB;;;OAGG;IACI,SAAS,IAAI,MAAM;CAG3B"}
+{"version":3,"file":"AppInsightsTelemetryClient.d.ts","sourceRoot":"","sources":["../../src/AppInsights/AppInsightsTelemetryClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAIrE,qBAAa,0BAA2B,YAAW,eAAe;IAChE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAO;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;gBAExC,OAAO,EAAE,gBAAgB;IAoBrC,IAAW,WAAW,IAAI,mBAAmB,CAE5C;IAED,IAAW,QAAQ,IAAI,IAAI,CAE1B;IAED;;;;OAIG;IACI,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIxD;;OAEG;IACU,QAAQ;IAOrB;;;OAGG;IACI,SAAS,IAAI,MAAM;CAG3B"}

package/lib/AppInsights/AppInsightsTelemetryClient.js

@@ -36,6 +36,7 @@ export class AppInsightsTelemetryClient {
      * Flushes all telemetry and shuts down the telemetry client.
      */
     async shutdown() {
+        this._performance.shutdown();
         this.rootSpan.end();
         await this._traceProvider.forceFlush();
         shutdownAzureMonitor();

package/lib/AppInsights/AppInsightsTelemetryClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppInsightsTelemetryClient.js","sourceRoot":"","sources":["../../src/AppInsights/AppInsightsTelemetryClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACrF,OAAO,EAAE,KAAK,EAAoD,MAAM,oBAAoB,CAAC;AAE7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAGhE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,MAAM,OAAO,0BAA0B;IAMrC,YAAY,OAAyB;QAHpB,yBAAoB,GAA2B,EAAE,CAAC;QAIjE,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAE7C,kDAAkD;QAClD,eAAe,CAAC,MAAM,CAAC,CAAC;QAExB,IAAI,CAAC,cAAc,GAAI,KAAK,CAAC,iBAAiB,EAA0B,CAAC,WAAW,EAAwB,CAAC;QAE7G,wBAAwB;QACxB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QAE/D,mEAAmE;QACnE,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,IAAI,sBAAsB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAElG,mBAAmB;QACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,IAAI,MAAM,CAAC,CAAC;QAE5E,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9D,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,GAAW,EAAE,KAAa;QACtD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACpB,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;QACvC,oBAAoB,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,OAAO,KAAK,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC7C,CAAC;CACF","sourcesContent":["import { shutdownAzureMonitor, useAzureMonitor } from '@azure/monitor-opentelemetry';\nimport { trace, type ProxyTracerProvider, type Span, type Tracer } from '@opentelemetry/api';\nimport type { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';\nimport { PerformanceRecorder } from '../PerformanceRecorder.js';\nimport type { TelemetryClient } from '../types/TelemetryClient.js';\nimport type { TelemetryOptions } from '../types/TelemetryOptions.js';\nimport { SpanEnrichingProcessor } from './SpanEnrichingProcessor.js';\nimport { getAppInsightsConfig } from './getAppInsightsConfig.js';\n\nexport class AppInsightsTelemetryClient implements TelemetryClient {\n  private readonly _performance: PerformanceRecorder;\n  private readonly _rootSpan: Span;\n  private readonly sharedSpanAttributes: Record<string, string> = {};\n  private readonly _traceProvider: NodeTracerProvider;\n\n  constructor(options: TelemetryOptions) {\n    const config = getAppInsightsConfig(options);\n\n    // Set up azure monitor (aka application insights)\n    useAzureMonitor(config);\n\n    this._traceProvider = (trace.getTracerProvider() as ProxyTracerProvider).getDelegate() as NodeTracerProvider;\n\n    // Set shared attributes\n    this.setSharedSpanAttribute('version', options.productVersion);\n\n    // Set SpanEnrichingProcessor to add shared attributes to all spans\n    this._traceProvider.addSpanProcessor(new SpanEnrichingProcessor(() => this.sharedSpanAttributes));\n\n    // Create root span\n    this._rootSpan = this.getTracer().startSpan(options.rootSpanName || 'root');\n\n    this._performance = new PerformanceRecorder(this._rootSpan);\n  }\n\n  public get performance(): PerformanceRecorder {\n    return this._performance;\n  }\n\n  public get rootSpan(): Span {\n    return this._rootSpan;\n  }\n\n  /**\n   * Sets a shared attribute that will be added to all spans.\n   * @param key - key of the attribute\n   * @param value - value of the attribute\n   */\n  public setSharedSpanAttribute(key: string, value: string) {\n    this.sharedSpanAttributes[key] = value;\n  }\n\n  /**\n   * Flushes all telemetry and shuts down the telemetry client.\n   */\n  public async shutdown() {\n    this.rootSpan.end();\n    await this._traceProvider.forceFlush();\n    shutdownAzureMonitor();\n  }\n\n  /**\n   * Gets the OpenTelemetry tracer.\n   * @returns the OpenTelemetry tracer\n   */\n  public getTracer(): Tracer {\n    return trace.getTracer('cloudpack-tracer');\n  }\n}\n"]}
+{"version":3,"file":"AppInsightsTelemetryClient.js","sourceRoot":"","sources":["../../src/AppInsights/AppInsightsTelemetryClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACrF,OAAO,EAAE,KAAK,EAAoD,MAAM,oBAAoB,CAAC;AAE7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAGhE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,MAAM,OAAO,0BAA0B;IAMrC,YAAY,OAAyB;QAHpB,yBAAoB,GAA2B,EAAE,CAAC;QAIjE,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAE7C,kDAAkD;QAClD,eAAe,CAAC,MAAM,CAAC,CAAC;QAExB,IAAI,CAAC,cAAc,GAAI,KAAK,CAAC,iBAAiB,EAA0B,CAAC,WAAW,EAAwB,CAAC;QAE7G,wBAAwB;QACxB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QAE/D,mEAAmE;QACnE,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,IAAI,sBAAsB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAElG,mBAAmB;QACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,IAAI,MAAM,CAAC,CAAC;QAE5E,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9D,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,GAAW,EAAE,KAAa;QACtD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACpB,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;QACvC,oBAAoB,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,OAAO,KAAK,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC7C,CAAC;CACF","sourcesContent":["import { shutdownAzureMonitor, useAzureMonitor } from '@azure/monitor-opentelemetry';\nimport { trace, type ProxyTracerProvider, type Span, type Tracer } from '@opentelemetry/api';\nimport type { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';\nimport { PerformanceRecorder } from '../PerformanceRecorder.js';\nimport type { TelemetryClient } from '../types/TelemetryClient.js';\nimport type { TelemetryOptions } from '../types/TelemetryOptions.js';\nimport { SpanEnrichingProcessor } from './SpanEnrichingProcessor.js';\nimport { getAppInsightsConfig } from './getAppInsightsConfig.js';\n\nexport class AppInsightsTelemetryClient implements TelemetryClient {\n  private readonly _performance: PerformanceRecorder;\n  private readonly _rootSpan: Span;\n  private readonly sharedSpanAttributes: Record<string, string> = {};\n  private readonly _traceProvider: NodeTracerProvider;\n\n  constructor(options: TelemetryOptions) {\n    const config = getAppInsightsConfig(options);\n\n    // Set up azure monitor (aka application insights)\n    useAzureMonitor(config);\n\n    this._traceProvider = (trace.getTracerProvider() as ProxyTracerProvider).getDelegate() as NodeTracerProvider;\n\n    // Set shared attributes\n    this.setSharedSpanAttribute('version', options.productVersion);\n\n    // Set SpanEnrichingProcessor to add shared attributes to all spans\n    this._traceProvider.addSpanProcessor(new SpanEnrichingProcessor(() => this.sharedSpanAttributes));\n\n    // Create root span\n    this._rootSpan = this.getTracer().startSpan(options.rootSpanName || 'root');\n\n    this._performance = new PerformanceRecorder(this._rootSpan);\n  }\n\n  public get performance(): PerformanceRecorder {\n    return this._performance;\n  }\n\n  public get rootSpan(): Span {\n    return this._rootSpan;\n  }\n\n  /**\n   * Sets a shared attribute that will be added to all spans.\n   * @param key - key of the attribute\n   * @param value - value of the attribute\n   */\n  public setSharedSpanAttribute(key: string, value: string) {\n    this.sharedSpanAttributes[key] = value;\n  }\n\n  /**\n   * Flushes all telemetry and shuts down the telemetry client.\n   */\n  public async shutdown() {\n    this._performance.shutdown();\n    this.rootSpan.end();\n    await this._traceProvider.forceFlush();\n    shutdownAzureMonitor();\n  }\n\n  /**\n   * Gets the OpenTelemetry tracer.\n   * @returns the OpenTelemetry tracer\n   */\n  public getTracer(): Tracer {\n    return trace.getTracer('cloudpack-tracer');\n  }\n}\n"]}

package/lib/MetricEventAggregatorRegistry.d.ts

@@ -0,0 +1,18 @@
+import type { MetricEvent } from './types/MetricEvent.js';
+import type { MetricEventAggregator } from './types/MetricEventAggregator.js';
+export declare class MetricEventAggregatorRegistry {
+    private readonly _aggregators;
+    /**
+     * Registers a new aggregator. If an aggregator already exists, it will be return the aggregator.
+     * @param name - The name of the metric.
+     * @param aggregate - The aggregator function.
+     * @returns The aggregator that is passed in.
+     */
+    register<T>(aggregator: MetricEventAggregator<T>): MetricEventAggregator<T>;
+    /**
+     * Gets all the aggregated events from all the registered aggregators.
+     * @returns The aggregated events.
+     */
+    getAggregatedEvents(): MetricEvent[];
+}
+//# sourceMappingURL=MetricEventAggregatorRegistry.d.ts.map

package/lib/MetricEventAggregatorRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricEventAggregatorRegistry.d.ts","sourceRoot":"","sources":["../src/MetricEventAggregatorRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAE9E,qBAAa,6BAA6B;IACxC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA6C;IAE1E;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAQhD;;;OAGG;IACH,mBAAmB,IAAI,WAAW,EAAE;CAQrC"}

package/lib/MetricEventAggregatorRegistry.js

@@ -0,0 +1,29 @@
+export class MetricEventAggregatorRegistry {
+    constructor() {
+        this._aggregators = new Set();
+    }
+    /**
+     * Registers a new aggregator. If an aggregator already exists, it will be return the aggregator.
+     * @param name - The name of the metric.
+     * @param aggregate - The aggregator function.
+     * @returns The aggregator that is passed in.
+     */
+    register(aggregator) {
+        if (!this._aggregators.has(aggregator)) {
+            this._aggregators.add(aggregator);
+        }
+        return aggregator;
+    }
+    /**
+     * Gets all the aggregated events from all the registered aggregators.
+     * @returns The aggregated events.
+     */
+    getAggregatedEvents() {
+        const events = [];
+        for (const aggregator of this._aggregators) {
+            events.push(...aggregator.getAggregatedEvents());
+        }
+        return events;
+    }
+}
+//# sourceMappingURL=MetricEventAggregatorRegistry.js.map

package/lib/MetricEventAggregatorRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricEventAggregatorRegistry.js","sourceRoot":"","sources":["../src/MetricEventAggregatorRegistry.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,6BAA6B;IAA1C;QACmB,iBAAY,GAAG,IAAI,GAAG,EAAkC,CAAC;IA4B5E,CAAC;IA1BC;;;;;OAKG;IACH,QAAQ,CAAI,UAAoC;QAC9C,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YACtC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;SACnC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,mBAAmB;QACjB,MAAM,MAAM,GAAkB,EAAE,CAAC;QACjC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE;YAC1C,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;SAClD;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","sourcesContent":["import type { MetricEvent } from './types/MetricEvent.js';\nimport type { MetricEventAggregator } from './types/MetricEventAggregator.js';\n\nexport class MetricEventAggregatorRegistry {\n  private readonly _aggregators = new Set<MetricEventAggregator<unknown>>();\n\n  /**\n   * Registers a new aggregator. If an aggregator already exists, it will be return the aggregator.\n   * @param name - The name of the metric.\n   * @param aggregate - The aggregator function.\n   * @returns The aggregator that is passed in.\n   */\n  register<T>(aggregator: MetricEventAggregator<T>) {\n    if (!this._aggregators.has(aggregator)) {\n      this._aggregators.add(aggregator);\n    }\n\n    return aggregator;\n  }\n\n  /**\n   * Gets all the aggregated events from all the registered aggregators.\n   * @returns The aggregated events.\n   */\n  getAggregatedEvents(): MetricEvent[] {\n    const events: MetricEvent[] = [];\n    for (const aggregator of this._aggregators) {\n      events.push(...aggregator.getAggregatedEvents());\n    }\n\n    return events;\n  }\n}\n"]}

package/lib/PerformanceRecorder.d.ts

@@ -1,12 +1,21 @@
 import type { Span } from '@opentelemetry/api';
-import type { SpanAttributes } from './types/SpanAttributes.js';
 import type { PerformanceTracker } from './types/PerformanceTracker.js';
+import type { SpanAttributes } from './types/SpanAttributes.js';
+import type { MetricEventAggregator } from './types/MetricEventAggregator.js';
 /**
  * PerformanceRecorder is a utility class for recording performance metrics into telemetry.
  */
 export declare class PerformanceRecorder {
     private readonly span;
+    private readonly _metricEventAggregatorRegistry;
     constructor(span: Span);
+    /**
+     * Registers a new aggregator for a given metric.
+     * If an aggregator already exists, it will be skipped.
+     * @param name - The name of the metric.
+     * @param aggregator - The aggregator function.
+     */
+    registerAggregator<T>(aggregator: MetricEventAggregator<T>): MetricEventAggregator<T>;
     /**
      * Records a performance metric into telemetry. The metric will be recorded as an event on the span and logged to the console.
      * It can be used for any situation where a performance metric (ie: how long does it take run something, or any other purpose) is needed.
@@ -24,5 +33,9 @@ export declare class PerformanceRecorder {
      * @returns - The result of the `execute` function.
      */
     track<T>(name: string, execute: (tracker: PerformanceTracker) => Promise<T>): Promise<T>;
+    /**
+     * Shuts down the performance recorder and records any aggregated events.
+     */
+    shutdown(): void;
 }
 //# sourceMappingURL=PerformanceRecorder.d.ts.map

package/lib/PerformanceRecorder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PerformanceRecorder.d.ts","sourceRoot":"","sources":["../src/PerformanceRecorder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAExE;;GAEG;AACH,qBAAa,mBAAmB;IAClB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,IAAI;IAEvC;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,oBAAoB,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,IAAI;IAMhG;;;;;OAKG;IACG,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAqB/F"}
+{"version":3,"file":"PerformanceRecorder.d.ts","sourceRoot":"","sources":["../src/PerformanceRecorder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAG/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAE9E;;GAEG;AACH,qBAAa,mBAAmB;IAGlB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAFjC,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAuC;gBAEzD,IAAI,EAAE,IAAI;IAEvC;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,EAAE,UAAU,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAI1D;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,oBAAoB,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,IAAI;IAMhG;;;;;OAKG;IACG,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAsB9F;;OAEG;IACH,QAAQ,IAAI,IAAI;CAKjB"}

package/lib/PerformanceRecorder.js

@@ -1,10 +1,21 @@
 import { performance } from 'perf_hooks';
+import { MetricEventAggregatorRegistry } from './MetricEventAggregatorRegistry.js';
 /**
  * PerformanceRecorder is a utility class for recording performance metrics into telemetry.
  */
 export class PerformanceRecorder {
     constructor(span) {
         this.span = span;
+        this._metricEventAggregatorRegistry = new MetricEventAggregatorRegistry();
+    }
+    /**
+     * Registers a new aggregator for a given metric.
+     * If an aggregator already exists, it will be skipped.
+     * @param name - The name of the metric.
+     * @param aggregator - The aggregator function.
+     */
+    registerAggregator(aggregator) {
+        return this._metricEventAggregatorRegistry.register(aggregator);
     }
     /**
      * Records a performance metric into telemetry. The metric will be recorded as an event on the span and logged to the console.
@@ -14,7 +25,7 @@ export class PerformanceRecorder {
     record(attributes) {
         const { name, value, additionalProperties = {} } = attributes;
         this.span.addEvent('Performance-Metric', { ...additionalProperties, name, value });
-        console.debug(`Performance-Metric: ${name} ${value} ms`);
+        console.debug(`Performance-Metric: ${name} ${value}`);
     }
     /**
      * Tracks the execution time of a given `execute` function and report it to telemetry.
@@ -38,5 +49,13 @@ export class PerformanceRecorder {
         this.record({ name, value: performance.now() - startTime, additionalProperties });
         return result;
     }
+    /**
+     * Shuts down the performance recorder and records any aggregated events.
+     */
+    shutdown() {
+        for (const { name, value, attributes } of this._metricEventAggregatorRegistry.getAggregatedEvents()) {
+            this.record({ name, value, additionalProperties: attributes });
+        }
+    }
 }
 //# sourceMappingURL=PerformanceRecorder.js.map

package/lib/PerformanceRecorder.js.map

@@ -1 +1 @@
-{"version":3,"file":"PerformanceRecorder.js","sourceRoot":"","sources":["../src/PerformanceRecorder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAIzC;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B,YAA6B,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;IAE3C;;;;OAIG;IACH,MAAM,CAAC,UAAkF;QACvF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,GAAG,EAAE,EAAE,GAAG,UAAU,CAAC;QAC9D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,EAAE,GAAG,oBAAoB,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACnF,OAAO,CAAC,KAAK,CAAC,uBAAuB,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAI,IAAY,EAAE,OAAoD;QAC/E,MAAM,oBAAoB,GAAmB,EAAE,CAAC;QAEhD,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAEpC,MAAM,OAAO,GAAuB;YAClC,IAAI;YACJ,SAAS;YACT,aAAa,EAAE,CAAC,UAA0B,EAAE,EAAE;gBAC5C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;oBACrD,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBACnC;YACH,CAAC;SACF,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAElF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","sourcesContent":["import type { Span } from '@opentelemetry/api';\nimport { performance } from 'perf_hooks';\nimport type { SpanAttributes } from './types/SpanAttributes.js';\nimport type { PerformanceTracker } from './types/PerformanceTracker.js';\n\n/**\n * PerformanceRecorder is a utility class for recording performance metrics into telemetry.\n */\nexport class PerformanceRecorder {\n  constructor(private readonly span: Span) {}\n\n  /**\n   * Records a performance metric into telemetry. The metric will be recorded as an event on the span and logged to the console.\n   * It can be used for any situation where a performance metric (ie: how long does it take run something, or any other purpose) is needed.\n   * @param attributes\n   */\n  record(attributes: { name: string; value: number; additionalProperties?: SpanAttributes }): void {\n    const { name, value, additionalProperties = {} } = attributes;\n    this.span.addEvent('Performance-Metric', { ...additionalProperties, name, value });\n    console.debug(`Performance-Metric: ${name} ${value} ms`);\n  }\n\n  /**\n   * Tracks the execution time of a given `execute` function and report it to telemetry.\n   * @param name - The name of the performance metric.\n   * @param execute - The function to execute and track.\n   * @returns - The result of the `execute` function.\n   */\n  async track<T>(name: string, execute: (tracker: PerformanceTracker) => Promise<T>): Promise<T> {\n    const additionalProperties: SpanAttributes = {};\n\n    const startTime = performance.now();\n\n    const tracker: PerformanceTracker = {\n      name,\n      startTime,\n      setProperties: (properties: SpanAttributes) => {\n        for (const [key, value] of Object.entries(properties)) {\n          additionalProperties[key] = value;\n        }\n      },\n    };\n\n    const result = await execute(tracker);\n\n    this.record({ name, value: performance.now() - startTime, additionalProperties });\n\n    return result;\n  }\n}\n"]}
+{"version":3,"file":"PerformanceRecorder.js","sourceRoot":"","sources":["../src/PerformanceRecorder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAKnF;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAG9B,YAA6B,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;QAFtB,mCAA8B,GAAG,IAAI,6BAA6B,EAAE,CAAC;IAE5C,CAAC;IAE3C;;;;;OAKG;IACH,kBAAkB,CAAI,UAAoC;QACxD,OAAO,IAAI,CAAC,8BAA8B,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAkF;QACvF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,GAAG,EAAE,EAAE,GAAG,UAAU,CAAC;QAC9D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,EAAE,GAAG,oBAAoB,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACnF,OAAO,CAAC,KAAK,CAAC,uBAAuB,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAI,IAAY,EAAE,OAAoD;QAC/E,MAAM,oBAAoB,GAAmB,EAAE,CAAC;QAEhD,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAEpC,MAAM,OAAO,GAAuB;YAClC,IAAI;YACJ,SAAS;YACT,aAAa,EAAE,CAAC,UAA0B,EAAE,EAAE;gBAC5C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;oBACrD,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBACnC;YACH,CAAC;SACF,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAElF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,IAAI,CAAC,8BAA8B,CAAC,mBAAmB,EAAE,EAAE;YACnG,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,UAAU,EAAE,CAAC,CAAC;SAChE;IACH,CAAC;CACF","sourcesContent":["import type { Span } from '@opentelemetry/api';\nimport { performance } from 'perf_hooks';\nimport { MetricEventAggregatorRegistry } from './MetricEventAggregatorRegistry.js';\nimport type { PerformanceTracker } from './types/PerformanceTracker.js';\nimport type { SpanAttributes } from './types/SpanAttributes.js';\nimport type { MetricEventAggregator } from './types/MetricEventAggregator.js';\n\n/**\n * PerformanceRecorder is a utility class for recording performance metrics into telemetry.\n */\nexport class PerformanceRecorder {\n  private readonly _metricEventAggregatorRegistry = new MetricEventAggregatorRegistry();\n\n  constructor(private readonly span: Span) {}\n\n  /**\n   * Registers a new aggregator for a given metric.\n   * If an aggregator already exists, it will be skipped.\n   * @param name - The name of the metric.\n   * @param aggregator - The aggregator function.\n   */\n  registerAggregator<T>(aggregator: MetricEventAggregator<T>) {\n    return this._metricEventAggregatorRegistry.register(aggregator);\n  }\n\n  /**\n   * Records a performance metric into telemetry. The metric will be recorded as an event on the span and logged to the console.\n   * It can be used for any situation where a performance metric (ie: how long does it take run something, or any other purpose) is needed.\n   * @param attributes\n   */\n  record(attributes: { name: string; value: number; additionalProperties?: SpanAttributes }): void {\n    const { name, value, additionalProperties = {} } = attributes;\n    this.span.addEvent('Performance-Metric', { ...additionalProperties, name, value });\n    console.debug(`Performance-Metric: ${name} ${value}`);\n  }\n\n  /**\n   * Tracks the execution time of a given `execute` function and report it to telemetry.\n   * @param name - The name of the performance metric.\n   * @param execute - The function to execute and track.\n   * @returns - The result of the `execute` function.\n   */\n  async track<T>(name: string, execute: (tracker: PerformanceTracker) => Promise<T>): Promise<T> {\n    const additionalProperties: SpanAttributes = {};\n\n    const startTime = performance.now();\n\n    const tracker: PerformanceTracker = {\n      name,\n      startTime,\n      setProperties: (properties: SpanAttributes) => {\n        for (const [key, value] of Object.entries(properties)) {\n          additionalProperties[key] = value;\n        }\n      },\n    };\n\n    const result = await execute(tracker);\n\n    this.record({ name, value: performance.now() - startTime, additionalProperties });\n\n    return result;\n  }\n\n  /**\n   * Shuts down the performance recorder and records any aggregated events.\n   */\n  shutdown(): void {\n    for (const { name, value, attributes } of this._metricEventAggregatorRegistry.getAggregatedEvents()) {\n      this.record({ name, value, additionalProperties: attributes });\n    }\n  }\n}\n"]}

package/lib/index.d.ts

@@ -7,4 +7,6 @@ export { createNoOpTelemetryClient } from './createNoOpTelemetryClient.js';
 export type { PerformanceTracker } from './types/PerformanceTracker.js';
 export type { SpanAttributes } from './types/SpanAttributes.js';
 export type { PerformanceRecorder } from './PerformanceRecorder.js';
+export type { MetricEvent } from './types/MetricEvent.js';
+export type { MetricEventAggregator } from './types/MetricEventAggregator.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,YAAY,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,YAAY,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,YAAY,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,YAAY,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,YAAY,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,YAAY,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,YAAY,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC"}

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAInE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC","sourcesContent":["export type { Span, Tracer } from '@opentelemetry/api';\nexport { createTelemetryClient } from './createTelemetryClient.js';\nexport type { LogLevel } from './types/LogLevel.js';\nexport type { TelemetryClient } from './types/TelemetryClient.js';\nexport type { TelemetryOptions } from './types/TelemetryOptions.js';\nexport { createNoOpTelemetryClient } from './createNoOpTelemetryClient.js';\nexport type { PerformanceTracker } from './types/PerformanceTracker.js';\nexport type { SpanAttributes } from './types/SpanAttributes.js';\nexport type { PerformanceRecorder } from './PerformanceRecorder.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAInE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC","sourcesContent":["export type { Span, Tracer } from '@opentelemetry/api';\nexport { createTelemetryClient } from './createTelemetryClient.js';\nexport type { LogLevel } from './types/LogLevel.js';\nexport type { TelemetryClient } from './types/TelemetryClient.js';\nexport type { TelemetryOptions } from './types/TelemetryOptions.js';\nexport { createNoOpTelemetryClient } from './createNoOpTelemetryClient.js';\nexport type { PerformanceTracker } from './types/PerformanceTracker.js';\nexport type { SpanAttributes } from './types/SpanAttributes.js';\nexport type { PerformanceRecorder } from './PerformanceRecorder.js';\nexport type { MetricEvent } from './types/MetricEvent.js';\nexport type { MetricEventAggregator } from './types/MetricEventAggregator.js';\n"]}

package/lib/types/MetricEvent.d.ts

@@ -0,0 +1,7 @@
+import type { SpanAttributes } from './SpanAttributes.js';
+export interface MetricEvent {
+    attributes?: SpanAttributes;
+    value: number;
+    name: string;
+}
+//# sourceMappingURL=MetricEvent.d.ts.map

package/lib/types/MetricEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricEvent.d.ts","sourceRoot":"","sources":["../../src/types/MetricEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd"}

package/lib/types/MetricEvent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MetricEvent.js.map

package/lib/types/MetricEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricEvent.js","sourceRoot":"","sources":["../../src/types/MetricEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { SpanAttributes } from './SpanAttributes.js';\n\nexport interface MetricEvent {\n  attributes?: SpanAttributes;\n  value: number;\n  name: string;\n}\n"]}

package/lib/types/MetricEventAggregator.d.ts

@@ -0,0 +1,6 @@
+import type { MetricEvent } from '../index.js';
+export interface MetricEventAggregator<T> {
+    record(event: T): void;
+    getAggregatedEvents(): MetricEvent[];
+}
+//# sourceMappingURL=MetricEventAggregator.d.ts.map

package/lib/types/MetricEventAggregator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricEventAggregator.d.ts","sourceRoot":"","sources":["../../src/types/MetricEventAggregator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IACvB,mBAAmB,IAAI,WAAW,EAAE,CAAC;CACtC"}

package/lib/types/MetricEventAggregator.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MetricEventAggregator.js.map

package/lib/types/MetricEventAggregator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetricEventAggregator.js","sourceRoot":"","sources":["../../src/types/MetricEventAggregator.ts"],"names":[],"mappings":"","sourcesContent":["import type { MetricEvent } from '../index.js';\n\nexport interface MetricEventAggregator<T> {\n  record(event: T): void;\n  getAggregatedEvents(): MetricEvent[];\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/telemetry",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Helpers for logging tasks to the console.",
   "license": "MIT",
   "type": "module",