@omob/otel-kit 0.1.0

package/dist/services/span.service.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTracer = getTracer;
+exports.currentTraceId = currentTraceId;
+exports.withSpan = withSpan;
+const api_1 = require("@opentelemetry/api");
+const DEFAULT_TRACER_NAME = "@omob/otel-kit";
+function getTracer(name, version) {
+    return api_1.trace.getTracer(name, version);
+}
+function currentTraceId() {
+    return api_1.trace.getSpan(api_1.context.active())?.spanContext().traceId;
+}
+function withSpan(name, optionsOrHandler, maybeHandler) {
+    const isHandlerOnly = typeof optionsOrHandler === "function";
+    const handler = (isHandlerOnly ? optionsOrHandler : maybeHandler);
+    const { tracer, isError, ...spanOptions } = isHandlerOnly ? {} : optionsOrHandler;
+    return (tracer ?? api_1.trace.getTracer(DEFAULT_TRACER_NAME)).startActiveSpan(name, spanOptions, async (span) => {
+        try {
+            return await handler(span);
+        }
+        catch (error) {
+            recordFailure(span, error, isError);
+            throw error;
+        }
+        finally {
+            span.end();
+        }
+    });
+}
+function recordFailure(span, error, isError) {
+    if (isError && !isError(error)) {
+        return;
+    }
+    const message = error instanceof Error ? error.message : String(error);
+    span.recordException(error instanceof Error ? error : new Error(message));
+    span.setStatus({ code: api_1.SpanStatusCode.ERROR, message });
+}
+//# sourceMappingURL=span.service.js.map

package/dist/services/span.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"span.service.js","sourceRoot":"","sources":["../../src/services/span.service.ts"],"names":[],"mappings":";;AAKA,8BAEC;AAED,wCAEC;AAID,4BAmBC;AAlCD,4CAAkF;AAGlF,MAAM,mBAAmB,GAAG,gBAAgB,CAAC;AAE7C,SAAgB,SAAS,CAAC,IAAY,EAAE,OAAgB;IACtD,OAAO,WAAK,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAED,SAAgB,cAAc;IAC5B,OAAO,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,OAAO,CAAC;AAChE,CAAC;AAID,SAAgB,QAAQ,CACtB,IAAY,EACZ,gBAAmD,EACnD,YAA6B;IAE7B,MAAM,aAAa,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC;IAC7D,MAAM,OAAO,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAmB,CAAC;IACpF,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,aAAa,CAAC,CAAC,CAAE,EAAuB,CAAC,CAAC,CAAC,gBAAgB,CAAC;IAExG,OAAO,CAAC,MAAM,IAAI,WAAK,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAU,EAAE,EAAE;QAC9G,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YACpC,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,aAAa,CAAC,IAAU,EAAE,KAAc,EAAE,OAAqC;IACtF,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEvE,IAAI,CAAC,eAAe,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1E,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,oBAAc,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;AAC1D,CAAC"}

package/dist/services/telemetry.service.d.ts

@@ -0,0 +1,19 @@
+import { ITelemetryConfig } from "../telemetry.types";
+declare class TelemetryService {
+    private sdk?;
+    private shutdownPromise?;
+    private signalHandlers;
+    start(config: ITelemetryConfig): void;
+    shutdown(timeoutMillis?: number): Promise<void>;
+    get isStarted(): boolean;
+    private startSdk;
+    private configureDiagnostics;
+    private reportStartupError;
+    private loadSdkFactory;
+    private registerShutdownHandlers;
+    private removeShutdownHandlers;
+    private resumeSignal;
+    private expireAfter;
+}
+declare const _default: TelemetryService;
+export default _default;

package/dist/services/telemetry.service.js

