@conduit-client/service-instrumentation-o11y 2.0.0

package/LICENSE.txt

@@ -0,0 +1,27 @@
+*Attorney/Client Privileged + Confidential*
+
+Terms of Use for Public Code (Non-OSS)
+
+*NOTE:* Before publishing code under this license/these Terms of Use, please review https://salesforce.quip.com/WFfvAMKB18AL and confirm that you’ve completed all prerequisites described therein. *These Terms of Use may not be used or modified without input from IP and Product Legal.*
+
+*Terms of Use*
+
+Copyright 2022 Salesforce, Inc. All rights reserved. 
+
+These Terms of Use govern the download, installation, and/or use of this software provided by Salesforce, Inc. (“Salesforce”) (the “Software”), were last updated on April 15, 2022, ** and constitute a legally binding agreement between you and Salesforce. If you do not agree to these Terms of Use, do not install or use the Software. 
+ 
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the Software and derivative works subject to these Terms. These Terms shall be included in all copies or substantial portions of the Software. 
+
+Subject to the limited rights expressly granted hereunder, Salesforce reserves all rights, title, and interest in and to all intellectual property subsisting in the Software. No rights are granted to you hereunder other than as expressly set forth herein. Users residing in countries on the United States Office of Foreign Assets Control sanction list, or which are otherwise subject to a US export embargo, may not use the Software.
+ 
+Implementation of the Software may require development work, for which you are responsible. The Software may contain bugs, errors and incompatibilities and is made available on an AS IS basis without support, updates, or service level commitments. 
+ 
+Salesforce reserves the right at any time to modify, suspend, or discontinue, the Software (or any part thereof) with or without notice. You agree that Salesforce shall not be liable to you or to any third party for any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or proceeding made or brought against Salesforce by a third party arising out of or accruing from (a) your use of the Software, and (b) any application you develop with the Software that infringes any copyright, trademark, trade secret, trade dress, patent, or other intellectual property right of any person or defames any person or violates their rights of publicity or privacy (each a “Claim Against Salesforce”), and will indemnify Salesforce from any damages, attorney fees, and costs finally awarded against Salesforce as a result of, or for any amounts paid by Salesforce under a settlement approved by you in writing of, a Claim Against Salesforce, provided Salesforce (x) promptly gives you written notice of the Claim Against Salesforce, (y) gives you sole control of the defense and settlement of the Claim Against Salesforce (except that you may not settle any Claim Against Salesforce unless it unconditionally releases Salesforce of all liability), and (z) gives you all reasonable assistance, at your expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA, OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ 
+These Terms of Use shall be governed exclusively by the internal laws of the State of California, without regard to its conflicts of laws rules. Each party hereby consents to the exclusive jurisdiction of the state and federal courts located in San Francisco County, California to adjudicate any dispute arising out of or relating to these Terms of Use and the download, installation, and/or use of the Software. Except as expressly stated herein, these Terms of Use constitute the entire agreement between the parties, and supersede all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning their subject matter. No modification, amendment, or waiver of any provision of these Terms of Use shall be effective unless it is by an update to these Terms of Use that Salesforce makes available, or is in writing and signed by the party against whom the modification, amendment, or waiver is to be asserted.
+
+_*Data Privacy*_: Salesforce may collect, process, and store device, system, and other information related to your use of the Software. This information includes, but is not limited to, IP address, user metrics, and other data (“Usage Data”). Salesforce may use Usage Data for analytics, product development, and marketing purposes. You acknowledge that files generated in conjunction with the Software may contain sensitive or confidential data, and you are solely responsible for anonymizing and protecting such data.  

package/README.md

@@ -0,0 +1,24 @@
+# Luvio O11y Instrumentation Service
+
+This package provides an instrumentation service implementation using O11y library for the interface defined in `-client/service-instrumentation-types`.
+
+## Installation
+
+```bash
+npm install -client/service-instrumentation-o11y
+```
+
+## Usage
+
+```js
+import { buildServiceDescriptor } from '@conduit-client/service-instrumentation-o11y/v1';
+import { logger } from '@conduit-client/logger';
+
+const instrumentationService = buildServiceDescriptor(logger);
+```
+
+This implementation provides OpenTelemetry compatible APIs backed by the O11y library.
+
+## Types
+
+This package implements the interfaces defined in [`-client/service-instrumentation-types`](../instrumentation-types).

package/dist/main/index.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+//# sourceMappingURL=index.js.map

package/dist/main/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/types/v1/__tests__/o11y-instrumentation-service.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/__tests__/o11y-metrics-api.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/__tests__/o11y-trace-api.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/index.d.ts

@@ -0,0 +1 @@
+export { buildServiceDescriptor } from './o11y-instrumentation-service';

package/dist/types/v1/o11y-instrumentation-service.d.ts

@@ -0,0 +1,3 @@
+import { type LoggerService } from '@conduit-client/utils';
+import type { InstrumentationServiceDescriptor } from '@conduit-client/service-instrumentation-types/v1';
+export declare function buildServiceDescriptor(logger: LoggerService): InstrumentationServiceDescriptor;

package/dist/types/v1/o11y-metrics-api.d.ts

