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

package/lib/container/telemetryProducer.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IFluidTelemetry } from "../index.js";
+import { type IContainerTelemetry } from "./containerTelemetry.js";
+import { type IFluidContainerSystemEventName } from "./containerSystemEvents.js";
+/**
+ * This class produces {@link IContainerTelemetry} from raw container system events {@link @fluidframework/fluid-static#IFluidContainerEvents}.
+ * The class contains different helper methods for simplifying and standardizing logic for adding additional information necessary
+ * to produce different {@link IContainerTelemetry}.
+ */
+export declare class ContainerEventTelemetryProducer {
+    private readonly containerId;
+    /**
+     * Unique identifier for the instance of the container that this class is generating telemetry for.
+     */
+    private readonly containerInstanceId;
+    constructor(containerId: string);
+    produceFromSystemEvent(eventName: IFluidContainerSystemEventName, payload?: unknown): IContainerTelemetry | undefined;
+    produceHeartbeatTelemetry: () => IFluidTelemetry;
+    private readonly produceBaseContainerTelemetry;
+    private readonly produceDiposedTelemetry;
+}
+//# sourceMappingURL=telemetryProducer.d.ts.map

package/lib/container/telemetryProducer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetryProducer.d.ts","sourceRoot":"","sources":["../../src/container/telemetryProducer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAGN,KAAK,mBAAmB,EAExB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,8BAA8B,EAEnC,MAAM,4BAA4B,CAAC;AAEpC;;;;GAIG;AACH,qBAAa,+BAA+B;IAMxB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAL/C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAU;gBAEV,WAAW,EAAE,MAAM;IAEhD,sBAAsB,CAC5B,SAAS,EAAE,8BAA8B,EACzC,OAAO,CAAC,EAAE,OAAO,GACf,mBAAmB,GAAG,SAAS;IAoB3B,yBAAyB,QAAO,eAAe,CAMpD;IAEF,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAQ5C;IAEF,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAYtC;CACF"}

package/lib/container/telemetryProducer.js

@@ -0,0 +1,64 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { v4 as uuid } from "uuid";
+import { ContainerTelemetryEventNames, } from "./containerTelemetry.js";
+import { IFluidContainerSystemEventNames, } from "./containerSystemEvents.js";
+/**
+ * This class produces {@link IContainerTelemetry} from raw container system events {@link @fluidframework/fluid-static#IFluidContainerEvents}.
+ * The class contains different helper methods for simplifying and standardizing logic for adding additional information necessary
+ * to produce different {@link IContainerTelemetry}.
+ */
+export class ContainerEventTelemetryProducer {
+    constructor(containerId) {
+        this.containerId = containerId;
+        /**
+         * Unique identifier for the instance of the container that this class is generating telemetry for.
+         */
+        this.containerInstanceId = uuid();
+        this.produceHeartbeatTelemetry = () => {
+            return {
+                eventName: "fluidframework.container.heartbeat",
+                containerId: this.containerId,
+                containerInstanceId: this.containerInstanceId,
+            };
+        };
+        this.produceBaseContainerTelemetry = (eventName) => {
+            return {
+                eventName,
+                containerId: this.containerId,
+                containerInstanceId: this.containerInstanceId,
+            };
+        };
+        this.produceDiposedTelemetry = (payload) => {
+            const telemetry = {
+                eventName: ContainerTelemetryEventNames.DISPOSED,
+                containerId: this.containerId,
+                containerInstanceId: this.containerInstanceId,
+            };
+            if (payload?.error !== undefined) {
+                telemetry.error = payload.error;
+            }
+            return telemetry;
+        };
+    }
+    produceFromSystemEvent(eventName, payload) {
+        switch (eventName) {
+            case IFluidContainerSystemEventNames.CONNECTED: {
+                return this.produceBaseContainerTelemetry(ContainerTelemetryEventNames.CONNECTED);
+            }
+            case IFluidContainerSystemEventNames.DISCONNECTED: {
+                return this.produceBaseContainerTelemetry(ContainerTelemetryEventNames.DISCONNECTED);
+            }
+            case IFluidContainerSystemEventNames.DISPOSED: {
+                const typedPayload = payload;
+                return this.produceDiposedTelemetry(typedPayload);
+            }
+            default: {
+                break;
+            }
+        }
+    }
+}
+//# sourceMappingURL=telemetryProducer.js.map

