@fluidframework/fluid-runner 2.0.0-internal.1.2.1 → 2.0.0-internal.1.2.2

package/README.md

@@ -31,10 +31,35 @@ fluidRunner({ /* IFluidFileConverter implementation here */ });
 The input file is expected to be an ODSP snapshot.
 For some examples, see the files in the [localOdspSnapshots folder](./src/test/localOdspSnapshots).
 
+### Telemetry format
+There is an optional command line option `telemetryFormat` that allows you to specify the telemetry output format. The naming provided to this option is strict and must match an option in [OutputFormat](./src/logger/fileLogger.ts).
+The default format is currently `JSON`
+
+### Additional telemetry properties
+There is an optional command line option `telemetryProp` that allows you to specify additional properties that will be added to every telemetry entry. The format follows these rules:
+- every key must be a string
+- values may be either a string or a number
+- a value may not be empty
+
+Example of valid usages:
+```
+--telemetryProp prop1 value1 --telemetryProp prop2 10.5
+--telemetryProp "  prop1 " "   value1 " prop2 value2
+--telemetryProp=prop1 value1 --telemetryProp prop2 value2
+--telemetryProp
+```
+
+Example of invalid usages:
+```
+--telemetryProp "10" value1
+--telemetryProp prop1
+--telemetryProp=             // this will be treated as ['']
+```
+
 ### Consumption
 The code around `exportFile` can be consumed in multiple different layers. It is not necessary to run all this code fully as is, and the following are some interesting code bits involved in this workflow:
-- [`createLogger(...)`](./src/logger/FileLogger.ts)
-    - Wraps a provided `FileLogger` and adds some useful telemetry data to every entry
+- [`createLogger(...)`](./src/logger/fileLogger.ts)
+    - Creates and wraps an `IFileLogger` and adds some useful telemetry data to every entry
 - [`createContainerAndExecute(...)`](./src/exportFile.ts)
     - This is the core logic for running some action based on a local ODSP snapshot
 - [`getSnapshotFileContent(...)`](./src/utils.ts)

package/dist/exportFile.d.ts

