ITelemetryLoggerExt Interface

This is the externally facing type for a FluidFramework internal telemetry logger wrapper.

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface ITelemetryLoggerExt extends ITelemetryBaseLogger

Extends: ITelemetryBaseLogger

Remarks

The methods if this interface are not to be used directly by consumers and are all deprecated to removed without replacement. This type is not deprecated and will transition to an erased type to handle cases where "internal" ITelemetryLoggerExt previously leaked out.

Methods

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

Method Details

sendErrorEvent

Send an error telemetry event.

This API is deprecated and will be removed in a future release.

This method is being removed without a replacement.

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.

See Also

Issue #26910 for details.

sendPerformanceEvent

Send a performance telemetry event.

This API is deprecated and will be removed in a future release.

This method is being removed without a replacement.

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.essential.

See Also

Issue #26910 for details.

sendTelemetryEvent

Send an information telemetry event.

This API is deprecated and will be removed in a future release.

This method is being removed without a replacement.

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.essential.

See Also

Issue #26910 for details.

See Also

Issue #26910 for deprecation and breaking change details.