@@ -0,0 +1,24 @@
+import { getInstrumentation } from 'o11y/client';
+import type { LoggerService, NamedLoggerService } from '@conduit-client/utils';
+import type { LuvioOTelMetricsAPI } from '@conduit-client/service-instrumentation-types/v1';
+import type { Attributes, BatchObservableCallback, Counter, Histogram, Meter, MeterOptions, MetricOptions, Observable, ObservableCounter, ObservableGauge, ObservableUpDownCounter, UpDownCounter } from '@opentelemetry/api';
+import { MetricsTags } from 'o11y/shared';
+export declare class O11yOTelMetricsAPI implements LuvioOTelMetricsAPI {
+    private services;
+    constructor(services: NamedLoggerService);
+    getMeter(name: string, _version?: string | undefined, __options?: MeterOptions | undefined): Meter;
+}
+export declare class O11yMeter implements Meter {
+    private o11yInstrumentation;
+    private logger;
+    constructor(o11yInstrumentation: ReturnType<typeof getInstrumentation>, logger: LoggerService);
+    createHistogram<AttributesTypes extends Attributes = Attributes>(name: string, _options?: MetricOptions | undefined): Histogram<AttributesTypes>;
+    createCounter<AttributesTypes extends Attributes = Attributes>(name: string, options?: MetricOptions | undefined): Counter<AttributesTypes>;
+    createUpDownCounter<AttributesTypes extends Attributes = Attributes>(_name: string, _options?: MetricOptions | undefined): UpDownCounter<AttributesTypes>;
+    createObservableGauge<AttributesTypes extends Attributes = Attributes>(_name: string, _options?: MetricOptions | undefined): ObservableGauge<AttributesTypes>;
+    createObservableCounter<AttributesTypes extends Attributes = Attributes>(_name: string, _options?: MetricOptions | undefined): ObservableCounter<AttributesTypes>;
+    createObservableUpDownCounter<AttributesTypes extends Attributes = Attributes>(_name: string, _options?: MetricOptions | undefined): ObservableUpDownCounter<AttributesTypes>;
+    addBatchObservableCallback<AttributesTypes extends Attributes = Attributes>(_callback: BatchObservableCallback<AttributesTypes>, _observables: Observable<AttributesTypes>[]): void;
+    removeBatchObservableCallback<AttributesTypes extends Attributes = Attributes>(_callback: BatchObservableCallback<AttributesTypes>, _observables: Observable<AttributesTypes>[]): void;
+}
+export declare function sanitizeAttributes(attributes?: Attributes | undefined): MetricsTags | undefined;

package/dist/types/v1/o11y-trace-api.d.ts

@@ -0,0 +1,37 @@
+import { getInstrumentation } from 'o11y/client';
+import type { LoggerService, NamedLoggerService } from '@conduit-client/utils';
+import type { LuvioOTelTraceAPI } from '@conduit-client/service-instrumentation-types/v1';
+import type { Tracer, TracerOptions, Span, SpanContext, SpanOptions, SpanStatus, Context, AttributeValue, Attributes, TimeInput, Exception } from '@opentelemetry/api';
+type Instrumentation = ReturnType<typeof getInstrumentation>;
+type Activity = ReturnType<Instrumentation['startActivity']>;
+export declare class O11yOTelTraceAPI implements LuvioOTelTraceAPI {
+    private services;
+    constructor(services: NamedLoggerService);
+    getTracer(name: string, _version?: string, _options?: TracerOptions): Tracer;
+}
+export declare class O11yTracer implements Tracer {
+    private o11yInstrumentation;
+    private logger;
+    constructor(o11yInstrumentation: ReturnType<typeof getInstrumentation>, logger: LoggerService);
+    startSpan(name: string, _options?: SpanOptions, context?: Context): O11ySpan;
+    startActiveSpan<F extends (span: Span) => unknown>(name: string, fn: F): ReturnType<F>;
+    startActiveSpan<F extends (span: Span) => unknown>(name: string, options: SpanOptions, fn: F): ReturnType<F>;
+    startActiveSpan<F extends (span: Span) => unknown>(name: string, options: SpanOptions, context: Context, fn: F): ReturnType<F>;
+}
+export declare class O11ySpan implements Span {
+    private activity;
+    private logger;
+    private _isRecording;
+    private attributes;
+    constructor(activity: Activity, logger: LoggerService);
+    spanContext(): SpanContext;
+    setAttribute(key: string, value: AttributeValue): this;
+    setAttributes(attributes: Attributes): this;
+    addEvent(_name: string, _attributesOrStartTime?: Attributes | TimeInput, _startTime?: TimeInput): this;
+    setStatus(_status: SpanStatus): this;
+    updateName(_name: string): this;
+    end(endTime?: TimeInput): void;
+    isRecording(): boolean;
+    recordException(exception: Exception, _time?: TimeInput): void;
+}
+export {};

package/dist/v1/index.js

