@fluidframework/telemetry-utils Package
Packages > @fluidframework/telemetry-utils
Classes
Class | Description |
---|---|
ChildLogger | ChildLogger class 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 |
DebugLogger | Implementation of debug logger |
EventEmitterWithErrorHandling | Event Emitter helper class Any exceptions thrown by listeners will be caught and raised through "error" event. Any exception thrown by "error" listeners will propagate to the caller. |
LoggingError | - Helper class for error tracking that can be used to log an error in telemetry. - Care needs to be taken not to log PII information! - This allows additional properties to be logged because object of this instance will record all of their properties when logged with a logger. - Logger ignores all properties from any other error objects (not being instance of LoggingError), with exception of 'message' & 'stack' properties if they exists on error object. - In other words, logger logs only what it knows about and has good confidence it does not container PII information. |
MultiSinkLogger | Multi-sink logger Takes multiple ITelemetryBaseLogger objects (sinks) and logs all events into each sink Implements ITelemetryBaseLogger (through static create() method) |
PerformanceEvent | Helper class to log performance events |
TelemetryLogger | TelemetryLogger class 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 |
Functions
Function | Description |
---|---|
raiseConnectedEvent(logger, emitter, connected, clientId) | |
safeRaiseEvent(emitter, logger, event, args) |
Interfaces
Interface | Description |
---|---|
ITelemetryPropertyGetters |
Functions
raiseConnectedEvent
Signature:
export declare function raiseConnectedEvent(logger: ITelemetryLogger, emitter: EventEmitter, connected: boolean, clientId?: string): void;
Parameters
Parameter | Type | Description |
---|---|---|
logger | ITelemetryLogger | |
emitter | EventEmitter | |
connected | boolean | |
clientId | string |
Returns:
void
safeRaiseEvent
Signature:
export declare function safeRaiseEvent(emitter: EventEmitter, logger: ITelemetryLogger, event: string, ...args: any[]): void;
Parameters
Parameter | Type | Description |
---|---|---|
emitter | EventEmitter | |
logger | ITelemetryLogger | |
event | string | |
args | any[] |
Returns:
void