@ms-cloudpack/telemetry 0.8.1 → 0.9.0

package/dist/{AppInsightsTelemetryClient-R4KUMXIS.js → AppInsightsTelemetryClient-U3TW3MST.js}

@@ -21,7 +21,7 @@ import {
   require_src2,
   require_src3,
   require_src4
-} from "./chunk-NJ4KSOZ3.js";
+} from "./chunk-NUFLYJEX.js";
 
 // ../../node_modules/.store/@azure-core-rest-pipeline-npm-1.17.0-aa1ea9ace7/package/dist/commonjs/pipeline.js
 var require_pipeline = __commonJS({

package/dist/{NoOpTelemetryClient-TTBAN54Z.js → NoOpTelemetryClient-W2RWEMCF.js}

@@ -6,8 +6,8 @@ const __filename = topLevelUrl.fileURLToPath(import.meta.url);
 const __dirname = topLevelPath.dirname(__filename);
 import {
   NoOpTelemetryClient
-} from "./chunk-BNPQM6Z3.js";
-import "./chunk-NJ4KSOZ3.js";
+} from "./chunk-J5XDHDQP.js";
+import "./chunk-NUFLYJEX.js";
 export {
   NoOpTelemetryClient
 };

package/dist/{chunk-BNPQM6Z3.js → chunk-J5XDHDQP.js}

@@ -7,7 +7,7 @@ const __dirname = topLevelPath.dirname(__filename);
 import {
   BaseTelemetryClient,
   __name
-} from "./chunk-NJ4KSOZ3.js";
+} from "./chunk-NUFLYJEX.js";
 
 // src/NoOpTelemetryClient.ts
 var _NoOpTelemetryClient = class _NoOpTelemetryClient extends BaseTelemetryClient {
@@ -15,7 +15,6 @@ var _NoOpTelemetryClient = class _NoOpTelemetryClient extends BaseTelemetryClien
     super({
       productVersion: "no-op",
       serviceName: "no-op",
-      rootSpanName: "no-op",
       serviceNamespace: "no-op",
       logLevel: "NONE"
     });

package/dist/{chunk-NJ4KSOZ3.js → chunk-NUFLYJEX.js}

@@ -12129,95 +12129,6 @@ var _SpanEnrichingProcessor = class _SpanEnrichingProcessor {
 __name(_SpanEnrichingProcessor, "SpanEnrichingProcessor");
 var SpanEnrichingProcessor = _SpanEnrichingProcessor;
 
-// src/PerformanceRecorder.ts
-import { performance } from "perf_hooks";
-
-// src/MetricEventAggregatorRegistry.ts
-var _MetricEventAggregatorRegistry = class _MetricEventAggregatorRegistry {
-  constructor() {
-    this._aggregators = /* @__PURE__ */ 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;
-  }
-};
-__name(_MetricEventAggregatorRegistry, "MetricEventAggregatorRegistry");
-var MetricEventAggregatorRegistry = _MetricEventAggregatorRegistry;
-
-// src/PerformanceRecorder.ts
-var _PerformanceRecorder = 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.
-   * 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.
-   * @param attributes
-   */
-  record(attributes) {
-    const { name, value, additionalProperties = {} } = attributes;
-    this.span.addEvent("Performance-Metric", { ...additionalProperties, name, value });
-    console.debug(`Performance-Metric: ${name} ${value}`);
-  }
-  async track(name, execute) {
-    const additionalProperties = {};
-    const startTime = performance.now();
-    const tracker = {
-      name,
-      startTime,
-      setProperties: /* @__PURE__ */ __name((properties) => {
-        Object.assign(additionalProperties, properties);
-      }, "setProperties")
-    };
-    const result = execute(tracker);
-    if (result instanceof Promise) {
-      await result;
-    }
-    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 });
-    }
-  }
-};
-__name(_PerformanceRecorder, "PerformanceRecorder");
-var PerformanceRecorder = _PerformanceRecorder;
-
 // ../../node_modules/.store/uuid-npm-10.0.0-4872b46ff8/package/dist/esm-node/stringify.js
 var byteToHex = [];
 for (let i = 0; i < 256; ++i) {
@@ -12405,6 +12316,108 @@ var _ConsoleSpanExporter = class _ConsoleSpanExporter {
 __name(_ConsoleSpanExporter, "ConsoleSpanExporter");
 var ConsoleSpanExporter = _ConsoleSpanExporter;
 
+// src/proxies/createEndGuardedSpan.ts
+var hasEnded = Symbol("hasEnded");
+function createEndGuardedSpan(span) {
+  return new Proxy(span, {
+    get(target, prop) {
+      if (prop === "hasEnded") {
+        return () => !!Reflect.get(target, hasEnded);
+      }
+      if (prop === "end") {
+        return () => {
+          if (!Reflect.get(target, hasEnded)) {
+            target.end();
+            Reflect.set(target, hasEnded, true);
+          }
+        };
+      }
+      return Reflect.get(target, prop);
+    },
+    set(target, prop, value) {
+      if (prop === "end") {
+        throw new Error("Cannot overwrite 'end' method on Span.");
+      }
+      return Reflect.set(target, prop, value);
+    }
+  });
+}
+__name(createEndGuardedSpan, "createEndGuardedSpan");
+
+// src/proxies/createSpanFunctionWrapper.ts
+function createSpanFunctionWrapper(fn) {
+  return function(span) {
+    const guardedSpan = createEndGuardedSpan(span);
+    try {
+      return fn(guardedSpan);
+    } catch (error) {
+      if (!guardedSpan.hasEnded()) {
+        guardedSpan.recordException(error instanceof Error || typeof error === "string" ? error : String(error));
+      } else {
+        console.info("OpenTelemetry:startActiveSpan: span has already ended, skipping recording exception.");
+      }
+      throw error;
+    } finally {
+      guardedSpan.end();
+    }
+  };
+}
+__name(createSpanFunctionWrapper, "createSpanFunctionWrapper");
+
+// src/proxies/createImprovedStartActiveSpan.ts
+function parseParameters(...params) {
+  const [name, optionsOrFn, contextOrFn, maybeFn] = params;
+  if (params.length === 2) {
+    return { name, fn: optionsOrFn };
+  }
+  if (params.length === 3) {
+    return { name, options: optionsOrFn, fn: contextOrFn };
+  }
+  if (params.length === 4) {
+    return {
+      name,
+      options: optionsOrFn,
+      context: contextOrFn,
+      fn: maybeFn
+    };
+  }
+  throw new Error("Number of arguments is not supported for startActiveSpan");
+}
+__name(parseParameters, "parseParameters");
+function createImprovedStartActiveSpan(target) {
+  return (...params) => {
+    const { fn, name, context: context2, options } = parseParameters(...params);
+    const wrappedSpanFunction = createSpanFunctionWrapper(fn);
+    if (context2) {
+      return target.startActiveSpan(name, options, context2, wrappedSpanFunction);
+    }
+    if (options) {
+      return target.startActiveSpan(name, options, wrappedSpanFunction);
+    }
+    return target.startActiveSpan(name, wrappedSpanFunction);
+  };
+}
+__name(createImprovedStartActiveSpan, "createImprovedStartActiveSpan");
+
+// src/proxies/createProxiedTracer.ts
+var isProxy = Symbol("isProxy");
+function createProxiedTracer(tracer) {
+  if (Reflect.has(tracer, isProxy)) {
+    return tracer;
+  }
+  const proxiedTracer = new Proxy(tracer, {
+    get(target, prop) {
+      if (prop === "startActiveSpan") {
+        return createImprovedStartActiveSpan(target);
+      }
+      return Reflect.get(target, prop);
+    }
+  });
+  Reflect.set(proxiedTracer, isProxy, true);
+  return proxiedTracer;
+}
+__name(createProxiedTracer, "createProxiedTracer");
+
 // src/BaseTelemetryClient.ts
 var _BaseTelemetryClient = class _BaseTelemetryClient {
   constructor(options) {
@@ -12424,8 +12437,6 @@ var _BaseTelemetryClient = class _BaseTelemetryClient {
     if (options.logLevel === "DEBUG") {
       this._tracerProvider.addSpanProcessor(new import_sdk_trace_node.BatchSpanProcessor(new ConsoleSpanExporter()));
     }
-    this._rootSpan = this.tracer.startSpan(options.rootSpanName || "root");
-    this._performance = new PerformanceRecorder(this._rootSpan);
     diag2.info("TelemetryClient is initialized.");
   }
   /**
@@ -12433,8 +12444,6 @@ var _BaseTelemetryClient = class _BaseTelemetryClient {
    */
   async shutdown() {
     diag2.debug("TelemetryClient is shuting down.");
-    this._performance.shutdown();
-    this.rootSpan.end();
     await this._tracerProvider.forceFlush();
     await this._tracerProvider.shutdown();
     diag2.debug("TelemetryClient has shutdown.");
@@ -12444,13 +12453,7 @@ var _BaseTelemetryClient = class _BaseTelemetryClient {
    * @returns the OpenTelemetry tracer
    */
   get tracer() {
-    return this._tracerProvider.getTracer("cloudpack-tracer");
-  }
-  get performance() {
-    return this._performance;
-  }
-  get rootSpan() {
-    return this._rootSpan;
+    return createProxiedTracer(this._tracerProvider.getTracer("cloudpack-tracer"));
   }
 };
 __name(_BaseTelemetryClient, "BaseTelemetryClient");

package/dist/index.js

@@ -6,28 +6,28 @@ const __filename = topLevelUrl.fileURLToPath(import.meta.url);
 const __dirname = topLevelPath.dirname(__filename);
 import {
   NoOpTelemetryClient
-} from "./chunk-BNPQM6Z3.js";
+} from "./chunk-J5XDHDQP.js";
 import {
   DiagConsoleLogger,
   DiagLogLevel,
   __name,
   diag,
   init_esm
-} from "./chunk-NJ4KSOZ3.js";
+} from "./chunk-NUFLYJEX.js";
 
 // src/createTelemetryClient.ts
 init_esm();
 async function createTelemetryClient(options) {
   if (!options.connectionString) {
     console.debug("No connection string found. Telemetry will not be sent.");
-    const { NoOpTelemetryClient: NoOpTelemetryClient2 } = await import("./NoOpTelemetryClient-TTBAN54Z.js");
+    const { NoOpTelemetryClient: NoOpTelemetryClient2 } = await import("./NoOpTelemetryClient-W2RWEMCF.js");
     return new NoOpTelemetryClient2();
   }
   diag.setLogger(new DiagConsoleLogger(), {
     logLevel: options.logLevel || DiagLogLevel.WARN,
     suppressOverrideMessage: true
   });
-  const { AppInsightsTelemetryClient } = await import("./AppInsightsTelemetryClient-R4KUMXIS.js");
+  const { AppInsightsTelemetryClient } = await import("./AppInsightsTelemetryClient-U3TW3MST.js");
   return new AppInsightsTelemetryClient(options);
 }
 __name(createTelemetryClient, "createTelemetryClient");

package/lib/BaseTelemetryClient.d.ts

@@ -1,11 +1,8 @@
-import { type Span, type Tracer } from '@opentelemetry/api';
+import { type Tracer } from '@opentelemetry/api';
 import type { TelemetryOptions } from './types/TelemetryOptions.js';
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import type { TelemetryClient } from './types/TelemetryClient.js';
-import { PerformanceRecorder } from './PerformanceRecorder.js';
 export declare class BaseTelemetryClient implements TelemetryClient {
-    private readonly _performance;
-    private readonly _rootSpan;
     protected readonly _tracerProvider: NodeTracerProvider;
     constructor(options: TelemetryOptions);
     /**
@@ -17,7 +14,5 @@ export declare class BaseTelemetryClient implements TelemetryClient {
      * @returns the OpenTelemetry tracer
      */
     get tracer(): Tracer;
-    get performance(): PerformanceRecorder;
-    get rootSpan(): Span;
 }
 //# sourceMappingURL=BaseTelemetryClient.d.ts.map

package/lib/index.d.ts

@@ -1,11 +1,7 @@
-export type { Span, Tracer, Attributes, AttributeValue } from '@opentelemetry/api';
+export type { Span, Tracer } from '@opentelemetry/api';
 export { createTelemetryClient } from './createTelemetryClient.js';
 export type { LogLevel } from './types/LogLevel.js';
 export type { TelemetryClient } from './types/TelemetryClient.js';
 export type { TelemetryOptions } from './types/TelemetryOptions.js';
 export { createNoOpTelemetryClient } from './createNoOpTelemetryClient.js';
-export type { PerformanceTracker } from './types/PerformanceTracker.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/proxies/createEndGuardedSpan.d.ts

@@ -0,0 +1,12 @@
+import type { Span } from '@opentelemetry/api';
+/**
+ * A span that can be ended only once
+ */
+export type EndGuardedSpan = Span & {
+    hasEnded: () => boolean;
+};
+/**
+ * Wraps a Span in a Proxy to intercept calls to `end` and ensure it’s only called once.
+ */
+export declare function createEndGuardedSpan(span: Span): EndGuardedSpan;
+//# sourceMappingURL=createEndGuardedSpan.d.ts.map

package/lib/proxies/createEndGuardedSpan.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=createEndGuardedSpan.test.d.ts.map

package/lib/proxies/createImprovedStartActiveSpan.d.ts

@@ -0,0 +1,4 @@
+import type { Tracer, Span, SpanOptions, Context } from '@opentelemetry/api';
+export type SpanFunction<T> = (span: Span) => T;
+export declare function createImprovedStartActiveSpan(target: Tracer): <T>(name: string, optionsOrFn?: SpanOptions | SpanFunction<unknown> | undefined, contextOrFn?: Context | SpanFunction<unknown> | undefined, maybeFn?: SpanFunction<unknown> | undefined) => T;
+//# sourceMappingURL=createImprovedStartActiveSpan.d.ts.map

package/lib/proxies/createImprovedStartActiveSpan.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=createImprovedStartActiveSpan.test.d.ts.map

package/lib/proxies/createProxiedTracer.d.ts

@@ -0,0 +1,10 @@
+import type { Tracer } from '@opentelemetry/api';
+/**
+ * Creates a proxied tracer that will automatically do the following things;
+ *  - End the span when the function ends
+ *  - Record any exceptions that are thrown
+ * @param tracer - The tracer to proxy
+ * @returns - Proxied tracer
+ */
+export declare function createProxiedTracer(tracer: Tracer): Tracer;
+//# sourceMappingURL=createProxiedTracer.d.ts.map

package/lib/proxies/createProxiedTracer.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=createProxiedTracer.test.d.ts.map

package/lib/proxies/createSpanFunctionWrapper.d.ts

@@ -0,0 +1,9 @@
+import type { Span } from '@opentelemetry/api';
+import type { SpanFunction } from './createImprovedStartActiveSpan.js';
+/**
+ * Wraps a span function to ensure that the span is ended and any exceptions are recorded.
+ * @param fn - The span function to wrap
+ * @returns - Wrapped span function
+ */
+export declare function createSpanFunctionWrapper<T>(fn: SpanFunction<T>): (span: Span) => T;
+//# sourceMappingURL=createSpanFunctionWrapper.d.ts.map

package/lib/proxies/createSpanFunctionWrapper.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=createSpanFunctionWrapper.test.d.ts.map

package/lib/types/TelemetryClient.d.ts

@@ -1,10 +1,5 @@
-import type { Span, Tracer } from '@opentelemetry/api';
-import type { PerformanceRecorder } from '../PerformanceRecorder.js';
+import type { Tracer } from '@opentelemetry/api';
 export interface TelemetryClient {
-    /**
-     * Root span which measures the duration of the highest level application (ie: CLI)
-     */
-    rootSpan: Span;
     /**
      * Flushes all telemetry and shuts down the telemetry client.
      */
@@ -14,9 +9,5 @@ export interface TelemetryClient {
      * @returns the OpenTelemetry tracer
      */
     get tracer(): Tracer;
-    /**
-     * Gets the performance recorder.
-     */
-    performance: PerformanceRecorder;
 }
 //# sourceMappingURL=TelemetryClient.d.ts.map

package/lib/types/TelemetryOptions.d.ts

@@ -22,9 +22,5 @@ export interface TelemetryOptions {
      * Possible values: cli, bundler-service, etc.
      */
     serviceName: string;
-    /**
-     * Name of the root span, 'root' will be used as a span name if this property is not set.
-     */
-    rootSpanName?: string;
 }
 //# sourceMappingURL=TelemetryOptions.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/telemetry",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Helpers for reporting telemetry in Cloudpack.",
   "license": "MIT",
   "type": "module",
@@ -16,7 +16,7 @@
   "devDependencies": {
     "@azure/monitor-opentelemetry-exporter": "1.0.0-beta.26",
     "@ms-cloudpack/eslint-plugin-internal": "^0.0.1",
-    "@ms-cloudpack/package-utilities": "^10.2.7",
+    "@ms-cloudpack/package-utilities": "^10.2.8",
     "@ms-cloudpack/scripts": "^0.0.1",
     "@opentelemetry/api": "~1.9.0",
     "@opentelemetry/core": "~1.26.0",
@@ -32,7 +32,10 @@
     "build:watch": "cloudpack-scripts build-watch",
     "build": "cloudpack-scripts build && cloudpack-scripts bundle-node",
     "lint:update": "cloudpack-scripts lint-update",
-    "lint": "cloudpack-scripts lint"
+    "lint": "cloudpack-scripts lint",
+    "test:update": "cloudpack-scripts test-update",
+    "test:watch": "cloudpack-scripts test-watch",
+    "test": "cloudpack-scripts test"
   },
   "files": [
     "dist",

package/lib/MetricEventAggregatorRegistry.d.ts

@@ -1,18 +0,0 @@
-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/PerformanceRecorder.d.ts

@@ -1,41 +0,0 @@
-import type { Attributes, Span } from '@opentelemetry/api';
-import type { PerformanceTracker } from './types/PerformanceTracker.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.
-     * @param attributes
-     */
-    record(attributes: {
-        name: string;
-        value: number;
-        additionalProperties?: Attributes;
-    }): void;
-    /**
-     * Tracks the execution time of a given `execute` function and report it to telemetry.
-     * @param name - The name of the performance metric.
-     * @param execute - The function to execute and track.
-     * @returns - The result of the `execute` function.
-     */
-    track<T>(name: string, execute: (tracker: PerformanceTracker) => T): T;
-    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/types/MetricEvent.d.ts

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

package/lib/types/MetricEventAggregator.d.ts

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

package/lib/types/PerformanceTracker.d.ts

@@ -1,7 +0,0 @@
-import type { Attributes } from '@opentelemetry/api';
-export interface PerformanceTracker {
-    name: string;
-    startTime: number;
-    setProperties(properties: Attributes): void;
-}
-//# sourceMappingURL=PerformanceTracker.d.ts.map