@fluidframework/telemetry-utils 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/src/telemetryTypes.ts

@@ -0,0 +1,140 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ITelemetryBaseLogger, LogLevel, Tagged } from "@fluidframework/core-interfaces";
+
+/**
+ * The categories FF uses when instrumenting the code.
+ *
+ * generic - Informational log event
+ *
+ * error - Error log event, ideally 0 of these are logged during a session
+ *
+ * performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking
+ * @public
+ */
+export type TelemetryEventCategory = "generic" | "error" | "performance";
+
+/**
+ * Property types that can be logged.
+ *
+ * @remarks
+ * Includes extra types beyond {@link @fluidframework/core-interfaces#TelemetryBaseEventPropertyType}, which must be
+ * converted before sending to a base logger.
+ * @public
+ */
+export type TelemetryEventPropertyTypeExt =
+	| string
+	| number
+	| boolean
+	| undefined
+	| (string | number | boolean)[]
+	| {
+			[key: string]: // Flat objects can have the same properties as the event itself
+			string | number | boolean | undefined | (string | number | boolean)[];
+	  };
+
+/**
+ * A property to be logged to telemetry containing both the value and a tag. Tags are generic strings that can be used
+ * to mark pieces of information that should be organized or handled differently by loggers in various first or third
+ * party scenarios. For example, tags are used to mark personal information that should not be stored in logs.
+ *
+ * @deprecated Use {@link @fluidframework/core-interfaces#Tagged}\<{@link TelemetryEventPropertyTypeExt}\>
+ * @internal
+ */
+export interface ITaggedTelemetryPropertyTypeExt {
+	value: TelemetryEventPropertyTypeExt;
+	tag: string;
+}
+
+/**
+ * JSON-serializable properties, which will be logged with telemetry.
+ * @public
+ */
+export interface ITelemetryPropertiesExt {
+	[index: string]: TelemetryEventPropertyTypeExt | Tagged<TelemetryEventPropertyTypeExt>;
+}
+
+/**
+ * Interface for logging telemetry statements.
+ * @remarks May contain any number of properties that get serialized as json payload.
+ * @param category - category of the event, like "error", "performance", "generic", etc.
+ * @param eventName - name of the event.
+ *
+ * @internal
+ */
+export interface ITelemetryEventExt extends ITelemetryPropertiesExt {
+	category: string;
+	eventName: string;
+}
+
+/**
+ * Informational (non-error) telemetry event
+ * @remarks Maps to category = "generic"
+ * @public
+ */
+export interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
+	eventName: string;
+	category?: TelemetryEventCategory;
+}
+
+/**
+ * Error telemetry event.
+ * @remarks Maps to category = "error"
+ * @public
+ */
+export interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
+	eventName: string;
+}
+
+/**
+ * Performance telemetry event.
+ * @remarks Maps to category = "performance"
+ * @public
+ */
+export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt {
+	duration?: number; // Duration of event (optional)
+}
+
+/**
+ * An extended {@link @fluidframework/core-interfaces#ITelemetryBaseLogger} which allows for more lenient event types.
+ *
+ * @remarks
+ * This interface is meant to be used internally within the Fluid Framework,
+ * and `ITelemetryBaseLogger` should be used when loggers are passed between layers.
+ * @public
+ */
+export interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
+	/**
+	 * Send information telemetry event
+	 * @param event - Event to send
+	 * @param error - optional error object to log
+	 * @param logLevel - optional level of the log.
+	 */
+	sendTelemetryEvent(
+		event: ITelemetryGenericEventExt,
+		error?: unknown,
+		logLevel?: typeof LogLevel.verbose | typeof LogLevel.default,
+	): void;
+
+	/**
+	 * Send error telemetry event
+	 * @param event - Event to send
+	 * @param error - optional error object to log
+	 */
+	sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
+
+	/**
+	 * Send performance telemetry event
+	 * @param event - Event to send
+	 * @param error - optional error object to log
+	 * @param logLevel - optional level of the log.
+	 */
+	sendPerformanceEvent(
+		event: ITelemetryPerformanceEventExt,
+		error?: unknown,
+		logLevel?: typeof LogLevel.verbose | typeof LogLevel.default,
+	): void;
+}

