Packages > @fluidframework/devtools-core
@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 |
|---|---|---|---|
| HasContainerKey |
BETA
|
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. |
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. |
Function Details
createDevtoolsLogger (BETA)
Creates a new IDevtoolsLogger by wrapping the provided (optional) base logger.
WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.
Signature
export declare function createDevtoolsLogger(baseLogger?: ITelemetryBaseLogger): IDevtoolsLogger;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| baseLogger | optional | ITelemetryBaseLogger |
Returns
Return type: IDevtoolsLogger