@fluidframework/telemetry-utils Package
Interfaces
| Interface | Alerts | Modifiers | Description |
|---|---|---|---|
| ITelemetryLoggerExt | Legacy | sealed | Handle for an extended ITelemetryBaseLogger used internally within the Fluid Framework. |
| ITelemetryLoggerPropertyBags | Legacy |
Classes
| Class | Alerts | Description |
|---|---|---|
| EventEmitterWithErrorHandling | Legacy | Event Emitter helper class |
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| ITelemetryLoggerPropertyBag | Legacy | |
| ITelemetryPropertiesExt | Legacy | JSON-serializable properties, which will be logged with telemetry. |
| TelemetryEventPropertyTypeExt | Legacy | Property types that can be logged. |
| TelemetryEventPropertyTypes | Legacy |
Functions
| Function | Alerts | Return Type | Description |
|---|---|---|---|
| createChildLogger(props) | Legacy | ITelemetryLoggerExt | Create a child logger based on the provided props object. |
Function Details
createChildLogger
Create a child logger based on the provided props object.
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.
Signature
export declare function createChildLogger(props?: {
logger?: ITelemetryBaseLogger;
namespace?: string;
properties?: ITelemetryLoggerPropertyBags;
}): ITelemetryLoggerExt;
Remarks
Passing in no props object (i.e. undefined) will return a logger that is effectively a no-op.
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| props | optional | { logger?: ITelemetryBaseLogger; namespace?: string; properties?: ITelemetryLoggerPropertyBags; } | logger is the base logger the child will log to after it's processing, namespace will be prefixed to all event names, properties are default properties that will be applied events. |
Returns
Return type: ITelemetryLoggerExt