@fluidframework/telemetry-utils 2.0.0-internal.5.3.2 → 2.0.0-internal.6.0.0

package/lib/debugLogger.js

@@ -1,108 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { performance } from "@fluidframework/common-utils";
-import { debug as registerDebug } from "debug";
-import { TelemetryLogger, MultiSinkLogger, ChildLogger, } from "./logger";
-/**
- * Implementation of debug logger
- */
-export class DebugLogger extends 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 = registerDebug(namespace);
-        // Create one for errors that is always enabled
-        // It can be silenced by replacing console.error if the debug namespace is not enabled.
-        const debugErr = registerDebug(namespace);
-        debugErr.log = function () {
-            if (debug.enabled) {
-                // if the namespace is enabled, just use the default logger
-                registerDebug.log(...arguments);
-            }
-            else {
-                // other wise, use the console logger (which could be replaced and silenced)
-                console.error(...arguments);
-            }
-        };
-        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 MultiSinkLogger(undefined, properties);
-        multiSinkLogger.addLogger(DebugLogger.create(namespace, this.tryGetBaseLoggerProps(baseLogger)));
-        multiSinkLogger.addLogger(ChildLogger.create(baseLogger, namespace));
-        return multiSinkLogger;
-    }
-    static tryGetBaseLoggerProps(baseLogger) {
-        if (baseLogger instanceof 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(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=${TelemetryLogger.formatTick(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}`);
-    }
-}
-//# sourceMappingURL=debugLogger.js.map

package/lib/debugLogger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"debugLogger.js","sourceRoot":"","sources":["../src/debugLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,KAAK,IAAI,aAAa,EAAa,MAAM,OAAO,CAAC;AAC1D,OAAO,EACN,eAAe,EACf,eAAe,EACf,WAAW,GAEX,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,eAAe;IAgE/C,YACkB,KAAgB,EAChB,QAAmB,EACpC,UAAyC;QAEzC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAJZ,UAAK,GAAL,KAAK,CAAW;QAChB,aAAQ,GAAR,QAAQ,CAAW;IAIrC,CAAC;IArED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CACnB,SAAiB,EACjB,UAAyC;QAEzC,uEAAuE;QACvE,MAAM,KAAK,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAEvC,+CAA+C;QAC/C,uFAAuF;QACvF,MAAM,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAC1C,QAAQ,CAAC,GAAG,GAAG;YACd,IAAI,KAAK,CAAC,OAAO,EAAE;gBAClB,2DAA2D;gBAC3D,aAAa,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;aAChC;iBAAM;gBACN,4EAA4E;gBAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC;aAC5B;QACF,CAAC,CAAC;QACF,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;QAExB,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,gBAAgB,CAC7B,SAAiB,EACjB,UAAiC,EACjC,UAAyC;QAEzC,IAAI,CAAC,UAAU,EAAE;YAChB,OAAO,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SACjD;QAED,MAAM,eAAe,GAAG,IAAI,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACnE,eAAe,CAAC,SAAS,CACxB,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CACrE,CAAC;QACF,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;QAErE,OAAO,eAAe,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,UAAiC;QACrE,IAAI,UAAU,YAAY,eAAe,EAAE;YAC1C,OAAQ,UAAkE,CAAC,UAAU,CAAC;SACtF;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAUD;;;;OAIG;IACI,IAAI,CAAC,KAA0B;QACrC,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,eAAe,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;YACd,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;SAC5D;QACD,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;QAE/B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,GAAG,QAAQ,eAAe,CAAC,UAAU,CAAC,WAAW,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;YACH,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SACnC;QAAC,OAAO,KAAK,EAAE;YACf,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAC;YAC3B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SACnC;QAED,IAAI,OAAO,KAAK,IAAI,EAAE;YACrB,OAAO,GAAG,EAAE,CAAC;SACb;QAED,6CAA6C;QAC7C,IAAI,OAAO,EAAE;YACZ,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;SACtB;QAED,oBAAoB;QACpB,MAAM,CAAC,GAAG,IAAI,IAAI,OAAO,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;IAC/C,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryProperties,\n} from \"@fluidframework/core-interfaces\";\nimport { performance } from \"@fluidframework/common-utils\";\nimport { debug as registerDebug, IDebugger } from \"debug\";\nimport {\n\tTelemetryLogger,\n\tMultiSinkLogger,\n\tChildLogger,\n\tITelemetryLoggerPropertyBags,\n} from \"./logger\";\n\n/**\n * Implementation of debug logger\n */\nexport class DebugLogger extends TelemetryLogger {\n\t/**\n\t * Create debug logger - all events are output to debug npm library\n\t * @param namespace - Telemetry event name prefix to add to all events\n\t * @param properties - Base properties to add to all events\n\t * @param propertyGetters - Getters to add additional properties to all events\n\t */\n\tpublic static create(\n\t\tnamespace: string,\n\t\tproperties?: ITelemetryLoggerPropertyBags,\n\t): TelemetryLogger {\n\t\t// Setup base logger upfront, such that host can disable it (if needed)\n\t\tconst debug = registerDebug(namespace);\n\n\t\t// Create one for errors that is always enabled\n\t\t// It can be silenced by replacing console.error if the debug namespace is not enabled.\n\t\tconst debugErr = registerDebug(namespace);\n\t\tdebugErr.log = function () {\n\t\t\tif (debug.enabled) {\n\t\t\t\t// if the namespace is enabled, just use the default logger\n\t\t\t\tregisterDebug.log(...arguments);\n\t\t\t} else {\n\t\t\t\t// other wise, use the console logger (which could be replaced and silenced)\n\t\t\t\tconsole.error(...arguments);\n\t\t\t}\n\t\t};\n\t\tdebugErr.enabled = true;\n\n\t\treturn new DebugLogger(debug, debugErr, properties);\n\t}\n\n\t/**\n\t * Mix in debug logger with another logger.\n\t * Returned logger will output events to both newly created debug logger, as well as base logger\n\t * @param namespace - Telemetry event name prefix to add to all events\n\t * @param properties - Base properties to add to all events\n\t * @param propertyGetters - Getters to add additional properties to all events\n\t * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.\n\t */\n\tpublic static mixinDebugLogger(\n\t\tnamespace: string,\n\t\tbaseLogger?: ITelemetryBaseLogger,\n\t\tproperties?: ITelemetryLoggerPropertyBags,\n\t): TelemetryLogger {\n\t\tif (!baseLogger) {\n\t\t\treturn DebugLogger.create(namespace, properties);\n\t\t}\n\n\t\tconst multiSinkLogger = new MultiSinkLogger(undefined, properties);\n\t\tmultiSinkLogger.addLogger(\n\t\t\tDebugLogger.create(namespace, this.tryGetBaseLoggerProps(baseLogger)),\n\t\t);\n\t\tmultiSinkLogger.addLogger(ChildLogger.create(baseLogger, namespace));\n\n\t\treturn multiSinkLogger;\n\t}\n\n\tprivate static tryGetBaseLoggerProps(baseLogger?: ITelemetryBaseLogger) {\n\t\tif (baseLogger instanceof TelemetryLogger) {\n\t\t\treturn (baseLogger as any as { properties: ITelemetryLoggerPropertyBags }).properties;\n\t\t}\n\t\treturn undefined;\n\t}\n\n\tconstructor(\n\t\tprivate readonly debug: IDebugger,\n\t\tprivate readonly debugErr: IDebugger,\n\t\tproperties?: ITelemetryLoggerPropertyBags,\n\t) {\n\t\tsuper(undefined, properties);\n\t}\n\n\t/**\n\t * Send an event to debug loggers\n\t *\n\t * @param event - the event to send\n\t */\n\tpublic send(event: ITelemetryBaseEvent): void {\n\t\tconst newEvent: ITelemetryProperties = this.prepareEvent(event);\n\t\tconst isError = newEvent.category === \"error\";\n\t\tlet logger = isError ? this.debugErr : this.debug;\n\n\t\t// Use debug's coloring schema for base of the event\n\t\tconst index = event.eventName.lastIndexOf(TelemetryLogger.eventNamespaceSeparator);\n\t\tconst name = event.eventName.substring(index + 1);\n\t\tif (index > 0) {\n\t\t\tlogger = logger.extend(event.eventName.substring(0, index));\n\t\t}\n\t\tnewEvent.eventName = undefined;\n\n\t\tlet tick = \"\";\n\t\ttick = `tick=${TelemetryLogger.formatTick(performance.now())}`;\n\n\t\t// Extract stack to put it last, but also to avoid escaping '\\n' in it by JSON.stringify below\n\t\tconst stack = newEvent.stack ? newEvent.stack : \"\";\n\t\tnewEvent.stack = undefined;\n\n\t\t// Watch out for circular references - they can come from two sources\n\t\t// 1) error object - we do not control it and should remove it and retry\n\t\t// 2) properties supplied by telemetry caller - that's a bug that should be addressed!\n\t\tlet payload: string;\n\t\ttry {\n\t\t\tpayload = JSON.stringify(newEvent);\n\t\t} catch (error) {\n\t\t\tnewEvent.error = undefined;\n\t\t\tpayload = JSON.stringify(newEvent);\n\t\t}\n\n\t\tif (payload === \"{}\") {\n\t\t\tpayload = \"\";\n\t\t}\n\n\t\t// Force errors out, to help with diagnostics\n\t\tif (isError) {\n\t\t\tlogger.enabled = true;\n\t\t}\n\n\t\t// Print multi-line.\n\t\tlogger(`${name} ${payload} ${tick} ${stack}`);\n\t}\n}\n"]}

package/src/debugLogger.ts

@@ -1,143 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import {
-	ITelemetryBaseEvent,
-	ITelemetryBaseLogger,
-	ITelemetryProperties,
-} from "@fluidframework/core-interfaces";
-import { performance } from "@fluidframework/common-utils";
-import { debug as registerDebug, IDebugger } from "debug";
-import {
-	TelemetryLogger,
-	MultiSinkLogger,
-	ChildLogger,
-	ITelemetryLoggerPropertyBags,
-} from "./logger";
-
-/**
- * Implementation of debug logger
- */
-export class DebugLogger extends TelemetryLogger {
-	/**
-	 * 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
-	 */
-	public static create(
-		namespace: string,
-		properties?: ITelemetryLoggerPropertyBags,
-	): TelemetryLogger {
-		// Setup base logger upfront, such that host can disable it (if needed)
-		const debug = registerDebug(namespace);
-
-		// Create one for errors that is always enabled
-		// It can be silenced by replacing console.error if the debug namespace is not enabled.
-		const debugErr = registerDebug(namespace);
-		debugErr.log = function () {
-			if (debug.enabled) {
-				// if the namespace is enabled, just use the default logger
-				registerDebug.log(...arguments);
-			} else {
-				// other wise, use the console logger (which could be replaced and silenced)
-				console.error(...arguments);
-			}
-		};
-		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.
-	 */
-	public static mixinDebugLogger(
-		namespace: string,
-		baseLogger?: ITelemetryBaseLogger,
-		properties?: ITelemetryLoggerPropertyBags,
-	): TelemetryLogger {
-		if (!baseLogger) {
-			return DebugLogger.create(namespace, properties);
-		}
-
-		const multiSinkLogger = new MultiSinkLogger(undefined, properties);
-		multiSinkLogger.addLogger(
-			DebugLogger.create(namespace, this.tryGetBaseLoggerProps(baseLogger)),
-		);
-		multiSinkLogger.addLogger(ChildLogger.create(baseLogger, namespace));
-
-		return multiSinkLogger;
-	}
-
-	private static tryGetBaseLoggerProps(baseLogger?: ITelemetryBaseLogger) {
-		if (baseLogger instanceof TelemetryLogger) {
-			return (baseLogger as any as { properties: ITelemetryLoggerPropertyBags }).properties;
-		}
-		return undefined;
-	}
-
-	constructor(
-		private readonly debug: IDebugger,
-		private readonly debugErr: IDebugger,
-		properties?: ITelemetryLoggerPropertyBags,
-	) {
-		super(undefined, properties);
-	}
-
-	/**
-	 * Send an event to debug loggers
-	 *
-	 * @param event - the event to send
-	 */
-	public send(event: ITelemetryBaseEvent): void {
-		const newEvent: ITelemetryProperties = 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(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=${TelemetryLogger.formatTick(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: string;
-		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}`);
-	}
-}