@fluidframework/telemetry-utils 2.0.0-internal.8.0.1 → 2.0.0-rc.1.0.0

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.
Files changed (44) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +1 -7
  3. package/api-extractor-esm.json +5 -0
  4. package/api-extractor-lint.json +1 -10
  5. package/api-extractor.json +1 -9
  6. package/api-report/telemetry-utils.api.md +16 -25
  7. package/dist/eventEmitterWithErrorHandling.d.ts +1 -1
  8. package/dist/eventEmitterWithErrorHandling.js +1 -1
  9. package/dist/eventEmitterWithErrorHandling.js.map +1 -1
  10. package/dist/index.d.ts +0 -17
  11. package/dist/index.d.ts.map +1 -1
  12. package/dist/index.js.map +1 -1
  13. package/dist/logger.d.ts +4 -4
  14. package/dist/logger.js +1 -1
  15. package/dist/logger.js.map +1 -1
  16. package/dist/telemetry-utils-alpha.d.ts +41 -21
  17. package/dist/telemetry-utils-beta.d.ts +105 -46
  18. package/dist/telemetry-utils-public.d.ts +105 -46
  19. package/dist/telemetry-utils-untrimmed.d.ts +16 -37
  20. package/dist/telemetryTypes.d.ts +7 -9
  21. package/dist/telemetryTypes.d.ts.map +1 -1
  22. package/dist/telemetryTypes.js.map +1 -1
  23. package/lib/eventEmitterWithErrorHandling.d.ts +1 -1
  24. package/lib/eventEmitterWithErrorHandling.js +1 -1
  25. package/lib/eventEmitterWithErrorHandling.js.map +1 -1
  26. package/lib/index.d.ts +0 -17
  27. package/lib/index.d.ts.map +1 -1
  28. package/lib/index.js.map +1 -1
  29. package/lib/logger.d.ts +4 -4
  30. package/lib/logger.js +1 -1
  31. package/lib/logger.js.map +1 -1
  32. package/lib/telemetry-utils-alpha.d.mts +290 -0
  33. package/lib/{telemetry-utils-alpha.d.ts → telemetry-utils-beta.d.mts} +9 -15
  34. package/lib/{telemetry-utils-beta.d.ts → telemetry-utils-public.d.mts} +105 -46
  35. package/lib/{telemetry-utils-untrimmed.d.ts → telemetry-utils-untrimmed.d.mts} +16 -37
  36. package/lib/telemetryTypes.d.ts +7 -9
  37. package/lib/telemetryTypes.d.ts.map +1 -1
  38. package/lib/telemetryTypes.js.map +1 -1
  39. package/package.json +26 -17
  40. package/src/eventEmitterWithErrorHandling.ts +1 -1
  41. package/src/index.ts +0 -19
  42. package/src/logger.ts +4 -4
  43. package/src/telemetryTypes.ts +7 -9
  44. package/lib/telemetry-utils-public.d.ts +0 -205
package/src/telemetryTypes.ts CHANGED
@@ -13,7 +13,7 @@ import { ITelemetryBaseLogger, LogLevel, Tagged } from "@fluidframework/core-int
13
13
  * error - Error log event, ideally 0 of these are logged during a session
14
14
  *
15
15
  * performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking
16
- * @alpha
16
+ * @public
17
17
  */
18
18
  export type TelemetryEventCategory = "generic" | "error" | "performance";
19
19
 
@@ -23,8 +23,7 @@ export type TelemetryEventCategory = "generic" | "error" | "performance";
23
23
  * @remarks
