@fluidframework/telemetry-utils 2.0.0-dev-rc.5.0.0.267932 → 2.0.0-dev-rc.5.0.0.268409
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
## Alpha API Report File for "@fluidframework/telemetry-utils"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { ConfigTypes } from '@fluidframework/core-interfaces';
|
|
8
|
+
import type { EventEmitter } from '@fluid-internal/client-utils';
|
|
9
|
+
import { EventEmitterEventType } from '@fluid-internal/client-utils';
|
|
10
|
+
import { IConfigProviderBase } from '@fluidframework/core-interfaces';
|
|
11
|
+
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
|
+
import { IErrorBase } from '@fluidframework/core-interfaces';
|
|
13
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
14
|
+
import { IGenericError } from '@fluidframework/core-interfaces/internal';
|
|
15
|
+
import type { ILoggingError } from '@fluidframework/core-interfaces/internal';
|
|
16
|
+
import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
|
|
17
|
+
import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
|
|
18
|
+
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
19
|
+
import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
|
|
20
|
+
import { IUsageError } from '@fluidframework/core-interfaces/internal';
|
|
21
|
+
import { Lazy } from '@fluidframework/core-utils/internal';
|
|
22
|
+
import { LogLevel } from '@fluidframework/core-interfaces';
|
|
23
|
+
import { Tagged } from '@fluidframework/core-interfaces';
|
|
24
|
+
import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
|
|
25
|
+
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
26
|
+
|
|
27
|
+
// @alpha
|
|
28
|
+
export function createChildLogger(props?: {
|
|
29
|
+
logger?: ITelemetryBaseLogger;
|
|
30
|
+
namespace?: string;
|
|
31
|
+
properties?: ITelemetryLoggerPropertyBags;
|
|
32
|
+
}): ITelemetryLoggerExt;
|
|
33
|
+
|
|
34
|
+
// @alpha
|
|
35
|
+
export class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {
|
|
36
|
+
constructor(errorHandler: (eventName: EventEmitterEventType, error: any) => void);
|
|
37
|
+
// (undocumented)
|
|
38
|
+
emit(event: EventEmitterEventType, ...args: unknown[]): boolean;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// @alpha
|
|
42
|
+
export interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
|
|
43
|
+
// (undocumented)
|
|
44
|
+
eventName: string;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// @alpha
|
|
48
|
+
export interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
|
|
49
|
+
// (undocumented)
|
|
50
|
+
category?: TelemetryEventCategory;
|
|
51
|
+
// (undocumented)
|
|
52
|
+
eventName: string;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
// @alpha
|
|
56
|
+
export interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
|
|
57
|
+
sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
|
|
58
|
+
sendPerformanceEvent(event: ITelemetryPerformanceEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
|
|
59
|
+
sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// @alpha (undocumented)
|
|
63
|
+
export interface ITelemetryLoggerPropertyBag {
|
|
64
|
+
// (undocumented)
|
|
65
|
+
[index: string]: TelemetryEventPropertyTypes | (() => TelemetryEventPropertyTypes);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// @alpha (undocumented)
|
|
69
|
+
export interface ITelemetryLoggerPropertyBags {
|
|
70
|
+
// (undocumented)
|
|
71
|
+
all?: ITelemetryLoggerPropertyBag;
|
|
72
|
+
// (undocumented)
|
|
73
|
+
error?: ITelemetryLoggerPropertyBag;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// @alpha
|
|
77
|
+
export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt {
|
|
78
|
+
// (undocumented)
|
|
79
|
+
duration?: number;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// @alpha
|
|
83
|
+
export interface ITelemetryPropertiesExt {
|
|
84
|
+
// (undocumented)
|
|
85
|
+
[index: string]: TelemetryEventPropertyTypeExt | Tagged<TelemetryEventPropertyTypeExt>;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
// @alpha
|
|
89
|
+
export class MockLogger implements ITelemetryBaseLogger {
|
|
90
|
+
constructor(minLogLevel?: LogLevel | undefined);
|
|
91
|
+
assertMatch(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
92
|
+
assertMatchAny(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
93
|
+
assertMatchNone(disallowedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
94
|
+
assertMatchStrict(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
95
|
+
// (undocumented)
|
|
96
|
+
clear(): void;
|
|
97
|
+
// (undocumented)
|
|
98
|
+
events: ITelemetryBaseEvent[];
|
|
99
|
+
matchAnyEvent(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], inlineDetailsProp?: boolean): boolean;
|
|
100
|
+
matchEvents(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], inlineDetailsProp?: boolean): boolean;
|
|
101
|
+
matchEventStrict(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], inlineDetailsProp?: boolean): boolean;
|
|
102
|
+
// (undocumented)
|
|
103
|
+
readonly minLogLevel?: LogLevel | undefined;
|
|
104
|
+
// (undocumented)
|
|
105
|
+
send(event: ITelemetryBaseEvent): void;
|
|
106
|
+
// (undocumented)
|
|
107
|
+
toTelemetryLogger(): ITelemetryLoggerExt;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
// @alpha
|
|
111
|
+
export type TelemetryEventCategory = "generic" | "error" | "performance";
|
|
112
|
+
|
|
113
|
+
// @alpha
|
|
114
|
+
export type TelemetryEventPropertyTypeExt = string | number | boolean | undefined | (string | number | boolean)[] | {
|
|
115
|
+
[key: string]: // Flat objects can have the same properties as the event itself
|
|
116
|
+
string | number | boolean | undefined | (string | number | boolean)[];
|
|
117
|
+
};
|
|
118
|
+
|
|
119
|
+
// @alpha (undocumented)
|
|
120
|
+
export type TelemetryEventPropertyTypes = ITelemetryPropertiesExt[string];
|
|
121
|
+
|
|
122
|
+
// (No @packageDocumentation comment for this package)
|
|
123
|
+
|
|
124
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
## Beta API Report File for "@fluidframework/telemetry-utils"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { ConfigTypes } from '@fluidframework/core-interfaces';
|
|
8
|
+
import type { EventEmitter } from '@fluid-internal/client-utils';
|
|
9
|
+
import { EventEmitterEventType } from '@fluid-internal/client-utils';
|
|
10
|
+
import { IConfigProviderBase } from '@fluidframework/core-interfaces';
|
|
11
|
+
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
|
+
import { IErrorBase } from '@fluidframework/core-interfaces';
|
|
13
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
14
|
+
import { IGenericError } from '@fluidframework/core-interfaces/internal';
|
|
15
|
+
import type { ILoggingError } from '@fluidframework/core-interfaces/internal';
|
|
16
|
+
import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
|
|
17
|
+
import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
|
|
18
|
+
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
19
|
+
import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
|
|
20
|
+
import { IUsageError } from '@fluidframework/core-interfaces/internal';
|
|
21
|
+
import { Lazy } from '@fluidframework/core-utils/internal';
|
|
22
|
+
import { LogLevel } from '@fluidframework/core-interfaces';
|
|
23
|
+
import { Tagged } from '@fluidframework/core-interfaces';
|
|
24
|
+
import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
|
|
25
|
+
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
26
|
+
|
|
27
|
+
// (No @packageDocumentation comment for this package)
|
|
28
|
+
|
|
29
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
## Public API Report File for "@fluidframework/telemetry-utils"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { ConfigTypes } from '@fluidframework/core-interfaces';
|
|
8
|
+
import type { EventEmitter } from '@fluid-internal/client-utils';
|
|
9
|
+
import { EventEmitterEventType } from '@fluid-internal/client-utils';
|
|
10
|
+
import { IConfigProviderBase } from '@fluidframework/core-interfaces';
|
|
11
|
+
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
|
+
import { IErrorBase } from '@fluidframework/core-interfaces';
|
|
13
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
14
|
+
import { IGenericError } from '@fluidframework/core-interfaces/internal';
|
|
15
|
+
import type { ILoggingError } from '@fluidframework/core-interfaces/internal';
|
|
16
|
+
import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
|
|
17
|
+
import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
|
|
18
|
+
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
19
|
+
import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
|
|
20
|
+
import { IUsageError } from '@fluidframework/core-interfaces/internal';
|
|
21
|
+
import { Lazy } from '@fluidframework/core-utils/internal';
|
|
22
|
+
import { LogLevel } from '@fluidframework/core-interfaces';
|
|
23
|
+
import { Tagged } from '@fluidframework/core-interfaces';
|
|
24
|
+
import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
|
|
25
|
+
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
26
|
+
|
|
27
|
+
// (No @packageDocumentation comment for this package)
|
|
28
|
+
|
|
29
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/telemetry-utils",
|
|
3
|
-
"version": "2.0.0-dev-rc.5.0.0.
|
|
3
|
+
"version": "2.0.0-dev-rc.5.0.0.268409",
|
|
4
4
|
"description": "Collection of telemetry relates utilities for Fluid",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -67,21 +67,21 @@
|
|
|
67
67
|
"temp-directory": "nyc/.nyc_output"
|
|
68
68
|
},
|
|
69
69
|
"dependencies": {
|
|
70
|
-
"@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.
|
|
71
|
-
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.
|
|
72
|
-
"@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.
|
|
73
|
-
"@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.
|
|
70
|
+
"@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
71
|
+
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
|
|
72
|
+
"@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
73
|
+
"@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
74
74
|
"debug": "^4.3.4",
|
|
75
75
|
"uuid": "^9.0.0"
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
78
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
79
|
-
"@biomejs/biome": "^1.
|
|
80
|
-
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.
|
|
79
|
+
"@biomejs/biome": "^1.7.3",
|
|
80
|
+
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.268409",
|
|
81
81
|
"@fluid-tools/build-cli": "^0.39.0-264124",
|
|
82
82
|
"@fluidframework/build-common": "^2.0.3",
|
|
83
83
|
"@fluidframework/build-tools": "^0.39.0-264124",
|
|
84
|
-
"@fluidframework/eslint-config-fluid": "^5.
|
|
84
|
+
"@fluidframework/eslint-config-fluid": "^5.3.0",
|
|
85
85
|
"@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@2.0.0-rc.4.0.0",
|
|
86
86
|
"@microsoft/api-extractor": "^7.45.1",
|
|
87
87
|
"@types/debug": "^4.1.5",
|
|
@@ -1,425 +0,0 @@
|
|
|
1
|
-
## API Report File for "@fluidframework/telemetry-utils"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
import { ConfigTypes } from '@fluidframework/core-interfaces';
|
|
8
|
-
import type { EventEmitter } from '@fluid-internal/client-utils';
|
|
9
|
-
import { EventEmitterEventType } from '@fluid-internal/client-utils';
|
|
10
|
-
import { IConfigProviderBase } from '@fluidframework/core-interfaces';
|
|
11
|
-
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
|
-
import { IErrorBase } from '@fluidframework/core-interfaces';
|
|
13
|
-
import { IEvent } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IGenericError } from '@fluidframework/core-interfaces/internal';
|
|
15
|
-
import type { ILoggingError } from '@fluidframework/core-interfaces/internal';
|
|
16
|
-
import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
|
|
17
|
-
import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
|
|
18
|
-
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
19
|
-
import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
|
|
20
|
-
import { IUsageError } from '@fluidframework/core-interfaces/internal';
|
|
21
|
-
import { Lazy } from '@fluidframework/core-utils/internal';
|
|
22
|
-
import { LogLevel } from '@fluidframework/core-interfaces';
|
|
23
|
-
import { Tagged } from '@fluidframework/core-interfaces';
|
|
24
|
-
import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
|
|
25
|
-
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
26
|
-
|
|
27
|
-
// @internal (undocumented)
|
|
28
|
-
export const connectedEventName = "connected";
|
|
29
|
-
|
|
30
|
-
// @alpha
|
|
31
|
-
export function createChildLogger(props?: {
|
|
32
|
-
logger?: ITelemetryBaseLogger;
|
|
33
|
-
namespace?: string;
|
|
34
|
-
properties?: ITelemetryLoggerPropertyBags;
|
|
35
|
-
}): ITelemetryLoggerExt;
|
|
36
|
-
|
|
37
|
-
// @internal
|
|
38
|
-
export function createChildMonitoringContext(props: Parameters<typeof createChildLogger>[0]): MonitoringContext;
|
|
39
|
-
|
|
40
|
-
// @internal
|
|
41
|
-
export function createMultiSinkLogger(props: MultiSinkLoggerProperties): ITelemetryLoggerExt;
|
|
42
|
-
|
|
43
|
-
// @internal
|
|
44
|
-
export function createSampledLogger(logger: ITelemetryLoggerExt, eventSampler?: IEventSampler, skipLoggingWhenSamplingIsDisabled?: boolean): ISampledTelemetryLogger;
|
|
45
|
-
|
|
46
|
-
// @internal
|
|
47
|
-
export class DataCorruptionError extends LoggingError implements IErrorBase, IFluidErrorBase {
|
|
48
|
-
constructor(message: string, props: ITelemetryBaseProperties);
|
|
49
|
-
// (undocumented)
|
|
50
|
-
readonly canRetry = false;
|
|
51
|
-
// (undocumented)
|
|
52
|
-
readonly errorType: "dataCorruptionError";
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
// @internal
|
|
56
|
-
export class DataProcessingError extends LoggingError implements IErrorBase, IFluidErrorBase {
|
|
57
|
-
// (undocumented)
|
|
58
|
-
readonly canRetry = false;
|
|
59
|
-
static create(errorMessage: string, dataProcessingCodepath: string, sequencedMessage?: ISequencedDocumentMessage, props?: ITelemetryPropertiesExt): IFluidErrorBase;
|
|
60
|
-
readonly errorType: "dataProcessingError";
|
|
61
|
-
static wrapIfUnrecognized(originalError: unknown, dataProcessingCodepath: string, messageLike?: Partial<Pick<ISequencedDocumentMessage, "clientId" | "sequenceNumber" | "clientSequenceNumber" | "referenceSequenceNumber" | "minimumSequenceNumber" | "timestamp">>): IFluidErrorBase;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
// @internal (undocumented)
|
|
65
|
-
export const disconnectedEventName = "disconnected";
|
|
66
|
-
|
|
67
|
-
// @alpha
|
|
68
|
-
export class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {
|
|
69
|
-
constructor(errorHandler: (eventName: EventEmitterEventType, error: any) => void);
|
|
70
|
-
// (undocumented)
|
|
71
|
-
emit(event: EventEmitterEventType, ...args: unknown[]): boolean;
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
// @internal
|
|
75
|
-
export const eventNamespaceSeparator: ":";
|
|
76
|
-
|
|
77
|
-
// @internal
|
|
78
|
-
export function extractLogSafeErrorProperties(error: unknown, sanitizeStack: boolean): {
|
|
79
|
-
message: string;
|
|
80
|
-
errorType?: string | undefined;
|
|
81
|
-
stack?: string | undefined;
|
|
82
|
-
};
|
|
83
|
-
|
|
84
|
-
// @internal
|
|
85
|
-
export const extractSafePropertiesFromMessage: (messageLike: Partial<Pick<ISequencedDocumentMessage, "clientId" | "sequenceNumber" | "clientSequenceNumber" | "referenceSequenceNumber" | "minimumSequenceNumber" | "timestamp">>) => {
|
|
86
|
-
messageClientId: string | undefined;
|
|
87
|
-
messageSequenceNumber: number | undefined;
|
|
88
|
-
messageClientSequenceNumber: number | undefined;
|
|
89
|
-
messageReferenceSequenceNumber: number | undefined;
|
|
90
|
-
messageMinimumSequenceNumber: number | undefined;
|
|
91
|
-
messageTimestamp: number | undefined;
|
|
92
|
-
};
|
|
93
|
-
|
|
94
|
-
// @internal (undocumented)
|
|
95
|
-
export function formatTick(tick: number): number;
|
|
96
|
-
|
|
97
|
-
// @internal
|
|
98
|
-
export function generateErrorWithStack(): Error;
|
|
99
|
-
|
|
100
|
-
// @internal
|
|
101
|
-
export function generateStack(): string | undefined;
|
|
102
|
-
|
|
103
|
-
// @internal
|
|
104
|
-
export class GenericError extends LoggingError implements IGenericError, IFluidErrorBase {
|
|
105
|
-
constructor(message: string, error?: any, props?: ITelemetryBaseProperties);
|
|
106
|
-
// (undocumented)
|
|
107
|
-
readonly error?: any;
|
|
108
|
-
// (undocumented)
|
|
109
|
-
readonly errorType: "genericError";
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
// @internal
|
|
113
|
-
export const getCircularReplacer: () => ((key: string, value: unknown) => any);
|
|
114
|
-
|
|
115
|
-
// @internal
|
|
116
|
-
export const hasErrorInstanceId: (x: unknown) => x is {
|
|
117
|
-
errorInstanceId: string;
|
|
118
|
-
};
|
|
119
|
-
|
|
120
|
-
// @internal
|
|
121
|
-
export interface IConfigProvider extends IConfigProviderBase {
|
|
122
|
-
// (undocumented)
|
|
123
|
-
getBoolean(name: string): boolean | undefined;
|
|
124
|
-
// (undocumented)
|
|
125
|
-
getBooleanArray(name: string): boolean[] | undefined;
|
|
126
|
-
// (undocumented)
|
|
127
|
-
getNumber(name: string): number | undefined;
|
|
128
|
-
// (undocumented)
|
|
129
|
-
getNumberArray(name: string): number[] | undefined;
|
|
130
|
-
// (undocumented)
|
|
131
|
-
getString(name: string): string | undefined;
|
|
132
|
-
// (undocumented)
|
|
133
|
-
getStringArray(name: string): string[] | undefined;
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
// @internal
|
|
137
|
-
export interface IEventSampler {
|
|
138
|
-
// (undocumented)
|
|
139
|
-
sample: () => boolean | undefined;
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
// @internal
|
|
143
|
-
export interface IFluidErrorAnnotations {
|
|
144
|
-
props?: ITelemetryBaseProperties;
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
// @internal
|
|
148
|
-
export interface IFluidErrorBase extends Error {
|
|
149
|
-
addTelemetryProperties: (props: ITelemetryPropertiesExt) => void;
|
|
150
|
-
readonly errorInstanceId: string;
|
|
151
|
-
readonly errorType: string;
|
|
152
|
-
getTelemetryProperties(): ITelemetryBaseProperties;
|
|
153
|
-
readonly message: string;
|
|
154
|
-
readonly name: string;
|
|
155
|
-
readonly stack?: string;
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
// @internal
|
|
159
|
-
export interface IPerformanceEventMarkers {
|
|
160
|
-
// (undocumented)
|
|
161
|
-
cancel?: "generic" | "error";
|
|
162
|
-
// (undocumented)
|
|
163
|
-
end?: true;
|
|
164
|
-
// (undocumented)
|
|
165
|
-
start?: true;
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
// @internal
|
|
169
|
-
export interface ISampledTelemetryLogger extends ITelemetryLoggerExt {
|
|
170
|
-
isSamplingDisabled: boolean;
|
|
171
|
-
}
|
|
172
|
-
|
|
173
|
-
// @internal
|
|
174
|
-
export function isExternalError(error: unknown): boolean;
|
|
175
|
-
|
|
176
|
-
// @internal
|
|
177
|
-
export function isFluidError(error: unknown): error is IFluidErrorBase;
|
|
178
|
-
|
|
179
|
-
// @internal
|
|
180
|
-
export const isILoggingError: (x: unknown) => x is ILoggingError;
|
|
181
|
-
|
|
182
|
-
// @internal
|
|
183
|
-
export function isTaggedTelemetryPropertyValue(x: Tagged<TelemetryEventPropertyTypeExt> | TelemetryEventPropertyTypeExt): x is Tagged<TelemetryEventPropertyTypeExt>;
|
|
184
|
-
|
|
185
|
-
// @internal
|
|
186
|
-
export function isValidLegacyError(error: unknown): error is Omit<IFluidErrorBase, "errorInstanceId">;
|
|
187
|
-
|
|
188
|
-
// @internal @deprecated
|
|
189
|
-
export interface ITaggedTelemetryPropertyTypeExt {
|
|
190
|
-
// (undocumented)
|
|
191
|
-
tag: string;
|
|
192
|
-
// (undocumented)
|
|
193
|
-
value: TelemetryEventPropertyTypeExt;
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
// @alpha
|
|
197
|
-
export interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
|
|
198
|
-
// (undocumented)
|
|
199
|
-
eventName: string;
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
// @internal
|
|
203
|
-
export interface ITelemetryEventExt extends ITelemetryPropertiesExt {
|
|
204
|
-
// (undocumented)
|
|
205
|
-
category: string;
|
|
206
|
-
// (undocumented)
|
|
207
|
-
eventName: string;
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
// @alpha
|
|
211
|
-
export interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
|
|
212
|
-
// (undocumented)
|
|
213
|
-
category?: TelemetryEventCategory;
|
|
214
|
-
// (undocumented)
|
|
215
|
-
eventName: string;
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
// @alpha
|
|
219
|
-
export interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
|
|
220
|
-
sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
|
|
221
|
-
sendPerformanceEvent(event: ITelemetryPerformanceEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
|
|
222
|
-
sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
// @alpha (undocumented)
|
|
226
|
-
export interface ITelemetryLoggerPropertyBag {
|
|
227
|
-
// (undocumented)
|
|
228
|
-
[index: string]: TelemetryEventPropertyTypes | (() => TelemetryEventPropertyTypes);
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
// @alpha (undocumented)
|
|
232
|
-
export interface ITelemetryLoggerPropertyBags {
|
|
233
|
-
// (undocumented)
|
|
234
|
-
all?: ITelemetryLoggerPropertyBag;
|
|
235
|
-
// (undocumented)
|
|
236
|
-
error?: ITelemetryLoggerPropertyBag;
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
// @alpha
|
|
240
|
-
export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt {
|
|
241
|
-
// (undocumented)
|
|
242
|
-
duration?: number;
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
// @alpha
|
|
246
|
-
export interface ITelemetryPropertiesExt {
|
|
247
|
-
// (undocumented)
|
|
248
|
-
[index: string]: TelemetryEventPropertyTypeExt | Tagged<TelemetryEventPropertyTypeExt>;
|
|
249
|
-
}
|
|
250
|
-
|
|
251
|
-
// @internal
|
|
252
|
-
export function loggerToMonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLoggerExt>(logger: L): MonitoringContext<L>;
|
|
253
|
-
|
|
254
|
-
// @internal
|
|
255
|
-
export class LoggingError extends Error implements ILoggingError, Omit<IFluidErrorBase, "errorType"> {
|
|
256
|
-
constructor(message: string, props?: ITelemetryBaseProperties, omitPropsFromLogging?: Set<string>);
|
|
257
|
-
addTelemetryProperties(props: ITelemetryPropertiesExt): void;
|
|
258
|
-
// (undocumented)
|
|
259
|
-
get errorInstanceId(): string;
|
|
260
|
-
getTelemetryProperties(): ITelemetryBaseProperties;
|
|
261
|
-
// (undocumented)
|
|
262
|
-
overwriteErrorInstanceId(id: string): void;
|
|
263
|
-
static typeCheck(object: unknown): object is LoggingError;
|
|
264
|
-
}
|
|
265
|
-
|
|
266
|
-
// @internal
|
|
267
|
-
export function mixinMonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLoggerExt>(logger: L, ...configs: (IConfigProviderBase | undefined)[]): MonitoringContext<L>;
|
|
268
|
-
|
|
269
|
-
// @alpha
|
|
270
|
-
export class MockLogger implements ITelemetryBaseLogger {
|
|
271
|
-
constructor(minLogLevel?: LogLevel | undefined);
|
|
272
|
-
assertMatch(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
273
|
-
assertMatchAny(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
274
|
-
assertMatchNone(disallowedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
275
|
-
assertMatchStrict(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], message?: string, inlineDetailsProp?: boolean): void;
|
|
276
|
-
// (undocumented)
|
|
277
|
-
clear(): void;
|
|
278
|
-
// (undocumented)
|
|
279
|
-
events: ITelemetryBaseEvent[];
|
|
280
|
-
matchAnyEvent(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], inlineDetailsProp?: boolean): boolean;
|
|
281
|
-
matchEvents(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], inlineDetailsProp?: boolean): boolean;
|
|
282
|
-
matchEventStrict(expectedEvents: Omit<ITelemetryBaseEvent, "category">[], inlineDetailsProp?: boolean): boolean;
|
|
283
|
-
// (undocumented)
|
|
284
|
-
readonly minLogLevel?: LogLevel | undefined;
|
|
285
|
-
// (undocumented)
|
|
286
|
-
send(event: ITelemetryBaseEvent): void;
|
|
287
|
-
// (undocumented)
|
|
288
|
-
toTelemetryLogger(): ITelemetryLoggerExt;
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
// @internal
|
|
292
|
-
export interface MonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLoggerExt> {
|
|
293
|
-
// (undocumented)
|
|
294
|
-
config: IConfigProvider;
|
|
295
|
-
// (undocumented)
|
|
296
|
-
logger: L;
|
|
297
|
-
}
|
|
298
|
-
|
|
299
|
-
// @internal
|
|
300
|
-
export interface MultiSinkLoggerProperties {
|
|
301
|
-
loggers?: (ITelemetryBaseLogger | undefined)[];
|
|
302
|
-
namespace?: string;
|
|
303
|
-
properties?: ITelemetryLoggerPropertyBags;
|
|
304
|
-
tryInheritProperties?: true;
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
// @internal
|
|
308
|
-
export const NORMALIZED_ERROR_TYPE = "genericError";
|
|
309
|
-
|
|
310
|
-
// @internal
|
|
311
|
-
export function normalizeError(error: unknown, annotations?: IFluidErrorAnnotations): IFluidErrorBase;
|
|
312
|
-
|
|
313
|
-
// @internal
|
|
314
|
-
export function numberFromString(str: string | null | undefined): string | number | undefined;
|
|
315
|
-
|
|
316
|
-
// @internal
|
|
317
|
-
export function overwriteStack(error: IFluidErrorBase | LoggingError, stack: string): void;
|
|
318
|
-
|
|
319
|
-
// @internal
|
|
320
|
-
export class PerformanceEvent {
|
|
321
|
-
protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, emitLogs?: boolean);
|
|
322
|
-
// (undocumented)
|
|
323
|
-
cancel(props?: ITelemetryPropertiesExt, error?: unknown): void;
|
|
324
|
-
// (undocumented)
|
|
325
|
-
get duration(): number;
|
|
326
|
-
// (undocumented)
|
|
327
|
-
end(props?: ITelemetryPropertiesExt): void;
|
|
328
|
-
reportEvent(eventNameSuffix: string, props?: ITelemetryPropertiesExt, error?: unknown): void;
|
|
329
|
-
// (undocumented)
|
|
330
|
-
reportProgress(props?: ITelemetryPropertiesExt, eventNameSuffix?: string): void;
|
|
331
|
-
static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, emitLogs?: boolean): PerformanceEvent;
|
|
332
|
-
static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
|
|
333
|
-
static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, sampleThreshold?: number): Promise<T>;
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
// @internal
|
|
337
|
-
export function raiseConnectedEvent(logger: ITelemetryLoggerExt, emitter: EventEmitter, connected: boolean, clientId?: string, disconnectedReason?: string): void;
|
|
338
|
-
|
|
339
|
-
// @internal (undocumented)
|
|
340
|
-
export function safeRaiseEvent(emitter: EventEmitter, logger: ITelemetryLoggerExt, event: string, ...args: unknown[]): void;
|
|
341
|
-
|
|
342
|
-
// @internal
|
|
343
|
-
export class SampledTelemetryHelper implements IDisposable {
|
|
344
|
-
constructor(eventBase: ITelemetryGenericEventExt, logger: ITelemetryLoggerExt, sampleThreshold: number, includeAggregateMetrics?: boolean, perBucketProperties?: Map<string, ITelemetryBaseProperties>);
|
|
345
|
-
// (undocumented)
|
|
346
|
-
dispose(error?: Error | undefined): void;
|
|
347
|
-
// (undocumented)
|
|
348
|
-
disposed: boolean;
|
|
349
|
-
measure<T>(codeToMeasure: () => T, bucket?: string): T;
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
// @internal
|
|
353
|
-
export const sessionStorageConfigProvider: Lazy<IConfigProviderBase>;
|
|
354
|
-
|
|
355
|
-
// @internal
|
|
356
|
-
export const tagCodeArtifacts: <T extends Record<string, TelemetryBaseEventPropertyType | (() => TelemetryBaseEventPropertyType)>>(values: T) => { [P in keyof T]: (T[P] extends () => TelemetryBaseEventPropertyType ? () => {
|
|
357
|
-
value: ReturnType<T[P]>;
|
|
358
|
-
tag: TelemetryDataTag.CodeArtifact;
|
|
359
|
-
} : {
|
|
360
|
-
value: Exclude<T[P], undefined>;
|
|
361
|
-
tag: TelemetryDataTag.CodeArtifact;
|
|
362
|
-
}) | (T[P] extends undefined ? undefined : never); };
|
|
363
|
-
|
|
364
|
-
// @internal
|
|
365
|
-
export const tagData: <T extends TelemetryDataTag, V extends Record<string, TelemetryBaseEventPropertyType | (() => TelemetryBaseEventPropertyType)>>(tag: T, values: V) => { [P in keyof V]: (V[P] extends () => TelemetryBaseEventPropertyType ? () => {
|
|
366
|
-
value: ReturnType<V[P]>;
|
|
367
|
-
tag: T;
|
|
368
|
-
} : {
|
|
369
|
-
value: Exclude<V[P], undefined>;
|
|
370
|
-
tag: T;
|
|
371
|
-
}) | (V[P] extends undefined ? undefined : never); };
|
|
372
|
-
|
|
373
|
-
// @internal @deprecated (undocumented)
|
|
374
|
-
export class TaggedLoggerAdapter implements ITelemetryBaseLogger {
|
|
375
|
-
constructor(logger: ITelemetryBaseLogger);
|
|
376
|
-
send(eventWithTagsMaybe: ITelemetryBaseEvent): void;
|
|
377
|
-
}
|
|
378
|
-
|
|
379
|
-
// @internal
|
|
380
|
-
export enum TelemetryDataTag {
|
|
381
|
-
CodeArtifact = "CodeArtifact",
|
|
382
|
-
UserData = "UserData"
|
|
383
|
-
}
|
|
384
|
-
|
|
385
|
-
// @alpha
|
|
386
|
-
export type TelemetryEventCategory = "generic" | "error" | "performance";
|
|
387
|
-
|
|
388
|
-
// @alpha
|
|
389
|
-
export type TelemetryEventPropertyTypeExt = string | number | boolean | undefined | (string | number | boolean)[] | {
|
|
390
|
-
[key: string]: // Flat objects can have the same properties as the event itself
|
|
391
|
-
string | number | boolean | undefined | (string | number | boolean)[];
|
|
392
|
-
};
|
|
393
|
-
|
|
394
|
-
// @alpha (undocumented)
|
|
395
|
-
export type TelemetryEventPropertyTypes = ITelemetryPropertiesExt[string];
|
|
396
|
-
|
|
397
|
-
// @internal
|
|
398
|
-
export class ThresholdCounter {
|
|
399
|
-
constructor(threshold: number, logger: ITelemetryLoggerExt, thresholdMultiple?: number);
|
|
400
|
-
send(eventName: string, value: number): void;
|
|
401
|
-
sendIfMultiple(eventName: string, value: number): void;
|
|
402
|
-
}
|
|
403
|
-
|
|
404
|
-
// @internal
|
|
405
|
-
export class UsageError extends LoggingError implements IUsageError, IFluidErrorBase {
|
|
406
|
-
constructor(message: string, props?: ITelemetryBaseProperties);
|
|
407
|
-
// (undocumented)
|
|
408
|
-
readonly errorType: "usageError";
|
|
409
|
-
}
|
|
410
|
-
|
|
411
|
-
// @internal
|
|
412
|
-
export function validatePrecondition(condition: boolean, message: string, props?: ITelemetryBaseProperties): asserts condition;
|
|
413
|
-
|
|
414
|
-
// @internal
|
|
415
|
-
export const wrapConfigProviderWithDefaults: (original: IConfigProviderBase | undefined, defaults: Record<string, ConfigTypes>) => IConfigProviderBase;
|
|
416
|
-
|
|
417
|
-
// @internal
|
|
418
|
-
export function wrapError<T extends LoggingError>(innerError: unknown, newErrorFn: (message: string) => T): T;
|
|
419
|
-
|
|
420
|
-
// @internal
|
|
421
|
-
export function wrapErrorAndLog<T extends LoggingError>(innerError: unknown, newErrorFn: (message: string) => T, logger: ITelemetryLoggerExt): T;
|
|
422
|
-
|
|
423
|
-
// (No @packageDocumentation comment for this package)
|
|
424
|
-
|
|
425
|
-
```
|