@@ -0,0 +1,104 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_1 = require("@opentelemetry/api");
+const telemetry_error_code_enum_1 = require("../enums/telemetry-error-code.enum");
+const telemetry_config_error_1 = __importDefault(require("../errors/telemetry-config.error"));
+const DEFAULT_SHUTDOWN_TIMEOUT_MILLIS = 5000;
+const SHUTDOWN_SIGNALS = ["SIGTERM", "SIGINT"];
+class TelemetryService {
+    constructor() {
+        this.signalHandlers = new Map();
+    }
+    start(config) {
+        if (this.sdk || config.enabled === false) {
+            return;
+        }
+        try {
+            this.startSdk(config);
+        }
+        catch (error) {
+            this.reportStartupError(error, config);
+        }
+    }
+    async shutdown(timeoutMillis = DEFAULT_SHUTDOWN_TIMEOUT_MILLIS) {
+        const sdk = this.sdk;
+        if (!sdk) {
+            return this.shutdownPromise ?? Promise.resolve();
+        }
+        this.sdk = undefined;
+        this.removeShutdownHandlers();
+        this.shutdownPromise = Promise.race([sdk.shutdown(), this.expireAfter(timeoutMillis)]).catch((error) => {
+            this.sdk = sdk;
+            throw error;
+        });
+        return this.shutdownPromise;
+    }
+    get isStarted() {
+        return this.sdk !== undefined;
+    }
+    startSdk(config) {
+        if (!config.serviceName) {
+            throw new telemetry_config_error_1.default(telemetry_error_code_enum_1.TelemetryErrorCode.MISSING_SERVICE_NAME, "serviceName is required");
+        }
+        this.configureDiagnostics(config);
+        const sdk = this.loadSdkFactory().createSdk(config);
+        sdk.start();
+        this.sdk = sdk;
+        this.shutdownPromise = undefined;
+        if (config.handleShutdownSignals !== false) {
+            this.registerShutdownHandlers(config);
+        }
+    }
+    // otel writes its own failures through diag, which discards everything until a logger is installed
+    configureDiagnostics(config) {
+        if (config.diagLogLevel === undefined) {
+            return;
+        }
+        api_1.diag.setLogger(config.diagLogger ?? new api_1.DiagConsoleLogger(), config.diagLogLevel);
+    }
+    // telemetry must never stop a service from booting, so a bad configuration disables it instead of throwing
+    reportStartupError(error, config) {
+        if (config.onStartupError) {
+            config.onStartupError(error);
+            return;
+        }
+        console.error("@omob/otel-kit is disabled, its configuration was rejected:", error.message);
+    }
+    // the sdk drags in every exporter, so it stays out of the module graph of apps that only import the span helpers
+    loadSdkFactory() {
+        return require("../factories/sdk.factory").default;
+    }
+    registerShutdownHandlers(config) {
+        const timeoutMillis = config.shutdownTimeoutMillis ?? DEFAULT_SHUTDOWN_TIMEOUT_MILLIS;
+        for (const signal of SHUTDOWN_SIGNALS) {
+            const handler = () => {
+                this.shutdown(timeoutMillis)
+                    .catch((error) => console.error("@omob/otel-kit failed to flush telemetry on shutdown", error))
+                    .finally(() => this.resumeSignal(signal, config.exitOnSignal === true));
+            };
+            this.signalHandlers.set(signal, handler);
+            process.on(signal, handler);
+        }
+    }
+    removeShutdownHandlers() {
+        this.signalHandlers.forEach((handler, signal) => process.removeListener(signal, handler));
+        this.signalHandlers.clear();
+    }
+    // hand the signal back so the host's own handlers run and the process exits with the conventional code
+    resumeSignal(signal, exitOnSignal) {
+        if (exitOnSignal) {
+            process.exit(0);
+        }
+        if (process.listenerCount(signal) === 0) {
+            process.kill(process.pid, signal);
+        }
+    }
+    expireAfter(millis) {
+        return new Promise((resolve) => setTimeout(resolve, millis).unref());
+    }
+}
+exports.default = new TelemetryService();
+//# sourceMappingURL=telemetry.service.js.map

