ITelemetryLogger Interface

Packages > @fluidframework/common-definitions > ITelemetryLogger

ITelemetryLogger interface contains various helper telemetry methods, encoding in one place schemas for various types of Fluid telemetry events. Creates sub-logger that appends properties to all events

Signature:

export interface ITelemetryLogger extends ITelemetryBaseLogger 

Extends: ITelemetryBaseLogger

Methods

List of methods of this class
Method Description
send(event) Actual implementation that sends telemetry event Implemented by derived classes
sendErrorEvent(event, error) Send error telemetry event
sendPerformanceEvent(event, error) Send performance telemetry event
sendTelemetryEvent(event, error) Send information telemetry event

Methods

send

Actual implementation that sends telemetry event Implemented by derived classes

Signature:

send(event: ITelemetryBaseEvent): void;

Parameters

List of parameters
Parameter Type Description
event ITelemetryBaseEvent Telemetry event to send over

Returns:

void

sendErrorEvent

Send error telemetry event

Signature:

sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;

Parameters

List of parameters
Parameter Type Description
event ITelemetryErrorEvent Event to send
error any

Returns:

void

sendPerformanceEvent

Send performance telemetry event

Signature:

sendPerformanceEvent(event: ITelemetryPerformanceEvent, error?: any): void;

Parameters

List of parameters
Parameter Type Description
event ITelemetryPerformanceEvent Event to send
error any

Returns:

void

sendTelemetryEvent

Send information telemetry event

Signature:

sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any): void;

Parameters

List of parameters
Parameter Type Description
event ITelemetryGenericEvent Event to send
error any optional error object to log

Returns:

void