@fluidframework/fluid-telemetry 2.0.0-dev-rc.3.0.0.253463

package/.eslintrc.cjs

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json"],
+	},
+};

package/.mocharc.cjs

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# Description
+
+This package contains code enabling the production and consumption of typed telemetry for Fluid Framework applications. The typed telemetry from this package is used as the backbone for different Fluid Framework cloud offerings such as dashboards and alarms for Fluid applications. This package can also be used as a reference for customizing and creating your own telemetry solution if desired.
+
+At this time, the package enables collection of Fluid Container related telemetry. In the future more areas may be added as needed by customers.
+
+# Getting Started
+
+Let's walk through some simple examples for getting started with Fluid telemetry for containers using the @fluidframework/fluid-telemetry package, we'll have to write some code.
+
+## Example 1: Logging container telemetry to Azure App Insights
+
+Before you can get telemetry sent to Azure App Insights, you'll need to create an Instance of App Insights on Azure. Then you'll be able to create an Azure App Insights client that you can easily turn into a ITelemetryConsumer and finally hook it up to container telemetry. [Learn more about Azure App Insights](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview)
+
+### Step 1: Install the @fluidframework/fluid-telemetry package and Azure App Insights package dependencies
+
+-   Using NPM: `npm install @fluidframework/fluid-telemetry @microsoft/applicationinsights-web`
+
+#### Step 2: Now, let's start the telemetry production by initializing our telemetry collection where we initialize our containers:
+
+```ts
+import { ApplicationInsights } from "@microsoft/applicationinsights-web";
+import { IFluidContainer } from "@fluidframework/fluid-static";
+import { ITelemetryConsumer , TelemetryConfig, startTelemetry, IFluidTelemetry } from "@fluidframework/fluid-telemetry"
+import { AppInsightsTelemetryConsumer } from "@fluidframework/fluid-telemetry/app-insights"
+
+// 1: This is supposed to be your code for creating/loading a Fluid Container
+let myAppContainer: IFluidContainer;
+let myAppContainerId: string;
+if (containerExists) {
+    myAppContainerId = {...your code to get the id of the existing container}
+    myAppContainer = {...your code to load a Fluid Container from myAppContainerId}
+} else {
+    myAppContainer = {...your code to create a new Fluid Container}
+    myAppContainerId = await myAppContainer.attach();
+}
+
+// 2a: Instantiate our Azure App Insights Client
+const appInsightsClient = new ApplicationInsights({
+    config: {
+        connectionString:
+            // Edit this with your app insights instance connection string (this is an example string)
+            "InstrumentationKey=abcdefgh-ijkl-mnop-qrst-uvwxyz6ffd9c;IngestionEndpoint=https://westus2-2.in.applicationinsights.azure.com/;LiveEndpoint=https://westus2.livediagnostics.monitor.azure.com/",
+    },
+});
+
+// 2b: Initializes the App Insights client. Without this, logs will not be sent to Azure.
+appInsightsClient.loadAppInsights();
+
+// 3: Next, we'll create the telemetry config object.
+// Note that we have to obtain the containerId before we can do this.
+const telemetryConfig: TelemetryConfig = {
+    container: myAppContainer,
+    containerId: myAppContainerId,
+    // We import AppInsightsTelemetryConsumer from the fluid-telemetry package
+    consumers: [new AppInsightsTelemetryConsumer(appInsightsClient)],
+};
+
+// 4. Start Telemetry
+startTelemetry(telemetryConfig);
+
+// Done! Your container telemetry is now being created and sent to your Telemetry Consumer which will forward it to Azure App Insights.
+```
+
+Congrats, that's it for now! If you've decided to use Azure App Insights, we have designed useful prebuilt queries for you that utilize the generated telemetry
+
+## Example 2: Extending ITelemetryConsumer to send Fluid telemetry to a custom destination
+
+In this example, you'll walk through the basic setup process to start getting container telemetry to be produced and logging it to the console.
+
+### Step 1: Install the @fluidframework/fluid-telemetry package dependency
+
+-   Using NPM: `npm install @fluidframework/fluid-telemetry`
+
+### Step 2: First, we'll have to create our own telemetry consumer which extends the ITelemetryConsumer interface. Let's look at an example that will simply console.log the telemetry.
+
+```ts
+import { ITelemetryConsumer, IFluidTelemetry } from "@fluidframework/fluid-telemetry";
+
+class MySimpleTelemetryConsumer implements ITelemetryConsumer {
+	consume(event: IFluidTelemetry) {
+		console.log(event);
+	}
+}
+```
+
+### Step 3: Now, let's start the telemetry production and hook in our telemetry consumer from step 2. We will be initializing our telemetry collection where we initialize our containers:
+
+```ts
+import { IFluidContainer } from "@fluidframework/fluid-static";
+import { ITelemetryConsumer , TelemetryConfig, startTelemetry, IFluidTelemetry } from "@fluidframework/external-telemetry"
+// 1: import our implementation of MySimpleTelemetryConsumer from step 1
+import { MySimpleTelemetryConsumer } from "./mySimpleTelmetryConsumer"
+
+// 2: This is supposed to be your code for creating/loading a Fluid Container
+let myAppContainer: IFluidContainer;
+let myAppContainerId: string;
+if (containerExists) {
+    myAppContainerId = {...your code to get the id of the existing container}
+    myAppContainer = {...your code to load a Fluid Container from myAppContainerId}
+} else {
+    myAppContainer = {...your code to create a new Fluid Container}
+    myAppContainerId = await myAppContainer.attach();
+}
+
+// 3. Next, we'll create the telemetry config object.
+// Note that we have to obtain the containerId before we can do this.
+const telemetryConfig: TelemetryConfig = {
+    container: myAppContainer,
+    containerId: myAppContainerId,
+    consumers: [new MySimpleTelemetryConsumer(appInsightsClient)],
+};
+
+// 4. Start Telemetry
+startTelemetry(telemetryConfig);
+
+// Done! Your container telemetry is now being created and sent to your Telemetry Consumer
+```

