@itwin/core-bentley 3.4.0-dev.48 → 3.4.0-dev.50

package/lib/esm/Tracing.d.ts

@@ -1,41 +1,41 @@
-import type { Attributes, SpanContext, SpanOptions, Tracer } from "@opentelemetry/api";
-/**
- * Mirrors the SpanKind enum from [@opentelemetry/api](https://open-telemetry.github.io/opentelemetry-js-api/enums/spankind)
- * @alpha
- */
-export declare enum SpanKind {
-    INTERNAL = 0,
-    SERVER = 1,
-    CLIENT = 2,
-    PRODUCER = 3,
-    CONSUMER = 4
-}
-/**
- * Enables OpenTelemetry tracing in addition to traditional logging.
- * @alpha
- */
-export declare class Tracing {
-    private static _tracer?;
-    private static _openTelemetry?;
-    /**
-     * If OpenTelemetry tracing is enabled, creates a new span and runs the provided function in it.
-     * If OpenTelemetry tracing is _not_ enabled, runs the provided function.
-     * @param name name of the new span
-     * @param fn function to run inside the new span
-     * @param options span options
-     * @param parentContext optional context used to retrieve parent span id
-     */
-    static withSpan<T>(name: string, fn: () => Promise<T>, options?: SpanOptions, parentContext?: SpanContext): Promise<T>;
-    /**
-     * Enable logging to OpenTelemetry. [[Tracing.withSpan]] will be enabled, all log entries will be attached to active span as span events.
-     * [[IModelHost.startup]] will call this automatically if it succeeds in requiring `@opentelemetry/api`.
-     * @note Node.js OpenTelemetry SDK should be initialized by the user.
-     */
-    static enableOpenTelemetry(tracer: Tracer, api: typeof Tracing._openTelemetry): void;
-    private static withOpenTelemetry;
-    /** Set attributes on currently active openTelemetry span. Doesn't do anything if openTelemetry logging is not initialized.
-     * @param attributes  The attributes to set
-     */
-    static setAttributes(attributes: Attributes): void;
-}
+import type { Attributes, SpanContext, SpanOptions, Tracer } from "@opentelemetry/api";
+/**
+ * Mirrors the SpanKind enum from [@opentelemetry/api](https://open-telemetry.github.io/opentelemetry-js-api/enums/spankind)
+ * @alpha
+ */
+export declare enum SpanKind {
+    INTERNAL = 0,
+    SERVER = 1,
+    CLIENT = 2,
+    PRODUCER = 3,
+    CONSUMER = 4
+}
+/**
+ * Enables OpenTelemetry tracing in addition to traditional logging.
+ * @alpha
+ */
+export declare class Tracing {
+    private static _tracer?;
+    private static _openTelemetry?;
+    /**
+     * If OpenTelemetry tracing is enabled, creates a new span and runs the provided function in it.
+     * If OpenTelemetry tracing is _not_ enabled, runs the provided function.
+     * @param name name of the new span
+     * @param fn function to run inside the new span
+     * @param options span options
+     * @param parentContext optional context used to retrieve parent span id
+     */
+    static withSpan<T>(name: string, fn: () => Promise<T>, options?: SpanOptions, parentContext?: SpanContext): Promise<T>;
+    /**
+     * Enable logging to OpenTelemetry. [[Tracing.withSpan]] will be enabled, all log entries will be attached to active span as span events.
+     * [[IModelHost.startup]] will call this automatically if it succeeds in requiring `@opentelemetry/api`.
+     * @note Node.js OpenTelemetry SDK should be initialized by the user.
+     */
+    static enableOpenTelemetry(tracer: Tracer, api: typeof Tracing._openTelemetry): void;
+    private static withOpenTelemetry;
+    /** Set attributes on currently active openTelemetry span. Doesn't do anything if openTelemetry logging is not initialized.
+     * @param attributes  The attributes to set
+     */
+    static setAttributes(attributes: Attributes): void;
+}
 //# sourceMappingURL=Tracing.d.ts.map

package/lib/esm/Tracing.js

