@fluidframework/telemetry-utils 2.0.0-rc.2.0.1 → 2.0.0-rc.3.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 (132) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/api-report/telemetry-utils.api.md +6 -6
  3. package/dist/config.d.ts +2 -2
  4. package/dist/config.d.ts.map +1 -1
  5. package/dist/config.js +6 -2
  6. package/dist/config.js.map +1 -1
  7. package/dist/error.d.ts +4 -2
  8. package/dist/error.d.ts.map +1 -1
  9. package/dist/error.js +5 -5
  10. package/dist/error.js.map +1 -1
  11. package/dist/errorLogging.d.ts +3 -2
  12. package/dist/errorLogging.d.ts.map +1 -1
  13. package/dist/errorLogging.js.map +1 -1
  14. package/dist/eventEmitterWithErrorHandling.d.ts +1 -1
  15. package/dist/eventEmitterWithErrorHandling.d.ts.map +1 -1
  16. package/dist/eventEmitterWithErrorHandling.js +2 -2
  17. package/dist/eventEmitterWithErrorHandling.js.map +1 -1
  18. package/dist/events.d.ts +1 -1
  19. package/dist/events.d.ts.map +1 -1
  20. package/dist/events.js.map +1 -1
  21. package/dist/fluidErrorBase.d.ts.map +1 -1
  22. package/dist/fluidErrorBase.js.map +1 -1
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +2 -2
  25. package/dist/index.js.map +1 -1
  26. package/dist/legacy.d.ts +28 -0
  27. package/dist/logger.d.ts +2 -2
  28. package/dist/logger.d.ts.map +1 -1
  29. package/dist/logger.js +1 -1
  30. package/dist/logger.js.map +1 -1
  31. package/dist/mockLogger.d.ts +1 -1
  32. package/dist/mockLogger.d.ts.map +1 -1
  33. package/dist/mockLogger.js +3 -3
  34. package/dist/mockLogger.js.map +1 -1
  35. package/dist/public.d.ts +20 -0
  36. package/dist/sampledTelemetryHelper.d.ts +2 -2
  37. package/dist/sampledTelemetryHelper.d.ts.map +1 -1
  38. package/dist/sampledTelemetryHelper.js.map +1 -1
  39. package/dist/utils.d.ts +4 -0
  40. package/dist/utils.d.ts.map +1 -1
  41. package/dist/utils.js +4 -0
  42. package/dist/utils.js.map +1 -1
  43. package/internal.d.ts +11 -0
  44. package/legacy.d.ts +11 -0
  45. package/lib/config.d.ts +2 -2
  46. package/lib/config.d.ts.map +1 -1
  47. package/lib/config.js +5 -1
  48. package/lib/config.js.map +1 -1
  49. package/lib/error.d.ts +4 -2
  50. package/lib/error.d.ts.map +1 -1
  51. package/lib/error.js +1 -1
  52. package/lib/error.js.map +1 -1
  53. package/lib/errorLogging.d.ts +3 -2
  54. package/lib/errorLogging.d.ts.map +1 -1
  55. package/lib/errorLogging.js.map +1 -1
  56. package/lib/eventEmitterWithErrorHandling.d.ts +1 -1
  57. package/lib/eventEmitterWithErrorHandling.d.ts.map +1 -1
  58. package/lib/eventEmitterWithErrorHandling.js.map +1 -1
  59. package/lib/events.d.ts +1 -1
  60. package/lib/events.d.ts.map +1 -1
  61. package/lib/events.js.map +1 -1
  62. package/lib/fluidErrorBase.d.ts.map +1 -1
  63. package/lib/fluidErrorBase.js.map +1 -1
  64. package/lib/index.d.ts.map +1 -1
  65. package/lib/index.js.map +1 -1
  66. package/lib/legacy.d.ts +28 -0
  67. package/lib/logger.d.ts +2 -2
  68. package/lib/logger.d.ts.map +1 -1
  69. package/lib/logger.js +2 -2
  70. package/lib/logger.js.map +1 -1
  71. package/lib/mockLogger.d.ts +1 -1
  72. package/lib/mockLogger.d.ts.map +1 -1
  73. package/lib/mockLogger.js +2 -2
  74. package/lib/mockLogger.js.map +1 -1
  75. package/lib/public.d.ts +20 -0
  76. package/lib/sampledTelemetryHelper.d.ts +2 -2
  77. package/lib/sampledTelemetryHelper.d.ts.map +1 -1
  78. package/lib/sampledTelemetryHelper.js.map +1 -1
  79. package/lib/utils.d.ts +4 -0
  80. package/lib/utils.d.ts.map +1 -1
  81. package/lib/utils.js +4 -0
  82. package/lib/utils.js.map +1 -1
  83. package/package.json +27 -48
  84. package/src/config.ts +5 -3
  85. package/src/error.ts +4 -4
  86. package/src/errorLogging.ts +6 -8
  87. package/src/eventEmitterWithErrorHandling.ts +2 -1
  88. package/src/events.ts +2 -1
  89. package/src/fluidErrorBase.ts +1 -0
  90. package/src/index.ts +1 -0
  91. package/src/logger.ts +7 -6
  92. package/src/mockLogger.ts +4 -3
  93. package/src/sampledTelemetryHelper.ts +3 -2
  94. package/src/utils.ts +2 -0
  95. package/api-extractor-cjs.json +0 -8
  96. package/dist/telemetry-utils-alpha.d.ts +0 -282
  97. package/dist/telemetry-utils-beta.d.ts +0 -239
  98. package/dist/telemetry-utils-public.d.ts +0 -239
  99. package/dist/telemetry-utils-untrimmed.d.ts +0 -1077
  100. package/lib/telemetry-utils-alpha.d.ts +0 -282
  101. package/lib/telemetry-utils-beta.d.ts +0 -239
  102. package/lib/telemetry-utils-public.d.ts +0 -239
  103. package/lib/telemetry-utils-untrimmed.d.ts +0 -1077
  104. package/lib/test/EventEmitterWithErrorHandling.spec.js +0 -86
  105. package/lib/test/EventEmitterWithErrorHandling.spec.js.map +0 -1
  106. package/lib/test/childLogger.spec.js +0 -233
  107. package/lib/test/childLogger.spec.js.map +0 -1
  108. package/lib/test/config.spec.js +0 -229
  109. package/lib/test/config.spec.js.map +0 -1
  110. package/lib/test/error.spec.js +0 -161
  111. package/lib/test/error.spec.js.map +0 -1
  112. package/lib/test/errorLogging.spec.js +0 -801
  113. package/lib/test/errorLogging.spec.js.map +0 -1
  114. package/lib/test/errorTypeLoggingTest.spec.js +0 -107
  115. package/lib/test/errorTypeLoggingTest.spec.js.map +0 -1
  116. package/lib/test/mockLogger.spec.js +0 -164
  117. package/lib/test/mockLogger.spec.js.map +0 -1
  118. package/lib/test/multiSinkLogger.spec.js +0 -84
  119. package/lib/test/multiSinkLogger.spec.js.map +0 -1
  120. package/lib/test/performanceEvent.spec.js +0 -86
  121. package/lib/test/performanceEvent.spec.js.map +0 -1
  122. package/lib/test/sampledTelemetryHelper.spec.js +0 -169
  123. package/lib/test/sampledTelemetryHelper.spec.js.map +0 -1
  124. package/lib/test/telemetryLogger.spec.js +0 -357
  125. package/lib/test/telemetryLogger.spec.js.map +0 -1
  126. package/lib/test/thresholdCounter.spec.js +0 -51
  127. package/lib/test/thresholdCounter.spec.js.map +0 -1
  128. package/lib/test/types/validateTelemetryUtilsPrevious.generated.js +0 -132
  129. package/lib/test/types/validateTelemetryUtilsPrevious.generated.js.map +0 -1
  130. package/lib/test/utils.spec.js +0 -284
  131. package/lib/test/utils.spec.js.map +0 -1
  132. /package/{dist → lib}/tsdoc-metadata.json +0 -0
