Skip to main content
Version: v1

ChildLogger Class

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

Signature​

export declare class ChildLogger extends TelemetryLogger

Extends: TelemetryLogger

Static Methods​

MethodReturn TypeDescription
create(baseLogger, namespace, properties)TelemetryLoggerCreate child logger

Properties​

PropertyTypeDescription
baseLoggerITelemetryBaseLogger

Methods​

MethodReturn TypeDescription
send(event)voidSend an event with the logger

Property Details​

baseLogger​

Signature​

protected readonly baseLogger: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger

Method Details​

create​

Create child logger

Signature​

static create(baseLogger?: ITelemetryBaseLogger, namespace?: string, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;

Parameters​

ParameterModifiersTypeDescription
baseLoggeroptionalITelemetryBaseLoggerBase logger to use to output events. If undefined, proper child logger is created, but it does not sends telemetry events anywhere.
namespaceoptionalstringTelemetry event name prefix to add to all events
propertiesoptionalITelemetryLoggerPropertyBagsBase properties to add to all events

Returns​

Return type: TelemetryLogger

send​

Send an event with the logger

Signature​

send(event: ITelemetryBaseEvent): void;

Parameters​

ParameterTypeDescription
eventITelemetryBaseEventthe event to send