24
24
  * Includes extra types beyond {@link @fluidframework/core-interfaces#TelemetryBaseEventPropertyType}, which must be
25
25
  * converted before sending to a base logger.
26
- *
27
- * @alpha
26
+ * @public
28
27
  */
29
28
  export type TelemetryEventPropertyTypeExt =
30
29
  | string
@@ -52,8 +51,7 @@ export interface ITaggedTelemetryPropertyTypeExt {
52
51
 
53
52
  /**
54
53
  * JSON-serializable properties, which will be logged with telemetry.
55
- *
56
- * @alpha
54
+ * @public
57
55
  */
58
56
  export interface ITelemetryPropertiesExt {
59
57
  [index: string]: TelemetryEventPropertyTypeExt | Tagged<TelemetryEventPropertyTypeExt>;
@@ -75,7 +73,7 @@ export interface ITelemetryEventExt extends ITelemetryPropertiesExt {
75
73
  /**
76
74
  * Informational (non-error) telemetry event
77
75
  * @remarks Maps to category = "generic"
78
- * @alpha
76
+ * @public
79
77
  */
80
78
  export interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
81
79
  eventName: string;
@@ -85,7 +83,7 @@ export interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
85
83
  /**
86
84
  * Error telemetry event.
87
85
  * @remarks Maps to category = "error"
88
- * @alpha
86
+ * @public
89
87
  */
90
88
  export interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
91
89
  eventName: string;
@@ -94,7 +92,7 @@ export interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
94
92
  /**
95
93
  * Performance telemetry event.
96
94
  * @remarks Maps to category = "performance"
97
- * @alpha
95
+ * @public
98
96
  */
99
97
  export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt {
100
98
  duration?: number; // Duration of event (optional)
@@ -106,7 +104,7 @@ export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt
106
104
  * @remarks
107
105
  * This interface is meant to be used internally within the Fluid Framework,
108
106
  * and `ITelemetryBaseLogger` should be used when loggers are passed between layers.
109
- * @alpha
107
+ * @public
110
108
  */
111
109
  export interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
112
110
  /**
package/lib/telemetry-utils-public.d.ts DELETED
@@ -1,205 +0,0 @@
1
- /// <reference types="node" />
2
-
3
- import { EventEmitter } from 'events';
4
- import { EventEmitterEventType } from '@fluid-internal/client-utils';
5
- import { IConfigProviderBase as IConfigProviderBase_2 } from '@fluidframework/core-interfaces';
6
- import { IDisposable } from '@fluidframework/core-interfaces';
7
- import { IErrorBase } from '@fluidframework/core-interfaces';
8
- import { IEvent } from '@fluidframework/core-interfaces';
9
- import { IGenericError } from '@fluidframework/core-interfaces';
10
- import { ILoggingError } from '@fluidframework/core-interfaces';
11
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
12
- import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
13
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
14
- import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
15
- import { ITelemetryErrorEvent } from '@fluidframework/core-interfaces';
16
- import { ITelemetryGenericEvent } from '@fluidframework/core-interfaces';
17
- import { ITelemetryPerformanceEvent } from '@fluidframework/core-interfaces';
18
- import { ITelemetryProperties } from '@fluidframework/core-interfaces';
19
- import { IUsageError } from '@fluidframework/core-interfaces';
20
- import { Lazy } from '@fluidframework/core-utils';
21
- import { LogLevel } from '@fluidframework/core-interfaces';
22
- import { Tagged } from '@fluidframework/core-interfaces';
23
- import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
24
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
25
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
26
-
27
- /* Excluded from this release type: ConfigTypes */
28
-
29
- /* Excluded from this release type: connectedEventName */
30
-
31
- /* Excluded from this release type: createChildLogger */
32
-
33
- /* Excluded from this release type: createChildMonitoringContext */
34
-
35
- /* Excluded from this release type: createMultiSinkLogger */
36
-
37
- /* Excluded from this release type: createSampledLogger */
38
-
39
- /* Excluded from this release type: DataCorruptionError */
40
-
41
- /* Excluded from this release type: DataProcessingError */
42
-
43
- /* Excluded from this release type: disconnectedEventName */
44
-
45
- /* Excluded from this release type: EventEmitterEventType */
46
-
47
- /* Excluded from this release type: EventEmitterWithErrorHandling */
48
-
49
- /* Excluded from this release type: eventNamespaceSeparator */
50
-
51
- /* Excluded from this release type: extractLogSafeErrorProperties */
52
-
53
- /* Excluded from this release type: extractSafePropertiesFromMessage */
54
-
55
- /* Excluded from this release type: formatTick */
56
-
57
- /* Excluded from this release type: generateErrorWithStack */
58
-
59
- /* Excluded from this release type: generateStack */
60
-
61
- /* Excluded from this release type: GenericError */
62
-
63
- /* Excluded from this release type: getCircularReplacer */
64
-
65
- /* Excluded from this release type: hasErrorInstanceId */
66
-
67
- /* Excluded from this release type: IConfigProvider */
68
-
69
- /* Excluded from this release type: IConfigProviderBase */
70
-
71
- /* Excluded from this release type: IConfigProviderBase_2 */
72
-
73
- /* Excluded from this release type: IDisposable */
74
-
75
- /* Excluded from this release type: IErrorBase */
76
-
77
- /* Excluded from this release type: IEvent */
78
-
79
- /* Excluded from this release type: IEventSampler */
80
-
81
- /* Excluded from this release type: IFluidErrorAnnotations */
82
-
83
- /* Excluded from this release type: IFluidErrorBase */
84
-
85
- /* Excluded from this release type: IGenericError */
86
-
87
- /* Excluded from this release type: ILoggingError */
88
-
89
- /* Excluded from this release type: IPerformanceEventMarkers */
90
-
91
- /* Excluded from this release type: ISampledTelemetryLogger */
92
-
93
- /* Excluded from this release type: isExternalError */
94
-
95
- /* Excluded from this release type: isFluidError */
96
-
97
- /* Excluded from this release type: isILoggingError */
98
-
99
- /* Excluded from this release type: isTaggedTelemetryPropertyValue */
100
-
101
- /* Excluded from this release type: isValidLegacyError */
102
-
103
- /* Excluded from this release type: ITaggedTelemetryPropertyTypeExt */
104
-
105
- /* Excluded from this release type: ITelemetryBaseEvent */
106
-
107
- /* Excluded from this release type: ITelemetryBaseLogger */
108
-
109
- /* Excluded from this release type: ITelemetryBaseProperties */
110
-
111
- /* Excluded from this release type: ITelemetryErrorEvent */
112
-
113
- /* Excluded from this release type: ITelemetryErrorEventExt */
114
-
115
- /* Excluded from this release type: ITelemetryEventExt */
116
-
117
- /* Excluded from this release type: ITelemetryGenericEvent */
118
-
119
- /* Excluded from this release type: ITelemetryGenericEventExt */
120
-
121
- /* Excluded from this release type: ITelemetryLoggerExt */
122
-
123
- /* Excluded from this release type: ITelemetryLoggerPropertyBag */
124
-
125
- /* Excluded from this release type: ITelemetryLoggerPropertyBags */
126
-
127
- /* Excluded from this release type: ITelemetryPerformanceEvent */
128
-
129
- /* Excluded from this release type: ITelemetryPerformanceEventExt */
130
-
131
- /* Excluded from this release type: ITelemetryProperties */
132
-
133
- /* Excluded from this release type: ITelemetryPropertiesExt */
134
-
135
- /* Excluded from this release type: IUsageError */
136
-
137
- /* Excluded from this release type: Lazy */
138
-
139
- /* Excluded from this release type: loggerToMonitoringContext */
140
-
141
- /* Excluded from this release type: LoggingError */
142
-
143
- /* Excluded from this release type: logIfFalse */
144
-
145
- /* Excluded from this release type: LogLevel */
146
-
147
- /* Excluded from this release type: mixinMonitoringContext */
148
-
149
- /* Excluded from this release type: MockLogger */
150
-
151
- /* Excluded from this release type: MonitoringContext */
152
-
153
- /* Excluded from this release type: MultiSinkLoggerProperties */
154
-
155
- /* Excluded from this release type: NORMALIZED_ERROR_TYPE */
156
-
157
- /* Excluded from this release type: normalizeError */
158
-
159
- /* Excluded from this release type: numberFromString */
160
-
161
- /* Excluded from this release type: overwriteStack */
162
-
163
- /* Excluded from this release type: PerformanceEvent */
164
-
165
- /* Excluded from this release type: raiseConnectedEvent */
166
-
167
- /* Excluded from this release type: safeRaiseEvent */
168
-
169
- /* Excluded from this release type: SampledTelemetryHelper */
170
-
171
- /* Excluded from this release type: sessionStorageConfigProvider */
172
-
173
- /* Excluded from this release type: tagCodeArtifacts */
174
-
175
- /* Excluded from this release type: tagData */
176
-
177
- /* Excluded from this release type: Tagged */
178
-
179
- /* Excluded from this release type: TaggedLoggerAdapter */
180
-
181
- /* Excluded from this release type: TelemetryBaseEventPropertyType */
182
-
183
- /* Excluded from this release type: TelemetryDataTag */
184
-
185
- /* Excluded from this release type: TelemetryEventCategory */
186
-
187
- /* Excluded from this release type: TelemetryEventPropertyTypeExt */
188
-
189
- /* Excluded from this release type: TelemetryEventPropertyTypes */
190
-
191
- /* Excluded from this release type: TelemetryNullLogger */
192
-
193
- /* Excluded from this release type: ThresholdCounter */
194
-
195
- /* Excluded from this release type: TypedEventEmitter */
196
-
197
- /* Excluded from this release type: UsageError */
198
-
199
- /* Excluded from this release type: validatePrecondition */
200
-
201
- /* Excluded from this release type: wrapError */
202
-
203
- /* Excluded from this release type: wrapErrorAndLog */
204
-
205
- export { }