@@ -0,0 +1,269 @@
+/*!
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import { getInstrumentation } from "o11y/client";
+class O11yOTelTraceAPI {
+  constructor(services) {
+    this.services = services;
+  }
+  getTracer(name, _version, _options) {
+    const o11yInstrumentation = getInstrumentation(name);
+    return new O11yTracer(o11yInstrumentation, this.services.logger);
+  }
+}
+class O11yTracer {
+  constructor(o11yInstrumentation, logger) {
+    this.o11yInstrumentation = o11yInstrumentation;
+    this.logger = logger;
+  }
+  startSpan(name, _options, context) {
+    const traceId = context == null ? void 0 : context.getValue(Symbol.for("traceId"));
+    const spanId = context == null ? void 0 : context.getValue(Symbol.for("spanId"));
+    const traceFlags = context == null ? void 0 : context.getValue(Symbol.for("traceFlags"));
+    let spanContext = void 0;
+    if (traceId !== void 0 && spanId !== void 0 && traceFlags !== void 0) {
+      spanContext = {
+        traceId,
+        spanId,
+        traceFlags
+      };
+    }
+    const activityOptions = spanContext === void 0 ? void 0 : {
+      instrumentationContext: {
+        rootId: spanContext.traceId,
+        isRootActivitySampled: spanContext.traceFlags === 1,
+        parentId: spanId
+      }
+    };
+    const activity = this.o11yInstrumentation.startActivity(name, activityOptions);
+    return new O11ySpan(activity, this.logger);
+  }
+  startActiveSpan(name, options, context, fn) {
+    let opts;
+    let ctx;
+    let fun;
+    if (typeof options === "function") {
+      fun = options;
+    } else {
+      opts = options;
+      if (typeof context === "function") {
+        fun = context;
+      } else {
+        ctx = context;
+        fun = fn;
+      }
+    }
+    const span = this.startSpan(name, opts, ctx);
+    return fun(span);
+  }
+}
+class O11ySpan {
+  constructor(activity, logger) {
+    this.activity = activity;
+    this.logger = logger;
+    this._isRecording = true;
+    this.attributes = {};
+  }
+  spanContext() {
+    return {
+      traceId: this.activity.getRootId(),
+      spanId: this.activity.getId(),
+      traceFlags: this.activity.getIsSampled() ? 1 : 0
+    };
+  }
+  setAttribute(key, value) {
+    this.attributes[key] = value;
+    return this;
+  }
+  setAttributes(attributes) {
+    this.attributes = { ...this.attributes, ...attributes };
+    return this;
+  }
+  addEvent(_name, _attributesOrStartTime, _startTime) {
+    this.logger.warn("O11ySpan does not support addEvents.");
+    return this;
+  }
+  setStatus(_status) {
+    this.logger.warn("O11ySpan does not support setStatus.");
+    return this;
+  }
+  updateName(_name) {
+    this.logger.warn("O11ySpan does not support updateName.");
+    return this;
+  }
+  end(endTime) {
+    let endTimeInternal = endTime;
+    try {
+      if (typeof endTimeInternal !== "number") {
+        this.logger.warn("O11ySpan does not support non number endTime override.");
+        endTimeInternal = void 0;
+      }
+      this.activity.stop(
+        void 0,
+        void 0,
+        endTimeInternal ? { perfStopOverride: endTimeInternal } : void 0
+      );
+    } finally {
+      this._isRecording = false;
+    }
+    return;
+  }
+  isRecording() {
+    return this._isRecording;
+  }
+  recordException(exception, _time) {
+    this.activity.error(exception);
+  }
+}
+class O11yOTelMetricsAPI {
+  constructor(services) {
+    this.services = services;
+  }
+  getMeter(name, _version, __options) {
+    const o11yInstrumentation = getInstrumentation(name);
+    return new O11yMeter(o11yInstrumentation, this.services.logger);
+  }
+}
+class O11yMeter {
+  constructor(o11yInstrumentation, logger) {
+    this.o11yInstrumentation = o11yInstrumentation;
+    this.logger = logger;
+  }
+  createHistogram(name, _options) {
+    return new O11yHistogram(name, this.o11yInstrumentation, this.logger);
+  }
+  createCounter(name, options) {
+    if (options) {
+      this.logger.warn("counter options not supported in O11y instrumentation");
+    }
+    return new O11yCounter(name, this.o11yInstrumentation, this.logger);
+  }
+  createUpDownCounter(_name, _options) {
+    return new O11yUpDownCounter(this.logger);
+  }
+  createObservableGauge(_name, _options) {
+    return new O11yObservableGuage(this.logger);
+  }
+  createObservableCounter(_name, _options) {
+    return new O11yObservableCounter(this.logger);
+  }
+  createObservableUpDownCounter(_name, _options) {
+    return new O11yObservableUpDownCounter(this.logger);
+  }
+  addBatchObservableCallback(_callback, _observables) {
+    this.logger.warn("addBatchObservableCallback not supported yet");
+  }
+  removeBatchObservableCallback(_callback, _observables) {
+    this.logger.warn("removeBatchObservableCallback not supported yet");
+  }
+}
+class O11yCounter {
+  constructor(name, o11yInstrumentation, logger) {
+    this.name = name;
+    this.o11yInstrumentation = o11yInstrumentation;
+    this.logger = logger;
+  }
+  add(value, attributes, _context) {
+    if (value < 0) {
+      this.logger.warn(`Counter values must be non-negative. Got ${value}.`);
+      return;
+    }
+    this.o11yInstrumentation.incrementCounter(
+      this.name,
+      value,
+      void 0,
+      sanitizeAttributes(attributes)
+    );
+  }
+}
+class O11yHistogram {
+  constructor(name, o11yInstrumentation, logger) {
+    this.name = name;
+    this.o11yInstrumentation = o11yInstrumentation;
+    this.logger = logger;
+  }
+  record(value, attributes, _context) {
+    if (value < 0) {
+      this.logger.warn(`Histogram values must be non-negative. Got ${value}.`);
+      return;
+    }
+    this.o11yInstrumentation.trackValue(
+      this.name,
+      value,
+      void 0,
+      sanitizeAttributes(attributes)
+    );
+  }
+}
+class O11yUpDownCounter {
+  constructor(logger) {
+    this.logger = logger;
+  }
+  add(_value, _attributes, _context) {
+    this.logger.warn("O11yUpDownCounter not supported yet.");
+  }
+}
+class O11yObservableCounter {
+  constructor(logger) {
+    this.logger = logger;
+  }
+  addCallback(_callback) {
+    this.logger.warn("O11yObservableCounter not supported yet. Defaulting to noop.");
+  }
+  removeCallback(_callback) {
+    this.logger.warn("O11yObservableCounter not supported yet. Defaulting to noop.");
+  }
+}
+class O11yObservableGuage {
+  constructor(logger) {
+    this.logger = logger;
+  }
+  addCallback(_callback) {
+    this.logger.warn("O11yObservableGuage not supported yet. Defaulting to noop.");
+  }
+  removeCallback(_callback) {
+    this.logger.warn("O11yObservableGuage not supported yet. Defaulting to noop.");
+  }
+}
+class O11yObservableUpDownCounter {
+  constructor(logger) {
+    this.logger = logger;
+  }
+  addCallback(_callback) {
+    this.logger.warn("O11yObservableUpDownCounter not supported yet. Defaulting to noop.");
+  }
+  removeCallback(_callback) {
+    this.logger.warn("O11yObservableUpDownCounter not supported yet. Defaulting to noop.");
+  }
+}
+function sanitizeAttributes(attributes) {
+  if (!attributes) return;
+  const metricTags = {};
+  Object.entries(attributes).forEach(([key, value]) => {
+    if (value !== void 0 && !Array.isArray(value)) {
+      metricTags[key] = value;
+    }
+  });
+  return metricTags;
+}
+class O11yInstrumentation {
+  constructor(services) {
+    this.services = services;
+    this.currentTimeMs = () => performance.now();
+    this.trace = new O11yOTelTraceAPI(this.services);
+    this.metrics = new O11yOTelMetricsAPI(this.services);
+  }
+}
+function buildServiceDescriptor(logger) {
+  return {
+    type: "instrumentation",
+    version: "1.0",
+    service: new O11yInstrumentation({ logger })
+  };
+}
+export {
+  buildServiceDescriptor
+};
+//# sourceMappingURL=index.js.map

package/dist/v1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/v1/o11y-trace-api.ts","../../src/v1/o11y-metrics-api.ts","../../src/v1/o11y-instrumentation-service.ts"],"sourcesContent":["/* eslint-disable no-dupe-class-members */\nimport { getInstrumentation } from 'o11y/client';\nimport type { LoggerService, NamedLoggerService } from '@conduit-client/utils';\nimport type { LuvioOTelTraceAPI } from '@conduit-client/service-instrumentation-types/v1';\nimport type {\n    Tracer,\n    TracerOptions,\n    Span,\n    SpanContext,\n    SpanOptions,\n    SpanStatus,\n    Context,\n    AttributeValue,\n    Attributes,\n    TimeInput,\n    Exception,\n} from '@opentelemetry/api';\n\ntype Instrumentation = ReturnType<typeof getInstrumentation>;\ntype ApiOptions = Parameters<Instrumentation['startActivity']>[1];\ntype Activity = ReturnType<Instrumentation['startActivity']>;\n\nexport class O11yOTelTraceAPI implements LuvioOTelTraceAPI {\n    constructor(private services: NamedLoggerService) {}\n\n    getTracer(name: string, _version?: string, _options?: TracerOptions): Tracer {\n        const o11yInstrumentation = getInstrumentation(name);\n        return new O11yTracer(o11yInstrumentation, this.services.logger);\n    }\n}\n\nexport class O11yTracer implements Tracer {\n    constructor(\n        private o11yInstrumentation: ReturnType<typeof getInstrumentation>,\n        private logger: LoggerService\n    ) {}\n    startSpan(name: string, _options?: SpanOptions, context?: Context): O11ySpan {\n        const traceId = context?.getValue(Symbol.for('traceId')) as string;\n        const spanId = context?.getValue(Symbol.for('spanId')) as string;\n        const traceFlags = context?.getValue(Symbol.for('traceFlags')) as number;\n        let spanContext: SpanContext | undefined = undefined;\n\n        if (traceId !== undefined && spanId !== undefined && traceFlags !== undefined) {\n            spanContext = {\n                traceId,\n                spanId,\n                traceFlags,\n            };\n        }\n\n        const activityOptions: ApiOptions =\n            spanContext === undefined\n                ? undefined\n                : {\n                      instrumentationContext: {\n                          rootId: spanContext.traceId,\n                          isRootActivitySampled: spanContext.traceFlags === 1,\n                          parentId: spanId,\n                      },\n                  };\n\n        const activity = this.o11yInstrumentation.startActivity(name, activityOptions);\n\n        return new O11ySpan(activity, this.logger);\n    }\n    startActiveSpan<F extends (span: Span) => unknown>(name: string, fn: F): ReturnType<F>;\n    startActiveSpan<F extends (span: Span) => unknown>(\n        name: string,\n        options: SpanOptions,\n        fn: F\n    ): ReturnType<F>;\n    startActiveSpan<F extends (span: Span) => unknown>(\n        name: string,\n        options: SpanOptions,\n        context: Context,\n        fn: F\n    ): ReturnType<F>;\n    startActiveSpan<F extends (span: Span) => unknown>(\n        name: string,\n        options: unknown,\n        context?: unknown,\n        fn?: unknown\n    ): ReturnType<F> {\n        let opts: SpanOptions | undefined;\n        let ctx: Context | undefined;\n        let fun: F;\n        if (typeof options === 'function') {\n            fun = options as F;\n        } else {\n            opts = options as SpanOptions;\n            if (typeof context === 'function') {\n                fun = context as F;\n            } else {\n                ctx = context as Context;\n                fun = fn as F;\n            }\n        }\n\n        const span = this.startSpan(name, opts, ctx);\n        return fun(span) as ReturnType<F>;\n    }\n}\n\nexport class O11ySpan implements Span {\n    private _isRecording: boolean = true;\n    private attributes: Attributes = {};\n\n    constructor(\n        private activity: Activity,\n        private logger: LoggerService\n    ) {}\n\n    spanContext(): SpanContext {\n        return {\n            traceId: this.activity.getRootId(),\n            spanId: this.activity.getId(),\n            traceFlags: this.activity.getIsSampled() ? 1 : 0,\n        };\n    }\n    setAttribute(key: string, value: AttributeValue): this {\n        this.attributes[key] = value;\n        return this;\n    }\n    setAttributes(attributes: Attributes): this {\n        this.attributes = { ...this.attributes, ...attributes };\n        return this;\n    }\n    addEvent(\n        _name: string,\n        _attributesOrStartTime?: Attributes | TimeInput,\n        _startTime?: TimeInput\n    ): this {\n        this.logger.warn('O11ySpan does not support addEvents.');\n        return this;\n    }\n    setStatus(_status: SpanStatus): this {\n        this.logger.warn('O11ySpan does not support setStatus.');\n        return this;\n    }\n    updateName(_name: string): this {\n        this.logger.warn('O11ySpan does not support updateName.');\n        return this;\n    }\n    end(endTime?: TimeInput): void {\n        let endTimeInternal = endTime;\n        try {\n            if (typeof endTimeInternal !== 'number') {\n                this.logger.warn('O11ySpan does not support non number endTime override.');\n                endTimeInternal = undefined;\n            }\n\n            // TODO: Add support for stop schemas and data\n            this.activity.stop(\n                undefined,\n                undefined,\n                endTimeInternal ? { perfStopOverride: endTimeInternal as number } : undefined\n            );\n        } finally {\n            this._isRecording = false;\n        }\n\n        return;\n    }\n\n    isRecording(): boolean {\n        return this._isRecording;\n    }\n\n    recordException(exception: Exception, _time?: TimeInput): void {\n        // TODO: Add support for exception schemas and data\n        this.activity.error(exception);\n    }\n}\n","import { getInstrumentation } from 'o11y/client';\nimport type { LoggerService, NamedLoggerService } from '@conduit-client/utils';\nimport type { LuvioOTelMetricsAPI } from '@conduit-client/service-instrumentation-types/v1';\nimport type {\n    Attributes,\n    BatchObservableCallback,\n    Context,\n    Counter,\n    Histogram,\n    Meter,\n    MeterOptions,\n    MetricOptions,\n    Observable,\n    ObservableCallback,\n    ObservableCounter,\n    ObservableGauge,\n    ObservableUpDownCounter,\n    UpDownCounter,\n} from '@opentelemetry/api';\nimport { MetricsTags } from 'o11y/shared';\n\nexport class O11yOTelMetricsAPI implements LuvioOTelMetricsAPI {\n    constructor(private services: NamedLoggerService) {}\n\n    getMeter(\n        name: string,\n        // TODO: Not sure what to do with these?\n        _version?: string | undefined,\n        __options?: MeterOptions | undefined\n    ): Meter {\n        const o11yInstrumentation = getInstrumentation(name);\n        return new O11yMeter(o11yInstrumentation, this.services.logger);\n    }\n}\n\nexport class O11yMeter implements Meter {\n    constructor(\n        private o11yInstrumentation: ReturnType<typeof getInstrumentation>,\n        private logger: LoggerService\n    ) {}\n\n    createHistogram<AttributesTypes extends Attributes = Attributes>(\n        name: string,\n        _options?: MetricOptions | undefined\n    ): Histogram<AttributesTypes> {\n        return new O11yHistogram(name, this.o11yInstrumentation, this.logger);\n    }\n    createCounter<AttributesTypes extends Attributes = Attributes>(\n        name: string,\n        options?: MetricOptions | undefined\n    ): Counter<AttributesTypes> {\n        if (options) {\n            this.logger.warn('counter options not supported in O11y instrumentation');\n        }\n        return new O11yCounter(name, this.o11yInstrumentation, this.logger);\n    }\n    createUpDownCounter<AttributesTypes extends Attributes = Attributes>(\n        _name: string,\n        _options?: MetricOptions | undefined\n    ): UpDownCounter<AttributesTypes> {\n        return new O11yUpDownCounter(this.logger);\n    }\n    createObservableGauge<AttributesTypes extends Attributes = Attributes>(\n        _name: string,\n        _options?: MetricOptions | undefined\n    ): ObservableGauge<AttributesTypes> {\n        return new O11yObservableGuage(this.logger);\n    }\n    createObservableCounter<AttributesTypes extends Attributes = Attributes>(\n        _name: string,\n        _options?: MetricOptions | undefined\n    ): ObservableCounter<AttributesTypes> {\n        return new O11yObservableCounter(this.logger);\n    }\n    createObservableUpDownCounter<AttributesTypes extends Attributes = Attributes>(\n        _name: string,\n        _options?: MetricOptions | undefined\n    ): ObservableUpDownCounter<AttributesTypes> {\n        return new O11yObservableUpDownCounter(this.logger);\n    }\n    addBatchObservableCallback<AttributesTypes extends Attributes = Attributes>(\n        _callback: BatchObservableCallback<AttributesTypes>,\n        _observables: Observable<AttributesTypes>[]\n    ): void {\n        this.logger.warn('addBatchObservableCallback not supported yet');\n    }\n    removeBatchObservableCallback<AttributesTypes extends Attributes = Attributes>(\n        _callback: BatchObservableCallback<AttributesTypes>,\n        _observables: Observable<AttributesTypes>[]\n    ): void {\n        this.logger.warn('removeBatchObservableCallback not supported yet');\n    }\n}\n\nclass O11yCounter implements Counter {\n    constructor(\n        private name: string,\n        private o11yInstrumentation: ReturnType<typeof getInstrumentation>,\n        private logger: LoggerService\n    ) {}\n\n    add(value: number, attributes?: Attributes | undefined, _context?: Context | undefined): void {\n        if (value < 0) {\n            this.logger.warn(`Counter values must be non-negative. Got ${value}.`);\n            return;\n        }\n        this.o11yInstrumentation.incrementCounter(\n            this.name,\n            value,\n            undefined,\n            sanitizeAttributes(attributes)\n        );\n    }\n}\n\nclass O11yHistogram implements Histogram {\n    constructor(\n        private name: string,\n        private o11yInstrumentation: ReturnType<typeof getInstrumentation>,\n        private logger: LoggerService\n    ) {}\n    record(\n        value: number,\n        attributes?: Attributes | undefined,\n        _context?: Context | undefined\n    ): void {\n        if (value < 0) {\n            this.logger.warn(`Histogram values must be non-negative. Got ${value}.`);\n            return;\n        }\n        this.o11yInstrumentation.trackValue(\n            this.name,\n            value,\n            undefined,\n            sanitizeAttributes(attributes)\n        );\n    }\n}\n\nclass O11yUpDownCounter implements UpDownCounter {\n    constructor(private logger: LoggerService) {}\n\n    add(\n        _value: number,\n        _attributes?: Attributes | undefined,\n        _context?: Context | undefined\n    ): void {\n        this.logger.warn('O11yUpDownCounter not supported yet.');\n    }\n}\n\nclass O11yObservableCounter implements ObservableCounter {\n    constructor(private logger: LoggerService) {}\n    addCallback(_callback: ObservableCallback<Attributes>): void {\n        this.logger.warn('O11yObservableCounter not supported yet. Defaulting to noop.');\n    }\n    removeCallback(_callback: ObservableCallback<Attributes>): void {\n        this.logger.warn('O11yObservableCounter not supported yet. Defaulting to noop.');\n    }\n}\n\nclass O11yObservableGuage implements ObservableGauge {\n    constructor(private logger: LoggerService) {}\n    addCallback(_callback: ObservableCallback<Attributes>): void {\n        this.logger.warn('O11yObservableGuage not supported yet. Defaulting to noop.');\n    }\n    removeCallback(_callback: ObservableCallback<Attributes>): void {\n        this.logger.warn('O11yObservableGuage not supported yet. Defaulting to noop.');\n    }\n}\n\nclass O11yObservableUpDownCounter implements ObservableUpDownCounter {\n    constructor(private logger: LoggerService) {}\n    addCallback(_callback: ObservableCallback<Attributes>): void {\n        this.logger.warn('O11yObservableUpDownCounter not supported yet. Defaulting to noop.');\n    }\n    removeCallback(_callback: ObservableCallback<Attributes>): void {\n        this.logger.warn('O11yObservableUpDownCounter not supported yet. Defaulting to noop.');\n    }\n}\n\nexport function sanitizeAttributes(attributes?: Attributes | undefined): MetricsTags | undefined {\n    if (!attributes) return;\n    const metricTags: MetricsTags = {};\n    Object.entries(attributes).forEach(([key, value]) => {\n        if (value !== undefined && !Array.isArray(value)) {\n            metricTags[key] = value;\n        }\n    });\n    return metricTags;\n}\n","import { type LoggerService, type NamedLoggerService } from '@conduit-client/utils';\nimport { O11yOTelTraceAPI } from './o11y-trace-api';\nimport { O11yOTelMetricsAPI } from './o11y-metrics-api';\nimport type { InstrumentationServiceDescriptor } from '@conduit-client/service-instrumentation-types/v1';\n\nclass O11yInstrumentation {\n    trace: O11yOTelTraceAPI;\n    metrics: O11yOTelMetricsAPI;\n    currentTimeMs = () => performance.now();\n\n    constructor(private services: NamedLoggerService) {\n        this.trace = new O11yOTelTraceAPI(this.services);\n        this.metrics = new O11yOTelMetricsAPI(this.services);\n    }\n}\n\nexport function buildServiceDescriptor(logger: LoggerService): InstrumentationServiceDescriptor {\n    return {\n        type: 'instrumentation',\n        version: '1.0',\n        service: new O11yInstrumentation({ logger }),\n    };\n}\n"],"names":[],"mappings":";;;;;;AAsBO,MAAM,iBAA8C;AAAA,EACvD,YAAoB,UAA8B;AAA9B,SAAA,WAAA;AAAA,EAA+B;AAAA,EAEnD,UAAU,MAAc,UAAmB,UAAkC;AACzE,UAAM,sBAAsB,mBAAmB,IAAI;AACnD,WAAO,IAAI,WAAW,qBAAqB,KAAK,SAAS,MAAM;AAAA,EACnE;AACJ;AAEO,MAAM,WAA6B;AAAA,EACtC,YACY,qBACA,QACV;AAFU,SAAA,sBAAA;AACA,SAAA,SAAA;AAAA,EACT;AAAA,EACH,UAAU,MAAc,UAAwB,SAA6B;AACzE,UAAM,UAAU,mCAAS,SAAS,OAAO,IAAI,SAAS;AACtD,UAAM,SAAS,mCAAS,SAAS,OAAO,IAAI,QAAQ;AACpD,UAAM,aAAa,mCAAS,SAAS,OAAO,IAAI,YAAY;AAC5D,QAAI,cAAuC;AAE3C,QAAI,YAAY,UAAa,WAAW,UAAa,eAAe,QAAW;AAC3E,oBAAc;AAAA,QACV;AAAA,QACA;AAAA,QACA;AAAA,MAAA;AAAA,IAER;AAEA,UAAM,kBACF,gBAAgB,SACV,SACA;AAAA,MACI,wBAAwB;AAAA,QACpB,QAAQ,YAAY;AAAA,QACpB,uBAAuB,YAAY,eAAe;AAAA,QAClD,UAAU;AAAA,MAAA;AAAA,IACd;AAGd,UAAM,WAAW,KAAK,oBAAoB,cAAc,MAAM,eAAe;AAE7E,WAAO,IAAI,SAAS,UAAU,KAAK,MAAM;AAAA,EAC7C;AAAA,EAaA,gBACI,MACA,SACA,SACA,IACa;AACb,QAAI;AACJ,QAAI;AACJ,QAAI;AACJ,QAAI,OAAO,YAAY,YAAY;AAC/B,YAAM;AAAA,IACV,OAAO;AACH,aAAO;AACP,UAAI,OAAO,YAAY,YAAY;AAC/B,cAAM;AAAA,MACV,OAAO;AACH,cAAM;AACN,cAAM;AAAA,MACV;AAAA,IACJ;AAEA,UAAM,OAAO,KAAK,UAAU,MAAM,MAAM,GAAG;AAC3C,WAAO,IAAI,IAAI;AAAA,EACnB;AACJ;AAEO,MAAM,SAAyB;AAAA,EAIlC,YACY,UACA,QACV;AAFU,SAAA,WAAA;AACA,SAAA,SAAA;AALZ,SAAQ,eAAwB;AAChC,SAAQ,aAAyB,CAAA;AAAA,EAK9B;AAAA,EAEH,cAA2B;AACvB,WAAO;AAAA,MACH,SAAS,KAAK,SAAS,UAAA;AAAA,MACvB,QAAQ,KAAK,SAAS,MAAA;AAAA,MACtB,YAAY,KAAK,SAAS,aAAA,IAAiB,IAAI;AAAA,IAAA;AAAA,EAEvD;AAAA,EACA,aAAa,KAAa,OAA6B;AACnD,SAAK,WAAW,GAAG,IAAI;AACvB,WAAO;AAAA,EACX;AAAA,EACA,cAAc,YAA8B;AACxC,SAAK,aAAa,EAAE,GAAG,KAAK,YAAY,GAAG,WAAA;AAC3C,WAAO;AAAA,EACX;AAAA,EACA,SACI,OACA,wBACA,YACI;AACJ,SAAK,OAAO,KAAK,sCAAsC;AACvD,WAAO;AAAA,EACX;AAAA,EACA,UAAU,SAA2B;AACjC,SAAK,OAAO,KAAK,sCAAsC;AACvD,WAAO;AAAA,EACX;AAAA,EACA,WAAW,OAAqB;AAC5B,SAAK,OAAO,KAAK,uCAAuC;AACxD,WAAO;AAAA,EACX;AAAA,EACA,IAAI,SAA2B;AAC3B,QAAI,kBAAkB;AACtB,QAAI;AACA,UAAI,OAAO,oBAAoB,UAAU;AACrC,aAAK,OAAO,KAAK,wDAAwD;AACzE,0BAAkB;AAAA,MACtB;AAGA,WAAK,SAAS;AAAA,QACV;AAAA,QACA;AAAA,QACA,kBAAkB,EAAE,kBAAkB,gBAAA,IAA8B;AAAA,MAAA;AAAA,IAE5E,UAAA;AACI,WAAK,eAAe;AAAA,IACxB;AAEA;AAAA,EACJ;AAAA,EAEA,cAAuB;AACnB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,gBAAgB,WAAsB,OAAyB;AAE3D,SAAK,SAAS,MAAM,SAAS;AAAA,EACjC;AACJ;ACvJO,MAAM,mBAAkD;AAAA,EAC3D,YAAoB,UAA8B;AAA9B,SAAA,WAAA;AAAA,EAA+B;AAAA,EAEnD,SACI,MAEA,UACA,WACK;AACL,UAAM,sBAAsB,mBAAmB,IAAI;AACnD,WAAO,IAAI,UAAU,qBAAqB,KAAK,SAAS,MAAM;AAAA,EAClE;AACJ;AAEO,MAAM,UAA2B;AAAA,EACpC,YACY,qBACA,QACV;AAFU,SAAA,sBAAA;AACA,SAAA,SAAA;AAAA,EACT;AAAA,EAEH,gBACI,MACA,UAC0B;AAC1B,WAAO,IAAI,cAAc,MAAM,KAAK,qBAAqB,KAAK,MAAM;AAAA,EACxE;AAAA,EACA,cACI,MACA,SACwB;AACxB,QAAI,SAAS;AACT,WAAK,OAAO,KAAK,uDAAuD;AAAA,IAC5E;AACA,WAAO,IAAI,YAAY,MAAM,KAAK,qBAAqB,KAAK,MAAM;AAAA,EACtE;AAAA,EACA,oBACI,OACA,UAC8B;AAC9B,WAAO,IAAI,kBAAkB,KAAK,MAAM;AAAA,EAC5C;AAAA,EACA,sBACI,OACA,UACgC;AAChC,WAAO,IAAI,oBAAoB,KAAK,MAAM;AAAA,EAC9C;AAAA,EACA,wBACI,OACA,UACkC;AAClC,WAAO,IAAI,sBAAsB,KAAK,MAAM;AAAA,EAChD;AAAA,EACA,8BACI,OACA,UACwC;AACxC,WAAO,IAAI,4BAA4B,KAAK,MAAM;AAAA,EACtD;AAAA,EACA,2BACI,WACA,cACI;AACJ,SAAK,OAAO,KAAK,8CAA8C;AAAA,EACnE;AAAA,EACA,8BACI,WACA,cACI;AACJ,SAAK,OAAO,KAAK,iDAAiD;AAAA,EACtE;AACJ;AAEA,MAAM,YAA+B;AAAA,EACjC,YACY,MACA,qBACA,QACV;AAHU,SAAA,OAAA;AACA,SAAA,sBAAA;AACA,SAAA,SAAA;AAAA,EACT;AAAA,EAEH,IAAI,OAAe,YAAqC,UAAsC;AAC1F,QAAI,QAAQ,GAAG;AACX,WAAK,OAAO,KAAK,4CAA4C,KAAK,GAAG;AACrE;AAAA,IACJ;AACA,SAAK,oBAAoB;AAAA,MACrB,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,mBAAmB,UAAU;AAAA,IAAA;AAAA,EAErC;AACJ;AAEA,MAAM,cAAmC;AAAA,EACrC,YACY,MACA,qBACA,QACV;AAHU,SAAA,OAAA;AACA,SAAA,sBAAA;AACA,SAAA,SAAA;AAAA,EACT;AAAA,EACH,OACI,OACA,YACA,UACI;AACJ,QAAI,QAAQ,GAAG;AACX,WAAK,OAAO,KAAK,8CAA8C,KAAK,GAAG;AACvE;AAAA,IACJ;AACA,SAAK,oBAAoB;AAAA,MACrB,KAAK;AAAA,MACL;AAAA,MACA;AAAA,MACA,mBAAmB,UAAU;AAAA,IAAA;AAAA,EAErC;AACJ;AAEA,MAAM,kBAA2C;AAAA,EAC7C,YAAoB,QAAuB;AAAvB,SAAA,SAAA;AAAA,EAAwB;AAAA,EAE5C,IACI,QACA,aACA,UACI;AACJ,SAAK,OAAO,KAAK,sCAAsC;AAAA,EAC3D;AACJ;AAEA,MAAM,sBAAmD;AAAA,EACrD,YAAoB,QAAuB;AAAvB,SAAA,SAAA;AAAA,EAAwB;AAAA,EAC5C,YAAY,WAAiD;AACzD,SAAK,OAAO,KAAK,8DAA8D;AAAA,EACnF;AAAA,EACA,eAAe,WAAiD;AAC5D,SAAK,OAAO,KAAK,8DAA8D;AAAA,EACnF;AACJ;AAEA,MAAM,oBAA+C;AAAA,EACjD,YAAoB,QAAuB;AAAvB,SAAA,SAAA;AAAA,EAAwB;AAAA,EAC5C,YAAY,WAAiD;AACzD,SAAK,OAAO,KAAK,4DAA4D;AAAA,EACjF;AAAA,EACA,eAAe,WAAiD;AAC5D,SAAK,OAAO,KAAK,4DAA4D;AAAA,EACjF;AACJ;AAEA,MAAM,4BAA+D;AAAA,EACjE,YAAoB,QAAuB;AAAvB,SAAA,SAAA;AAAA,EAAwB;AAAA,EAC5C,YAAY,WAAiD;AACzD,SAAK,OAAO,KAAK,oEAAoE;AAAA,EACzF;AAAA,EACA,eAAe,WAAiD;AAC5D,SAAK,OAAO,KAAK,oEAAoE;AAAA,EACzF;AACJ;AAEO,SAAS,mBAAmB,YAA8D;AAC7F,MAAI,CAAC,WAAY;AACjB,QAAM,aAA0B,CAAA;AAChC,SAAO,QAAQ,UAAU,EAAE,QAAQ,CAAC,CAAC,KAAK,KAAK,MAAM;AACjD,QAAI,UAAU,UAAa,CAAC,MAAM,QAAQ,KAAK,GAAG;AAC9C,iBAAW,GAAG,IAAI;AAAA,IACtB;AAAA,EACJ,CAAC;AACD,SAAO;AACX;ACzLA,MAAM,oBAAoB;AAAA,EAKtB,YAAoB,UAA8B;AAA9B,SAAA,WAAA;AAFpB,SAAA,gBAAgB,MAAM,YAAY,IAAA;AAG9B,SAAK,QAAQ,IAAI,iBAAiB,KAAK,QAAQ;AAC/C,SAAK,UAAU,IAAI,mBAAmB,KAAK,QAAQ;AAAA,EACvD;AACJ;AAEO,SAAS,uBAAuB,QAAyD;AAC5F,SAAO;AAAA,IACH,MAAM;AAAA,IACN,SAAS;AAAA,IACT,SAAS,IAAI,oBAAoB,EAAE,QAAQ;AAAA,EAAA;AAEnD;"}

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@conduit-client/service-instrumentation-o11y",
+    "version": "2.0.0",
+    "private": false,
+    "description": "Luvio O11y Instrumentation Service implementation",
+    "type": "module",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/luvio-next.git",
+        "directory": "packages/@conduit-client/services/instrumentation-o11y"
+    },
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "exports": {
+        "./v1": {
+            "import": "./dist/v1/index.js",
+            "types": "./dist/types/v1/index.d.ts",
+            "require": "./dist/v1/index.js"
+        }
+    },
+    "main": "./dist/main/index.js",
+    "module": "./dist/main/index.js",
+    "types": "./dist/main/index.d.ts",
+    "files": [
+        "dist/"
+    ],
+    "scripts": {
+        "build": "vite build && tsc --build --emitDeclarationOnly",
+        "clean": "rm -rf dist",
+        "test": "vitest run",
+        "test:size": "size-limit",
+        "watch": "npm run build --watch"
+    },
+    "dependencies": {
+        "@conduit-client/service-instrumentation-types": "2.0.0",
+        "@conduit-client/utils": "2.0.0",
+        "@opentelemetry/api": "1.7.0",
+        "o11y": "252.7.0"
+    },
+    "volta": {
+        "extends": "../../../../package.json"
+    },
+    "size-limit": [
+        {
+            "path": "./dist/v1/index.js",
+            "limit": "2 kB"
+        }
+    ]
+}