package/dist/services/telemetry.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.service.js","sourceRoot":"","sources":["../../src/services/telemetry.service.ts"],"names":[],"mappings":";;;;;AAAA,4CAA6D;AAE7D,kFAAwE;AACxE,8FAAoE;AAIpE,MAAM,+BAA+B,GAAG,IAAK,CAAC;AAC9C,MAAM,gBAAgB,GAAqB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AAEjE,MAAM,gBAAgB;IAAtB;QAGU,mBAAc,GAAG,IAAI,GAAG,EAA8B,CAAC;IAkHjE,CAAC;IAhHC,KAAK,CAAC,MAAwB;QAC5B,IAAI,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YACzC,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,kBAAkB,CAAC,KAAc,EAAE,MAAM,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,aAAa,GAAG,+BAA+B;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QAErB,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACnD,CAAC;QAED,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;QACrB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACrG,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;YACf,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC;IAChC,CAAC;IAEO,QAAQ,CAAC,MAAwB;QACvC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YACxB,MAAM,IAAI,gCAAoB,CAAC,8CAAkB,CAAC,oBAAoB,EAAE,yBAAyB,CAAC,CAAC;QACrG,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAElC,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAEpD,GAAG,CAAC,KAAK,EAAE,CAAC;QAEZ,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QAEjC,IAAI,MAAM,CAAC,qBAAqB,KAAK,KAAK,EAAE,CAAC;YAC3C,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,mGAAmG;IAC3F,oBAAoB,CAAC,MAAwB;QACnD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO;QACT,CAAC;QAED,UAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,uBAAiB,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;IACpF,CAAC;IAED,2GAA2G;IACnG,kBAAkB,CAAC,KAAY,EAAE,MAAwB;QAC/D,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC1B,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAE7B,OAAO;QACT,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,6DAA6D,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED,iHAAiH;IACzG,cAAc;QACpB,OAAO,OAAO,CAAC,0BAA0B,CAAC,CAAC,OAAO,CAAC;IACrD,CAAC;IAEO,wBAAwB,CAAC,MAAwB;QACvD,MAAM,aAAa,GAAG,MAAM,CAAC,qBAAqB,IAAI,+BAA+B,CAAC;QAEtF,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;qBACzB,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,sDAAsD,EAAE,KAAK,CAAC,CAAC;qBAC9F,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC;YAEF,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACzC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAEO,sBAAsB;QAC5B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,uGAAuG;IAC/F,YAAY,CAAC,MAAsB,EAAE,YAAqB;QAChE,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAEO,WAAW,CAAC,MAAc;QAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAED,kBAAe,IAAI,gBAAgB,EAAE,CAAC"}

package/dist/telemetry.types.d.ts

@@ -0,0 +1,100 @@
+import type { DiagLogLevel, DiagLogger, SpanOptions, Tracer } from "@opentelemetry/api";
+import type { InstrumentationConfigMap } from "@opentelemetry/auto-instrumentations-node";
+import type { Instrumentation } from "@opentelemetry/instrumentation";
+import type { MetricReader, PushMetricExporter, ViewOptions } from "@opentelemetry/sdk-metrics";
+import type { Sampler, SpanExporter, SpanProcessor } from "@opentelemetry/sdk-trace-node";
+import { ExporterType } from "./enums/exporter-type.enum";
+import { InstrumentationName } from "./enums/instrumentation-name.enum";
+import { OtlpProtocol } from "./enums/otlp-protocol.enum";
+import { PropagatorType } from "./enums/propagator-type.enum";
+export type ResourceAttributeValue = string | number | boolean;
+export type SpanHandler<T> = (span: import("@opentelemetry/api").Span) => Promise<T> | T;
+export interface IGcpTraceModule {
+    TraceExporter: new (options: object) => SpanExporter;
+}
+export interface IGcpMonitoringModule {
+    MetricExporter: new (options: object) => PushMetricExporter;
+}
+export interface IPrometheusModule {
+    PrometheusExporter: new (options: object) => MetricReader;
+}
+export interface IOtlpOptions {
+    protocol?: OtlpProtocol;
+    url?: string;
+    headers?: Record<string, string>;
+    timeoutMillis?: number;
+}
+export interface IGcpOptions {
+    projectId?: string;
+    keyFile?: string;
+}
+export interface IPrometheusOptions {
+    host?: string;
+    port?: number;
+    endpoint?: string;
+}
+export interface IBatchOptions {
+    maxQueueSize?: number;
+    maxExportBatchSize?: number;
+    scheduledDelayMillis?: number;
+    exportTimeoutMillis?: number;
+}
+export interface ISpanLimits {
+    attributeValueLengthLimit?: number;
+    attributeCountLimit?: number;
+    eventCountLimit?: number;
+    linkCountLimit?: number;
+}
+export interface ITraceConfig {
+    exporter: ExporterType;
+    sampleRatio?: number;
+    sampler?: Sampler;
+    additionalProcessors?: SpanProcessor[];
+    sanitizeAttributes?: boolean;
+    batch?: IBatchOptions;
+    otlp?: IOtlpOptions;
+    gcp?: IGcpOptions;
+}
+export interface IMetricConfig {
+    exporter: ExporterType;
+    exportIntervalMillis?: number;
+    views?: ViewOptions[];
+    otlp?: IOtlpOptions;
+    gcp?: IGcpOptions;
+    prometheus?: IPrometheusOptions;
+}
+export interface ILogConfig {
+    exporter: ExporterType;
+    otlp?: IOtlpOptions;
+}
+export interface IInstrumentationConfig {
+    disable?: InstrumentationName[];
+    enable?: InstrumentationName[];
+    ignoreIncomingPaths?: string[];
+    additional?: Instrumentation[];
+    config?: InstrumentationConfigMap;
+}
+export interface ITelemetryConfig {
+    serviceName: string;
+    serviceVersion?: string;
+    environment?: string;
+    enabled?: boolean;
+    resourceAttributes?: Record<string, ResourceAttributeValue>;
+    resourceDetection?: boolean;
+    spanLimits?: ISpanLimits;
+    traces?: ITraceConfig;
+    metrics?: IMetricConfig;
+    logs?: ILogConfig;
+    instrumentation?: IInstrumentationConfig;
+    propagators?: PropagatorType[];
+    diagLogLevel?: DiagLogLevel;
+    diagLogger?: DiagLogger;
+    handleShutdownSignals?: boolean;
+    exitOnSignal?: boolean;
+    shutdownTimeoutMillis?: number;
+    onStartupError?: (error: Error) => void;
+}
+export interface IWithSpanOptions extends SpanOptions {
+    tracer?: Tracer;
+    isError?: (error: unknown) => boolean;
+}

