@fluidframework/telemetry-utils 2.0.0-dev.1.4.6.106135 → 2.0.0-dev.2.3.0.115467

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.
package/src/events.ts CHANGED
@@ -23,16 +23,25 @@ export function safeRaiseEvent(
23
23
  }
24
24
  }
25
25
 
26
+ /**
27
+ * Raises events pertaining to the connection
28
+ * @param logger - The logger to log telemetry
29
+ * @param emitter - The event emitter instance
30
+ * @param connected - A boolean tracking whether the connection was in a connected state or not
31
+ * @param clientId - The connected/disconnected clientId
32
+ * @param disconnectedReason - The reason for the connection to be disconnected (Used for telemetry purposes only)
33
+ */
26
34
  export function raiseConnectedEvent(
27
35
  logger: ITelemetryLogger,
28
36
  emitter: EventEmitter,
29
37
  connected: boolean,
30
- clientId?: string) {
38
+ clientId?: string,
39
+ disconnectedReason?: string) {
31
40
  try {
32
41
  if (connected) {
33
42
  emitter.emit(connectedEventName, clientId);
34
43
  } else {
35
- emitter.emit(disconnectedEventName);
44
+ emitter.emit(disconnectedEventName, disconnectedReason);
36
45
  }
37
46
  } catch (error) {
38
47
  logger.sendErrorEvent({ eventName: "RaiseConnectedEventError" }, error);
package/src/index.ts CHANGED
@@ -2,16 +2,6 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export * from "./debugLogger";
6
- export * from "./errorLogging";
7
- export * from "./eventEmitterWithErrorHandling";
8
- export * from "./events";
9
- export * from "./fluidErrorBase";
10
- export * from "./logger";
11
- export * from "./mockLogger";
12
- export * from "./thresholdCounter";
13
- export * from "./utils";
14
- export * from "./sampledTelemetryHelper";
15
5
  export {
16
6
  MonitoringContext,
17
7
  IConfigProviderBase,
@@ -21,3 +11,41 @@ export {
21
11
  ConfigTypes,
22
12
  loggerToMonitoringContext,
23
13
  } from "./config";
14
+ export { DebugLogger } from "./debugLogger";
15
+ export {
16
+ extractLogSafeErrorProperties,
17
+ generateErrorWithStack,
18
+ generateStack,
19
+ getCircularReplacer,
20
+ IFluidErrorAnnotations,
21
+ isExternalError,
22
+ isILoggingError,
23
+ isTaggedTelemetryPropertyValue,
24
+ LoggingError,
25
+ NORMALIZED_ERROR_TYPE,
26
+ normalizeError,
27
+ wrapError,
28
+ wrapErrorAndLog,
29
+ } from "./errorLogging";
30
+ export { EventEmitterWithErrorHandling } from "./eventEmitterWithErrorHandling";
31
+ export { connectedEventName, disconnectedEventName, raiseConnectedEvent, safeRaiseEvent } from "./events";
32
+ export { hasErrorInstanceId, IFluidErrorBase, isFluidError, isValidLegacyError } from "./fluidErrorBase";
33
+ export {
34
+ BaseTelemetryNullLogger,
35
+ ChildLogger,
36
+ IPerformanceEventMarkers,
37
+ ITelemetryLoggerPropertyBag,
38
+ ITelemetryLoggerPropertyBags,
39
+ MultiSinkLogger,
40
+ PerformanceEvent,
41
+ TaggedLoggerAdapter,
42
+ TelemetryDataTag,
43
+ TelemetryEventPropertyTypes,
44
+ TelemetryLogger,
45
+ TelemetryNullLogger,
46
+ TelemetryUTLogger,
47
+ } from "./logger";
48
+ export { MockLogger } from "./mockLogger";
49
+ export { ThresholdCounter } from "./thresholdCounter";
50
+ export { SampledTelemetryHelper } from "./sampledTelemetryHelper";
51
+ export { logIfFalse } from "./utils";
package/src/logger.ts CHANGED
@@ -15,7 +15,7 @@ import {
15
15
  ITaggedTelemetryPropertyType,
16
16
  TelemetryEventCategory,
17
17
  } from "@fluidframework/common-definitions";
18
- import { BaseTelemetryNullLogger, performance } from "@fluidframework/common-utils";
18
+ import { performance } from "@fluidframework/common-utils";
19
19
  import {
20
20
  CachedConfigProvider,
21
21
  loggerIsMonitoringContext,
@@ -528,7 +528,7 @@ export class PerformanceEvent {
528
528
  * Logger that is useful for UT
529
529
  * It can be used in places where logger instance is required, but events should be not send over.
530
530
  */
531
- export class TelemetryUTLogger implements ITelemetryLogger {
531
+ export class TelemetryUTLogger implements ITelemetryLogger {
532
532
  public send(event: ITelemetryBaseEvent): void {
533
533
  }
534
534
  public sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any) {
@@ -561,3 +561,29 @@ export class PerformanceEvent {
561
561
  throw error;
562
562
  }
563
563
  }
564
+
565
+ /**
566
+ * Null logger
567
+ * It can be used in places where logger instance is required, but events should be not send over.
568
+ */
569
+ export class BaseTelemetryNullLogger implements ITelemetryBaseLogger {
570
+ /**
571
+ * Send an event with the logger
572
+ *
573
+ * @param event - the event to send
574
+ */
575
+ public send(event: ITelemetryBaseEvent): void {
576
+ return;
577
+ }
578
+ }
579
+
580
+ /**
581
+ * Null logger
582
+ * It can be used in places where logger instance is required, but events should be not send over.
583
+ */
584
+ export class TelemetryNullLogger implements ITelemetryLogger {
585
+ public send(event: ITelemetryBaseEvent): void {}
586
+ public sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any): void {}
587
+ public sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void {}
588
+ public sendPerformanceEvent(event: ITelemetryPerformanceEvent, error?: any): void {}
589
+ }
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/telemetry-utils";
9
- export const pkgVersion = "2.0.0-dev.1.4.6.106135";
9
+ export const pkgVersion = "2.0.0-dev.2.3.0.115467";