package/lib/container/telemetryProducer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetryProducer.js","sourceRoot":"","sources":["../../src/container/telemetryProducer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EACN,4BAA4B,GAI5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAEN,+BAA+B,GAC/B,MAAM,4BAA4B,CAAC;AAEpC;;;;GAIG;AACH,MAAM,OAAO,+BAA+B;IAM3C,YAAoC,WAAmB;QAAnB,gBAAW,GAAX,WAAW,CAAQ;QALvD;;WAEG;QACc,wBAAmB,GAAG,IAAI,EAAE,CAAC;QA2BvC,8BAAyB,GAAG,GAAoB,EAAE;YACxD,OAAO;gBACN,SAAS,EAAE,oCAAoC;gBAC/C,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aACf,CAAC;QACjC,CAAC,CAAC;QAEe,kCAA6B,GAAG,CAChD,SAAsC,EAChB,EAAE;YACxB,OAAO;gBACN,SAAS;gBACT,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aACf,CAAC;QACjC,CAAC,CAAC;QAEe,4BAAuB,GAAG,CAAC,OAE3C,EAA8B,EAAE;YAChC,MAAM,SAAS,GAA+B;gBAC7C,SAAS,EAAE,4BAA4B,CAAC,QAAQ;gBAChD,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;aAC7C,CAAC;YACF,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS,EAAE;gBACjC,SAAS,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;aAChC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC,CAAC;IAvDwD,CAAC;IAEpD,sBAAsB,CAC5B,SAAyC,EACzC,OAAiB;QAEjB,QAAQ,SAAS,EAAE;YAClB,KAAK,+BAA+B,CAAC,SAAS,CAAC,CAAC;gBAC/C,OAAO,IAAI,CAAC,6BAA6B,CAAC,4BAA4B,CAAC,SAAS,CAAC,CAAC;aAClF;YACD,KAAK,+BAA+B,CAAC,YAAY,CAAC,CAAC;gBAClD,OAAO,IAAI,CAAC,6BAA6B,CACxC,4BAA4B,CAAC,YAAY,CACzC,CAAC;aACF;YACD,KAAK,+BAA+B,CAAC,QAAQ,CAAC,CAAC;gBAC9C,MAAM,YAAY,GAAG,OAA8C,CAAC;gBACpE,OAAO,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;aAClD;YACD,OAAO,CAAC,CAAC;gBACR,MAAM;aACN;SACD;IACF,CAAC;CAiCD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport type { IFluidTelemetry } from \"../index.js\";\nimport {\n\tContainerTelemetryEventNames,\n\ttype ContainerTelemetryEventName,\n\ttype IContainerTelemetry,\n\ttype ContainerDisposedTelemetry,\n} from \"./containerTelemetry.js\";\nimport {\n\ttype IFluidContainerSystemEventName,\n\tIFluidContainerSystemEventNames,\n} from \"./containerSystemEvents.js\";\n\n/**\n * This class produces {@link IContainerTelemetry} from raw container system events {@link @fluidframework/fluid-static#IFluidContainerEvents}.\n * The class contains different helper methods for simplifying and standardizing logic for adding additional information necessary\n * to produce different {@link IContainerTelemetry}.\n */\nexport class ContainerEventTelemetryProducer {\n\t/**\n\t * Unique identifier for the instance of the container that this class is generating telemetry for.\n\t */\n\tprivate readonly containerInstanceId = uuid();\n\n\tpublic constructor(private readonly containerId: string) {}\n\n\tpublic produceFromSystemEvent(\n\t\teventName: IFluidContainerSystemEventName,\n\t\tpayload?: unknown,\n\t): IContainerTelemetry | undefined {\n\t\tswitch (eventName) {\n\t\t\tcase IFluidContainerSystemEventNames.CONNECTED: {\n\t\t\t\treturn this.produceBaseContainerTelemetry(ContainerTelemetryEventNames.CONNECTED);\n\t\t\t}\n\t\t\tcase IFluidContainerSystemEventNames.DISCONNECTED: {\n\t\t\t\treturn this.produceBaseContainerTelemetry(\n\t\t\t\t\tContainerTelemetryEventNames.DISCONNECTED,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase IFluidContainerSystemEventNames.DISPOSED: {\n\t\t\t\tconst typedPayload = payload as { error?: ICriticalContainerError };\n\t\t\t\treturn this.produceDiposedTelemetry(typedPayload);\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic produceHeartbeatTelemetry = (): IFluidTelemetry => {\n\t\treturn {\n\t\t\teventName: \"fluidframework.container.heartbeat\",\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t} as unknown as IFluidTelemetry;\n\t};\n\n\tprivate readonly produceBaseContainerTelemetry = (\n\t\teventName: ContainerTelemetryEventName,\n\t): IContainerTelemetry => {\n\t\treturn {\n\t\t\teventName,\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t} satisfies IContainerTelemetry;\n\t};\n\n\tprivate readonly produceDiposedTelemetry = (payload?: {\n\t\terror?: ICriticalContainerError;\n\t}): ContainerDisposedTelemetry => {\n\t\tconst telemetry: ContainerDisposedTelemetry = {\n\t\t\teventName: ContainerTelemetryEventNames.DISPOSED,\n\t\t\tcontainerId: this.containerId,\n\t\t\tcontainerInstanceId: this.containerInstanceId,\n\t\t};\n\t\tif (payload?.error !== undefined) {\n\t\t\ttelemetry.error = payload.error;\n\t\t}\n\t\treturn telemetry;\n\t};\n}\n"]}