package/dist/telemetry.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=telemetry.types.js.map

package/dist/telemetry.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.types.js","sourceRoot":"","sources":["../src/telemetry.types.ts"],"names":[],"mappings":""}

package/dist/utils/gcp-credentials.d.ts

@@ -0,0 +1,5 @@
+import { IGcpOptions } from "../telemetry.types";
+export declare function toGcpExporterOptions(options?: IGcpOptions): {
+    keyFile?: string | undefined;
+    projectId?: string | undefined;
+};

package/dist/utils/gcp-credentials.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toGcpExporterOptions = toGcpExporterOptions;
+const fs_1 = require("fs");
+function toGcpExporterOptions(options = {}) {
+    const keyFile = options.keyFile ?? process.env.GOOGLE_APPLICATION_CREDENTIALS;
+    const projectId = options.projectId ?? process.env.GCP_PROJECT_ID;
+    // an unreadable keyFile must be omitted entirely so the exporter falls back to application default credentials
+    return {
+        ...(projectId ? { projectId } : {}),
+        ...(keyFile && (0, fs_1.existsSync)(keyFile) ? { keyFile } : {}),
+    };
+}
+//# sourceMappingURL=gcp-credentials.js.map

package/dist/utils/gcp-credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcp-credentials.js","sourceRoot":"","sources":["../../src/utils/gcp-credentials.ts"],"names":[],"mappings":";;AAGA,oDASC;AAZD,2BAAgC;AAGhC,SAAgB,oBAAoB,CAAC,UAAuB,EAAE;IAC5D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC;IAC9E,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IAElE,+GAA+G;IAC/G,OAAO;QACL,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnC,GAAG,CAAC,OAAO,IAAI,IAAA,eAAU,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvD,CAAC;AACJ,CAAC"}

package/dist/utils/optional-dependency.d.ts

@@ -0,0 +1 @@
+export declare function loadOptionalDependency<T>(moduleName: string): T;

package/dist/utils/optional-dependency.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadOptionalDependency = loadOptionalDependency;
+const telemetry_config_error_1 = __importDefault(require("../errors/telemetry-config.error"));
+const telemetry_error_code_enum_1 = require("../enums/telemetry-error-code.enum");
+function loadOptionalDependency(moduleName) {
+    try {
+        require.resolve(moduleName);
+    }
+    catch {
+        throw new telemetry_config_error_1.default(telemetry_error_code_enum_1.TelemetryErrorCode.MISSING_OPTIONAL_DEPENDENCY, `${moduleName} is not installed. Add it to the host project to use this exporter.`);
+    }
+    // resolving separately keeps a genuine load failure inside the module from being reported as a missing install
+    return require(moduleName);
+}
+//# sourceMappingURL=optional-dependency.js.map

