@fluidframework/devtools-core Package

Contains an API for initializing developer tooling alongside the Fluid Framework.

This tooling is built for use alongside our Chromium browser extension. It listens for incoming messages from the corresponding extension, and posts direct responses as well as automatic updates for Fluid state changes.

Individual Fluid Containers can be registered to generate Container-level stats.

Visualization of telemetry logs can be enabled by creating a DevtoolsLogger and providing it to Devtools initialization.

See the package README for more details.

Interfaces

Interface	Alerts	Modifiers	Description
ContainerDevtoolsProps	Alpha		Properties for registering a IContainer with the Devtools.
FluidDevtoolsProps	Alpha		Properties for configuring the Devtools.
HasContainerKey	System	sealed	Common interface for data associated with a particular Container registered with the Devtools.
IDevtoolsLogger	Beta	sealed	Logger implementation that posts all telemetry events to the window (globalThis object). This logger is intended to integrate with the Fluid DevTools browser extension.
IFluidDevtools	Alpha		Fluid Devtools. A single, global instance is used to generate and communicate stats associated with the general Fluid runtime (i.e., it is not associated with any single Framework entity).

Types

TypeAlias	Alerts	Description
ContainerKey	Beta	A key used to identify and differentiate Containers registered with the IFluidDevtools.

Functions

Function	Alerts	Return Type	Description
createDevtoolsLogger(baseLogger)	Beta	IDevtoolsLogger	Creates a new IDevtoolsLogger by wrapping the provided (optional) base logger.
initializeDevtools(props)	Alpha	IFluidDevtools	Initializes the Devtools singleton and returns a handle to it.
tryGetFluidDevtools()	Alpha	IFluidDevtools | undefined	Gets the Devtools singleton if it has been initialized, otherwise returns undefined.

Function Details

createDevtoolsLogger

Creates a new IDevtoolsLogger by wrapping the provided (optional) base logger.

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/devtools-core/beta.

For more information about our API support guarantees, see here.

Signature

export declare function createDevtoolsLogger(baseLogger?: ITelemetryBaseLogger): IDevtoolsLogger;

Parameters

Parameter	Modifiers	Type	Description
baseLogger	optional	ITelemetryBaseLogger

Returns

Return type: IDevtoolsLogger

initializeDevtools

Initializes the Devtools singleton and returns a handle to it.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/devtools-core/alpha.

For more information about our API support guarantees, see here.

Signature

export declare function initializeDevtools(props?: FluidDevtoolsProps): IFluidDevtools;

Remarks

The instance is tracked as a static singleton.

It is automatically disposed on webpage unload, but it can be closed earlier by calling dispose on the returned handle.

Parameters

Parameter	Modifiers	Type	Description
props	optional	FluidDevtoolsProps

Returns

Return type: IFluidDevtools

tryGetFluidDevtools

Gets the Devtools singleton if it has been initialized, otherwise returns undefined.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/devtools-core/alpha.

For more information about our API support guarantees, see here.

Signature

export declare function tryGetFluidDevtools(): IFluidDevtools | undefined;

Returns

Return type: IFluidDevtools | undefined