Packages > @fluidframework/telemetry-utils
@fluidframework/telemetry-utils Package
Interfaces
Interface | Alerts | Description |
---|---|---|
ITelemetryErrorEventExt |
ALPHA
|
Error telemetry event. |
ITelemetryGenericEventExt |
ALPHA
|
Informational (non-error) telemetry event |
ITelemetryLoggerExt |
ALPHA
|
An extended @fluidframework/core-interfaces#ITelemetryBaseLogger which allows for more lenient event types. |
ITelemetryPerformanceEventExt |
ALPHA
|
Performance telemetry event. |
ITelemetryPropertiesExt |
ALPHA
|
JSON-serializable properties, which will be logged with telemetry. |
Classes
Class | Alerts | Description |
---|---|---|
EventEmitterWithErrorHandling |
ALPHA
|
Event Emitter helper class |
Types
TypeAlias | Alerts | Description |
---|---|---|
TelemetryEventCategory |
ALPHA
|
The categories FF uses when instrumenting the code. generic - Informational log event error - Error log event, ideally 0 of these are logged during a session performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking |
TelemetryEventPropertyTypeExt |
ALPHA
|
Property types that can be logged. |
Type Details
TelemetryEventCategory (ALPHA)
The categories FF uses when instrumenting the code.
generic - Informational log event
error - Error log event, ideally 0 of these are logged during a session
performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type TelemetryEventCategory = "generic" | "error" | "performance";
TelemetryEventPropertyTypeExt (ALPHA)
Property types that can be logged.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export type TelemetryEventPropertyTypeExt = string | number | boolean | undefined | (string | number | boolean)[] | {
[key: string]: // Flat objects can have the same properties as the event itself
string | number | boolean | undefined | (string | number | boolean)[];
};
Remarks
Includes extra types beyond @fluidframework/core-interfaces#TelemetryBaseEventPropertyType, which must be converted before sending to a base logger.