package/src/thresholdCounter.ts

@@ -3,47 +3,48 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt } from "./telemetryTypes";
 
 /**
- * Utility counter which will send event only if the provided value
- * is above a configured threshold
+ * Utility counter which will send event only if the provided value is above a configured threshold.
+ *
+ * @internal
  */
 export class ThresholdCounter {
-    public constructor(
-        private readonly threshold: number,
-        private readonly logger: ITelemetryLogger,
-        private thresholdMultiple = threshold,
-    ) {}
+	public constructor(
+		private readonly threshold: number,
+		private readonly logger: ITelemetryLoggerExt,
+		private thresholdMultiple = threshold,
+	) {}
 
-    /**
-     * Sends the value if it's above the treshold.
-     */
-    public send(eventName: string, value: number) {
-        if (value < this.threshold) {
-            return;
-        }
-        this.logger.sendPerformanceEvent({
-            eventName,
-            value,
-        });
-    }
+	/**
+	 * Sends the value if it's above the treshold.
+	 */
+	public send(eventName: string, value: number): void {
+		if (value < this.threshold) {
+			return;
+		}
+		this.logger.sendPerformanceEvent({
+			eventName,
+			value,
+		});
+	}
 
-    /**
-     * Sends the value if it's above the treshold
-     * and a multiple of the threshold.
-     *
-     * To be used in scenarios where we'd like to record a
-     * threshold violation while reducing telemetry noise.
-     */
-    public sendIfMultiple(eventName: string, value: number) {
-        if (value === this.thresholdMultiple) {
-            this.logger.sendPerformanceEvent({
-                eventName,
-                value,
-            });
-            // reduce number of "multiple" events.
-            this.thresholdMultiple = this.thresholdMultiple * 2;
-        }
-    }
+	/**
+	 * Sends the value if it's above the threshold
+	 * and a multiple of the threshold.
+	 *
+	 * To be used in scenarios where we'd like to record a
+	 * threshold violation while reducing telemetry noise.
+	 */
+	public sendIfMultiple(eventName: string, value: number): void {
+		if (value === this.thresholdMultiple) {
+			this.logger.sendPerformanceEvent({
+				eventName,
+				value,
+			});
+			// reduce number of "multiple" events.
+			this.thresholdMultiple = this.thresholdMultiple * 2;
+		}
+	}
 }

package/src/utils.ts

