IErrorBase Interface

Base interface for all errors and warnings at container level

Signature

export interface IErrorBase extends Partial<Error>

Extends: Partial<Error

Properties

Property	Modifiers	Type	Description
errorType		string	errorType is a union of error types from - container - runtime - drivers
message		string	See Error.message Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error) If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.
name	optional	string	See Error.name
stack	optional	string	See Error.stack

Methods

Method	Modifiers	Return Type	Description
getTelemetryProperties()	optional	ITelemetryProperties	Returns all properties of this error object that are either safe to log or explicitly tagged as containing privacy-sensitive data.

Property Details

errorType

errorType is a union of error types from - container - runtime - drivers

Signature

readonly errorType: string;

Type: string

message

See Error.message Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error) If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.

Signature

readonly message: string;

Type: string

name

See Error.name

Signature

readonly name?: string;

Type: string

stack

See Error.stack

Signature

readonly stack?: string;

Type: string

Method Details

getTelemetryProperties

Returns all properties of this error object that are either safe to log or explicitly tagged as containing privacy-sensitive data.

Signature

getTelemetryProperties?(): ITelemetryProperties;

Returns

Return type: ITelemetryProperties