@fluidframework/telemetry-utils - npm Package Compare versions

Comparing version 2.0.0-internal.7.4.6 to 2.0.0-internal.7.4.7

api-report/telemetry-utils.api.md

@@ -339,15 +339,15 @@ ## API Report File for "@fluidframework/telemetry-utils"
 export class PerformanceEvent {
-    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
+    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
     // (undocumented)
-    cancel(props?: ITelemetryProperties, error?: unknown): void;
+    cancel(props?: ITelemetryPropertiesExt, error?: unknown): void;
     // (undocumented)
     get duration(): number;
     // (undocumented)
-    end(props?: ITelemetryProperties): void;
-    reportEvent(eventNameSuffix: string, props?: ITelemetryProperties, error?: unknown): void;
+    end(props?: ITelemetryPropertiesExt): void;
+    reportEvent(eventNameSuffix: string, props?: ITelemetryPropertiesExt, error?: unknown): void;
     // (undocumented)
-    reportProgress(props?: ITelemetryProperties, eventNameSuffix?: string): void;
-    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
-    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
-    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
+    reportProgress(props?: ITelemetryPropertiesExt, eventNameSuffix?: string): void;
+    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
+    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
+    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
 }
@@ -354,0 +354,0 @@

dist/logger.d.ts

@@ -5,5 +5,5 @@ /*!
  */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryErrorEvent, ITelemetryGenericEvent, ITelemetryPerformanceEvent, ITelemetryProperties, TelemetryBaseEventPropertyType as TelemetryEventPropertyType, LogLevel, Tagged, ITelemetryBaseProperties, TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