package/dist/utils/optional-dependency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional-dependency.js","sourceRoot":"","sources":["../../src/utils/optional-dependency.ts"],"names":[],"mappings":";;;;;AAGA,wDAYC;AAfD,8FAAoE;AACpE,kFAAwE;AAExE,SAAgB,sBAAsB,CAAI,UAAkB;IAC1D,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,gCAAoB,CAC5B,8CAAkB,CAAC,2BAA2B,EAC9C,GAAG,UAAU,qEAAqE,CACnF,CAAC;IACJ,CAAC;IAED,+GAA+G;IAC/G,OAAO,OAAO,CAAC,UAAU,CAAM,CAAC;AAClC,CAAC"}

package/dist/utils/otlp-options.d.ts

@@ -0,0 +1,6 @@
+import { IOtlpOptions } from "../telemetry.types";
+export declare function toOtlpExporterOptions(options?: IOtlpOptions): {
+    timeoutMillis?: number | undefined;
+    headers?: Record<string, string> | undefined;
+    url?: string | undefined;
+};

package/dist/utils/otlp-options.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toOtlpExporterOptions = toOtlpExporterOptions;
+function toOtlpExporterOptions(options = {}) {
+    return {
+        ...(options.url ? { url: options.url } : {}),
+        ...(options.headers ? { headers: options.headers } : {}),
+        ...(options.timeoutMillis !== undefined ? { timeoutMillis: options.timeoutMillis } : {}),
+    };
+}
+//# sourceMappingURL=otlp-options.js.map

package/dist/utils/otlp-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otlp-options.js","sourceRoot":"","sources":["../../src/utils/otlp-options.ts"],"names":[],"mappings":";;AAEA,sDAMC;AAND,SAAgB,qBAAqB,CAAC,UAAwB,EAAE;IAC9D,OAAO;QACL,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACzF,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@omob/otel-kit",
+  "version": "0.1.0",
+  "description": "Configurable OpenTelemetry bootstrap for Node services: traces, metrics and logs with pluggable exporters",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint src test",
+    "lint:fix": "eslint src test --fix",
+    "test": "jest --runInBand",
+    "verify:consumers": "node scripts/verify-consumers.mjs"
+  },
+  "keywords": [
+    "opentelemetry",
+    "tracing",
+    "observability",
+    "metrics",
+    "logs"
+  ],
+  "license": "MIT",
+  "author": "Ayodeji Abodunrin",
+  "homepage": "https://github.com/omob/otel-kit#readme",
+  "bugs": {
+    "url": "https://github.com/omob/otel-kit/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": "^18.19.0 || >=20.6.0"
+  },
+  "dependencies": {
+    "@opentelemetry/auto-instrumentations-node": "^0.67.0",
+    "@opentelemetry/core": "2.11.0",
+    "@opentelemetry/exporter-logs-otlp-grpc": "0.222.0",
+    "@opentelemetry/exporter-logs-otlp-http": "0.222.0",
+    "@opentelemetry/exporter-logs-otlp-proto": "0.222.0",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "0.222.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "0.222.0",
+    "@opentelemetry/exporter-metrics-otlp-proto": "0.222.0",
+    "@opentelemetry/exporter-prometheus": "0.222.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "0.222.0",
+    "@opentelemetry/exporter-trace-otlp-http": "0.222.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "0.222.0",
+    "@opentelemetry/instrumentation": "0.222.0",
+    "@opentelemetry/propagator-b3": "2.11.0",
+    "@opentelemetry/propagator-jaeger": "2.11.0",
+    "@opentelemetry/resources": "2.11.0",
+    "@opentelemetry/sdk-logs": "0.222.0",
+    "@opentelemetry/sdk-metrics": "2.11.0",
+    "@opentelemetry/sdk-node": "0.222.0",
+    "@opentelemetry/sdk-trace-node": "2.11.0",
+    "@opentelemetry/semantic-conventions": "^1.36.0"
+  },
+  "peerDependencies": {
+    "@google-cloud/opentelemetry-cloud-monitoring-exporter": ">=0.20.0",
+    "@google-cloud/opentelemetry-cloud-trace-exporter": ">=2.4.0",
+    "@opentelemetry/api": "^1.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@google-cloud/opentelemetry-cloud-monitoring-exporter": {
+      "optional": true
+    },
+    "@google-cloud/opentelemetry-cloud-trace-exporter": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/sdk-trace-base": "^2.11.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.14.0",
+    "eslint": "^9.39.5",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.12",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.69.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/omob/otel-kit.git"
+  }
+}