@@ -3,30 +3,121 @@
  * Licensed under the MIT License.
  */
 import {
-    ITelemetryBaseEvent,
-    ITelemetryBaseLogger,
-    ITelemetryGenericEvent,
-} from "@fluidframework/common-definitions";
+	ITelemetryBaseEvent,
+	ITelemetryBaseLogger,
+	ITelemetryGenericEvent,
+} from "@fluidframework/core-interfaces";
+import { loggerToMonitoringContext } from "./config";
+import { ITelemetryGenericEventExt, ITelemetryLoggerExt } from "./telemetryTypes";
 
 /**
  * Like assert, but logs only if the condition is false, rather than throwing
  * @param condition - The condition to attest too
  * @param logger - The logger to log with
  * @param event - The string or event to log
- * @returns - The outcome of the condition
+ * @returns The outcome of the condition
+ *
+ * @internal
+ *
+ * @deprecated
+ * This API will be removed in a future release.
+ * No replacement API is intended, but reproducing its behavior should be trivial for anyone who needs it.
  */
 export function logIfFalse(
-    condition: any,
-    logger: ITelemetryBaseLogger,
-    event: string | ITelemetryGenericEvent,
+	condition: unknown,
+	logger: ITelemetryBaseLogger,
+	event: string | ITelemetryGenericEvent,
 ): condition is true {
-    if (condition) {
-        return true;
-    }
-    const newEvent: ITelemetryBaseEvent =
-        typeof event === "string"
-        ? { eventName: event, category: "error" }
-        : { category: "error", ...event };
-    logger.send(newEvent);
-    return false;
+	if (condition) {
+		return true;
+	}
+	const newEvent: ITelemetryBaseEvent =
+		typeof event === "string"
+			? { eventName: event, category: "error" }
+			: { category: "error", ...event };
+	logger.send(newEvent);
+	return false;
+}
+
+/**
+ * An object that contains a callback used in conjunction with the {@link createSampledLogger} utility function to provide custom logic for sampling events.
+ *
+ * @internal
+ */
+export interface IEventSampler {
+	/**
+	 * @returns true if the event should be sampled or false if not
+	 */
+	sample: () => boolean | undefined;
+}
+
+/**
+ * A telemetry logger that has sampling capabilities
+ *
+ * @internal
+ */
+export interface ISampledTelemetryLogger extends ITelemetryLoggerExt {
+	/**
+	 * Indicates if the feature flag to disable sampling is set.
+	 *
+	 * @remarks Exposed to enable some advanced scenarios where the code using the sampled logger
+	 * could take advantage of skipping the execution of some logic when it can determine
+	 * it won't be necessary because the telemetry event that needs it wouldn't be
+	 * emitted anyway.
+	 */
+	isSamplingDisabled: boolean;
+}
+
+/**
+ * Wraps around an existing logger matching the {@link ITelemetryLoggerExt} interface and provides the ability to only log a subset of events using a sampling strategy provided by an ${@link IEventSampler}.
+ * You can chose to not provide an event sampler which is effectively a no-op, meaning that it will be treated as if the sampler always returns true.
+ *
+ * @remarks
+ * The sampling functionality uses the Fluid telemetry logging configuration along with the optionally provided event sampling callback to determine whether an event should
+ * be logged or not.
+ *
+ * Configuration object parameters:
+ * 'Fluid.Telemetry.DisableSampling': if this config value is set to true, all events will be unsampled and therefore logged.
+ * Otherwise only a sample will be logged according to the provided event sampler callback.
+ *
+ * Note that the same sampler is used for all APIs of the returned logger. If you want separate events flowing through the returned logger to be sampled separately, the {@link IEventSampler} you provide should track them separately.
+ *
+ * @internal
+ */
+export function createSampledLogger(
+	logger: ITelemetryLoggerExt,
+	eventSampler?: IEventSampler,
+): ISampledTelemetryLogger {
+	const monitoringContext = loggerToMonitoringContext(logger);
+	const isSamplingDisabled =
+		monitoringContext.config.getBoolean("Fluid.Telemetry.DisableSampling") ?? false;
+
+	const sampledLogger = {
+		send: (event: ITelemetryBaseEvent): void => {
+			// The sampler uses the following logic for sending events:
+			// 1. If isSamplingDisabled is true, then this means events should be unsampled. Therefore we send the event without any checks.
+			// 2. If isSamplingDisabled is false, then event should be sampled using the event sampler, if the sampler is not defined just send all events, other use the eventSampler.sample() method.
+			if (isSamplingDisabled || eventSampler === undefined || eventSampler.sample()) {
+				logger.send(event);
+			}
+		},
+		sendTelemetryEvent: (event: ITelemetryGenericEventExt): void => {
+			if (isSamplingDisabled || eventSampler === undefined || eventSampler.sample()) {
+				logger.sendTelemetryEvent(event);
+			}
+		},
+		sendErrorEvent: (event: ITelemetryGenericEventExt): void => {
+			if (isSamplingDisabled || eventSampler === undefined || eventSampler.sample()) {
+				logger.sendErrorEvent(event);
+			}
+		},
+		sendPerformanceEvent: (event: ITelemetryGenericEventExt): void => {
+			if (isSamplingDisabled || eventSampler === undefined || eventSampler.sample()) {
+				logger.sendPerformanceEvent(event);
+			}
+		},
+		isSamplingDisabled,
+	};
+
+	return sampledLogger;
 }