+import { ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryErrorEvent, ITelemetryGenericEvent, ITelemetryPerformanceEvent, TelemetryBaseEventPropertyType as TelemetryEventPropertyType, LogLevel, Tagged, ITelemetryBaseProperties, TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
 import { IsomorphicPerformance } from "@fluid-internal/client-utils";
-import { ITelemetryGenericEventExt, ITelemetryLoggerExt, ITelemetryPerformanceEventExt, TelemetryEventPropertyTypeExt, TelemetryEventCategory } from "./telemetryTypes";
+import { ITelemetryGenericEventExt, ITelemetryLoggerExt, ITelemetryPerformanceEventExt, TelemetryEventPropertyTypeExt, TelemetryEventCategory, ITelemetryPropertiesExt } from "./telemetryTypes";
 export interface Memory {
@@ -284,3 +284,3 @@ usedJSHeapSize: number;
      */
-    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
+    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
     /**
@@ -301,3 +301,3 @@ * Measure a synchronous task
      */
-    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
+    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
     /**
@@ -319,3 +319,3 @@ * Measure an asynchronous task
      */
-    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
+    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
     get duration(): number;
@@ -326,12 +326,12 @@ private event?;
     private startMemoryCollection;
-    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
-    reportProgress(props?: ITelemetryProperties, eventNameSuffix?: string): void;
+    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
+    reportProgress(props?: ITelemetryPropertiesExt, eventNameSuffix?: string): void;
     private autoEnd;
-    end(props?: ITelemetryProperties): void;
+    end(props?: ITelemetryPropertiesExt): void;
     private performanceEndMark;
-    cancel(props?: ITelemetryProperties, error?: unknown): void;
+    cancel(props?: ITelemetryPropertiesExt, error?: unknown): void;
     /**
      * Report the event, if it hasn't already been reported.
      */
-    reportEvent(eventNameSuffix: string, props?: ITelemetryProperties, error?: unknown): void;
+    reportEvent(eventNameSuffix: string, props?: ITelemetryPropertiesExt, error?: unknown): void;
     private static readonly eventHits;
@@ -338,0 +338,0 @@ private static shouldReport;

dist/telemetry-utils-untrimmed.d.ts

@@ -783,3 +783,3 @@ /// <reference types="node" />
      */
-    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
+    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
     /**
@@ -800,3 +800,3 @@ * Measure a synchronous task
      */
-    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
+    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
     /**
@@ -818,3 +818,3 @@ * Measure an asynchronous task
      */
-    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
+    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
     get duration(): number;
@@ -825,12 +825,12 @@ private event?;
     private startMemoryCollection;
-    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
-    reportProgress(props?: ITelemetryProperties, eventNameSuffix?: string): void;
+    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
+    reportProgress(props?: ITelemetryPropertiesExt, eventNameSuffix?: string): void;
     private autoEnd;
-    end(props?: ITelemetryProperties): void;
+    end(props?: ITelemetryPropertiesExt): void;
     private performanceEndMark;
-    cancel(props?: ITelemetryProperties, error?: unknown): void;
+    cancel(props?: ITelemetryPropertiesExt, error?: unknown): void;
     /**
      * Report the event, if it hasn't already been reported.
      */
-    reportEvent(eventNameSuffix: string, props?: ITelemetryProperties, error?: unknown): void;
+    reportEvent(eventNameSuffix: string, props?: ITelemetryPropertiesExt, error?: unknown): void;
     private static readonly eventHits;
@@ -837,0 +837,0 @@ private static shouldReport;

lib/logger.d.ts

@@ -5,5 +5,5 @@ /*!
  */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryErrorEvent, ITelemetryGenericEvent, ITelemetryPerformanceEvent, ITelemetryProperties, TelemetryBaseEventPropertyType as TelemetryEventPropertyType, LogLevel, Tagged, ITelemetryBaseProperties, TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
+import { ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryErrorEvent, ITelemetryGenericEvent, ITelemetryPerformanceEvent, TelemetryBaseEventPropertyType as TelemetryEventPropertyType, LogLevel, Tagged, ITelemetryBaseProperties, TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
 import { IsomorphicPerformance } from "@fluid-internal/client-utils";
-import { ITelemetryGenericEventExt, ITelemetryLoggerExt, ITelemetryPerformanceEventExt, TelemetryEventPropertyTypeExt, TelemetryEventCategory } from "./telemetryTypes";
+import { ITelemetryGenericEventExt, ITelemetryLoggerExt, ITelemetryPerformanceEventExt, TelemetryEventPropertyTypeExt, TelemetryEventCategory, ITelemetryPropertiesExt } from "./telemetryTypes";
 export interface Memory {
@@ -284,3 +284,3 @@ usedJSHeapSize: number;
      */
-    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
+    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
     /**
@@ -301,3 +301,3 @@ * Measure a synchronous task
      */
-    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
+    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
     /**
@@ -319,3 +319,3 @@ * Measure an asynchronous task
      */
-    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
+    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
     get duration(): number;
@@ -326,12 +326,12 @@ private event?;
     private startMemoryCollection;
-    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
-    reportProgress(props?: ITelemetryProperties, eventNameSuffix?: string): void;
+    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
+    reportProgress(props?: ITelemetryPropertiesExt, eventNameSuffix?: string): void;
     private autoEnd;
-    end(props?: ITelemetryProperties): void;
+    end(props?: ITelemetryPropertiesExt): void;
     private performanceEndMark;
-    cancel(props?: ITelemetryProperties, error?: unknown): void;
+    cancel(props?: ITelemetryPropertiesExt, error?: unknown): void;
     /**
      * Report the event, if it hasn't already been reported.
      */
-    reportEvent(eventNameSuffix: string, props?: ITelemetryProperties, error?: unknown): void;
+    reportEvent(eventNameSuffix: string, props?: ITelemetryPropertiesExt, error?: unknown): void;
     private static readonly eventHits;
@@ -338,0 +338,0 @@ private static shouldReport;

lib/telemetry-utils-untrimmed.d.ts

@@ -783,3 +783,3 @@ /// <reference types="node" />
      */
-    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
+    static start(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean): PerformanceEvent;
     /**
@@ -800,3 +800,3 @@ * Measure a synchronous task
      */
-    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
+    static timedExec<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => T, markers?: IPerformanceEventMarkers, sampleThreshold?: number): T;
     /**
@@ -818,3 +818,3 @@ * Measure an asynchronous task
      */
-    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
+    static timedExecAsync<T>(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, callback: (event: PerformanceEvent) => Promise<T>, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, sampleThreshold?: number): Promise<T>;
     get duration(): number;
@@ -825,12 +825,12 @@ private event?;
     private startMemoryCollection;
-    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEvent, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
-    reportProgress(props?: ITelemetryProperties, eventNameSuffix?: string): void;
+    protected constructor(logger: ITelemetryLoggerExt, event: ITelemetryGenericEventExt, markers?: IPerformanceEventMarkers, recordHeapSize?: boolean, emitLogs?: boolean);
+    reportProgress(props?: ITelemetryPropertiesExt, eventNameSuffix?: string): void;
     private autoEnd;
-    end(props?: ITelemetryProperties): void;
+    end(props?: ITelemetryPropertiesExt): void;
     private performanceEndMark;
-    cancel(props?: ITelemetryProperties, error?: unknown): void;
+    cancel(props?: ITelemetryPropertiesExt, error?: unknown): void;
     /**
      * Report the event, if it hasn't already been reported.
      */
-    reportEvent(eventNameSuffix: string, props?: ITelemetryProperties, error?: unknown): void;
+    reportEvent(eventNameSuffix: string, props?: ITelemetryPropertiesExt, error?: unknown): void;
     private static readonly eventHits;
@@ -837,0 +837,0 @@ private static shouldReport;

package.json

 {
   "name": "@fluidframework/telemetry-utils",
-  "version": "2.0.0-internal.7.4.6",
+  "version": "2.0.0-internal.7.4.7",
   "description": "Collection of telemetry relates utilities for Fluid",
@@ -42,5 +42,5 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-internal.7.4.6 <2.0.0-internal.7.5.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.4.6 <2.0.0-internal.7.5.0",
-    "@fluidframework/core-utils": ">=2.0.0-internal.7.4.6 <2.0.0-internal.7.5.0",
+    "@fluid-internal/client-utils": ">=2.0.0-internal.7.4.7 <2.0.0-internal.7.5.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.4.7 <2.0.0-internal.7.5.0",
+    "@fluidframework/core-utils": ">=2.0.0-internal.7.4.7 <2.0.0-internal.7.5.0",
     "@fluidframework/protocol-definitions": "^3.0.0",
@@ -57,3 +57,3 @@ "debug": "^4.3.4",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.4.6 <2.0.0-internal.7.5.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.4.7 <2.0.0-internal.7.5.0",
     "@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@2.0.0-internal.7.2.0",
@@ -60,0 +60,0 @@ "@microsoft/api-extractor": "^7.38.3",

src/logger.ts

@@ -12,3 +12,2 @@ /*!
 	ITelemetryPerformanceEvent,
-	ITelemetryProperties,
 	TelemetryBaseEventPropertyType as TelemetryEventPropertyType,
@@ -35,2 +34,3 @@ LogLevel,
 	TelemetryEventCategory,
+	ITelemetryPropertiesExt,
 } from "./telemetryTypes";
@@ -647,3 +647,3 @@
 		logger: ITelemetryLoggerExt,
-		event: ITelemetryGenericEvent,
+		event: ITelemetryGenericEventExt,
 		markers?: IPerformanceEventMarkers,
@@ -673,3 +673,3 @@ recordHeapSize: boolean = false,
 		logger: ITelemetryLoggerExt,
-		event: ITelemetryGenericEvent,
+		event: ITelemetryGenericEventExt,
 		callback: (event: PerformanceEvent) => T,
@@ -714,3 +714,3 @@ markers?: IPerformanceEventMarkers,
 		logger: ITelemetryLoggerExt,
-		event: ITelemetryGenericEvent,
+		event: ITelemetryGenericEventExt,
 		callback: (event: PerformanceEvent) => Promise<T>,
@@ -742,3 +742,3 @@ markers?: IPerformanceEventMarkers,
 
-	private event?: ITelemetryGenericEvent;
+	private event?: ITelemetryGenericEventExt;
 	private readonly startTime = performance.now();
@@ -750,3 +750,3 @@ private startMark?: string;
 		private readonly logger: ITelemetryLoggerExt,
-		event: ITelemetryGenericEvent,
+		event: ITelemetryGenericEventExt,
 		private readonly markers: IPerformanceEventMarkers = { end: true, cancel: "generic" },
@@ -767,3 +767,6 @@ private readonly recordHeapSize: boolean = false,
 
-	public reportProgress(props?: ITelemetryProperties, eventNameSuffix: string = "update"): void {
+	public reportProgress(
+		props?: ITelemetryPropertiesExt,
+		eventNameSuffix: string = "update",
+	): void {
 		this.reportEvent(eventNameSuffix, props);
@@ -781,3 +784,3 @@ }
 
-	public end(props?: ITelemetryProperties): void {
+	public end(props?: ITelemetryPropertiesExt): void {
 		this.reportEvent("end", props);
@@ -797,3 +800,3 @@ this.performanceEndMark();
 
-	public cancel(props?: ITelemetryProperties, error?: unknown): void {
+	public cancel(props?: ITelemetryPropertiesExt, error?: unknown): void {
 		if (this.markers.cancel !== undefined) {
@@ -810,3 +813,3 @@ this.reportEvent("cancel", { category: this.markers.cancel, ...props }, error);
 		eventNameSuffix: string,
-		props?: ITelemetryProperties,
+		props?: ITelemetryPropertiesExt,
 		error?: unknown,
@@ -825,3 +828,3 @@ ): void {
 
-		const event: ITelemetryPerformanceEvent = { ...this.event, ...props };
+		const event: ITelemetryPerformanceEventExt = { ...this.event, ...props };
 		event.eventName = `${event.eventName}_${eventNameSuffix}`;
@@ -849,3 +852,6 @@ if (eventNameSuffix !== "start") {
 	private static readonly eventHits = new Map<string, number>();
-	private static shouldReport(event: ITelemetryGenericEvent, sampleThreshold: number): boolean {
+	private static shouldReport(
+		event: ITelemetryGenericEventExt,
+		sampleThreshold: number,
+	): boolean {
 		const eventKey = `.${event.category}.${event.eventName}`;
@@ -852,0 +858,0 @@ const hitCount = PerformanceEvent.eventHits.get(eventKey) ?? 0;

No alert changes

Improved metrics

Total package byte prevSize

919710

increased by0.04%

Lines of code

12810

increased by0.05%

Dependency changes

• Updated@fluid-internal/client-utils@>=2.0.0-internal.7.4.7 <2.0.0-internal.7.5.0

• Updated@fluidframework/core-interfaces@>=2.0.0-internal.7.4.7 <2.0.0-internal.7.5.0

• Updated@fluidframework/core-utils@>=2.0.0-internal.7.4.7 <2.0.0-internal.7.5.0