package/lib/telemetry-utils-public.d.ts DELETED
@@ -1,239 +0,0 @@
1
- import { ConfigTypes } from '@fluidframework/core-interfaces';
2
- import type { EventEmitter } from '@fluid-internal/client-utils';
3
- import { EventEmitterEventType } from '@fluid-internal/client-utils';
4
- import { IConfigProviderBase } from '@fluidframework/core-interfaces';
5
- import type { IDisposable } from '@fluidframework/core-interfaces';
6
- import { IErrorBase } from '@fluidframework/core-interfaces';
7
- import { IEvent } from '@fluidframework/core-interfaces';
8
- import { IGenericError } from '@fluidframework/core-interfaces';
9
- import type { ILoggingError } from '@fluidframework/core-interfaces';
10
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
11
- import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
12
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
13
- import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
14
- import { IUsageError } from '@fluidframework/core-interfaces';
15
- import { Lazy } from '@fluidframework/core-utils';
16
- import { LogLevel } from '@fluidframework/core-interfaces';
17
- import { Tagged } from '@fluidframework/core-interfaces';
18
- import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
19
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
20
-
21
- /* Excluded from this release type: connectedEventName */
22
-
23
- /* Excluded from this release type: createChildLogger */
24
-
25
- /* Excluded from this release type: createChildMonitoringContext */
26
-
27
- /* Excluded from this release type: createMultiSinkLogger */
28
-
29
- /* Excluded from this release type: createSampledLogger */
30
-
31
- /* Excluded from this release type: DataCorruptionError */
32
-
33
- /* Excluded from this release type: DataProcessingError */
34
-
35
- /* Excluded from this release type: disconnectedEventName */
36
-
37
- /* Excluded from this release type: EventEmitterWithErrorHandling */
38
-
39
- /* Excluded from this release type: eventNamespaceSeparator */
40
-
41
- /* Excluded from this release type: extractLogSafeErrorProperties */
42
-
43
- /* Excluded from this release type: extractSafePropertiesFromMessage */
44
-
45
- /* Excluded from this release type: formatTick */
46
-
47
- /* Excluded from this release type: generateErrorWithStack */
48
-
49
- /* Excluded from this release type: generateStack */
50
-
51
- /* Excluded from this release type: GenericError */
52
-
53
- /* Excluded from this release type: getCircularReplacer */
54
-
55
- /* Excluded from this release type: hasErrorInstanceId */
56
-
57
- /* Excluded from this release type: IConfigProvider */
58
-
59
- /* Excluded from this release type: IEventSampler */
60
-
61
- /* Excluded from this release type: IFluidErrorAnnotations */
62
-
63
- /* Excluded from this release type: IFluidErrorBase */
64
-
65
- /* Excluded from this release type: IGenericError */
66
-
67
- /* Excluded from this release type: ILoggingError */
68
-
69
- /* Excluded from this release type: IPerformanceEventMarkers */
70
-
71
- /* Excluded from this release type: ISampledTelemetryLogger */
72
-
73
- /* Excluded from this release type: isExternalError */
74
-
75
- /* Excluded from this release type: isFluidError */
76
-
77
- /* Excluded from this release type: isILoggingError */
78
-
79
- /* Excluded from this release type: isTaggedTelemetryPropertyValue */
80
-
81
- /* Excluded from this release type: isValidLegacyError */
82
-
83
- /* Excluded from this release type: ITaggedTelemetryPropertyTypeExt */
84
-
85
- /**
86
- * Error telemetry event.
87
- * @remarks Maps to category = "error"
88
- * @public
89
- */
90
- export declare interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
91
- eventName: string;
92
- }
93
-
94
- /* Excluded from this release type: ITelemetryEventExt */
95
-
96
- /**
97
- * Informational (non-error) telemetry event
98
- * @remarks Maps to category = "generic"
99
- * @public
100
- */
101
- export declare interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
102
- eventName: string;
103
- category?: TelemetryEventCategory;
104
- }
105
-
106
- /**
107
- * An extended {@link @fluidframework/core-interfaces#ITelemetryBaseLogger} which allows for more lenient event types.
108
- *
109
- * @remarks
110
- * This interface is meant to be used internally within the Fluid Framework,
111
- * and `ITelemetryBaseLogger` should be used when loggers are passed between layers.
112
- * @public
113
- */
114
- export declare interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
115
- /**
116
- * Send information telemetry event
117
- * @param event - Event to send
118
- * @param error - optional error object to log
119
- * @param logLevel - optional level of the log.
120
- */
121
- sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
122
- /**
123
- * Send error telemetry event
124
- * @param event - Event to send
125
- * @param error - optional error object to log
126
- */
127
- sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
128
- /**
129
- * Send performance telemetry event
130
- * @param event - Event to send
131
- * @param error - optional error object to log
132
- * @param logLevel - optional level of the log.
133
- */
134
- sendPerformanceEvent(event: ITelemetryPerformanceEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
135
- }
136
-
137
- /* Excluded from this release type: ITelemetryLoggerPropertyBag */
138
-
139
- /* Excluded from this release type: ITelemetryLoggerPropertyBags */
140
-
141
- /**
142
- * Performance telemetry event.
143
- * @remarks Maps to category = "performance"
144
- * @public
145
- */
146
- export declare interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt {
147
- duration?: number;
148
- }
149
-
150
- /**
151
- * JSON-serializable properties, which will be logged with telemetry.
152
- * @public
153
- */
154
- export declare interface ITelemetryPropertiesExt {
155
- [index: string]: TelemetryEventPropertyTypeExt | Tagged<TelemetryEventPropertyTypeExt>;
156
- }
157
-
158
- /* Excluded from this release type: IUsageError */
159
-
160
- /* Excluded from this release type: Lazy */
161
-
162
- /* Excluded from this release type: loggerToMonitoringContext */
163
-
164
- /* Excluded from this release type: LoggingError */
165
-
166
- /* Excluded from this release type: mixinMonitoringContext */
167
-
168
- /* Excluded from this release type: MockLogger */
169
-
170
- /* Excluded from this release type: MonitoringContext */
171
-
172
- /* Excluded from this release type: MultiSinkLoggerProperties */
173
-
174
- /* Excluded from this release type: NORMALIZED_ERROR_TYPE */
175
-
176
- /* Excluded from this release type: normalizeError */
177
-
178
- /* Excluded from this release type: numberFromString */
179
-
180
- /* Excluded from this release type: overwriteStack */
181
-
182
- /* Excluded from this release type: PerformanceEvent */
183
-
184
- /* Excluded from this release type: raiseConnectedEvent */
185
-
186
- /* Excluded from this release type: safeRaiseEvent */
187
-
188
- /* Excluded from this release type: SampledTelemetryHelper */
189
-
190
- /* Excluded from this release type: sessionStorageConfigProvider */
191
-
192
- /* Excluded from this release type: tagCodeArtifacts */
193
-
194
- /* Excluded from this release type: tagData */
195
-
196
- /* Excluded from this release type: TaggedLoggerAdapter */
197
-
198
- /* Excluded from this release type: TelemetryDataTag */
199
-
200
- /**
201
- * The categories FF uses when instrumenting the code.
202
- *
203
- * generic - Informational log event
204
- *
205
- * error - Error log event, ideally 0 of these are logged during a session
206
- *
207
- * performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking
208
- * @public
209
- */
210
- export declare type TelemetryEventCategory = "generic" | "error" | "performance";
211
-
212
- /**
213
- * Property types that can be logged.
214
- *
215
- * @remarks
216
- * Includes extra types beyond {@link @fluidframework/core-interfaces#TelemetryBaseEventPropertyType}, which must be
217
- * converted before sending to a base logger.
218
- * @public
219
- */
220
- export declare type TelemetryEventPropertyTypeExt = string | number | boolean | undefined | (string | number | boolean)[] | {
221
- [key: string]: // Flat objects can have the same properties as the event itself
222
- string | number | boolean | undefined | (string | number | boolean)[];
223
- };
224
-
225
- /* Excluded from this release type: TelemetryEventPropertyTypes */
226
-
227
- /* Excluded from this release type: ThresholdCounter */
228
-
229
- /* Excluded from this release type: UsageError */
230
-
231
- /* Excluded from this release type: validatePrecondition */
232
-
233
- /* Excluded from this release type: wrapConfigProviderWithDefaults */
234
-
235
- /* Excluded from this release type: wrapError */
236
-
237
- /* Excluded from this release type: wrapErrorAndLog */
238
-
239
- export { }