package/lib/factory/index.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IFluidContainer } from "@fluidframework/fluid-static";
+import { type ITelemetryConsumer } from "../common/index.js";
+/**
+ * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}
+ *
+ * @beta
+ */
+export interface TelemetryConfig {
+    /**
+     * The container whose events should be monitored, transformed into Fluid telemetry, and sent to a {@link ITelemetryConsumer}.
+     */
+    container: IFluidContainer;
+    /**
+     * Unique identifier for the passed in container, i.e. the return value of a call
+     * to {@link @fluidframework/fluid-static#IFluidContainer.attach | `IFluidContainer.attach()`} when creating a new
+     * Fluid container, or the id used to load a pre-existing one.
+     */
+    containerId: string;
+    /**
+     * Conusmers take incoming produced {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and do something of your choice with it.
+     * This could be sending the telemetry to a cloud platform or just console logging.
+     */
+    consumers: ITelemetryConsumer[];
+}
+/**
+ * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container
+ * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}
+ *
+ * @beta
+ */
+export declare const startTelemetry: (config: TelemetryConfig) => void;
+//# sourceMappingURL=index.d.ts.map

package/lib/factory/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAEpE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAC3B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,WAAY,eAAe,KAAG,IAGxD,CAAC"}

package/lib/factory/index.js

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ContainerTelemetryManager, ContainerEventTelemetryProducer } from "../container/index.js";
+/**
+ * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container
+ * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}
+ *
+ * @beta
+ */
+export const startTelemetry = (config) => {
+    const telemetryProducer = new ContainerEventTelemetryProducer(config.containerId);
+    new ContainerTelemetryManager(config.container, telemetryProducer, config.consumers);
+};
+//# sourceMappingURL=index.js.map

package/lib/factory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AA0BnG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAuB,EAAQ,EAAE;IAC/D,MAAM,iBAAiB,GAAG,IAAI,+BAA+B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAClF,IAAI,yBAAyB,CAAC,MAAM,CAAC,SAAS,EAAE,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;AACtF,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidContainer } from \"@fluidframework/fluid-static\";\nimport { ContainerTelemetryManager, ContainerEventTelemetryProducer } from \"../container/index.js\";\nimport { type ITelemetryConsumer } from \"../common/index.js\";\n\n/**\n * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}\n *\n * @beta\n */\nexport interface TelemetryConfig {\n\t/**\n\t * The container whose events should be monitored, transformed into Fluid telemetry, and sent to a {@link ITelemetryConsumer}.\n\t */\n\tcontainer: IFluidContainer;\n\t/**\n\t * Unique identifier for the passed in container, i.e. the return value of a call\n\t * to {@link @fluidframework/fluid-static#IFluidContainer.attach | `IFluidContainer.attach()`} when creating a new\n\t * Fluid container, or the id used to load a pre-existing one.\n\t */\n\tcontainerId: string;\n\t/**\n\t * Conusmers take incoming produced {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and do something of your choice with it.\n\t * This could be sending the telemetry to a cloud platform or just console logging.\n\t */\n\tconsumers: ITelemetryConsumer[];\n}\n\n/**\n * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container\n * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}\n *\n * @beta\n */\nexport const startTelemetry = (config: TelemetryConfig): void => {\n\tconst telemetryProducer = new ContainerEventTelemetryProducer(config.containerId);\n\tnew ContainerTelemetryManager(config.container, telemetryProducer, config.consumers);\n};\n"]}

