ITelemetryLoggerExt Interface

An extended ITelemetryBaseLogger which allows for more lenient event types.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/telemetry-utils/legacy.

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

Signature

export interface ITelemetryLoggerExt extends ITelemetryBaseLogger

Extends: ITelemetryBaseLogger

Remarks

This interface is meant to be used internally within the Fluid Framework, and ITelemetryBaseLogger should be used when loggers are passed between layers.

Methods

Method	Alerts	Return Type	Description
sendErrorEvent(event, error)	Beta	void	Send an error telemetry event.
sendPerformanceEvent(event, error, logLevel)	Beta	void	Send a performance telemetry event.
sendTelemetryEvent(event, error, logLevel)	Beta	void	Send an information telemetry event.

Method Details

sendErrorEvent

Send an error telemetry event.

This API is provided for existing users, but is not recommended for new users.

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

Signature

sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;

Parameters

Parameter	Modifiers	Type	Description
event		ITelemetryErrorEventExt	Event to send.
error	optional	unknown	Optional error object to log.

sendPerformanceEvent

Send a performance telemetry event.

This API is provided for existing users, but is not recommended for new users.

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

Signature

sendPerformanceEvent(event: ITelemetryPerformanceEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;

Parameters

Parameter	Modifiers	Type	Description
event		ITelemetryPerformanceEventExt	Event to send
error	optional	unknown	Optional error object to log.
logLevel	optional	typeof LogLevel.verbose | typeof LogLevel.default	Optional level of the log. Default: @fluidframework/core-interfaces#LogLevel.default.

sendTelemetryEvent

Send an information telemetry event.

This API is provided for existing users, but is not recommended for new users.

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

Signature

sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;

Parameters

Parameter	Modifiers	Type	Description
event		ITelemetryGenericEventExt	Event to send.
error	optional	unknown	Optional error object to log.
logLevel	optional	typeof LogLevel.verbose | typeof LogLevel.default	Optional level of the log. Default: @fluidframework/core-interfaces#LogLevel.default.