package/tsconfig.esnext.json

@@ -1,7 +1,7 @@
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

@@ -1,14 +1,10 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "src/test/**/*"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "composite": true
-    },
-    "include": [
-        "src/**/*"
-    ]
-}
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+	},
+	"include": ["src/**/*"],
+}

package/dist/debugLogger.d.ts

@@ -1,39 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger } from "@fluidframework/common-definitions";
-import { IDebugger } from "debug";
-import { TelemetryLogger, ITelemetryLoggerPropertyBags } from "./logger";
-/**
- * Implementation of debug logger
- */
-export declare class DebugLogger extends TelemetryLogger {
-    private readonly debug;
-    private readonly debugErr;
-    /**
-     * Create debug logger - all events are output to debug npm library
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     */
-    static create(namespace: string, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    /**
-     * Mix in debug logger with another logger.
-     * Returned logger will output events to both newly created debug logger, as well as base logger
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.
-     */
-    static mixinDebugLogger(namespace: string, baseLogger?: ITelemetryBaseLogger, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    private static tryGetBaseLoggerProps;
-    constructor(debug: IDebugger, debugErr: IDebugger, properties?: ITelemetryLoggerPropertyBags);
-    /**
-     * Send an event to debug loggers
-     *
-     * @param event - the event to send
-     */
-    send(event: ITelemetryBaseEvent): void;
-}
-//# sourceMappingURL=debugLogger.d.ts.map

package/dist/debugLogger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"debugLogger.d.ts","sourceRoot":"","sources":["../src/debugLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,oBAAoB,EAEvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAA0B,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAgC,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAEvG;;GAEG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAqDxC,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IArD7B;;;;;OAKG;WACW,MAAM,CAChB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,4BAA4B,GAC1C,eAAe;IAWlB;;;;;;;OAOG;WACW,gBAAgB,CAC1B,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,oBAAoB,EACjC,UAAU,CAAC,EAAE,4BAA4B,GAC1C,eAAe;IAYlB,OAAO,CAAC,MAAM,CAAC,qBAAqB;gBAQf,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,SAAS,EACpC,UAAU,CAAC,EAAE,4BAA4B;IAK7C;;;;OAIG;IACI,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;CA2ChD"}

package/dist/debugLogger.js

@@ -1,101 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DebugLogger = void 0;
-const common_utils_1 = require("@fluidframework/common-utils");
-const debug_1 = require("debug");
-const logger_1 = require("./logger");
-/**
- * Implementation of debug logger
- */
-class DebugLogger extends logger_1.TelemetryLogger {
-    constructor(debug, debugErr, properties) {
-        super(undefined, properties);
-        this.debug = debug;
-        this.debugErr = debugErr;
-    }
-    /**
-     * Create debug logger - all events are output to debug npm library
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     */
-    static create(namespace, properties) {
-        // Setup base logger upfront, such that host can disable it (if needed)
-        const debug = (0, debug_1.debug)(namespace);
-        const debugErr = (0, debug_1.debug)(namespace);
-        debugErr.log = console.error.bind(console);
-        debugErr.enabled = true;
-        return new DebugLogger(debug, debugErr, properties);
-    }
-    /**
-     * Mix in debug logger with another logger.
-     * Returned logger will output events to both newly created debug logger, as well as base logger
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.
-     */
-    static mixinDebugLogger(namespace, baseLogger, properties) {
-        if (!baseLogger) {
-            return DebugLogger.create(namespace, properties);
-        }
-        const multiSinkLogger = new logger_1.MultiSinkLogger(undefined, properties);
-        multiSinkLogger.addLogger(DebugLogger.create(namespace, this.tryGetBaseLoggerProps(baseLogger)));
-        multiSinkLogger.addLogger(logger_1.ChildLogger.create(baseLogger, namespace));
-        return multiSinkLogger;
-    }
-    static tryGetBaseLoggerProps(baseLogger) {
-        if (baseLogger instanceof logger_1.TelemetryLogger) {
-            return baseLogger.properties;
-        }
-        return undefined;
-    }
-    /**
-     * Send an event to debug loggers
-     *
-     * @param event - the event to send
-     */
-    send(event) {
-        const newEvent = this.prepareEvent(event);
-        const isError = newEvent.category === "error";
-        let logger = isError ? this.debugErr : this.debug;
-        // Use debug's coloring schema for base of the event
-        const index = event.eventName.lastIndexOf(logger_1.TelemetryLogger.eventNamespaceSeparator);
-        const name = event.eventName.substring(index + 1);
-        if (index > 0) {
-            logger = logger.extend(event.eventName.substring(0, index));
-        }
-        newEvent.eventName = undefined;
-        let tick = "";
-        tick = `tick=${logger_1.TelemetryLogger.formatTick(common_utils_1.performance.now())}`;
-        // Extract stack to put it last, but also to avoid escaping '\n' in it by JSON.stringify below
-        const stack = newEvent.stack ? newEvent.stack : "";
-        newEvent.stack = undefined;
-        // Watch out for circular references - they can come from two sources
-        // 1) error object - we do not control it and should remove it and retry
-        // 2) properties supplied by telemetry caller - that's a bug that should be addressed!
-        let payload;
-        try {
-            payload = JSON.stringify(newEvent);
-        }
-        catch (error) {
-            newEvent.error = undefined;
-            payload = JSON.stringify(newEvent);
-        }
-        if (payload === "{}") {
-            payload = "";
-        }
-        // Force errors out, to help with diagnostics
-        if (isError) {
-            logger.enabled = true;
-        }
-        // Print multi-line.
-        logger(`${name} ${payload} ${tick} ${stack}`);
-    }
-}
-exports.DebugLogger = DebugLogger;
-//# sourceMappingURL=debugLogger.js.map

package/dist/debugLogger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"debugLogger.js","sourceRoot":"","sources":["../src/debugLogger.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,+DAA2D;AAC3D,iCAA0D;AAC1D,qCAAuG;AAEvG;;GAEG;AACH,MAAa,WAAY,SAAQ,wBAAe;IAoD5C,YACqB,KAAgB,EAChB,QAAmB,EACpC,UAAyC;QAEzC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAJZ,UAAK,GAAL,KAAK,CAAW;QAChB,aAAQ,GAAR,QAAQ,CAAW;IAIxC,CAAC;IAzDD;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAChB,SAAiB,EACjB,UAAyC;QAEzC,uEAAuE;QACvE,MAAM,KAAK,GAAG,IAAA,aAAa,EAAC,SAAS,CAAC,CAAC;QAEvC,MAAM,QAAQ,GAAG,IAAA,aAAa,EAAC,SAAS,CAAC,CAAC;QAC1C,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;QAExB,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,gBAAgB,CAC1B,SAAiB,EACjB,UAAiC,EACjC,UAAyC;QAEzC,IAAI,CAAC,UAAU,EAAE;YACb,OAAO,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SACpD;QAED,MAAM,eAAe,GAAG,IAAI,wBAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACnE,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACjG,eAAe,CAAC,SAAS,CAAC,oBAAW,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;QAErE,OAAO,eAAe,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,UAAiC;QAClE,IAAI,UAAU,YAAY,wBAAe,EAAE;YACvC,OAAQ,UAAmE,CAAC,UAAU,CAAC;SAC1F;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAUD;;;;OAIG;IACI,IAAI,CAAC,KAA0B;QAClC,MAAM,QAAQ,GAAyB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,KAAK,OAAO,CAAC;QAC9C,IAAI,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QAElD,oDAAoD;QACpD,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,wBAAe,CAAC,uBAAuB,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAClD,IAAI,KAAK,GAAG,CAAC,EAAE;YACX,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;SAC/D;QACD,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;QAE/B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,GAAG,QAAQ,wBAAe,CAAC,UAAU,CAAC,0BAAW,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;QAE/D,8FAA8F;QAC9F,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAC;QAE3B,qEAAqE;QACrE,wEAAwE;QACxE,sFAAsF;QACtF,IAAI,OAAe,CAAC;QACpB,IAAI;YACA,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACZ,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAC;YAC3B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SACtC;QAED,IAAI,OAAO,KAAK,IAAI,EAAE;YAClB,OAAO,GAAG,EAAE,CAAC;SAChB;QAED,6CAA6C;QAC7C,IAAI,OAAO,EAAE;YACT,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;SACzB;QAED,oBAAoB;QACpB,MAAM,CAAC,GAAG,IAAI,IAAI,OAAO,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;IAClD,CAAC;CACJ;AA5GD,kCA4GC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    ITelemetryBaseEvent,\n    ITelemetryBaseLogger,\n    ITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { performance } from \"@fluidframework/common-utils\";\nimport { debug as registerDebug, IDebugger } from \"debug\";\nimport { TelemetryLogger, MultiSinkLogger, ChildLogger, ITelemetryLoggerPropertyBags } from \"./logger\";\n\n/**\n * Implementation of debug logger\n */\nexport class DebugLogger extends TelemetryLogger {\n    /**\n     * Create debug logger - all events are output to debug npm library\n     * @param namespace - Telemetry event name prefix to add to all events\n     * @param properties - Base properties to add to all events\n     * @param propertyGetters - Getters to add additional properties to all events\n     */\n    public static create(\n        namespace: string,\n        properties?: ITelemetryLoggerPropertyBags,\n    ): TelemetryLogger {\n        // Setup base logger upfront, such that host can disable it (if needed)\n        const debug = registerDebug(namespace);\n\n        const debugErr = registerDebug(namespace);\n        debugErr.log = console.error.bind(console);\n        debugErr.enabled = true;\n\n        return new DebugLogger(debug, debugErr, properties);\n    }\n\n    /**\n     * Mix in debug logger with another logger.\n     * Returned logger will output events to both newly created debug logger, as well as base logger\n     * @param namespace - Telemetry event name prefix to add to all events\n     * @param properties - Base properties to add to all events\n     * @param propertyGetters - Getters to add additional properties to all events\n     * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.\n     */\n    public static mixinDebugLogger(\n        namespace: string,\n        baseLogger?: ITelemetryBaseLogger,\n        properties?: ITelemetryLoggerPropertyBags,\n    ): TelemetryLogger {\n        if (!baseLogger) {\n            return DebugLogger.create(namespace, properties);\n        }\n\n        const multiSinkLogger = new MultiSinkLogger(undefined, properties);\n        multiSinkLogger.addLogger(DebugLogger.create(namespace, this.tryGetBaseLoggerProps(baseLogger)));\n        multiSinkLogger.addLogger(ChildLogger.create(baseLogger, namespace));\n\n        return multiSinkLogger;\n    }\n\n    private static tryGetBaseLoggerProps(baseLogger?: ITelemetryBaseLogger) {\n        if (baseLogger instanceof TelemetryLogger) {\n            return (baseLogger as any as { properties: ITelemetryLoggerPropertyBags; }).properties;\n        }\n        return undefined;\n    }\n\n    constructor(\n        private readonly debug: IDebugger,\n        private readonly debugErr: IDebugger,\n        properties?: ITelemetryLoggerPropertyBags,\n    ) {\n        super(undefined, properties);\n    }\n\n    /**\n     * Send an event to debug loggers\n     *\n     * @param event - the event to send\n     */\n    public send(event: ITelemetryBaseEvent): void {\n        const newEvent: ITelemetryProperties = this.prepareEvent(event);\n        const isError = newEvent.category === \"error\";\n        let logger = isError ? this.debugErr : this.debug;\n\n        // Use debug's coloring schema for base of the event\n        const index = event.eventName.lastIndexOf(TelemetryLogger.eventNamespaceSeparator);\n        const name = event.eventName.substring(index + 1);\n        if (index > 0) {\n            logger = logger.extend(event.eventName.substring(0, index));\n        }\n        newEvent.eventName = undefined;\n\n        let tick = \"\";\n        tick = `tick=${TelemetryLogger.formatTick(performance.now())}`;\n\n        // Extract stack to put it last, but also to avoid escaping '\\n' in it by JSON.stringify below\n        const stack = newEvent.stack ? newEvent.stack : \"\";\n        newEvent.stack = undefined;\n\n        // Watch out for circular references - they can come from two sources\n        // 1) error object - we do not control it and should remove it and retry\n        // 2) properties supplied by telemetry caller - that's a bug that should be addressed!\n        let payload: string;\n        try {\n            payload = JSON.stringify(newEvent);\n        } catch (error) {\n            newEvent.error = undefined;\n            payload = JSON.stringify(newEvent);\n        }\n\n        if (payload === \"{}\") {\n            payload = \"\";\n        }\n\n        // Force errors out, to help with diagnostics\n        if (isError) {\n            logger.enabled = true;\n        }\n\n        // Print multi-line.\n        logger(`${name} ${payload} ${tick} ${stack}`);\n    }\n}\n"]}

package/dist/packageVersion.d.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-export declare const pkgName = "@fluidframework/telemetry-utils";
-export declare const pkgVersion = "1.4.0-121020";
-//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,oCAAoC,CAAC;AACzD,eAAO,MAAM,UAAU,iBAAiB,CAAC"}

package/dist/packageVersion.js

@@ -1,12 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pkgVersion = exports.pkgName = void 0;
-exports.pkgName = "@fluidframework/telemetry-utils";
-exports.pkgVersion = "1.4.0-121020";
-//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,iCAAiC,CAAC;AAC5C,QAAA,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"1.4.0-121020\";\n"]}

package/lib/debugLogger.d.ts

@@ -1,39 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger } from "@fluidframework/common-definitions";
-import { IDebugger } from "debug";
-import { TelemetryLogger, ITelemetryLoggerPropertyBags } from "./logger";
-/**
- * Implementation of debug logger
- */
-export declare class DebugLogger extends TelemetryLogger {
-    private readonly debug;
-    private readonly debugErr;
-    /**
-     * Create debug logger - all events are output to debug npm library
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     */
-    static create(namespace: string, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    /**
-     * Mix in debug logger with another logger.
-     * Returned logger will output events to both newly created debug logger, as well as base logger
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.
-     */
-    static mixinDebugLogger(namespace: string, baseLogger?: ITelemetryBaseLogger, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    private static tryGetBaseLoggerProps;
-    constructor(debug: IDebugger, debugErr: IDebugger, properties?: ITelemetryLoggerPropertyBags);
-    /**
-     * Send an event to debug loggers
-     *
-     * @param event - the event to send
-     */
-    send(event: ITelemetryBaseEvent): void;
-}
-//# sourceMappingURL=debugLogger.d.ts.map

package/lib/debugLogger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"debugLogger.d.ts","sourceRoot":"","sources":["../src/debugLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,oBAAoB,EAEvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAA0B,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAgC,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAEvG;;GAEG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAqDxC,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IArD7B;;;;;OAKG;WACW,MAAM,CAChB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,4BAA4B,GAC1C,eAAe;IAWlB;;;;;;;OAOG;WACW,gBAAgB,CAC1B,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,oBAAoB,EACjC,UAAU,CAAC,EAAE,4BAA4B,GAC1C,eAAe;IAYlB,OAAO,CAAC,MAAM,CAAC,qBAAqB;gBAQf,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,SAAS,EACpC,UAAU,CAAC,EAAE,4BAA4B;IAK7C;;;;OAIG;IACI,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;CA2ChD"}