@@ -4,6 +4,7 @@
  */
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IFluidFileConverter } from "./codeLoaderBundle";
+import { ITelemetryOptions } from "./logger/fileLogger";
 export declare type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;
 interface IExportFileResponseSuccess {
     success: true;
@@ -17,7 +18,7 @@ interface IExportFileResponseFailure {
 /**
  * Execute code on Container based on ODSP snapshot and write result to file
  */
-export declare function exportFile(fluidFileConverter: IFluidFileConverter, inputFile: string, outputFile: string, telemetryFile: string, options?: string): Promise<IExportFileResponse>;
+export declare function exportFile(fluidFileConverter: IFluidFileConverter, inputFile: string, outputFile: string, telemetryFile: string, options?: string, telemetryOptions?: ITelemetryOptions): Promise<IExportFileResponse>;
 /**
  * Create the container based on an ODSP snapshot and execute code on it
  * @returns result of execution

package/dist/exportFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exportFile.d.ts","sourceRoot":"","sources":["../src/exportFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAMtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAMzD,oBAAY,mBAAmB,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAE1F,UAAU,0BAA0B;IAChC,OAAO,EAAE,IAAI,CAAC;CACjB;AAED,UAAU,0BAA0B;IAChC,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAID;;GAEG;AACH,wBAAsB,UAAU,CAC5B,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,mBAAmB,CAAC,CAkC9B;AAED;;;GAGG;AACH,wBAAsB,yBAAyB,CAC3C,iBAAiB,EAAE,MAAM,GAAG,UAAU,EACtC,kBAAkB,EAAE,mBAAmB,EACvC,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,CAcjB"}
+{"version":3,"file":"exportFile.d.ts","sourceRoot":"","sources":["../src/exportFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAMtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAIzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,oBAAY,mBAAmB,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAE1F,UAAU,0BAA0B;IAChC,OAAO,EAAE,IAAI,CAAC;CACjB;AAED,UAAU,0BAA0B;IAChC,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAID;;GAEG;AACH,wBAAsB,UAAU,CAC5B,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,MAAM,EAChB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,mBAAmB,CAAC,CAiC9B;AAED;;;GAGG;AACH,wBAAsB,yBAAyB,CAC3C,iBAAiB,EAAE,MAAM,GAAG,UAAU,EACtC,kBAAkB,EAAE,mBAAmB,EACvC,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,CAcjB"}

package/dist/exportFile.js

@@ -32,20 +32,18 @@ const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const getArgsValidationError_1 = require("./getArgsValidationError");
 const fakeUrlResolver_1 = require("./fakeUrlResolver");
 const utils_1 = require("./utils");
-// eslint-disable-next-line import/no-internal-modules
-const FileLogger_1 = require("./logger/FileLogger");
+const loggerUtils_1 = require("./logger/loggerUtils");
 const clientArgsValidationError = "Client_ArgsValidationError";
 /**
  * Execute code on Container based on ODSP snapshot and write result to file
  */
-async function exportFile(fluidFileConverter, inputFile, outputFile, telemetryFile, options) {
-    const telemetryArgError = (0, FileLogger_1.getTelemetryFileValidationError)(telemetryFile);
+async function exportFile(fluidFileConverter, inputFile, outputFile, telemetryFile, options, telemetryOptions) {
+    const telemetryArgError = (0, loggerUtils_1.getTelemetryFileValidationError)(telemetryFile);
     if (telemetryArgError) {
         const eventName = clientArgsValidationError;
         return { success: false, eventName, errorMessage: telemetryArgError };
     }
-    const fileLogger = new FileLogger_1.FileLogger(telemetryFile);
-    const logger = (0, FileLogger_1.createLogger)(fileLogger);
+    const { fileLogger, logger } = (0, loggerUtils_1.createLogger)(telemetryFile, telemetryOptions);
     try {
         return await telemetry_utils_1.PerformanceEvent.timedExecAsync(logger, { eventName: "ExportFile" }, async () => {
             const argsValidationError = (0, getArgsValidationError_1.getArgsValidationError)(inputFile, outputFile);
@@ -64,7 +62,7 @@ async function exportFile(fluidFileConverter, inputFile, outputFile, telemetryFi
         return { success: false, eventName, errorMessage: "Unexpected error", error };
     }
     finally {
-        await fileLogger.flush();
+        await fileLogger.close();
     }
 }
 exports.exportFile = exportFile;

package/dist/exportFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"exportFile.js","sourceRoot":"","sources":["../src/exportFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,iFAAqE;AACrE,uEAA0D;AAC1D,6DAAoF;AACpF,qEAAmE;AACnE,qEAAkE;AAElE,uDAAoD;AACpD,mCAAiD;AACjD,sDAAsD;AACtD,oDAAgG;AAehG,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAE/D;;GAEG;AACI,KAAK,UAAU,UAAU,CAC5B,kBAAuC,EACvC,SAAiB,EACjB,UAAkB,EAClB,aAAqB,EACrB,OAAgB;IAEhB,MAAM,iBAAiB,GAAG,IAAA,4CAA+B,EAAC,aAAa,CAAC,CAAC;IACzE,IAAI,iBAAiB,EAAE;QACnB,MAAM,SAAS,GAAG,yBAAyB,CAAC;QAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC;KACzE;IACD,MAAM,UAAU,GAAG,IAAI,uBAAU,CAAC,aAAa,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,IAAA,yBAAY,EAAC,UAAU,CAAC,CAAC;IAExC,IAAI;QACA,OAAO,MAAM,kCAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,IAAI,EAAE;YACzF,MAAM,mBAAmB,GAAG,IAAA,+CAAsB,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC1E,IAAI,mBAAmB,EAAE;gBACrB,MAAM,SAAS,GAAG,yBAAyB,CAAC;gBAC5C,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;gBACnE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,mBAAmB,EAAE,CAAC;aAC3E;YAED,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,yBAAyB,CACxD,IAAA,8BAAsB,EAAC,SAAS,CAAC,EACjC,kBAAkB,EAClB,MAAM,EACN,OAAO,CACV,CAAC,CAAC;YAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;KACN;IAAC,OAAO,KAAK,EAAE;QACZ,MAAM,SAAS,GAAG,wBAAwB,CAAC;QAC3C,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC;QAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;KACjF;YAAS;QACN,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;KAC5B;AACL,CAAC;AAxCD,gCAwCC;AAED;;;GAGG;AACI,KAAK,UAAU,yBAAyB,CAC3C,iBAAsC,EACtC,kBAAuC,EACvC,MAAwB,EACxB,OAAgB;IAEhB,MAAM,MAAM,GAAG,IAAI,yBAAM,CAAC;QACtB,WAAW,EAAE,IAAI,iCAAe,EAAE;QAClC,sBAAsB,EAAE,IAAA,mDAAqC,EAAC,iBAAiB,CAAC;QAChF,UAAU,EAAE,MAAM,kBAAkB,CAAC,aAAa,CAAC,MAAM,CAAC;QAC1D,KAAK,EAAE,kBAAkB,CAAC,KAAK;QAC/B,MAAM;KACT,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE;YAChE,CAAC,oCAAY,CAAC,QAAQ,CAAC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE;SAAE,EAAE,CAAC,CAAC;IAEhE,OAAO,kCAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,IAAI,EAAE,CACnF,kBAAkB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AACxD,CAAC;AAnBD,8DAmBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { LoaderHeader } from \"@fluidframework/container-definitions\";\nimport { Loader } from \"@fluidframework/container-loader\";\nimport { createLocalOdspDocumentServiceFactory } from \"@fluidframework/odsp-driver\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { getArgsValidationError } from \"./getArgsValidationError\";\nimport { IFluidFileConverter } from \"./codeLoaderBundle\";\nimport { FakeUrlResolver } from \"./fakeUrlResolver\";\nimport { getSnapshotFileContent } from \"./utils\";\n// eslint-disable-next-line import/no-internal-modules\nimport { createLogger, FileLogger, getTelemetryFileValidationError } from \"./logger/FileLogger\";\n\nexport type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;\n\ninterface IExportFileResponseSuccess {\n    success: true;\n}\n\ninterface IExportFileResponseFailure {\n    success: false;\n    eventName: string;\n    errorMessage: string;\n    error?: any;\n}\n\nconst clientArgsValidationError = \"Client_ArgsValidationError\";\n\n/**\n * Execute code on Container based on ODSP snapshot and write result to file\n */\nexport async function exportFile(\n    fluidFileConverter: IFluidFileConverter,\n    inputFile: string,\n    outputFile: string,\n    telemetryFile: string,\n    options?: string,\n): Promise<IExportFileResponse> {\n    const telemetryArgError = getTelemetryFileValidationError(telemetryFile);\n    if (telemetryArgError) {\n        const eventName = clientArgsValidationError;\n        return { success: false, eventName, errorMessage: telemetryArgError };\n    }\n    const fileLogger = new FileLogger(telemetryFile);\n    const logger = createLogger(fileLogger);\n\n    try {\n        return await PerformanceEvent.timedExecAsync(logger, { eventName: \"ExportFile\" }, async () => {\n            const argsValidationError = getArgsValidationError(inputFile, outputFile);\n            if (argsValidationError) {\n                const eventName = clientArgsValidationError;\n                logger.sendErrorEvent({ eventName, message: argsValidationError });\n                return { success: false, eventName, errorMessage: argsValidationError };\n            }\n\n            fs.writeFileSync(outputFile, await createContainerAndExecute(\n                getSnapshotFileContent(inputFile),\n                fluidFileConverter,\n                logger,\n                options,\n            ));\n\n            return { success: true };\n        });\n    } catch (error) {\n        const eventName = \"Client_UnexpectedError\";\n        logger.sendErrorEvent({ eventName }, error);\n        return { success: false, eventName, errorMessage: \"Unexpected error\", error };\n    } finally {\n        await fileLogger.flush();\n    }\n}\n\n/**\n * Create the container based on an ODSP snapshot and execute code on it\n * @returns result of execution\n */\nexport async function createContainerAndExecute(\n    localOdspSnapshot: string | Uint8Array,\n    fluidFileConverter: IFluidFileConverter,\n    logger: ITelemetryLogger,\n    options?: string,\n): Promise<string> {\n    const loader = new Loader({\n        urlResolver: new FakeUrlResolver(),\n        documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),\n        codeLoader: await fluidFileConverter.getCodeLoader(logger),\n        scope: fluidFileConverter.scope,\n        logger,\n    });\n\n    const container = await loader.resolve({ url: \"/fakeUrl/\", headers: {\n        [LoaderHeader.loadMode]: { opsBeforeReturn: \"cached\" } } });\n\n    return PerformanceEvent.timedExecAsync(logger, { eventName: \"ExportFile\" }, async () =>\n        fluidFileConverter.execute(container, options));\n}\n"]}
+{"version":3,"file":"exportFile.js","sourceRoot":"","sources":["../src/exportFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,iFAAqE;AACrE,uEAA0D;AAC1D,6DAAoF;AACpF,qEAAmE;AACnE,qEAAkE;AAElE,uDAAoD;AACpD,mCAAiD;AAGjD,sDAAqF;AAgBrF,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAE/D;;GAEG;AACI,KAAK,UAAU,UAAU,CAC5B,kBAAuC,EACvC,SAAiB,EACjB,UAAkB,EAClB,aAAqB,EACrB,OAAgB,EAChB,gBAAoC;IAEpC,MAAM,iBAAiB,GAAG,IAAA,6CAA+B,EAAC,aAAa,CAAC,CAAC;IACzE,IAAI,iBAAiB,EAAE;QACnB,MAAM,SAAS,GAAG,yBAAyB,CAAC;QAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC;KACzE;IACD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAA,0BAAY,EAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAE7E,IAAI;QACA,OAAO,MAAM,kCAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,IAAI,EAAE;YACzF,MAAM,mBAAmB,GAAG,IAAA,+CAAsB,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC1E,IAAI,mBAAmB,EAAE;gBACrB,MAAM,SAAS,GAAG,yBAAyB,CAAC;gBAC5C,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,CAAC;gBACnE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,mBAAmB,EAAE,CAAC;aAC3E;YAED,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,yBAAyB,CACxD,IAAA,8BAAsB,EAAC,SAAS,CAAC,EACjC,kBAAkB,EAClB,MAAM,EACN,OAAO,CACV,CAAC,CAAC;YAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;KACN;IAAC,OAAO,KAAK,EAAE;QACZ,MAAM,SAAS,GAAG,wBAAwB,CAAC;QAC3C,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC;QAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;KACjF;YAAS;QACN,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;KAC5B;AACL,CAAC;AAxCD,gCAwCC;AAED;;;GAGG;AACI,KAAK,UAAU,yBAAyB,CAC3C,iBAAsC,EACtC,kBAAuC,EACvC,MAAwB,EACxB,OAAgB;IAEhB,MAAM,MAAM,GAAG,IAAI,yBAAM,CAAC;QACtB,WAAW,EAAE,IAAI,iCAAe,EAAE;QAClC,sBAAsB,EAAE,IAAA,mDAAqC,EAAC,iBAAiB,CAAC;QAChF,UAAU,EAAE,MAAM,kBAAkB,CAAC,aAAa,CAAC,MAAM,CAAC;QAC1D,KAAK,EAAE,kBAAkB,CAAC,KAAK;QAC/B,MAAM;KACT,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE;YAChE,CAAC,oCAAY,CAAC,QAAQ,CAAC,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE;SAAE,EAAE,CAAC,CAAC;IAEhE,OAAO,kCAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,KAAK,IAAI,EAAE,CACnF,kBAAkB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AACxD,CAAC;AAnBD,8DAmBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { LoaderHeader } from \"@fluidframework/container-definitions\";\nimport { Loader } from \"@fluidframework/container-loader\";\nimport { createLocalOdspDocumentServiceFactory } from \"@fluidframework/odsp-driver\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { getArgsValidationError } from \"./getArgsValidationError\";\nimport { IFluidFileConverter } from \"./codeLoaderBundle\";\nimport { FakeUrlResolver } from \"./fakeUrlResolver\";\nimport { getSnapshotFileContent } from \"./utils\";\n/* eslint-disable import/no-internal-modules */\nimport { ITelemetryOptions } from \"./logger/fileLogger\";\nimport { createLogger, getTelemetryFileValidationError } from \"./logger/loggerUtils\";\n/* eslint-enable import/no-internal-modules */\n\nexport type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure;\n\ninterface IExportFileResponseSuccess {\n    success: true;\n}\n\ninterface IExportFileResponseFailure {\n    success: false;\n    eventName: string;\n    errorMessage: string;\n    error?: any;\n}\n\nconst clientArgsValidationError = \"Client_ArgsValidationError\";\n\n/**\n * Execute code on Container based on ODSP snapshot and write result to file\n */\nexport async function exportFile(\n    fluidFileConverter: IFluidFileConverter,\n    inputFile: string,\n    outputFile: string,\n    telemetryFile: string,\n    options?: string,\n    telemetryOptions?: ITelemetryOptions,\n): Promise<IExportFileResponse> {\n    const telemetryArgError = getTelemetryFileValidationError(telemetryFile);\n    if (telemetryArgError) {\n        const eventName = clientArgsValidationError;\n        return { success: false, eventName, errorMessage: telemetryArgError };\n    }\n    const { fileLogger, logger } = createLogger(telemetryFile, telemetryOptions);\n\n    try {\n        return await PerformanceEvent.timedExecAsync(logger, { eventName: \"ExportFile\" }, async () => {\n            const argsValidationError = getArgsValidationError(inputFile, outputFile);\n            if (argsValidationError) {\n                const eventName = clientArgsValidationError;\n                logger.sendErrorEvent({ eventName, message: argsValidationError });\n                return { success: false, eventName, errorMessage: argsValidationError };\n            }\n\n            fs.writeFileSync(outputFile, await createContainerAndExecute(\n                getSnapshotFileContent(inputFile),\n                fluidFileConverter,\n                logger,\n                options,\n            ));\n\n            return { success: true };\n        });\n    } catch (error) {\n        const eventName = \"Client_UnexpectedError\";\n        logger.sendErrorEvent({ eventName }, error);\n        return { success: false, eventName, errorMessage: \"Unexpected error\", error };\n    } finally {\n        await fileLogger.close();\n    }\n}\n\n/**\n * Create the container based on an ODSP snapshot and execute code on it\n * @returns result of execution\n */\nexport async function createContainerAndExecute(\n    localOdspSnapshot: string | Uint8Array,\n    fluidFileConverter: IFluidFileConverter,\n    logger: ITelemetryLogger,\n    options?: string,\n): Promise<string> {\n    const loader = new Loader({\n        urlResolver: new FakeUrlResolver(),\n        documentServiceFactory: createLocalOdspDocumentServiceFactory(localOdspSnapshot),\n        codeLoader: await fluidFileConverter.getCodeLoader(logger),\n        scope: fluidFileConverter.scope,\n        logger,\n    });\n\n    const container = await loader.resolve({ url: \"/fakeUrl/\", headers: {\n        [LoaderHeader.loadMode]: { opsBeforeReturn: \"cached\" } } });\n\n    return PerformanceEvent.timedExecAsync(logger, { eventName: \"ExportFile\" }, async () =>\n        fluidFileConverter.execute(container, options));\n}\n"]}

package/dist/fakeUrlResolver.d.ts

@@ -6,6 +6,7 @@ import { IRequest } from "@fluidframework/core-interfaces";
 import { IContainerPackageInfo, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
 /**
  * Fake URL resolver that returns hard coded values on every request
+ * @internal
  */
 export declare class FakeUrlResolver implements IUrlResolver {
     resolve(_request: IRequest): Promise<IResolvedUrl | undefined>;

package/dist/fakeUrlResolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fakeUrlResolver.d.ts","sourceRoot":"","sources":["../src/fakeUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAMvG;;GAEG;AACH,qBAAa,eAAgB,YAAW,YAAY;IACnC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAyB9D,cAAc,CACvB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,qBAAqB,GAC3C,OAAO,CAAC,MAAM,CAAC;CAGrB"}
+{"version":3,"file":"fakeUrlResolver.d.ts","sourceRoot":"","sources":["../src/fakeUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAMvG;;;GAGG;AACH,qBAAa,eAAgB,YAAW,YAAY;IACnC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAyB9D,cAAc,CACvB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,qBAAqB,GAC3C,OAAO,CAAC,MAAM,CAAC;CAGrB"}

package/dist/fakeUrlResolver.js

@@ -9,6 +9,7 @@ const fakeId = "FakeUrlResolver";
 const fakeUrl = "/FakeUrlResolver/";
 /**
  * Fake URL resolver that returns hard coded values on every request
+ * @internal
  */
 class FakeUrlResolver {
     async resolve(_request) {

package/dist/fakeUrlResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"fakeUrlResolver.js","sourceRoot":"","sources":["../src/fakeUrlResolver.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH,MAAM,MAAM,GAAG,iBAAiB,CAAC;AACjC,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAEpC;;GAEG;AACH,MAAa,eAAe;IACjB,KAAK,CAAC,OAAO,CAAC,QAAkB;QACnC,MAAM,mBAAmB,GAAqB;YAC1C,IAAI,EAAE,OAAO;YACb,eAAe,EAAE,IAAI;YACrB,EAAE,EAAE,MAAM;YACV,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,MAAM;YACf,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,OAAO;YACZ,gBAAgB,EAAE,MAAM;YACxB,SAAS,EAAE;gBACP,kBAAkB,EAAE,OAAO;gBAC3B,wBAAwB,EAAE,OAAO;gBACjC,uBAAuB,EAAE,OAAO;gBAChC,eAAe,EAAE,OAAO;aAC3B;YACD,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,MAAM;YAChB,UAAU,EAAE,KAAK;YACjB,WAAW,EAAE,MAAM;SACtB,CAAC;QAEF,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,YAA0B,EAC1B,YAAoB,EACpB,kBAA0C;QAE1C,OAAO,EAAE,CAAC;IACd,CAAC;CACJ;AAjCD,0CAiCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport { IContainerPackageInfo, IResolvedUrl, IUrlResolver } from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl } from \"@fluidframework/odsp-driver-definitions\";\n\nconst fakeId = \"FakeUrlResolver\";\nconst fakeUrl = \"/FakeUrlResolver/\";\n\n/**\n * Fake URL resolver that returns hard coded values on every request\n */\nexport class FakeUrlResolver implements IUrlResolver {\n    public async resolve(_request: IRequest): Promise<IResolvedUrl | undefined> {\n        const fakeOdspResolvedUrl: IOdspResolvedUrl = {\n            type: \"fluid\",\n            odspResolvedUrl: true,\n            id: fakeId,\n            siteUrl: fakeUrl,\n            driveId: fakeId,\n            itemId: fakeId,\n            url: fakeUrl,\n            hashedDocumentId: fakeId,\n            endpoints: {\n                snapshotStorageUrl: fakeUrl,\n                attachmentPOSTStorageUrl: fakeUrl,\n                attachmentGETStorageUrl: fakeUrl,\n                deltaStorageUrl: fakeUrl,\n            },\n            tokens: {},\n            fileName: fakeId,\n            summarizer: false,\n            fileVersion: fakeId,\n        };\n\n        return fakeOdspResolvedUrl;\n    }\n\n    public async getAbsoluteUrl(\n        _resolvedUrl: IResolvedUrl,\n        _relativeUrl: string,\n        _packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        return \"\";\n    }\n}\n"]}
+{"version":3,"file":"fakeUrlResolver.js","sourceRoot":"","sources":["../src/fakeUrlResolver.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH,MAAM,MAAM,GAAG,iBAAiB,CAAC;AACjC,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAEpC;;;GAGG;AACH,MAAa,eAAe;IACjB,KAAK,CAAC,OAAO,CAAC,QAAkB;QACnC,MAAM,mBAAmB,GAAqB;YAC1C,IAAI,EAAE,OAAO;YACb,eAAe,EAAE,IAAI;YACrB,EAAE,EAAE,MAAM;YACV,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,MAAM;YACf,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,OAAO;YACZ,gBAAgB,EAAE,MAAM;YACxB,SAAS,EAAE;gBACP,kBAAkB,EAAE,OAAO;gBAC3B,wBAAwB,EAAE,OAAO;gBACjC,uBAAuB,EAAE,OAAO;gBAChC,eAAe,EAAE,OAAO;aAC3B;YACD,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,MAAM;YAChB,UAAU,EAAE,KAAK;YACjB,WAAW,EAAE,MAAM;SACtB,CAAC;QAEF,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,YAA0B,EAC1B,YAAoB,EACpB,kBAA0C;QAE1C,OAAO,EAAE,CAAC;IACd,CAAC;CACJ;AAjCD,0CAiCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport { IContainerPackageInfo, IResolvedUrl, IUrlResolver } from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl } from \"@fluidframework/odsp-driver-definitions\";\n\nconst fakeId = \"FakeUrlResolver\";\nconst fakeUrl = \"/FakeUrlResolver/\";\n\n/**\n * Fake URL resolver that returns hard coded values on every request\n * @internal\n */\nexport class FakeUrlResolver implements IUrlResolver {\n    public async resolve(_request: IRequest): Promise<IResolvedUrl | undefined> {\n        const fakeOdspResolvedUrl: IOdspResolvedUrl = {\n            type: \"fluid\",\n            odspResolvedUrl: true,\n            id: fakeId,\n            siteUrl: fakeUrl,\n            driveId: fakeId,\n            itemId: fakeId,\n            url: fakeUrl,\n            hashedDocumentId: fakeId,\n            endpoints: {\n                snapshotStorageUrl: fakeUrl,\n                attachmentPOSTStorageUrl: fakeUrl,\n                attachmentGETStorageUrl: fakeUrl,\n                deltaStorageUrl: fakeUrl,\n            },\n            tokens: {},\n            fileName: fakeId,\n            summarizer: false,\n            fileVersion: fakeId,\n        };\n\n        return fakeOdspResolvedUrl;\n    }\n\n    public async getAbsoluteUrl(\n        _resolvedUrl: IResolvedUrl,\n        _relativeUrl: string,\n        _packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        return \"\";\n    }\n}\n"]}

package/dist/fluidRunner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidRunner.d.ts","sourceRoot":"","sources":["../src/fluidRunner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAGzD;;GAEG;AACH,wBAAgB,WAAW,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,QAoEnE"}
+{"version":3,"file":"fluidRunner.d.ts","sourceRoot":"","sources":["../src/fluidRunner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAMzD;;GAEG;AACH,wBAAgB,WAAW,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,QAqFnE"}

package/dist/fluidRunner.js

@@ -24,9 +24,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fluidRunner = void 0;
+/* eslint-disable max-len */
 const yargs = __importStar(require("yargs"));
 const exportFile_1 = require("./exportFile");
 const parseBundleAndExportFile_1 = require("./parseBundleAndExportFile");
+// eslint-disable-next-line import/no-internal-modules
+const loggerUtils_1 = require("./logger/loggerUtils");
+const utils_1 = require("./utils");
 /**
  * @param fluidFileConverter - needs to be provided if "codeLoaderBundle" is not and vice versa
  */
@@ -39,7 +43,6 @@ function fluidRunner(fluidFileConverter) {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     (yargs) => yargs
         .option("codeLoader", {
-        // eslint-disable-next-line max-len
         describe: "Path to code loader bundle. Required if this application is being called without modification.\nSee \"README.md\" for more details.",
         type: "string",
         demandOption: false,
@@ -63,16 +66,32 @@ function fluidRunner(fluidFileConverter) {
         describe: "Additional options passed to container on execution",
         type: "string",
         demandOption: false,
+    })
+        .option("telemetryFormat", {
+        describe: "Output format for telemetry. Current options are: [\"JSON\", \"CSV\"]",
+        type: "string",
+        demandOption: false,
+        default: "JSON",
+    })
+        .option("telemetryProp", {
+        describe: "Property to add to every telemetry entry. Formatted like \"--telemetryProp prop1 value1 --telemetryProp prop2 \\\"value 2\\\"\".",
+        type: "array",
+        demandOption: false,
     }), 
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
     async (argv) => {
-        const argsError = validateProvidedArgs(argv.codeLoader, fluidFileConverter);
+        const argsError = (0, utils_1.validateCommandLineArgs)(argv.codeLoader, fluidFileConverter);
         if (argsError) {
             console.error(argsError);
             process.exit(1);
         }
+        const telemetryOptionsResult = (0, loggerUtils_1.validateAndParseTelemetryOptions)(argv.telemetryFormat, argv.telemetryProp);
+        if (!telemetryOptionsResult.success) {
+            console.error(telemetryOptionsResult.error);
+            process.exit(1);
+        }
         const result = await (argv.codeLoader
-            ? (0, parseBundleAndExportFile_1.parseBundleAndExportFile)(argv.codeLoader, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options) : (0, exportFile_1.exportFile)(fluidFileConverter, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options));
+            ? (0, parseBundleAndExportFile_1.parseBundleAndExportFile)(argv.codeLoader, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options, telemetryOptionsResult.telemetryOptions) : (0, exportFile_1.exportFile)(fluidFileConverter, argv.inputFile, argv.outputFile, argv.telemetryFile, argv.options, telemetryOptionsResult.telemetryOptions));
         if (!result.success) {
             console.error(`${result.eventName}: ${result.errorMessage}`);
             process.exit(1);
@@ -82,15 +101,6 @@ function fluidRunner(fluidFileConverter) {
         .demandCommand().argv;
 }
 exports.fluidRunner = fluidRunner;
-function validateProvidedArgs(codeLoader, fluidFileConverter) {
-    if (codeLoader !== undefined && fluidFileConverter !== undefined) {
-        return "\"codeLoader\" and \"fluidFileConverter\" cannot both be provided. See \"fluidRunner.ts\" for details.";
-    }
-    if (codeLoader === undefined && fluidFileConverter === undefined) {
-        // eslint-disable-next-line max-len
-        return "\"codeLoader\" must be provided if there is no explicit \"fluidFileConverter\". See \"fluidRunner.ts\" for details.";
-    }
-    return undefined;
-}
 fluidRunner();
+/* eslint-enable max-len */
 //# sourceMappingURL=fluidRunner.js.map

package/dist/fluidRunner.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidRunner.js","sourceRoot":"","sources":["../src/fluidRunner.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAC/B,6CAA0C;AAE1C,yEAAsE;AAEtE;;GAEG;AACH,SAAgB,WAAW,CAAC,kBAAwC;IAChE,oEAAoE;IACpE,KAAK;SACA,MAAM,EAAE;SACR,OAAO,CAAC,KAAK,CAAC;SACd,OAAO,CACJ,YAAY,EACZ,8CAA8C;IAC9C,wDAAwD;IACxD,CAAC,KAAK,EAAE,EAAE,CACN,KAAK;SACA,MAAM,CAAC,YAAY,EAAE;QAClB,mCAAmC;QACnC,QAAQ,EAAE,qIAAqI;QAC/I,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACtB,CAAC;SACD,MAAM,CAAC,WAAW,EAAE;QACjB,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,YAAY,EAAE;QAClB,QAAQ,EAAE,oFAAoF;QAC9F,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACrB,QAAQ,EAAE,2EAA2E;QACrF,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,SAAS,EAAE;QACf,QAAQ,EAAE,qDAAqD;QAC/D,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACtB,CAAC;IACV,kEAAkE;IAClE,KAAK,EAAE,IAAI,EAAE,EAAE;QACX,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QAC5E,IAAI,SAAS,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU;YACjC,CAAC,CAAC,IAAA,mDAAwB,EACtB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,CACf,CAAC,CAAC,CAAC,IAAA,uBAAU,EACV,kBAAmB,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,CACf,CAAC,CAAC;QAEP,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACjB,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,SAAS,KAAK,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;IACL,CAAC,CACJ;SACA,IAAI,EAAE;SACN,aAAa,EAAE,CAAC,IAAI,CAAC;AAC9B,CAAC;AApED,kCAoEC;AAED,SAAS,oBAAoB,CACzB,UAAmB,EACnB,kBAAwC;IAExC,IAAI,UAAU,KAAK,SAAS,IAAI,kBAAkB,KAAK,SAAS,EAAE;QAC9D,OAAO,wGAAwG,CAAC;KACnH;IACD,IAAI,UAAU,KAAK,SAAS,IAAI,kBAAkB,KAAK,SAAS,EAAE;QAC9D,mCAAmC;QACnC,OAAO,qHAAqH,CAAC;KAChI;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,WAAW,EAAE,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as yargs from \"yargs\";\nimport { exportFile } from \"./exportFile\";\nimport { IFluidFileConverter } from \"./codeLoaderBundle\";\nimport { parseBundleAndExportFile } from \"./parseBundleAndExportFile\";\n\n/**\n * @param fluidFileConverter - needs to be provided if \"codeLoaderBundle\" is not and vice versa\n */\nexport function fluidRunner(fluidFileConverter?: IFluidFileConverter) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n    yargs\n        .strict()\n        .version(false)\n        .command(\n            \"exportFile\",\n            \"Generate an output for a local ODSP snapshot\",\n            // eslint-disable-next-line @typescript-eslint/no-shadow\n            (yargs) =>\n                yargs\n                    .option(\"codeLoader\", {\n                        // eslint-disable-next-line max-len\n                        describe: \"Path to code loader bundle. Required if this application is being called without modification.\\nSee \\\"README.md\\\" for more details.\",\n                        type: \"string\",\n                        demandOption: false,\n                    })\n                    .option(\"inputFile\", {\n                        describe: \"Path to local ODSP snapshot\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"outputFile\", {\n                        describe: \"Path of output file (cannot already exist).\\nExecution result will be written here\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"telemetryFile\", {\n                        describe: \"Path of telemetry file for config and session data (cannot already exist)\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"options\", {\n                        describe: \"Additional options passed to container on execution\",\n                        type: \"string\",\n                        demandOption: false,\n                    }),\n            // eslint-disable-next-line @typescript-eslint/no-misused-promises\n            async (argv) => {\n                const argsError = validateProvidedArgs(argv.codeLoader, fluidFileConverter);\n                if (argsError) {\n                    console.error(argsError);\n                    process.exit(1);\n                }\n\n                const result = await (argv.codeLoader\n                    ? parseBundleAndExportFile(\n                        argv.codeLoader,\n                        argv.inputFile,\n                        argv.outputFile,\n                        argv.telemetryFile,\n                        argv.options,\n                    ) : exportFile(\n                        fluidFileConverter!,\n                        argv.inputFile,\n                        argv.outputFile,\n                        argv.telemetryFile,\n                        argv.options,\n                    ));\n\n                if (!result.success) {\n                    console.error(`${result.eventName}: ${result.errorMessage}`);\n                    process.exit(1);\n                }\n            },\n        )\n        .help()\n        .demandCommand().argv;\n}\n\nfunction validateProvidedArgs(\n    codeLoader?: string,\n    fluidFileConverter?: IFluidFileConverter,\n): string | undefined {\n    if (codeLoader !== undefined && fluidFileConverter !== undefined) {\n        return \"\\\"codeLoader\\\" and \\\"fluidFileConverter\\\" cannot both be provided. See \\\"fluidRunner.ts\\\" for details.\";\n    }\n    if (codeLoader === undefined && fluidFileConverter === undefined) {\n        // eslint-disable-next-line max-len\n        return \"\\\"codeLoader\\\" must be provided if there is no explicit \\\"fluidFileConverter\\\". See \\\"fluidRunner.ts\\\" for details.\";\n    }\n    return undefined;\n}\n\nfluidRunner();\n"]}
+{"version":3,"file":"fluidRunner.js","sourceRoot":"","sources":["../src/fluidRunner.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,4BAA4B;AAC5B,6CAA+B;AAC/B,6CAA0C;AAE1C,yEAAsE;AACtE,sDAAsD;AACtD,sDAAwE;AACxE,mCAAkD;AAElD;;GAEG;AACH,SAAgB,WAAW,CAAC,kBAAwC;IAChE,oEAAoE;IACpE,KAAK;SACA,MAAM,EAAE;SACR,OAAO,CAAC,KAAK,CAAC;SACd,OAAO,CACJ,YAAY,EACZ,8CAA8C;IAC9C,wDAAwD;IACxD,CAAC,KAAK,EAAE,EAAE,CACN,KAAK;SACA,MAAM,CAAC,YAAY,EAAE;QAClB,QAAQ,EAAE,qIAAqI;QAC/I,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACtB,CAAC;SACD,MAAM,CAAC,WAAW,EAAE;QACjB,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,YAAY,EAAE;QAClB,QAAQ,EAAE,oFAAoF;QAC9F,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACrB,QAAQ,EAAE,2EAA2E;QACrF,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;KACrB,CAAC;SACD,MAAM,CAAC,SAAS,EAAE;QACf,QAAQ,EAAE,qDAAqD;QAC/D,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;KACtB,CAAC;SACD,MAAM,CAAC,iBAAiB,EAAE;QACvB,QAAQ,EAAE,uEAAuE;QACjF,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,MAAM;KAClB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACrB,QAAQ,EAAE,kIAAkI;QAC5I,IAAI,EAAE,OAAO;QACb,YAAY,EAAE,KAAK;KACtB,CAAC;IACV,kEAAkE;IAClE,KAAK,EAAE,IAAI,EAAE,EAAE;QACX,MAAM,SAAS,GAAG,IAAA,+BAAuB,EAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QAC/E,IAAI,SAAS,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;QACD,MAAM,sBAAsB,GAAG,IAAA,8CAAgC,EAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1G,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE;YACjC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;YAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU;YACjC,CAAC,CAAC,IAAA,mDAAwB,EACtB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,EACZ,sBAAsB,CAAC,gBAAgB,CAC1C,CAAC,CAAC,CAAC,IAAA,uBAAU,EACV,kBAAmB,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,EACZ,sBAAsB,CAAC,gBAAgB,CAC1C,CAAC,CAAC;QAEP,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACjB,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,SAAS,KAAK,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;IACL,CAAC,CACJ;SACA,IAAI,EAAE;SACN,aAAa,EAAE,CAAC,IAAI,CAAC;AAC9B,CAAC;AArFD,kCAqFC;AAED,WAAW,EAAE,CAAC;AACd,2BAA2B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable max-len */\nimport * as yargs from \"yargs\";\nimport { exportFile } from \"./exportFile\";\nimport { IFluidFileConverter } from \"./codeLoaderBundle\";\nimport { parseBundleAndExportFile } from \"./parseBundleAndExportFile\";\n// eslint-disable-next-line import/no-internal-modules\nimport { validateAndParseTelemetryOptions } from \"./logger/loggerUtils\";\nimport { validateCommandLineArgs } from \"./utils\";\n\n/**\n * @param fluidFileConverter - needs to be provided if \"codeLoaderBundle\" is not and vice versa\n */\nexport function fluidRunner(fluidFileConverter?: IFluidFileConverter) {\n    // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n    yargs\n        .strict()\n        .version(false)\n        .command(\n            \"exportFile\",\n            \"Generate an output for a local ODSP snapshot\",\n            // eslint-disable-next-line @typescript-eslint/no-shadow\n            (yargs) =>\n                yargs\n                    .option(\"codeLoader\", {\n                        describe: \"Path to code loader bundle. Required if this application is being called without modification.\\nSee \\\"README.md\\\" for more details.\",\n                        type: \"string\",\n                        demandOption: false,\n                    })\n                    .option(\"inputFile\", {\n                        describe: \"Path to local ODSP snapshot\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"outputFile\", {\n                        describe: \"Path of output file (cannot already exist).\\nExecution result will be written here\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"telemetryFile\", {\n                        describe: \"Path of telemetry file for config and session data (cannot already exist)\",\n                        type: \"string\",\n                        demandOption: true,\n                    })\n                    .option(\"options\", {\n                        describe: \"Additional options passed to container on execution\",\n                        type: \"string\",\n                        demandOption: false,\n                    })\n                    .option(\"telemetryFormat\", {\n                        describe: \"Output format for telemetry. Current options are: [\\\"JSON\\\", \\\"CSV\\\"]\",\n                        type: \"string\",\n                        demandOption: false,\n                        default: \"JSON\",\n                    })\n                    .option(\"telemetryProp\", {\n                        describe: \"Property to add to every telemetry entry. Formatted like \\\"--telemetryProp prop1 value1 --telemetryProp prop2 \\\\\\\"value 2\\\\\\\"\\\".\",\n                        type: \"array\",\n                        demandOption: false,\n                    }),\n            // eslint-disable-next-line @typescript-eslint/no-misused-promises\n            async (argv) => {\n                const argsError = validateCommandLineArgs(argv.codeLoader, fluidFileConverter);\n                if (argsError) {\n                    console.error(argsError);\n                    process.exit(1);\n                }\n                const telemetryOptionsResult = validateAndParseTelemetryOptions(argv.telemetryFormat, argv.telemetryProp);\n                if (!telemetryOptionsResult.success) {\n                    console.error(telemetryOptionsResult.error);\n                    process.exit(1);\n                }\n\n                const result = await (argv.codeLoader\n                    ? parseBundleAndExportFile(\n                        argv.codeLoader,\n                        argv.inputFile,\n                        argv.outputFile,\n                        argv.telemetryFile,\n                        argv.options,\n                        telemetryOptionsResult.telemetryOptions,\n                    ) : exportFile(\n                        fluidFileConverter!,\n                        argv.inputFile,\n                        argv.outputFile,\n                        argv.telemetryFile,\n                        argv.options,\n                        telemetryOptionsResult.telemetryOptions,\n                    ));\n\n                if (!result.success) {\n                    console.error(`${result.eventName}: ${result.errorMessage}`);\n                    process.exit(1);\n                }\n            },\n        )\n        .help()\n        .demandCommand().argv;\n}\n\nfluidRunner();\n/* eslint-enable max-len */\n"]}

package/dist/getArgsValidationError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getArgsValidationError.d.ts","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,wBAAgB,sBAAsB,CAClC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACnB,MAAM,GAAG,SAAS,CAiBpB"}
+{"version":3,"file":"getArgsValidationError.d.ts","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,wBAAgB,sBAAsB,CAClC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACnB,MAAM,GAAG,SAAS,CAgBpB"}

package/dist/getArgsValidationError.js

@@ -28,7 +28,6 @@ const fs = __importStar(require("fs"));
 function getArgsValidationError(inputFile, outputFile) {
     // Validate input file
     if (!inputFile) {
-        // TODO: Do not log file name. It can be customer content
         return "Input file name argument is missing.";
     }
     else if (!fs.existsSync(inputFile)) {

package/dist/getArgsValidationError.js.map

@@ -1 +1 @@
-{"version":3,"file":"getArgsValidationError.js","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,SAAgB,sBAAsB,CAClC,SAAiB,EACjB,UAAkB;IAElB,sBAAsB;IACtB,IAAI,CAAC,SAAS,EAAE;QACZ,yDAAyD;QACzD,OAAO,sCAAsC,CAAC;KACjD;SAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAClC,OAAO,4BAA4B,CAAC;KACvC;IAED,uBAAuB;IACvB,IAAI,CAAC,UAAU,EAAE;QACb,OAAO,kCAAkC,CAAC;KAC7C;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;QAClC,OAAO,+BAA+B,UAAU,IAAI,CAAC;KACxD;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AApBD,wDAoBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\n\nexport function getArgsValidationError(\n    inputFile: string,\n    outputFile: string,\n): string | undefined {\n    // Validate input file\n    if (!inputFile) {\n        // TODO: Do not log file name. It can be customer content\n        return \"Input file name argument is missing.\";\n    } else if (!fs.existsSync(inputFile)) {\n        return \"Input file does not exist.\";\n    }\n\n    // Validate output file\n    if (!outputFile) {\n        return \"Output file argument is missing.\";\n    } else if (fs.existsSync(outputFile)) {\n        return `Output file already exists [${outputFile}].`;\n    }\n\n    return undefined;\n}\n"]}
+{"version":3,"file":"getArgsValidationError.js","sourceRoot":"","sources":["../src/getArgsValidationError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,SAAgB,sBAAsB,CAClC,SAAiB,EACjB,UAAkB;IAElB,sBAAsB;IACtB,IAAI,CAAC,SAAS,EAAE;QACZ,OAAO,sCAAsC,CAAC;KACjD;SAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAClC,OAAO,4BAA4B,CAAC;KACvC;IAED,uBAAuB;IACvB,IAAI,CAAC,UAAU,EAAE;QACb,OAAO,kCAAkC,CAAC;KAC7C;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;QAClC,OAAO,+BAA+B,UAAU,IAAI,CAAC;KACxD;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAnBD,wDAmBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\n\nexport function getArgsValidationError(\n    inputFile: string,\n    outputFile: string,\n): string | undefined {\n    // Validate input file\n    if (!inputFile) {\n        return \"Input file name argument is missing.\";\n    } else if (!fs.existsSync(inputFile)) {\n        return \"Input file does not exist.\";\n    }\n\n    // Validate output file\n    if (!outputFile) {\n        return \"Output file argument is missing.\";\n    } else if (fs.existsSync(outputFile)) {\n        return `Output file already exists [${outputFile}].`;\n    }\n\n    return undefined;\n}\n"]}

package/dist/index.d.ts

@@ -5,6 +5,8 @@
 export { ICodeLoaderBundle, IFluidFileConverter } from "./codeLoaderBundle";
 export * from "./exportFile";
 export { fluidRunner } from "./fluidRunner";
-export * from "./logger/FileLogger";
+export { OutputFormat } from "./logger/fileLogger";
+export { createLogger, getTelemetryFileValidationError } from "./logger/loggerUtils";
 export * from "./parseBundleAndExportFile";
+export { getSnapshotFileContent } from "./utils";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAC;AACrF,cAAc,4BAA4B,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -14,11 +14,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fluidRunner = void 0;
+exports.getSnapshotFileContent = exports.getTelemetryFileValidationError = exports.createLogger = exports.OutputFormat = exports.fluidRunner = void 0;
 __exportStar(require("./exportFile"), exports);
 var fluidRunner_1 = require("./fluidRunner");
 Object.defineProperty(exports, "fluidRunner", { enumerable: true, get: function () { return fluidRunner_1.fluidRunner; } });
-// eslint-disable-next-line import/no-internal-modules
-__exportStar(require("./logger/FileLogger"), exports);
+var fileLogger_1 = require("./logger/fileLogger");
+Object.defineProperty(exports, "OutputFormat", { enumerable: true, get: function () { return fileLogger_1.OutputFormat; } });
+var loggerUtils_1 = require("./logger/loggerUtils");
+Object.defineProperty(exports, "createLogger", { enumerable: true, get: function () { return loggerUtils_1.createLogger; } });
+Object.defineProperty(exports, "getTelemetryFileValidationError", { enumerable: true, get: function () { return loggerUtils_1.getTelemetryFileValidationError; } });
 __exportStar(require("./parseBundleAndExportFile"), exports);
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getSnapshotFileContent", { enumerable: true, get: function () { return utils_1.getSnapshotFileContent; } });
+/* eslint-enable import/no-internal-modules */
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAGH,+CAA6B;AAC7B,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,sDAAsD;AACtD,sDAAoC;AACpC,6DAA2C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ICodeLoaderBundle, IFluidFileConverter } from \"./codeLoaderBundle\";\nexport * from \"./exportFile\";\nexport { fluidRunner } from \"./fluidRunner\";\n// eslint-disable-next-line import/no-internal-modules\nexport * from \"./logger/FileLogger\";\nexport * from \"./parseBundleAndExportFile\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAIH,+CAA6B;AAC7B,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,kDAAmD;AAA1C,0GAAA,YAAY,OAAA;AACrB,oDAAqF;AAA5E,2GAAA,YAAY,OAAA;AAAE,8HAAA,+BAA+B,OAAA;AACtD,6DAA2C;AAC3C,iCAAiD;AAAxC,+GAAA,sBAAsB,OAAA;AAC/B,8CAA8C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable import/no-internal-modules */\nexport { ICodeLoaderBundle, IFluidFileConverter } from \"./codeLoaderBundle\";\nexport * from \"./exportFile\";\nexport { fluidRunner } from \"./fluidRunner\";\nexport { OutputFormat } from \"./logger/fileLogger\";\nexport { createLogger, getTelemetryFileValidationError } from \"./logger/loggerUtils\";\nexport * from \"./parseBundleAndExportFile\";\nexport { getSnapshotFileContent } from \"./utils\";\n/* eslint-enable import/no-internal-modules */\n"]}

package/dist/logger/baseFileLogger.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryBaseEvent } from "@fluidframework/common-definitions";
+import { IFileLogger } from "./fileLogger";
+/**
+ * @internal
+ */
+export declare abstract class BaseFileLogger implements IFileLogger {
+    protected readonly filePath: string;
+    protected readonly eventsPerFlush: number;
+    protected readonly defaultProps?: Record<string, string | number> | undefined;
+    supportsTags?: true | undefined;
+    /** Hold events in memory until flushed */
+    protected events: any[];
+    protected hasWrittenToFile: boolean;
+    /**
+     * @param filePath - file path to write logs to
+     * @param eventsPerFlush - number of events per flush
+     * @param defaultProps - default properties to add to every telemetry event
+     */
+    constructor(filePath: string, eventsPerFlush?: number, defaultProps?: Record<string, string | number> | undefined);
+    send(event: ITelemetryBaseEvent): void;
+    protected flush(): Promise<void>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=baseFileLogger.d.ts.map

package/dist/logger/baseFileLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseFileLogger.d.ts","sourceRoot":"","sources":["../../src/logger/baseFileLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;GAEG;AACH,8BAAsB,cAAe,YAAW,WAAW;IAanD,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACnC,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM;IACzC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC;IAd7B,YAAY,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAEvC,0CAA0C;IAC1C,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,CAAM;IAC7B,SAAS,CAAC,gBAAgB,UAAS;IAEnC;;;;OAIG;gBAEoB,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,MAAW,EAC3B,YAAY,CAAC,6CAAiC;IAG9D,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;cAW7B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAazB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGtC"}

package/dist/logger/{FileLogger.js → baseFileLogger.js}

@@ -23,58 +23,50 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTelemetryFileValidationError = exports.createLogger = exports.FileLogger = void 0;
+exports.BaseFileLogger = void 0;
 const fs = __importStar(require("fs"));
-const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 /**
- * Logger that writes events into a defined file
+ * @internal
  */
-class FileLogger {
+class BaseFileLogger {
     /**
      * @param filePath - file path to write logs to
      * @param eventsPerFlush - number of events per flush
+     * @param defaultProps - default properties to add to every telemetry event
      */
-    constructor(filePath, eventsPerFlush = 50) {
+    constructor(filePath, eventsPerFlush = 50, defaultProps) {
         this.filePath = filePath;
         this.eventsPerFlush = eventsPerFlush;
+        this.defaultProps = defaultProps;
         /** Hold events in memory until flushed */
         this.events = [];
-    }
-    async flush() {
-        if (this.events.length > 0) {
-            fs.appendFileSync(this.filePath, this.events.join("\n"));
-            this.events = [];
-        }
+        this.hasWrittenToFile = false;
     }
     send(event) {
-        const logEvent = JSON.stringify(event);
-        this.events.push(logEvent);
+        // eslint-disable-next-line no-param-reassign
+        event = Object.assign(Object.assign({}, event), this.defaultProps);
+        this.events.push(event);
         if (this.events.length >= this.eventsPerFlush || event.category === "error") {
             // eslint-disable-next-line @typescript-eslint/no-floating-promises
             this.flush();
         }
     }
-}
-exports.FileLogger = FileLogger;
-/**
- * Create a ITelemetryLogger wrapped around provided FileLogger
- */
-function createLogger(fileLogger) {
-    return telemetry_utils_1.ChildLogger.create(fileLogger, "LocalSnapshotRunnerApp", { all: { Event_Time: () => Date.now() } });
-}
-exports.createLogger = createLogger;
-/**
- * Validate the telemetryFile command line argument
- * @param telemetryFile - path where telemetry will be written
- */
-function getTelemetryFileValidationError(telemetryFile) {
-    if (!telemetryFile) {
-        return "Telemetry file argument is missing.";
+    async flush() {
+        if (this.events.length > 0) {
+            const contentToWrite = this.events.map((it) => JSON.stringify(it)).join(",");
+            if (this.hasWrittenToFile) {
+                fs.appendFileSync(this.filePath, `,${contentToWrite}`);
+            }
+            else {
+                fs.appendFileSync(this.filePath, contentToWrite);
+            }
+            this.events = [];
+            this.hasWrittenToFile = true;
+        }
     }
-    else if (fs.existsSync(telemetryFile)) {
-        return `Telemetry file already exists [${telemetryFile}].`;
+    async close() {
+        await this.flush();
     }
-    return undefined;
 }
-exports.getTelemetryFileValidationError = getTelemetryFileValidationError;
-//# sourceMappingURL=FileLogger.js.map
+exports.BaseFileLogger = BaseFileLogger;
+//# sourceMappingURL=baseFileLogger.js.map

package/dist/logger/baseFileLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseFileLogger.js","sourceRoot":"","sources":["../../src/logger/baseFileLogger.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAIzB;;GAEG;AACH,MAAsB,cAAc;IAOhC;;;;OAIG;IACF,YACsB,QAAgB,EAChB,iBAAyB,EAAE,EAC3B,YAA8C;QAF9C,aAAQ,GAAR,QAAQ,CAAQ;QAChB,mBAAc,GAAd,cAAc,CAAa;QAC3B,iBAAY,GAAZ,YAAY,CAAkC;QAZrE,0CAA0C;QAChC,WAAM,GAAU,EAAE,CAAC;QACnB,qBAAgB,GAAG,KAAK,CAAC;IAW/B,CAAC;IAEE,IAAI,CAAC,KAA0B;QAClC,6CAA6C;QAC7C,KAAK,mCAAQ,KAAK,GAAK,IAAI,CAAC,YAAY,CAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAExB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO,EAAE;YACzE,mEAAmE;YACnE,IAAI,CAAC,KAAK,EAAE,CAAC;SAChB;IACL,CAAC;IAES,KAAK,CAAC,KAAK;QACjB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7E,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACvB,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,cAAc,EAAE,CAAC,CAAC;aAC1D;iBAAM;gBACH,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;aACpD;YACD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;YACjB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;SAChC;IACL,CAAC;IAEM,KAAK,CAAC,KAAK;QACd,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;CACJ;AA7CD,wCA6CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\nimport { ITelemetryBaseEvent } from \"@fluidframework/common-definitions\";\nimport { IFileLogger } from \"./fileLogger\";\n\n/**\n * @internal\n */\nexport abstract class BaseFileLogger implements IFileLogger {\n    public supportsTags?: true | undefined;\n\n    /** Hold events in memory until flushed */\n    protected events: any[] = [];\n    protected hasWrittenToFile = false;\n\n    /**\n     * @param filePath - file path to write logs to\n     * @param eventsPerFlush - number of events per flush\n     * @param defaultProps - default properties to add to every telemetry event\n     */\n     public constructor(\n        protected readonly filePath: string,\n        protected readonly eventsPerFlush: number = 50,\n        protected readonly defaultProps?: Record<string, string | number>,\n    ) { }\n\n    public send(event: ITelemetryBaseEvent): void {\n        // eslint-disable-next-line no-param-reassign\n        event = { ...event, ...this.defaultProps };\n        this.events.push(event);\n\n        if (this.events.length >= this.eventsPerFlush || event.category === \"error\") {\n            // eslint-disable-next-line @typescript-eslint/no-floating-promises\n            this.flush();\n        }\n    }\n\n    protected async flush(): Promise<void> {\n        if (this.events.length > 0) {\n            const contentToWrite = this.events.map((it) => JSON.stringify(it)).join(\",\");\n            if (this.hasWrittenToFile) {\n                fs.appendFileSync(this.filePath, `,${contentToWrite}`);\n            } else {\n                fs.appendFileSync(this.filePath, contentToWrite);\n            }\n            this.events = [];\n            this.hasWrittenToFile = true;\n        }\n    }\n\n    public async close(): Promise<void> {\n        await this.flush();\n    }\n}\n"]}

package/dist/logger/csvFileLogger.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryBaseEvent } from "@fluidframework/common-definitions";
+import { BaseFileLogger } from "./baseFileLogger";
+/**
+ * FileLogger that writes events into a defined CSV file
+ * @internal
+ */
+export declare class CSVFileLogger extends BaseFileLogger {
+    /** Store the column names to write as the CSV header */
+    private readonly columns;
+    flush(): Promise<void>;
+    send(event: ITelemetryBaseEvent): void;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=csvFileLogger.d.ts.map

package/dist/logger/csvFileLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csvFileLogger.d.ts","sourceRoot":"","sources":["../../src/logger/csvFileLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,qBAAa,aAAc,SAAQ,cAAc;IAC7C,wDAAwD;IACxD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IAExB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAQhC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAStC"}

package/dist/logger/csvFileLogger.js

@@ -0,0 +1,60 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CSVFileLogger = void 0;
+const fs = __importStar(require("fs"));
+const json2csv_1 = require("json2csv");
+const baseFileLogger_1 = require("./baseFileLogger");
+/**
+ * FileLogger that writes events into a defined CSV file
+ * @internal
+ */
+class CSVFileLogger extends baseFileLogger_1.BaseFileLogger {
+    constructor() {
+        super(...arguments);
+        /** Store the column names to write as the CSV header */
+        this.columns = new Set();
+    }
+    async flush() {
+        // Do nothing
+    }
+    send(event) {
+        // eslint-disable-next-line guard-for-in, no-restricted-syntax
+        for (const prop in event) {
+            this.columns.add(prop);
+        }
+        super.send(event);
+    }
+    async close() {
+        await super.close();
+        // eslint-disable-next-line guard-for-in, no-restricted-syntax
+        for (const field in this.defaultProps) {
+            this.columns.add(field);
+        }
+        fs.writeFileSync(this.filePath, (0, json2csv_1.parse)(this.events, Array.from(this.columns)));
+    }
+}
+exports.CSVFileLogger = CSVFileLogger;
+//# sourceMappingURL=csvFileLogger.js.map

package/dist/logger/csvFileLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csvFileLogger.js","sourceRoot":"","sources":["../../src/logger/csvFileLogger.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,uCAAiC;AAEjC,qDAAkD;AAElD;;;GAGG;AACH,MAAa,aAAc,SAAQ,+BAAc;IAAjD;;QACI,wDAAwD;QACvC,YAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IAuBzC,CAAC;IArBU,KAAK,CAAC,KAAK;QACd,aAAa;IACjB,CAAC;IAEM,IAAI,CAAC,KAA0B;QAClC,8DAA8D;QAC9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACtB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SAC1B;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,KAAK;QACd,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACpB,8DAA8D;QAC9D,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,EAAE;YACnC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SAC3B;QAED,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAA,gBAAK,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;CACJ;AAzBD,sCAyBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as fs from \"fs\";\nimport { parse } from \"json2csv\";\nimport { ITelemetryBaseEvent } from \"@fluidframework/common-definitions\";\nimport { BaseFileLogger } from \"./baseFileLogger\";\n\n/**\n * FileLogger that writes events into a defined CSV file\n * @internal\n */\nexport class CSVFileLogger extends BaseFileLogger {\n    /** Store the column names to write as the CSV header */\n    private readonly columns = new Set();\n\n    public async flush(): Promise<void> {\n        // Do nothing\n    }\n\n    public send(event: ITelemetryBaseEvent): void {\n        // eslint-disable-next-line guard-for-in, no-restricted-syntax\n        for (const prop in event) {\n            this.columns.add(prop);\n        }\n        super.send(event);\n    }\n\n    public async close(): Promise<void> {\n        await super.close();\n        // eslint-disable-next-line guard-for-in, no-restricted-syntax\n        for (const field in this.defaultProps) {\n            this.columns.add(field);\n        }\n\n        fs.writeFileSync(this.filePath, parse(this.events, Array.from(this.columns)));\n    }\n}\n"]}

package/dist/logger/fileLogger.d.ts

@@ -0,0 +1,38 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+/**
+ * Contract for logger that writes telemetry to a file
+ * @internal
+ */
+export interface IFileLogger extends ITelemetryBaseLogger {
+    /**
+     * This method acts as a "dispose" and should be explicitly called at the end of execution
+     */
+    close(): Promise<void>;
+}
+/**
+ * Desired output format for the telemetry
+ */
+export declare enum OutputFormat {
+    JSON = 0,
+    CSV = 1
+}
+/**
+ * Options to provide upon creation of IFileLogger
+ * @internal
+ */
+export interface ITelemetryOptions {
+    /** Desired output format used to create a specific IFileLogger implementation */
+    outputFormat?: OutputFormat;
+    /**
+     * Properties that should be added to every telemetry event
+     * Example: { "prop1": "value1", "prop2": 10.0 }
+     */
+    defaultProps?: Record<string, string | number>;
+    /** Number of telemetry events per flush to telemetry file */
+    eventsPerFlush?: number;
+}
+//# sourceMappingURL=fileLogger.d.ts.map