package/lib/fluid-telemetry-alpha.d.ts

@@ -0,0 +1,213 @@
+/**
+ * This package provides an implementation and types for producing and consuming telemetry for Fluid Framework applications
+ * @packageDocumentation
+ */
+
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+
+/**
+ * The container "connected" telemetry event.
+ * It is produced from an internal Fluid container system event {@link @fluidframework/container-definitions#IContainerEvents} which is emitted when the {@link @fluidframework/container-definitions#IContainer} completes connecting to the Fluid service.
+ *
+ * @see More details about {@link @fluidframework/container-definitions#IContainer.connectionState  | the containers connection state}
+ * @see More details about {@link @fluidframework/container-definitions#IContainer.connect | the function to connect a container }
+ * @see More details about {@link @fluidframework/container-definitions#IContainer.connectionState  | the containers connection state}
+ *
+ * @beta
+ */
+export declare interface ContainerConnectedTelemetry extends IContainerTelemetry {
+    /**
+     * {@inheritDoc IFluidTelemetry.eventName}
+     */
+    eventName: "fluidframework.container.connected";
+}
+
+/**
+ * The container "disconnected" telemetry event. This telemetry is produced from an internal Fluid container system event
+ * {@link @fluidframework/container-definitions#IContainerEvents} which is emitted when the {@link @fluidframework/container-definitions#IContainer}
+ * becomes disconnected from the Fluid service.
+ *
+ * @see More details about{@link @fluidframework/container-definitions#IContainer.connectionState | the containers connection state}
+ *
+ * @see More details about{@link @fluidframework/container-definitions#IContainer.disconnect | the function to disconnect a container}
+ *
+ * @beta
+ */
+export declare interface ContainerDisconnectedTelemetry extends IContainerTelemetry {
+    /**
+     * {@inheritDoc IFluidTelemetry.eventName}
+     */
+    eventName: "fluidframework.container.disconnected";
+}
+
+/**
+ *
+ * The Fluid container "disposed" telemetry event. This telemetry is produced from the "disposed" Fluid container system event
+ * which is emitted when the {@link @fluidframework/fluid-static#IFluidContainer} is closed, which permanently disables it.
+ *
+ * @see More details about{@link @fluidframework/container-definitions#IContainer.close | the container close event}
+ *
+ * @beta
+ */
+export declare interface ContainerDisposedTelemetry extends IContainerTelemetry {
+    /**
+     * {@inheritDoc IFluidTelemetry.eventName}
+     */
+    eventName: "fluidframework.container.disposed";
+    /**
+     * If the container was closed due to error (as opposed to an explicit call to
+     * {@link @fluidframework/fluid-static#IFluidContainer."dispose"}), this will contain details about the error that caused it.
+     */
+    error?: ICriticalContainerError;
+}
+
+/**
+ * The aggregate type for all values within {@link ContainerTelemetryEventNames}
+ * @beta
+ */
+export declare type ContainerTelemetryEventName = (typeof ContainerTelemetryEventNames)[keyof typeof ContainerTelemetryEventNames];
+
+/**
+ * This object contains names for Container Telemetry. Unlike the raw {@link @fluidframework/fluid-static#IFluidContainerEvents | IFluidContainer system event names} they contain more information such as the scope
+ *
+ * @beta
+ */
+export declare const ContainerTelemetryEventNames: {
+    /**
+     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "connected" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
+     *
+     * @see {@link ContainerConnectedTelemetry}
+     */
+    readonly CONNECTED: "fluidframework.container.connected";
+    /**
+     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "disconnected" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
+     *
+     * @see {@link ContainerDisconnectedTelemetry}
+     */
+    readonly DISCONNECTED: "fluidframework.container.disconnected";
+    /**
+     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "disposed" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
+     *
+     * @see {@link ContainerDisposedTelemetry}
+     */
+    readonly DISPOSED: "fluidframework.container.disposed";
+};
+
+/**
+ * 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 declare type FluidTelemetryEventName = ContainerTelemetryEventName;
+
+/**
+ * The base interface for all Container telemetry
+ * @beta
+ */
+export declare interface IContainerTelemetry extends IFluidTelemetry {
+    /**
+     * {@inheritdoc IFluidTelemetry.eventName}
+     */
+    eventName: ContainerTelemetryEventName;
+    /**
+     * Unique identifier for a container, stable across creation and load.
+     * I.e. different clients loading the same container (or the same client loading the container two separate times)
+     * will agree on this value.
+     *
+     * @remarks This can be undefined for a container that has not been attached.
+     */
+    containerId?: string;
+    /**
+     * Unique identifier for the container instance that generated the telemetry.
+     * This is not a stable identifier for the container across clients/time.
+     * Every load of the container will result in a different value.
+     *
+     */
+    containerInstanceId: string;
+}
+
+export { ICriticalContainerError }
+
+/**
+ * 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 declare 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;
+}
+
+/**
+ * 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 declare 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;
+}
+
+/**
+ * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container
+ * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}
+ *
+ * @beta
+ */
+export declare const startTelemetry: (config: TelemetryConfig) => void;
+
+/**
+ * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}
+ *
+ * @beta
+ */
+export declare interface TelemetryConfig {
+    /**
+     * The container whose events should be monitored, transformed into Fluid telemetry, and sent to a {@link ITelemetryConsumer}.
+     */
+    container: IFluidContainer;
+    /**
+     * Unique identifier for the passed in container, i.e. the return value of a call
+     * to {@link @fluidframework/fluid-static#IFluidContainer.attach | `IFluidContainer.attach()`} when creating a new
+     * Fluid container, or the id used to load a pre-existing one.
+     */
+    containerId: string;
+    /**
+     * Conusmers take incoming produced {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and do something of your choice with it.
+     * This could be sending the telemetry to a cloud platform or just console logging.
+     */
+    consumers: ITelemetryConsumer[];
+}
+
+export { }