@@ -1,127 +1,127 @@
-import { Logger } from "./Logger";
-// re-export so that consumers can construct full SpanOptions object without external dependencies
-/**
- * Mirrors the SpanKind enum from [@opentelemetry/api](https://open-telemetry.github.io/opentelemetry-js-api/enums/spankind)
- * @alpha
- */
-export var SpanKind;
-(function (SpanKind) {
-    SpanKind[SpanKind["INTERNAL"] = 0] = "INTERNAL";
-    SpanKind[SpanKind["SERVER"] = 1] = "SERVER";
-    SpanKind[SpanKind["CLIENT"] = 2] = "CLIENT";
-    SpanKind[SpanKind["PRODUCER"] = 3] = "PRODUCER";
-    SpanKind[SpanKind["CONSUMER"] = 4] = "CONSUMER";
-})(SpanKind || (SpanKind = {}));
-function isValidPrimitive(val) {
-    return typeof val === "string" || typeof val === "number" || typeof val === "boolean";
-}
-// Only _homogenous_ arrays of strings, numbers, or booleans are supported as OpenTelemetry Attribute values.
-// Per the spec (https://opentelemetry.io/docs/reference/specification/common/common/#attribute), empty arrays and null values are supported too.
-function isValidPrimitiveArray(val) {
-    if (!Array.isArray(val))
-        return false;
-    let itemType;
-    for (const x of val) {
-        if (x === undefined || x === null)
-            continue;
-        if (!itemType) {
-            itemType = typeof x;
-            if (!isValidPrimitive(x))
-                return false;
-        }
-        if (typeof x !== itemType)
-            return false;
-    }
-    return true;
-}
-function isPlainObject(obj) {
-    return typeof obj === "object" && obj !== null && Object.getPrototypeOf(obj) === Object.prototype;
-}
-function* getFlatEntries(obj, path = "") {
-    if (isValidPrimitiveArray(obj)) {
-        yield [path, obj];
-        return;
-    }
-    // Prefer JSON serialization over flattening for any non-POJO types.
-    // There's just too many ways trying to flatten those can go wrong (Dates, Buffers, TypedArrays, etc.)
-    if (!isPlainObject(obj) && !Array.isArray(obj)) {
-        yield [path, isValidPrimitive(obj) ? obj : JSON.stringify(obj)];
-        return;
-    }
-    // Always serialize empty objects/arrays as empty array values
-    const entries = Object.entries(obj);
-    if (entries.length === 0)
-        yield [path, []];
-    for (const [key, val] of entries)
-        yield* getFlatEntries(val, (path === "") ? key : `${path}.${key}`);
-}
-function flattenObject(obj) {
-    return Object.fromEntries(getFlatEntries(obj));
-}
-/**
- * Enables OpenTelemetry tracing in addition to traditional logging.
- * @alpha
- */
-export class Tracing {
-    /**
-     * If OpenTelemetry tracing is enabled, creates a new span and runs the provided function in it.
-     * If OpenTelemetry tracing is _not_ enabled, runs the provided function.
-     * @param name name of the new span
-     * @param fn function to run inside the new span
-     * @param options span options
-     * @param parentContext optional context used to retrieve parent span id
-     */
-    static async withSpan(name, fn, options, parentContext) {
-        if (Tracing._tracer === undefined || Tracing._openTelemetry === undefined)
-            return fn();
-        // this case is for context propagation - parentContext is typically constructed from HTTP headers
-        const parent = parentContext === undefined
-            ? Tracing._openTelemetry.context.active()
-            : Tracing._openTelemetry.trace.setSpanContext(Tracing._openTelemetry.context.active(), parentContext);
-        return Tracing._openTelemetry.context.with(Tracing._openTelemetry.trace.setSpan(parent, Tracing._tracer.startSpan(name, options, Tracing._openTelemetry.context.active())), async () => {
-            var _a, _b, _c, _d;
-            try {
-                return await fn();
-            }
-            catch (err) {
-                if (err instanceof Error) // ignore non-Error throws, such as RpcControlResponse
-                    (_b = (_a = Tracing._openTelemetry) === null || _a === void 0 ? void 0 : _a.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _b === void 0 ? void 0 : _b.setAttribute("error", true);
-                throw err;
-            }
-            finally {
-                (_d = (_c = Tracing._openTelemetry) === null || _c === void 0 ? void 0 : _c.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _d === void 0 ? void 0 : _d.end();
-            }
-        });
-    }
-    /**
-     * Enable logging to OpenTelemetry. [[Tracing.withSpan]] will be enabled, all log entries will be attached to active span as span events.
-     * [[IModelHost.startup]] will call this automatically if it succeeds in requiring `@opentelemetry/api`.
-     * @note Node.js OpenTelemetry SDK should be initialized by the user.
-     */
-    static enableOpenTelemetry(tracer, api) {
-        Tracing._tracer = tracer;
-        Tracing._openTelemetry = api;
-        Logger.logTrace = Tracing.withOpenTelemetry(Logger.logTrace);
-        Logger.logInfo = Tracing.withOpenTelemetry(Logger.logInfo);
-        Logger.logWarning = Tracing.withOpenTelemetry(Logger.logWarning);
-        Logger.logError = Tracing.withOpenTelemetry(Logger.logError);
-    }
-    static withOpenTelemetry(base, isError = false) {
-        return (category, message, metaData) => {
-            var _a, _b;
-            try {
-                (_b = (_a = Tracing._openTelemetry) === null || _a === void 0 ? void 0 : _a.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _b === void 0 ? void 0 : _b.addEvent(message, { ...flattenObject(Logger.getMetaData(metaData)), error: isError });
-            }
-            catch (_e) { } // avoid throwing random errors (with stack trace mangled by async hooks) when openTelemetry collector doesn't work
-            base(category, message, metaData);
-        };
-    }
-    /** Set attributes on currently active openTelemetry span. Doesn't do anything if openTelemetry logging is not initialized.
-     * @param attributes  The attributes to set
-     */
-    static setAttributes(attributes) {
-        var _a, _b;
-        (_b = (_a = Tracing._openTelemetry) === null || _a === void 0 ? void 0 : _a.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _b === void 0 ? void 0 : _b.setAttributes(attributes);
-    }
-}
+import { Logger } from "./Logger";
+// re-export so that consumers can construct full SpanOptions object without external dependencies
+/**
+ * Mirrors the SpanKind enum from [@opentelemetry/api](https://open-telemetry.github.io/opentelemetry-js-api/enums/spankind)
+ * @alpha
+ */
+export var SpanKind;
+(function (SpanKind) {
+    SpanKind[SpanKind["INTERNAL"] = 0] = "INTERNAL";
+    SpanKind[SpanKind["SERVER"] = 1] = "SERVER";
+    SpanKind[SpanKind["CLIENT"] = 2] = "CLIENT";
+    SpanKind[SpanKind["PRODUCER"] = 3] = "PRODUCER";
+    SpanKind[SpanKind["CONSUMER"] = 4] = "CONSUMER";
+})(SpanKind || (SpanKind = {}));
+function isValidPrimitive(val) {
+    return typeof val === "string" || typeof val === "number" || typeof val === "boolean";
+}
+// Only _homogenous_ arrays of strings, numbers, or booleans are supported as OpenTelemetry Attribute values.
+// Per the spec (https://opentelemetry.io/docs/reference/specification/common/common/#attribute), empty arrays and null values are supported too.
+function isValidPrimitiveArray(val) {
+    if (!Array.isArray(val))
+        return false;
+    let itemType;
+    for (const x of val) {
+        if (x === undefined || x === null)
+            continue;
+        if (!itemType) {
+            itemType = typeof x;
+            if (!isValidPrimitive(x))
+                return false;
+        }
+        if (typeof x !== itemType)
+            return false;
+    }
+    return true;
+}
+function isPlainObject(obj) {
+    return typeof obj === "object" && obj !== null && Object.getPrototypeOf(obj) === Object.prototype;
+}
+function* getFlatEntries(obj, path = "") {
+    if (isValidPrimitiveArray(obj)) {
+        yield [path, obj];
+        return;
+    }
+    // Prefer JSON serialization over flattening for any non-POJO types.
+    // There's just too many ways trying to flatten those can go wrong (Dates, Buffers, TypedArrays, etc.)
+    if (!isPlainObject(obj) && !Array.isArray(obj)) {
+        yield [path, isValidPrimitive(obj) ? obj : JSON.stringify(obj)];
+        return;
+    }
+    // Always serialize empty objects/arrays as empty array values
+    const entries = Object.entries(obj);
+    if (entries.length === 0)
+        yield [path, []];
+    for (const [key, val] of entries)
+        yield* getFlatEntries(val, (path === "") ? key : `${path}.${key}`);
+}
+function flattenObject(obj) {
+    return Object.fromEntries(getFlatEntries(obj));
+}
+/**
+ * Enables OpenTelemetry tracing in addition to traditional logging.
+ * @alpha
+ */
+export class Tracing {
+    /**
+     * If OpenTelemetry tracing is enabled, creates a new span and runs the provided function in it.
+     * If OpenTelemetry tracing is _not_ enabled, runs the provided function.
+     * @param name name of the new span
+     * @param fn function to run inside the new span
+     * @param options span options
+     * @param parentContext optional context used to retrieve parent span id
+     */
+    static async withSpan(name, fn, options, parentContext) {
+        if (Tracing._tracer === undefined || Tracing._openTelemetry === undefined)
+            return fn();
+        // this case is for context propagation - parentContext is typically constructed from HTTP headers
+        const parent = parentContext === undefined
+            ? Tracing._openTelemetry.context.active()
+            : Tracing._openTelemetry.trace.setSpanContext(Tracing._openTelemetry.context.active(), parentContext);
+        return Tracing._openTelemetry.context.with(Tracing._openTelemetry.trace.setSpan(parent, Tracing._tracer.startSpan(name, options, Tracing._openTelemetry.context.active())), async () => {
+            var _a, _b, _c, _d;
+            try {
+                return await fn();
+            }
+            catch (err) {
+                if (err instanceof Error) // ignore non-Error throws, such as RpcControlResponse
+                    (_b = (_a = Tracing._openTelemetry) === null || _a === void 0 ? void 0 : _a.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _b === void 0 ? void 0 : _b.setAttribute("error", true);
+                throw err;
+            }
+            finally {
+                (_d = (_c = Tracing._openTelemetry) === null || _c === void 0 ? void 0 : _c.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _d === void 0 ? void 0 : _d.end();
+            }
+        });
+    }
+    /**
+     * Enable logging to OpenTelemetry. [[Tracing.withSpan]] will be enabled, all log entries will be attached to active span as span events.
+     * [[IModelHost.startup]] will call this automatically if it succeeds in requiring `@opentelemetry/api`.
+     * @note Node.js OpenTelemetry SDK should be initialized by the user.
+     */
+    static enableOpenTelemetry(tracer, api) {
+        Tracing._tracer = tracer;
+        Tracing._openTelemetry = api;
+        Logger.logTrace = Tracing.withOpenTelemetry(Logger.logTrace);
+        Logger.logInfo = Tracing.withOpenTelemetry(Logger.logInfo);
+        Logger.logWarning = Tracing.withOpenTelemetry(Logger.logWarning);
+        Logger.logError = Tracing.withOpenTelemetry(Logger.logError);
+    }
+    static withOpenTelemetry(base, isError = false) {
+        return (category, message, metaData) => {
+            var _a, _b;
+            try {
+                (_b = (_a = Tracing._openTelemetry) === null || _a === void 0 ? void 0 : _a.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _b === void 0 ? void 0 : _b.addEvent(message, { ...flattenObject(Logger.getMetaData(metaData)), error: isError });
+            }
+            catch (_e) { } // avoid throwing random errors (with stack trace mangled by async hooks) when openTelemetry collector doesn't work
+            base(category, message, metaData);
+        };
+    }
+    /** Set attributes on currently active openTelemetry span. Doesn't do anything if openTelemetry logging is not initialized.
+     * @param attributes  The attributes to set
+     */
+    static setAttributes(attributes) {
+        var _a, _b;
+        (_b = (_a = Tracing._openTelemetry) === null || _a === void 0 ? void 0 : _a.trace.getSpan(Tracing._openTelemetry.context.active())) === null || _b === void 0 ? void 0 : _b.setAttributes(attributes);
+    }
+}
 //# sourceMappingURL=Tracing.js.map

package/lib/esm/Tracing.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tracing.js","sourceRoot":"","sources":["../../src/Tracing.ts"],"names":[],"mappings":"AAKA,OAAO,EAAe,MAAM,EAAE,MAAM,UAAU,CAAC;AAE/C,kGAAkG;AAClG;;;GAGG;AACH,MAAM,CAAN,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,+CAAY,CAAA;IACZ,2CAAU,CAAA;IACV,2CAAU,CAAA;IACV,+CAAY,CAAA;IACZ,+CAAY,CAAA;AACd,CAAC,EANW,QAAQ,KAAR,QAAQ,QAMnB;AAED,SAAS,gBAAgB,CAAC,GAAY;IACpC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,SAAS,CAAC;AACxF,CAAC;AAED,6GAA6G;AAC7G,iJAAiJ;AACjJ,SAAS,qBAAqB,CAAC,GAAY;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACrB,OAAO,KAAK,CAAC;IAEf,IAAI,QAAQ,CAAC;IACb,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI;YAC/B,SAAS;QAEX,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,GAAG,OAAO,CAAC,CAAC;YACpB,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBACtB,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,OAAO,CAAC,KAAK,QAAQ;YACvB,OAAO,KAAK,CAAC;KAChB;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,GAAY;IACjC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,SAAS,CAAC;AACpG,CAAC;AAED,QAAQ,CAAC,CAAC,cAAc,CAAC,GAAY,EAAE,IAAI,GAAG,EAAE;IAC9C,IAAI,qBAAqB,CAAC,GAAG,CAAC,EAAE;QAC9B,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAClB,OAAO;KACR;IAED,oEAAoE;IACpE,sGAAsG;IACtG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC9C,MAAM,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,OAAO;KACR;IAED,8DAA8D;IAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QACtB,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO;QAC9B,KAAK,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,OAAO,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,OAAO;IAIlB;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAI,IAAY,EAAE,EAAoB,EAAE,OAAqB,EAAE,aAA2B;QACpH,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS;YACvE,OAAO,EAAE,EAAE,CAAC;QAEd,kGAAkG;QAClG,MAAM,MAAM,GAAG,aAAa,KAAK,SAAS;YACxC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE;YACzC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC,CAAC;QAExG,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CACxC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAClC,MAAM,EACN,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAClF,EACD,KAAK,IAAI,EAAE;;YACT,IAAI;gBACF,OAAO,MAAM,EAAE,EAAE,CAAC;aACnB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,GAAG,YAAY,KAAK,EAAE,sDAAsD;oBAC9E,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAC9G,MAAM,GAAG,CAAC;aACX;oBAAS;gBACR,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,GAAG,EAAE,CAAC;aACvF;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,GAAkC;QAClF,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC;QACzB,OAAO,CAAC,cAAc,GAAG,GAAG,CAAC;QAC7B,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7D,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACjE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAiB,EAAE,UAAmB,KAAK;QAC1E,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;;YACrC,IAAI;gBACF,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;aACvK;YAAC,OAAO,EAAE,EAAE,GAAG,CAAC,mHAAmH;YACpI,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,aAAa,CAAC,UAAsB;;QAChD,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAC5G,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport type { Attributes, AttributeValue, ContextAPI, SpanContext, SpanOptions, TraceAPI, Tracer } from \"@opentelemetry/api\";\nimport { LogFunction, Logger } from \"./Logger\";\n\n// re-export so that consumers can construct full SpanOptions object without external dependencies\n/**\n * Mirrors the SpanKind enum from [@opentelemetry/api](https://open-telemetry.github.io/opentelemetry-js-api/enums/spankind)\n * @alpha\n */\nexport enum SpanKind {\n  INTERNAL = 0,\n  SERVER = 1,\n  CLIENT = 2,\n  PRODUCER = 3,\n  CONSUMER = 4\n}\n\nfunction isValidPrimitive(val: unknown): val is AttributeValue {\n  return typeof val === \"string\" || typeof val === \"number\" || typeof val === \"boolean\";\n}\n\n// Only _homogenous_ arrays of strings, numbers, or booleans are supported as OpenTelemetry Attribute values.\n// Per the spec (https://opentelemetry.io/docs/reference/specification/common/common/#attribute), empty arrays and null values are supported too.\nfunction isValidPrimitiveArray(val: unknown): val is AttributeValue {\n  if (!Array.isArray(val))\n    return false;\n\n  let itemType;\n  for (const x of val) {\n    if (x === undefined || x === null)\n      continue;\n\n    if (!itemType) {\n      itemType = typeof x;\n      if (!isValidPrimitive(x))\n        return false;\n    }\n\n    if (typeof x !== itemType)\n      return false;\n  }\n  return true;\n}\n\nfunction isPlainObject(obj: unknown): obj is object {\n  return typeof obj === \"object\" && obj !== null && Object.getPrototypeOf(obj) === Object.prototype;\n}\n\nfunction* getFlatEntries(obj: unknown, path = \"\"): Iterable<[string, AttributeValue]> {\n  if (isValidPrimitiveArray(obj)) {\n    yield [path, obj];\n    return;\n  }\n\n  // Prefer JSON serialization over flattening for any non-POJO types.\n  // There's just too many ways trying to flatten those can go wrong (Dates, Buffers, TypedArrays, etc.)\n  if (!isPlainObject(obj) && !Array.isArray(obj)) {\n    yield [path, isValidPrimitive(obj) ? obj : JSON.stringify(obj)];\n    return;\n  }\n\n  // Always serialize empty objects/arrays as empty array values\n  const entries = Object.entries(obj);\n  if (entries.length === 0)\n    yield [path, []];\n\n  for (const [key, val] of entries)\n    yield* getFlatEntries(val, (path === \"\") ? key : `${path}.${key}`);\n}\n\nfunction flattenObject(obj: object): Attributes {\n  return Object.fromEntries(getFlatEntries(obj));\n}\n\n/**\n * Enables OpenTelemetry tracing in addition to traditional logging.\n * @alpha\n */\nexport class Tracing {\n  private static _tracer?: Tracer;\n  private static _openTelemetry?: { trace: Pick<TraceAPI, \"setSpan\" | \"setSpanContext\" | \"getSpan\">, context: Pick<ContextAPI, \"active\" | \"with\"> };\n\n  /**\n   * If OpenTelemetry tracing is enabled, creates a new span and runs the provided function in it.\n   * If OpenTelemetry tracing is _not_ enabled, runs the provided function.\n   * @param name name of the new span\n   * @param fn function to run inside the new span\n   * @param options span options\n   * @param parentContext optional context used to retrieve parent span id\n   */\n  public static async withSpan<T>(name: string, fn: () => Promise<T>, options?: SpanOptions, parentContext?: SpanContext): Promise<T> {\n    if (Tracing._tracer === undefined || Tracing._openTelemetry === undefined)\n      return fn();\n\n    // this case is for context propagation - parentContext is typically constructed from HTTP headers\n    const parent = parentContext === undefined\n      ? Tracing._openTelemetry.context.active()\n      : Tracing._openTelemetry.trace.setSpanContext(Tracing._openTelemetry.context.active(), parentContext);\n\n    return Tracing._openTelemetry.context.with(\n      Tracing._openTelemetry.trace.setSpan(\n        parent,\n        Tracing._tracer.startSpan(name, options, Tracing._openTelemetry.context.active())\n      ),\n      async () => {\n        try {\n          return await fn();\n        } catch (err) {\n          if (err instanceof Error) // ignore non-Error throws, such as RpcControlResponse\n            Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.setAttribute(\"error\", true);\n          throw err;\n        } finally {\n          Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.end();\n        }\n      },\n    );\n  }\n\n  /**\n   * Enable logging to OpenTelemetry. [[Tracing.withSpan]] will be enabled, all log entries will be attached to active span as span events.\n   * [[IModelHost.startup]] will call this automatically if it succeeds in requiring `@opentelemetry/api`.\n   * @note Node.js OpenTelemetry SDK should be initialized by the user.\n   */\n  public static enableOpenTelemetry(tracer: Tracer, api: typeof Tracing._openTelemetry) {\n    Tracing._tracer = tracer;\n    Tracing._openTelemetry = api;\n    Logger.logTrace = Tracing.withOpenTelemetry(Logger.logTrace);\n    Logger.logInfo = Tracing.withOpenTelemetry(Logger.logInfo);\n    Logger.logWarning = Tracing.withOpenTelemetry(Logger.logWarning);\n    Logger.logError = Tracing.withOpenTelemetry(Logger.logError);\n  }\n\n  private static withOpenTelemetry(base: LogFunction, isError: boolean = false): LogFunction {\n    return (category, message, metaData) => {\n      try {\n        Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.addEvent(message, { ...flattenObject(Logger.getMetaData(metaData)), error: isError });\n      } catch (_e) { } // avoid throwing random errors (with stack trace mangled by async hooks) when openTelemetry collector doesn't work\n      base(category, message, metaData);\n    };\n  }\n\n  /** Set attributes on currently active openTelemetry span. Doesn't do anything if openTelemetry logging is not initialized.\n   * @param attributes  The attributes to set\n   */\n  public static setAttributes(attributes: Attributes) {\n    Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.setAttributes(attributes);\n  }\n}\n"]}
+{"version":3,"file":"Tracing.js","sourceRoot":"","sources":["../../src/Tracing.ts"],"names":[],"mappings":"AAKA,OAAO,EAAe,MAAM,EAAE,MAAM,UAAU,CAAC;AAE/C,kGAAkG;AAClG;;;GAGG;AACH,MAAM,CAAN,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,+CAAY,CAAA;IACZ,2CAAU,CAAA;IACV,2CAAU,CAAA;IACV,+CAAY,CAAA;IACZ,+CAAY,CAAA;AACd,CAAC,EANW,QAAQ,KAAR,QAAQ,QAMnB;AAED,SAAS,gBAAgB,CAAC,GAAY;IACpC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,SAAS,CAAC;AACxF,CAAC;AAED,6GAA6G;AAC7G,iJAAiJ;AACjJ,SAAS,qBAAqB,CAAC,GAAY;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACrB,OAAO,KAAK,CAAC;IAEf,IAAI,QAAQ,CAAC;IACb,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI;YAC/B,SAAS;QAEX,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,GAAG,OAAO,CAAC,CAAC;YACpB,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBACtB,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,OAAO,CAAC,KAAK,QAAQ;YACvB,OAAO,KAAK,CAAC;KAChB;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,GAAY;IACjC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,SAAS,CAAC;AACpG,CAAC;AAED,QAAQ,CAAC,CAAC,cAAc,CAAC,GAAY,EAAE,IAAI,GAAG,EAAE;IAC9C,IAAI,qBAAqB,CAAC,GAAG,CAAC,EAAE;QAC9B,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAClB,OAAO;KACR;IAED,oEAAoE;IACpE,sGAAsG;IACtG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC9C,MAAM,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,OAAO;KACR;IAED,8DAA8D;IAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QACtB,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAEnB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO;QAC9B,KAAK,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,OAAO,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,OAAO;IAIlB;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAI,IAAY,EAAE,EAAoB,EAAE,OAAqB,EAAE,aAA2B;QACpH,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS;YACvE,OAAO,EAAE,EAAE,CAAC;QAEd,kGAAkG;QAClG,MAAM,MAAM,GAAG,aAAa,KAAK,SAAS;YACxC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE;YACzC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC,CAAC;QAExG,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CACxC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAClC,MAAM,EACN,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAClF,EACD,KAAK,IAAI,EAAE;;YACT,IAAI;gBACF,OAAO,MAAM,EAAE,EAAE,CAAC;aACnB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,GAAG,YAAY,KAAK,EAAE,sDAAsD;oBAC9E,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAC9G,MAAM,GAAG,CAAC;aACX;oBAAS;gBACR,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,GAAG,EAAE,CAAC;aACvF;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,GAAkC;QAClF,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC;QACzB,OAAO,CAAC,cAAc,GAAG,GAAG,CAAC;QAC7B,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7D,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACjE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAiB,EAAE,UAAmB,KAAK;QAC1E,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;;YACrC,IAAI;gBACF,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;aACvK;YAAC,OAAO,EAAE,EAAE,GAAG,CAAC,mHAAmH;YACpI,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,aAAa,CAAC,UAAsB;;QAChD,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,0CAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAC5G,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport type { Attributes, AttributeValue, ContextAPI, SpanContext, SpanOptions, TraceAPI, Tracer } from \"@opentelemetry/api\";\r\nimport { LogFunction, Logger } from \"./Logger\";\r\n\r\n// re-export so that consumers can construct full SpanOptions object without external dependencies\r\n/**\r\n * Mirrors the SpanKind enum from [@opentelemetry/api](https://open-telemetry.github.io/opentelemetry-js-api/enums/spankind)\r\n * @alpha\r\n */\r\nexport enum SpanKind {\r\n  INTERNAL = 0,\r\n  SERVER = 1,\r\n  CLIENT = 2,\r\n  PRODUCER = 3,\r\n  CONSUMER = 4\r\n}\r\n\r\nfunction isValidPrimitive(val: unknown): val is AttributeValue {\r\n  return typeof val === \"string\" || typeof val === \"number\" || typeof val === \"boolean\";\r\n}\r\n\r\n// Only _homogenous_ arrays of strings, numbers, or booleans are supported as OpenTelemetry Attribute values.\r\n// Per the spec (https://opentelemetry.io/docs/reference/specification/common/common/#attribute), empty arrays and null values are supported too.\r\nfunction isValidPrimitiveArray(val: unknown): val is AttributeValue {\r\n  if (!Array.isArray(val))\r\n    return false;\r\n\r\n  let itemType;\r\n  for (const x of val) {\r\n    if (x === undefined || x === null)\r\n      continue;\r\n\r\n    if (!itemType) {\r\n      itemType = typeof x;\r\n      if (!isValidPrimitive(x))\r\n        return false;\r\n    }\r\n\r\n    if (typeof x !== itemType)\r\n      return false;\r\n  }\r\n  return true;\r\n}\r\n\r\nfunction isPlainObject(obj: unknown): obj is object {\r\n  return typeof obj === \"object\" && obj !== null && Object.getPrototypeOf(obj) === Object.prototype;\r\n}\r\n\r\nfunction* getFlatEntries(obj: unknown, path = \"\"): Iterable<[string, AttributeValue]> {\r\n  if (isValidPrimitiveArray(obj)) {\r\n    yield [path, obj];\r\n    return;\r\n  }\r\n\r\n  // Prefer JSON serialization over flattening for any non-POJO types.\r\n  // There's just too many ways trying to flatten those can go wrong (Dates, Buffers, TypedArrays, etc.)\r\n  if (!isPlainObject(obj) && !Array.isArray(obj)) {\r\n    yield [path, isValidPrimitive(obj) ? obj : JSON.stringify(obj)];\r\n    return;\r\n  }\r\n\r\n  // Always serialize empty objects/arrays as empty array values\r\n  const entries = Object.entries(obj);\r\n  if (entries.length === 0)\r\n    yield [path, []];\r\n\r\n  for (const [key, val] of entries)\r\n    yield* getFlatEntries(val, (path === \"\") ? key : `${path}.${key}`);\r\n}\r\n\r\nfunction flattenObject(obj: object): Attributes {\r\n  return Object.fromEntries(getFlatEntries(obj));\r\n}\r\n\r\n/**\r\n * Enables OpenTelemetry tracing in addition to traditional logging.\r\n * @alpha\r\n */\r\nexport class Tracing {\r\n  private static _tracer?: Tracer;\r\n  private static _openTelemetry?: { trace: Pick<TraceAPI, \"setSpan\" | \"setSpanContext\" | \"getSpan\">, context: Pick<ContextAPI, \"active\" | \"with\"> };\r\n\r\n  /**\r\n   * If OpenTelemetry tracing is enabled, creates a new span and runs the provided function in it.\r\n   * If OpenTelemetry tracing is _not_ enabled, runs the provided function.\r\n   * @param name name of the new span\r\n   * @param fn function to run inside the new span\r\n   * @param options span options\r\n   * @param parentContext optional context used to retrieve parent span id\r\n   */\r\n  public static async withSpan<T>(name: string, fn: () => Promise<T>, options?: SpanOptions, parentContext?: SpanContext): Promise<T> {\r\n    if (Tracing._tracer === undefined || Tracing._openTelemetry === undefined)\r\n      return fn();\r\n\r\n    // this case is for context propagation - parentContext is typically constructed from HTTP headers\r\n    const parent = parentContext === undefined\r\n      ? Tracing._openTelemetry.context.active()\r\n      : Tracing._openTelemetry.trace.setSpanContext(Tracing._openTelemetry.context.active(), parentContext);\r\n\r\n    return Tracing._openTelemetry.context.with(\r\n      Tracing._openTelemetry.trace.setSpan(\r\n        parent,\r\n        Tracing._tracer.startSpan(name, options, Tracing._openTelemetry.context.active())\r\n      ),\r\n      async () => {\r\n        try {\r\n          return await fn();\r\n        } catch (err) {\r\n          if (err instanceof Error) // ignore non-Error throws, such as RpcControlResponse\r\n            Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.setAttribute(\"error\", true);\r\n          throw err;\r\n        } finally {\r\n          Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.end();\r\n        }\r\n      },\r\n    );\r\n  }\r\n\r\n  /**\r\n   * Enable logging to OpenTelemetry. [[Tracing.withSpan]] will be enabled, all log entries will be attached to active span as span events.\r\n   * [[IModelHost.startup]] will call this automatically if it succeeds in requiring `@opentelemetry/api`.\r\n   * @note Node.js OpenTelemetry SDK should be initialized by the user.\r\n   */\r\n  public static enableOpenTelemetry(tracer: Tracer, api: typeof Tracing._openTelemetry) {\r\n    Tracing._tracer = tracer;\r\n    Tracing._openTelemetry = api;\r\n    Logger.logTrace = Tracing.withOpenTelemetry(Logger.logTrace);\r\n    Logger.logInfo = Tracing.withOpenTelemetry(Logger.logInfo);\r\n    Logger.logWarning = Tracing.withOpenTelemetry(Logger.logWarning);\r\n    Logger.logError = Tracing.withOpenTelemetry(Logger.logError);\r\n  }\r\n\r\n  private static withOpenTelemetry(base: LogFunction, isError: boolean = false): LogFunction {\r\n    return (category, message, metaData) => {\r\n      try {\r\n        Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.addEvent(message, { ...flattenObject(Logger.getMetaData(metaData)), error: isError });\r\n      } catch (_e) { } // avoid throwing random errors (with stack trace mangled by async hooks) when openTelemetry collector doesn't work\r\n      base(category, message, metaData);\r\n    };\r\n  }\r\n\r\n  /** Set attributes on currently active openTelemetry span. Doesn't do anything if openTelemetry logging is not initialized.\r\n   * @param attributes  The attributes to set\r\n   */\r\n  public static setAttributes(attributes: Attributes) {\r\n    Tracing._openTelemetry?.trace.getSpan(Tracing._openTelemetry.context.active())?.setAttributes(attributes);\r\n  }\r\n}\r\n"]}

package/lib/esm/UnexpectedErrors.d.ts

@@ -1,44 +1,44 @@
-/** @packageDocumentation
- * @module Errors
- */
-/// <reference types="node" />
-/** A function to be notified when an unexpected error happens
- * @public
- */
-export declare type OnUnexpectedError = (error: any) => void;
-/**
- * Utility for handling/reporting unexpected runtime errors. This class establishes a global handler for
- * unexpected errors, and programmers should use its `handle` method when they occur. Generally, unexpected
- * errors should not cause program termination, and should instead be logged and swallowed. However, for
- * development/debugging, it can be helpful to re-throw exceptions so they are not missed.
- * @public
- */
-export declare class UnexpectedErrors {
-    /** handler for re-throwing exceptions directly */
-    static readonly reThrowImmediate: (e: any) => never;
-    /** handler for re-throwing exceptions from an asynchronous interval (so the current call stack is not aborted) */
-    static readonly reThrowDeferred: (e: any) => NodeJS.Timeout;
-    /** handler for logging exception to console */
-    static readonly consoleLog: (e: any) => void;
-    /** handler for logging exception with [[Logger]] */
-    static readonly errorLog: (e: any) => void;
-    private static _telemetry;
-    private static _handler;
-    private constructor();
-    /** Add a "telemetry tracker" for unexpected errors. Useful for tracking/reporting errors without changing handler.
-     * @returns a method to remove the tracker
-     */
-    static addTelemetry(tracker: OnUnexpectedError): () => void;
-    /** call this method when an unexpected error happens so the global handler can process it.
-     * @param error the unexpected error
-     * @param notifyTelemetry if false, don't notify telemetry trackers. Use this for exceptions from third-party code, for example.
-     */
-    static handle(error: any, notifyTelemetry?: boolean): void;
-    /** establish a new global *unexpected error* handler.
-     * @param handler the new global handler. You may provide your own function or use one of the static members of this class.
-     * The default is [[errorLog]].
-     * @returns the previous handler. Useful to temporarily change the handler.
-     */
-    static setHandler(handler: OnUnexpectedError): OnUnexpectedError;
-}
+/** @packageDocumentation
+ * @module Errors
+ */
+/// <reference types="node" />
+/** A function to be notified when an unexpected error happens
+ * @public
+ */
+export declare type OnUnexpectedError = (error: any) => void;
+/**
+ * Utility for handling/reporting unexpected runtime errors. This class establishes a global handler for
+ * unexpected errors, and programmers should use its `handle` method when they occur. Generally, unexpected
+ * errors should not cause program termination, and should instead be logged and swallowed. However, for
+ * development/debugging, it can be helpful to re-throw exceptions so they are not missed.
+ * @public
+ */
+export declare class UnexpectedErrors {
+    /** handler for re-throwing exceptions directly */
+    static readonly reThrowImmediate: (e: any) => never;
+    /** handler for re-throwing exceptions from an asynchronous interval (so the current call stack is not aborted) */
+    static readonly reThrowDeferred: (e: any) => NodeJS.Timeout;
+    /** handler for logging exception to console */
+    static readonly consoleLog: (e: any) => void;
+    /** handler for logging exception with [[Logger]] */
+    static readonly errorLog: (e: any) => void;
+    private static _telemetry;
+    private static _handler;
+    private constructor();
+    /** Add a "telemetry tracker" for unexpected errors. Useful for tracking/reporting errors without changing handler.
+     * @returns a method to remove the tracker
+     */
+    static addTelemetry(tracker: OnUnexpectedError): () => void;
+    /** call this method when an unexpected error happens so the global handler can process it.
+     * @param error the unexpected error
+     * @param notifyTelemetry if false, don't notify telemetry trackers. Use this for exceptions from third-party code, for example.
+     */
+    static handle(error: any, notifyTelemetry?: boolean): void;
+    /** establish a new global *unexpected error* handler.
+     * @param handler the new global handler. You may provide your own function or use one of the static members of this class.
+     * The default is [[errorLog]].
+     * @returns the previous handler. Useful to temporarily change the handler.
+     */
+    static setHandler(handler: OnUnexpectedError): OnUnexpectedError;
+}
 //# sourceMappingURL=UnexpectedErrors.d.ts.map

package/lib/esm/UnexpectedErrors.js

@@ -1,62 +1,62 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Errors
- */
-var _a;
-import { Logger } from "./Logger";
-/**
- * Utility for handling/reporting unexpected runtime errors. This class establishes a global handler for
- * unexpected errors, and programmers should use its `handle` method when they occur. Generally, unexpected
- * errors should not cause program termination, and should instead be logged and swallowed. However, for
- * development/debugging, it can be helpful to re-throw exceptions so they are not missed.
- * @public
- */
-export class UnexpectedErrors {
-    constructor() { } // this is a singleton
-    /** Add a "telemetry tracker" for unexpected errors. Useful for tracking/reporting errors without changing handler.
-     * @returns a method to remove the tracker
-     */
-    static addTelemetry(tracker) {
-        this._telemetry.push(tracker);
-        return () => this._telemetry.splice(this._telemetry.indexOf(tracker), 1);
-    }
-    /** call this method when an unexpected error happens so the global handler can process it.
-     * @param error the unexpected error
-     * @param notifyTelemetry if false, don't notify telemetry trackers. Use this for exceptions from third-party code, for example.
-     */
-    static handle(error, notifyTelemetry = true) {
-        this._handler(error);
-        if (notifyTelemetry)
-            this._telemetry.forEach((telemetry) => {
-                try {
-                    telemetry(error);
-                }
-                catch (_) { } // ignore errors from telemetry trackers
-            });
-    }
-    /** establish a new global *unexpected error* handler.
-     * @param handler the new global handler. You may provide your own function or use one of the static members of this class.
-     * The default is [[errorLog]].
-     * @returns the previous handler. Useful to temporarily change the handler.
-     */
-    static setHandler(handler) {
-        const oldHandler = this._handler;
-        this._handler = handler;
-        return oldHandler;
-    }
-}
-_a = UnexpectedErrors;
-/** handler for re-throwing exceptions directly */
-UnexpectedErrors.reThrowImmediate = (e) => { throw e; };
-/** handler for re-throwing exceptions from an asynchronous interval (so the current call stack is not aborted) */
-UnexpectedErrors.reThrowDeferred = (e) => setTimeout(() => { throw e; }, 0);
-/** handler for logging exception to console */
-UnexpectedErrors.consoleLog = (e) => console.error(e); // eslint-disable-line no-console
-/** handler for logging exception with [[Logger]] */
-UnexpectedErrors.errorLog = (e) => Logger.logException("unhandled", e);
-UnexpectedErrors._telemetry = [];
-UnexpectedErrors._handler = _a.errorLog; // default to error logging
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Errors
+ */
+var _a;
+import { Logger } from "./Logger";
+/**
+ * Utility for handling/reporting unexpected runtime errors. This class establishes a global handler for
+ * unexpected errors, and programmers should use its `handle` method when they occur. Generally, unexpected
+ * errors should not cause program termination, and should instead be logged and swallowed. However, for
+ * development/debugging, it can be helpful to re-throw exceptions so they are not missed.
+ * @public
+ */
+export class UnexpectedErrors {
+    constructor() { } // this is a singleton
+    /** Add a "telemetry tracker" for unexpected errors. Useful for tracking/reporting errors without changing handler.
+     * @returns a method to remove the tracker
+     */
+    static addTelemetry(tracker) {
+        this._telemetry.push(tracker);
+        return () => this._telemetry.splice(this._telemetry.indexOf(tracker), 1);
+    }
+    /** call this method when an unexpected error happens so the global handler can process it.
+     * @param error the unexpected error
+     * @param notifyTelemetry if false, don't notify telemetry trackers. Use this for exceptions from third-party code, for example.
+     */
+    static handle(error, notifyTelemetry = true) {
+        this._handler(error);
+        if (notifyTelemetry)
+            this._telemetry.forEach((telemetry) => {
+                try {
+                    telemetry(error);
+                }
+                catch (_) { } // ignore errors from telemetry trackers
+            });
+    }
+    /** establish a new global *unexpected error* handler.
+     * @param handler the new global handler. You may provide your own function or use one of the static members of this class.
+     * The default is [[errorLog]].
+     * @returns the previous handler. Useful to temporarily change the handler.
+     */
+    static setHandler(handler) {
+        const oldHandler = this._handler;
+        this._handler = handler;
+        return oldHandler;
+    }
+}
+_a = UnexpectedErrors;
+/** handler for re-throwing exceptions directly */
+UnexpectedErrors.reThrowImmediate = (e) => { throw e; };
+/** handler for re-throwing exceptions from an asynchronous interval (so the current call stack is not aborted) */
+UnexpectedErrors.reThrowDeferred = (e) => setTimeout(() => { throw e; }, 0);
+/** handler for logging exception to console */
+UnexpectedErrors.consoleLog = (e) => console.error(e); // eslint-disable-line no-console
+/** handler for logging exception with [[Logger]] */
+UnexpectedErrors.errorLog = (e) => Logger.logException("unhandled", e);
+UnexpectedErrors._telemetry = [];
+UnexpectedErrors._handler = _a.errorLog; // default to error logging
 //# sourceMappingURL=UnexpectedErrors.js.map

package/lib/esm/UnexpectedErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"UnexpectedErrors.js","sourceRoot":"","sources":["../../src/UnexpectedErrors.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAOlC;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IAY3B,gBAAwB,CAAC,CAAC,sBAAsB;IAEhD;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,OAA0B;QACnD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,KAAU,EAAE,eAAe,GAAG,IAAI;QACrD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrB,IAAI,eAAe;YACjB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACpC,IAAI;oBAAE,SAAS,CAAC,KAAK,CAAC,CAAC;iBAAE;gBAAC,OAAO,CAAC,EAAE,GAAG,CAAC,wCAAwC;YAClF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,OAA0B;QACjD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,OAAO,UAAU,CAAC;IACpB,CAAC;;;AA1CD,kDAAkD;AAC3B,iCAAgB,GAAG,CAAC,CAAM,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAE,CAAA;AACnE,kHAAkH;AAC3F,gCAAe,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAE,CAAA;AACvF,+CAA+C;AACxB,2BAAU,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAE,CAAA,CAAC,iCAAiC;AACnG,oDAAoD;AAC7B,yBAAQ,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAE,CAAA;AAEnE,2BAAU,GAAwB,EAAG,CAAA;AACrC,yBAAQ,GAAG,EAAI,CAAC,QAAS,CAAA,CAAC,2BAA2B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Errors\n */\n\nimport { Logger } from \"./Logger\";\n\n/** A function to be notified when an unexpected error happens\n * @public\n */\nexport type OnUnexpectedError = (error: any) => void;\n\n/**\n * Utility for handling/reporting unexpected runtime errors. This class establishes a global handler for\n * unexpected errors, and programmers should use its `handle` method when they occur. Generally, unexpected\n * errors should not cause program termination, and should instead be logged and swallowed. However, for\n * development/debugging, it can be helpful to re-throw exceptions so they are not missed.\n * @public\n */\nexport class UnexpectedErrors {\n  /** handler for re-throwing exceptions directly */\n  public static readonly reThrowImmediate = (e: any) => { throw e; };\n  /** handler for re-throwing exceptions from an asynchronous interval (so the current call stack is not aborted) */\n  public static readonly reThrowDeferred = (e: any) => setTimeout(() => { throw e; }, 0);\n  /** handler for logging exception to console */\n  public static readonly consoleLog = (e: any) => console.error(e); // eslint-disable-line no-console\n  /** handler for logging exception with [[Logger]] */\n  public static readonly errorLog = (e: any) => Logger.logException(\"unhandled\", e);\n\n  private static _telemetry: OnUnexpectedError[] = [];\n  private static _handler = this.errorLog; // default to error logging\n  private constructor() { } // this is a singleton\n\n  /** Add a \"telemetry tracker\" for unexpected errors. Useful for tracking/reporting errors without changing handler.\n   * @returns a method to remove the tracker\n   */\n  public static addTelemetry(tracker: OnUnexpectedError): () => void {\n    this._telemetry.push(tracker);\n    return () => this._telemetry.splice(this._telemetry.indexOf(tracker), 1);\n  }\n\n  /** call this method when an unexpected error happens so the global handler can process it.\n   * @param error the unexpected error\n   * @param notifyTelemetry if false, don't notify telemetry trackers. Use this for exceptions from third-party code, for example.\n   */\n  public static handle(error: any, notifyTelemetry = true): void {\n    this._handler(error);\n    if (notifyTelemetry)\n      this._telemetry.forEach((telemetry) => {\n        try { telemetry(error); } catch (_) { } // ignore errors from telemetry trackers\n      });\n  }\n\n  /** establish a new global *unexpected error* handler.\n   * @param handler the new global handler. You may provide your own function or use one of the static members of this class.\n   * The default is [[errorLog]].\n   * @returns the previous handler. Useful to temporarily change the handler.\n   */\n  public static setHandler(handler: OnUnexpectedError): OnUnexpectedError {\n    const oldHandler = this._handler;\n    this._handler = handler;\n    return oldHandler;\n  }\n}\n"]}
+{"version":3,"file":"UnexpectedErrors.js","sourceRoot":"","sources":["../../src/UnexpectedErrors.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAOlC;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IAY3B,gBAAwB,CAAC,CAAC,sBAAsB;IAEhD;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,OAA0B;QACnD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,KAAU,EAAE,eAAe,GAAG,IAAI;QACrD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrB,IAAI,eAAe;YACjB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACpC,IAAI;oBAAE,SAAS,CAAC,KAAK,CAAC,CAAC;iBAAE;gBAAC,OAAO,CAAC,EAAE,GAAG,CAAC,wCAAwC;YAClF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,OAA0B;QACjD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,OAAO,UAAU,CAAC;IACpB,CAAC;;;AA1CD,kDAAkD;AAC3B,iCAAgB,GAAG,CAAC,CAAM,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAE,CAAA;AACnE,kHAAkH;AAC3F,gCAAe,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAE,CAAA;AACvF,+CAA+C;AACxB,2BAAU,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAE,CAAA,CAAC,iCAAiC;AACnG,oDAAoD;AAC7B,yBAAQ,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAE,CAAA;AAEnE,2BAAU,GAAwB,EAAG,CAAA;AACrC,yBAAQ,GAAG,EAAI,CAAC,QAAS,CAAA,CAAC,2BAA2B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Errors\r\n */\r\n\r\nimport { Logger } from \"./Logger\";\r\n\r\n/** A function to be notified when an unexpected error happens\r\n * @public\r\n */\r\nexport type OnUnexpectedError = (error: any) => void;\r\n\r\n/**\r\n * Utility for handling/reporting unexpected runtime errors. This class establishes a global handler for\r\n * unexpected errors, and programmers should use its `handle` method when they occur. Generally, unexpected\r\n * errors should not cause program termination, and should instead be logged and swallowed. However, for\r\n * development/debugging, it can be helpful to re-throw exceptions so they are not missed.\r\n * @public\r\n */\r\nexport class UnexpectedErrors {\r\n  /** handler for re-throwing exceptions directly */\r\n  public static readonly reThrowImmediate = (e: any) => { throw e; };\r\n  /** handler for re-throwing exceptions from an asynchronous interval (so the current call stack is not aborted) */\r\n  public static readonly reThrowDeferred = (e: any) => setTimeout(() => { throw e; }, 0);\r\n  /** handler for logging exception to console */\r\n  public static readonly consoleLog = (e: any) => console.error(e); // eslint-disable-line no-console\r\n  /** handler for logging exception with [[Logger]] */\r\n  public static readonly errorLog = (e: any) => Logger.logException(\"unhandled\", e);\r\n\r\n  private static _telemetry: OnUnexpectedError[] = [];\r\n  private static _handler = this.errorLog; // default to error logging\r\n  private constructor() { } // this is a singleton\r\n\r\n  /** Add a \"telemetry tracker\" for unexpected errors. Useful for tracking/reporting errors without changing handler.\r\n   * @returns a method to remove the tracker\r\n   */\r\n  public static addTelemetry(tracker: OnUnexpectedError): () => void {\r\n    this._telemetry.push(tracker);\r\n    return () => this._telemetry.splice(this._telemetry.indexOf(tracker), 1);\r\n  }\r\n\r\n  /** call this method when an unexpected error happens so the global handler can process it.\r\n   * @param error the unexpected error\r\n   * @param notifyTelemetry if false, don't notify telemetry trackers. Use this for exceptions from third-party code, for example.\r\n   */\r\n  public static handle(error: any, notifyTelemetry = true): void {\r\n    this._handler(error);\r\n    if (notifyTelemetry)\r\n      this._telemetry.forEach((telemetry) => {\r\n        try { telemetry(error); } catch (_) { } // ignore errors from telemetry trackers\r\n      });\r\n  }\r\n\r\n  /** establish a new global *unexpected error* handler.\r\n   * @param handler the new global handler. You may provide your own function or use one of the static members of this class.\r\n   * The default is [[errorLog]].\r\n   * @returns the previous handler. Useful to temporarily change the handler.\r\n   */\r\n  public static setHandler(handler: OnUnexpectedError): OnUnexpectedError {\r\n    const oldHandler = this._handler;\r\n    this._handler = handler;\r\n    return oldHandler;\r\n  }\r\n}\r\n"]}