package/api-extractor-cjs.json

@@ -0,0 +1,30 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../../common/build/build-common/api-extractor-base.cjs.primary.json",
+	// CJS is actually secondary; so, no report.
+	"apiReport": {
+		"enabled": false
+	},
+	"messages": {
+		// The following overrides are workarounds for API-Extractor incorrectly running analysis on our application
+		// insights dependency.
+		"tsdocMessageReporting": {
+			"tsdoc-escape-right-brace": {
+				"logLevel": "none"
+			},
+			"tsdoc-malformed-inline-tag": {
+				"logLevel": "none"
+			},
+			"tsdoc-undefined-tag": {
+				"logLevel": "none"
+			}
+		},
+		"extractorMessageReporting": {
+			// Require documentation on all package-exported API items.
+			"ae-undocumented": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../../common/build/build-common/api-extractor-lint.esm.primary.json"
+}

package/api-extractor.json

@@ -0,0 +1,26 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../../common/build/build-common/api-extractor-base.esm.primary.json",
+	"messages": {
+		// The following overrides are workarounds for API-Extractor incorrectly running analysis on our application
+		// insights dependency.
+		"tsdocMessageReporting": {
+			"tsdoc-escape-right-brace": {
+				"logLevel": "none"
+			},
+			"tsdoc-malformed-inline-tag": {
+				"logLevel": "none"
+			},
+			"tsdoc-undefined-tag": {
+				"logLevel": "none"
+			}
+		},
+		"extractorMessageReporting": {
+			// Require documentation on all package-exported API items.
+			"ae-undocumented": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-report/external-telemetry.api.md

@@ -0,0 +1,68 @@
+## API Report File for "@fluidframework/external-telemetry"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+
+// @beta
+export interface ContainerConnectedTelemetry extends IContainerTelemetry {
+    eventName: "fluidframework.container.connected";
+}
+
+// @beta
+export interface ContainerDisconnectedTelemetry extends IContainerTelemetry {
+    eventName: "fluidframework.container.disconnected";
+}
+
+// @beta
+export interface ContainerDisposedTelemetry extends IContainerTelemetry {
+    error?: ICriticalContainerError;
+    eventName: "fluidframework.container.disposed";
+}
+
+// @beta
+export type ContainerTelemetryEventName = (typeof ContainerTelemetryEventNames)[keyof typeof ContainerTelemetryEventNames];
+
+// @beta
+export const ContainerTelemetryEventNames: {
+    readonly CONNECTED: "fluidframework.container.connected";
+    readonly DISCONNECTED: "fluidframework.container.disconnected";
+    readonly DISPOSED: "fluidframework.container.disposed";
+};
+
+// @beta
+export type FluidTelemetryEventName = ContainerTelemetryEventName;
+
+// @beta
+export interface IContainerTelemetry extends IFluidTelemetry {
+    containerId?: string;
+    containerInstanceId: string;
+    eventName: ContainerTelemetryEventName;
+}
+
+// @beta
+export interface IFluidTelemetry {
+    eventName: FluidTelemetryEventName;
+}
+
+// @beta
+export interface ITelemetryConsumer {
+    consume(event: IFluidTelemetry): any;
+}
+
+// @beta
+export const startTelemetry: (config: TelemetryConfig) => void;
+
+// @beta
+export interface TelemetryConfig {
+    consumers: ITelemetryConsumer[];
+    container: IFluidContainer;
+    containerId: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-report/fluid-telemetry.api.md

@@ -0,0 +1,68 @@
+## API Report File for "@fluidframework/fluid-telemetry"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+
+// @beta
+export interface ContainerConnectedTelemetry extends IContainerTelemetry {
+    eventName: "fluidframework.container.connected";
+}
+
+// @beta
+export interface ContainerDisconnectedTelemetry extends IContainerTelemetry {
+    eventName: "fluidframework.container.disconnected";
+}
+
+// @beta
+export interface ContainerDisposedTelemetry extends IContainerTelemetry {
+    error?: ICriticalContainerError;
+    eventName: "fluidframework.container.disposed";
+}
+
+// @beta
+export type ContainerTelemetryEventName = (typeof ContainerTelemetryEventNames)[keyof typeof ContainerTelemetryEventNames];
+
+// @beta
+export const ContainerTelemetryEventNames: {
+    readonly CONNECTED: "fluidframework.container.connected";
+    readonly DISCONNECTED: "fluidframework.container.disconnected";
+    readonly DISPOSED: "fluidframework.container.disposed";
+};
+
+// @beta
+export type FluidTelemetryEventName = ContainerTelemetryEventName;
+
+// @beta
+export interface IContainerTelemetry extends IFluidTelemetry {
+    containerId?: string;
+    containerInstanceId: string;
+    eventName: ContainerTelemetryEventName;
+}
+
+export { ICriticalContainerError }
+
+// @beta
+export interface IFluidTelemetry {
+    eventName: FluidTelemetryEventName;
+}
+
+// @beta
+export interface ITelemetryConsumer {
+    consume(event: IFluidTelemetry): any;
+}
+
+// @beta
+export const startTelemetry: (config: TelemetryConfig) => void;
+
+// @beta
+export interface TelemetryConfig {
+    consumers: ITelemetryConsumer[];
+    container: IFluidContainer;
+    containerId: string;
+}
+
+```

package/dist/app-insights/appInsightsTelemetryConsumer.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type ApplicationInsights } from "@microsoft/applicationinsights-web";
+import type { IFluidTelemetry, ITelemetryConsumer } from "../common/index.js";
+/**
+ * An implementation of {@link ITelemetryConsumer} that routes {@link IFluidTelemetry} to Azure App Insights
+ * in a format that is supported by Fluid Framework service offerings such as Cloud dashboards and alarms.
+ */
+export declare class AppInsightsTelemetryConsumer implements ITelemetryConsumer {
+    private readonly appInsightsClient;
+    constructor(appInsightsClient: ApplicationInsights);
+    consume(event: IFluidTelemetry): void;
+}
+//# sourceMappingURL=appInsightsTelemetryConsumer.d.ts.map

package/dist/app-insights/appInsightsTelemetryConsumer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appInsightsTelemetryConsumer.d.ts","sourceRoot":"","sources":["../../src/app-insights/appInsightsTelemetryConsumer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE9E;;;GAGG;AACH,qBAAa,4BAA6B,YAAW,kBAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,iBAAiB;gBAAjB,iBAAiB,EAAE,mBAAmB;IAEnE,OAAO,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;CAM5C"}

package/dist/app-insights/appInsightsTelemetryConsumer.js

@@ -0,0 +1,24 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppInsightsTelemetryConsumer = void 0;
+/**
+ * An implementation of {@link ITelemetryConsumer} that routes {@link IFluidTelemetry} to Azure App Insights
+ * in a format that is supported by Fluid Framework service offerings such as Cloud dashboards and alarms.
+ */
+class AppInsightsTelemetryConsumer {
+    constructor(appInsightsClient) {
+        this.appInsightsClient = appInsightsClient;
+    }
+    consume(event) {
+        this.appInsightsClient.trackEvent({
+            name: event.eventName,
+            properties: event,
+        });
+    }
+}
+exports.AppInsightsTelemetryConsumer = AppInsightsTelemetryConsumer;
+//# sourceMappingURL=appInsightsTelemetryConsumer.js.map

package/dist/app-insights/appInsightsTelemetryConsumer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appInsightsTelemetryConsumer.js","sourceRoot":"","sources":["../../src/app-insights/appInsightsTelemetryConsumer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH;;;GAGG;AACH,MAAa,4BAA4B;IACxC,YAAoC,iBAAsC;QAAtC,sBAAiB,GAAjB,iBAAiB,CAAqB;IAAG,CAAC;IAEvE,OAAO,CAAC,KAAsB;QACpC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC;YACjC,IAAI,EAAE,KAAK,CAAC,SAAS;YACrB,UAAU,EAAE,KAAK;SACjB,CAAC,CAAC;IACJ,CAAC;CACD;AATD,oEASC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type ApplicationInsights } from \"@microsoft/applicationinsights-web\";\nimport type { IFluidTelemetry, ITelemetryConsumer } from \"../common/index.js\";\n\n/**\n * An implementation of {@link ITelemetryConsumer} that routes {@link IFluidTelemetry} to Azure App Insights\n * in a format that is supported by Fluid Framework service offerings such as Cloud dashboards and alarms.\n */\nexport class AppInsightsTelemetryConsumer implements ITelemetryConsumer {\n\tpublic constructor(private readonly appInsightsClient: ApplicationInsights) {}\n\n\tpublic consume(event: IFluidTelemetry): void {\n\t\tthis.appInsightsClient.trackEvent({\n\t\t\tname: event.eventName,\n\t\t\tproperties: event,\n\t\t});\n\t}\n}\n"]}

package/dist/app-insights/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { AppInsightsTelemetryConsumer } from "./appInsightsTelemetryConsumer.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/app-insights/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/app-insights/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/app-insights/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppInsightsTelemetryConsumer = void 0;
+var appInsightsTelemetryConsumer_js_1 = require("./appInsightsTelemetryConsumer.js");
+Object.defineProperty(exports, "AppInsightsTelemetryConsumer", { enumerable: true, get: function () { return appInsightsTelemetryConsumer_js_1.AppInsightsTelemetryConsumer; } });
+//# sourceMappingURL=index.js.map

package/dist/app-insights/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/app-insights/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qFAAiF;AAAxE,+IAAA,4BAA4B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { AppInsightsTelemetryConsumer } from \"./appInsightsTelemetryConsumer.js\";\n"]}

package/dist/common/consumers/index.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IFluidTelemetry } from "../index.js";
+/**
+ * Base interface for all telemetry consumers.
+ * Conusmers are intended to take incoming produced {@link IFluidTelemetry} and do something of your choice with it.
+ * This could be sending the telemetry to a cloud platform or just console logging.
+ *
+ * @example
+ * Here is an example of how we construct a consumer to send telemetry to Azure App Insights, a cloud logging platform:
+ * ```ts
+ * class AppInsightsTelemetryConsumer implements ITelemetryConsumer {
+ *	   constructor(private readonly appInsightsClient: ApplicationInsights) {}
+ *
+ *	   consume(event: IFluidTelemetry) {
+ *		   this.appInsightsClient.trackEvent({
+ *			   name: event.eventName,
+ *			   properties: event,
+ *		   });
+ *	   }
+ * }
+ *```
+ *
+ * @beta
+ */
+export interface ITelemetryConsumer {
+    /**
+     * This method is intended to take created {@link IFluidTelemetry} and do something with it.
+     * This could be sending the telemetry to a cloud platform, just console logging or something else of your choice.
+     */
+    consume(event: IFluidTelemetry): any;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/common/consumers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/consumers/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,eAAe,OAAE;CAChC"}

package/dist/common/consumers/index.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/common/consumers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/consumers/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidTelemetry } from \"../index.js\";\n\n/**\n * Base interface for all telemetry consumers.\n * Conusmers are intended to take incoming produced {@link IFluidTelemetry} and do something of your choice with it.\n * This could be sending the telemetry to a cloud platform or just console logging.\n *\n * @example\n * Here is an example of how we construct a consumer to send telemetry to Azure App Insights, a cloud logging platform:\n * ```ts\n * class AppInsightsTelemetryConsumer implements ITelemetryConsumer {\n *\t   constructor(private readonly appInsightsClient: ApplicationInsights) {}\n *\n *\t   consume(event: IFluidTelemetry) {\n *\t\t   this.appInsightsClient.trackEvent({\n *\t\t\t   name: event.eventName,\n *\t\t\t   properties: event,\n *\t\t   });\n *\t   }\n * }\n *```\n *\n * @beta\n */\nexport interface ITelemetryConsumer {\n\t/**\n\t * This method is intended to take created {@link IFluidTelemetry} and do something with it.\n\t * This could be sending the telemetry to a cloud platform, just console logging or something else of your choice.\n\t */\n\tconsume(event: IFluidTelemetry);\n}\n"]}

package/dist/common/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { type ITelemetryConsumer } from "./consumers/index.js";
+export { type IFluidTelemetry, type FluidTelemetryEventName } from "./telemetry/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/common/index.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { type ITelemetryConsumer } from \"./consumers/index.js\";\nexport { type IFluidTelemetry, type FluidTelemetryEventName } from \"./telemetry/index.js\";\n"]}

package/dist/common/telemetry/index.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ContainerTelemetryEventName } from "../../container/index.js";
+/**
+ * The base interface extended by all Fluid telemetry
+ *
+ * @see {@link @fluidframework/fluid-telemetry#IContainerTelemetry} for an extension of this interface for all container related telemetry.
+ *
+ * @beta
+ */
+export interface IFluidTelemetry {
+    /**
+     * The unique name of the telemetry event. The event name contains scope concatenated together
+     * with periods to enable more granular log searching
+     *
+     * @example
+     * "fluidframework.container.connected"
+     */
+    eventName: FluidTelemetryEventName;
+}
+/**
+ * Aggregate type for all the different types of Fluid telemetry event names.
+ *
+ * @privateremarks This only looks odd right now because {@link ContainerTelemetryEventName} is the only aggregation at the moment.
+ *
+ * @beta
+ */
+export type FluidTelemetryEventName = ContainerTelemetryEventName;
+//# sourceMappingURL=index.d.ts.map

package/dist/common/telemetry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/telemetry/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC/B;;;;;;OAMG;IACH,SAAS,EAAE,uBAAuB,CAAC;CACnC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,CAAC"}

package/dist/common/telemetry/index.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/common/telemetry/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/telemetry/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ContainerTelemetryEventName } from \"../../container/index.js\";\n\n/**\n * The base interface extended by all Fluid telemetry\n *\n * @see {@link @fluidframework/fluid-telemetry#IContainerTelemetry} for an extension of this interface for all container related telemetry.\n *\n * @beta\n */\nexport interface IFluidTelemetry {\n\t/**\n\t * The unique name of the telemetry event. The event name contains scope concatenated together\n\t * with periods to enable more granular log searching\n\t *\n\t * @example\n\t * \"fluidframework.container.connected\"\n\t */\n\teventName: FluidTelemetryEventName;\n}\n\n/**\n * Aggregate type for all the different types of Fluid telemetry event names.\n *\n * @privateremarks This only looks odd right now because {@link ContainerTelemetryEventName} is the only aggregation at the moment.\n *\n * @beta\n */\nexport type FluidTelemetryEventName = ContainerTelemetryEventName;\n"]}

package/dist/container/containerSystemEvents.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * This object contains a non-exhaustive set of the unique event names of raw {@link @fluidframework/fluid-static#IFluidContainerEvents | system events } produced by Fluid containers.
+ * It's important to note that each actual system events is a function signature such as `(event: "readonly", listener: (readonly: boolean) => void): void;`
+ * but this object only captures the event name in each function.
+ *
+ * @privateremarks This should probably exist within IContainer itself instead of being defined here.
+ */
+export declare const IFluidContainerSystemEventNames: {
+    readonly CONNECTED: "connected";
+    readonly DISCONNECTED: "disconnected";
+    readonly DISPOSED: "disposed";
+};
+/**
+ * The type for all values within {@link IFluidContainerSystemEventNames}
+ */
+export type IFluidContainerSystemEventName = (typeof IFluidContainerSystemEventNames)[keyof typeof IFluidContainerSystemEventNames];
+//# sourceMappingURL=containerSystemEvents.d.ts.map

package/dist/container/containerSystemEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerSystemEvents.d.ts","sourceRoot":"","sources":["../../src/container/containerSystemEvents.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;CAIlC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACzC,CAAC,OAAO,+BAA+B,CAAC,CAAC,MAAM,OAAO,+BAA+B,CAAC,CAAC"}

package/dist/container/containerSystemEvents.js

@@ -0,0 +1,20 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IFluidContainerSystemEventNames = void 0;
+/**
+ * This object contains a non-exhaustive set of the unique event names of raw {@link @fluidframework/fluid-static#IFluidContainerEvents | system events } produced by Fluid containers.
+ * It's important to note that each actual system events is a function signature such as `(event: "readonly", listener: (readonly: boolean) => void): void;`
+ * but this object only captures the event name in each function.
+ *
+ * @privateremarks This should probably exist within IContainer itself instead of being defined here.
+ */
+exports.IFluidContainerSystemEventNames = {
+    CONNECTED: "connected",
+    DISCONNECTED: "disconnected",
+    DISPOSED: "disposed",
+};
+//# sourceMappingURL=containerSystemEvents.js.map

package/dist/container/containerSystemEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerSystemEvents.js","sourceRoot":"","sources":["../../src/container/containerSystemEvents.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;;GAMG;AACU,QAAA,+BAA+B,GAAG;IAC9C,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,QAAQ,EAAE,UAAU;CACX,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This object contains a non-exhaustive set of the unique event names of raw {@link @fluidframework/fluid-static#IFluidContainerEvents | system events } produced by Fluid containers.\n * It's important to note that each actual system events is a function signature such as `(event: \"readonly\", listener: (readonly: boolean) => void): void;`\n * but this object only captures the event name in each function.\n *\n * @privateremarks This should probably exist within IContainer itself instead of being defined here.\n */\nexport const IFluidContainerSystemEventNames = {\n\tCONNECTED: \"connected\",\n\tDISCONNECTED: \"disconnected\",\n\tDISPOSED: \"disposed\",\n} as const;\n\n/**\n * The type for all values within {@link IFluidContainerSystemEventNames}\n */\nexport type IFluidContainerSystemEventName =\n\t(typeof IFluidContainerSystemEventNames)[keyof typeof IFluidContainerSystemEventNames];\n"]}