EventAndErrorTrackingLogger Class

This class tracks events. It allows specifying expected events, which will be looked for in order. It also tracks all unexpected errors. At any point you call reportAndClearTrackedEvents which will provide all unexpected errors, and any expected events that have not occurred.

Signature

export declare class EventAndErrorTrackingLogger extends TelemetryLogger

Extends: TelemetryLogger

Constructors

Constructor	Description
(constructor)(baseLogger)	Constructs a new instance of the EventAndErrorTrackingLogger class

Methods

Method	Return Type	Description
registerExpectedEvent(orderedExpectedEvents)	void
reportAndClearTrackedEvents()	{ expectedNotFound: ({ index: number; event: ITelemetryGenericEvent | undefined; } | undefined)[]; unexpectedErrors: ITelemetryBaseEvent[]; }
send(event)	void

Constructor Details

(constructor)

Constructs a new instance of the EventAndErrorTrackingLogger class

Signature

constructor(baseLogger: ITelemetryBaseLogger);

Parameters

Parameter	Type	Description
baseLogger	ITelemetryBaseLogger

Method Details

registerExpectedEvent

Signature

registerExpectedEvent(...orderedExpectedEvents: ITelemetryGenericEvent[]): void;

Parameters

Parameter	Type	Description
orderedExpectedEvents	ITelemetryGenericEvent[]

reportAndClearTrackedEvents

Signature

reportAndClearTrackedEvents(): {
        expectedNotFound: ({
            index: number;
            event: ITelemetryGenericEvent | undefined;
        } | undefined)[];
        unexpectedErrors: ITelemetryBaseEvent[];
    };

Returns

Return type: { expectedNotFound: ({ index: number; event: ITelemetryGenericEvent | undefined; } | undefined)[]; unexpectedErrors: ITelemetryBaseEvent[]; }

send

Signature

send(event: ITelemetryBaseEvent): void;

Parameters

Parameter	Type	Description
event	ITelemetryBaseEvent