package/lib/fluid-telemetry-beta.d.ts

@@ -0,0 +1,213 @@
+/**
+ * This package provides an implementation and types for producing and consuming telemetry for Fluid Framework applications
+ * @packageDocumentation
+ */
+
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+
+/**
+ * The container "connected" telemetry event.
+ * It is produced from an internal Fluid container system event {@link @fluidframework/container-definitions#IContainerEvents} which is emitted when the {@link @fluidframework/container-definitions#IContainer} completes connecting to the Fluid service.
+ *
+ * @see More details about {@link @fluidframework/container-definitions#IContainer.connectionState  | the containers connection state}
+ * @see More details about {@link @fluidframework/container-definitions#IContainer.connect | the function to connect a container }
+ * @see More details about {@link @fluidframework/container-definitions#IContainer.connectionState  | the containers connection state}
+ *
+ * @beta
+ */
+export declare interface ContainerConnectedTelemetry extends IContainerTelemetry {
+    /**
+     * {@inheritDoc IFluidTelemetry.eventName}
+     */
+    eventName: "fluidframework.container.connected";
+}
+
+/**
+ * The container "disconnected" telemetry event. This telemetry is produced from an internal Fluid container system event
+ * {@link @fluidframework/container-definitions#IContainerEvents} which is emitted when the {@link @fluidframework/container-definitions#IContainer}
+ * becomes disconnected from the Fluid service.
+ *
+ * @see More details about{@link @fluidframework/container-definitions#IContainer.connectionState | the containers connection state}
+ *
+ * @see More details about{@link @fluidframework/container-definitions#IContainer.disconnect | the function to disconnect a container}
+ *
+ * @beta
+ */
+export declare interface ContainerDisconnectedTelemetry extends IContainerTelemetry {
+    /**
+     * {@inheritDoc IFluidTelemetry.eventName}
+     */
+    eventName: "fluidframework.container.disconnected";
+}
+
+/**
+ *
+ * The Fluid container "disposed" telemetry event. This telemetry is produced from the "disposed" Fluid container system event
+ * which is emitted when the {@link @fluidframework/fluid-static#IFluidContainer} is closed, which permanently disables it.
+ *
+ * @see More details about{@link @fluidframework/container-definitions#IContainer.close | the container close event}
+ *
+ * @beta
+ */
+export declare interface ContainerDisposedTelemetry extends IContainerTelemetry {
+    /**
+     * {@inheritDoc IFluidTelemetry.eventName}
+     */
+    eventName: "fluidframework.container.disposed";
+    /**
+     * If the container was closed due to error (as opposed to an explicit call to
+     * {@link @fluidframework/fluid-static#IFluidContainer."dispose"}), this will contain details about the error that caused it.
+     */
+    error?: ICriticalContainerError;
+}
+
+/**
+ * The aggregate type for all values within {@link ContainerTelemetryEventNames}
+ * @beta
+ */
+export declare type ContainerTelemetryEventName = (typeof ContainerTelemetryEventNames)[keyof typeof ContainerTelemetryEventNames];
+
+/**
+ * This object contains names for Container Telemetry. Unlike the raw {@link @fluidframework/fluid-static#IFluidContainerEvents | IFluidContainer system event names} they contain more information such as the scope
+ *
+ * @beta
+ */
+export declare const ContainerTelemetryEventNames: {
+    /**
+     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "connected" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
+     *
+     * @see {@link ContainerConnectedTelemetry}
+     */
+    readonly CONNECTED: "fluidframework.container.connected";
+    /**
+     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "disconnected" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
+     *
+     * @see {@link ContainerDisconnectedTelemetry}
+     */
+    readonly DISCONNECTED: "fluidframework.container.disconnected";
+    /**
+     * Name for the container telemetry event that is intended to be produced from the IFluidContainer "disposed" {@link @fluidframework/fluid-static#IFluidContainerEvents | system event}
+     *
+     * @see {@link ContainerDisposedTelemetry}
+     */
+    readonly DISPOSED: "fluidframework.container.disposed";
+};
+
+/**
+ * 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 declare type FluidTelemetryEventName = ContainerTelemetryEventName;
+
+/**
+ * The base interface for all Container telemetry
+ * @beta
+ */
+export declare interface IContainerTelemetry extends IFluidTelemetry {
+    /**
+     * {@inheritdoc IFluidTelemetry.eventName}
+     */
+    eventName: ContainerTelemetryEventName;
+    /**
+     * Unique identifier for a container, stable across creation and load.
+     * I.e. different clients loading the same container (or the same client loading the container two separate times)
+     * will agree on this value.
+     *
+     * @remarks This can be undefined for a container that has not been attached.
+     */
+    containerId?: string;
+    /**
+     * Unique identifier for the container instance that generated the telemetry.
+     * This is not a stable identifier for the container across clients/time.
+     * Every load of the container will result in a different value.
+     *
+     */
+    containerInstanceId: string;
+}
+
+export { ICriticalContainerError }
+
+/**
+ * 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 declare 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;
+}
+
+/**
+ * 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 declare 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;
+}
+
+/**
+ * Starts creating {@link @fluidframework/fluid-telemetry#IFluidTelemetry} by transforming raw system events emitted by the specified container
+ * into said telemetry and passing it onto to the specified {@link ITelemetryConsumer}
+ *
+ * @beta
+ */
+export declare const startTelemetry: (config: TelemetryConfig) => void;
+
+/**
+ * Configuration object for subscribing to {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and consuming said telemetry via one or more {@link ITelemetryConsumer}
+ *
+ * @beta
+ */
+export declare interface TelemetryConfig {
+    /**
+     * The container whose events should be monitored, transformed into Fluid telemetry, and sent to a {@link ITelemetryConsumer}.
+     */
+    container: IFluidContainer;
+    /**
+     * Unique identifier for the passed in container, i.e. the return value of a call
+     * to {@link @fluidframework/fluid-static#IFluidContainer.attach | `IFluidContainer.attach()`} when creating a new
+     * Fluid container, or the id used to load a pre-existing one.
+     */
+    containerId: string;
+    /**
+     * Conusmers take incoming produced {@link @fluidframework/fluid-telemetry#IFluidTelemetry} and do something of your choice with it.
+     * This could be sending the telemetry to a cloud platform or just console logging.
+     */
+    consumers: ITelemetryConsumer[];
+}
+
+export { }

package/lib/fluid-telemetry-public.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This package provides an implementation and types for producing and consuming telemetry for Fluid Framework applications
+ * @packageDocumentation
+ */
+
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+
+/* Excluded from this release type: ContainerConnectedTelemetry */
+
+/* Excluded from this release type: ContainerDisconnectedTelemetry */
+
+/* Excluded from this release type: ContainerDisposedTelemetry */
+
+/* Excluded from this release type: ContainerTelemetryEventName */
+
+/* Excluded from this release type: ContainerTelemetryEventNames */
+
+/* Excluded from this release type: FluidTelemetryEventName */
+
+/* Excluded from this release type: IContainerTelemetry */
+export { ICriticalContainerError }
+
+/* Excluded from this release type: IFluidTelemetry */
+
+/* Excluded from this release type: ITelemetryConsumer */
+
+/* Excluded from this release type: startTelemetry */
+
+/* Excluded from this release type: TelemetryConfig */
+
+export { }