@fluidframework/telemetry-utils 2.0.0-internal.6.1.2 → 2.0.0-internal.6.2.1

package/src/sampledTelemetryHelper.ts

@@ -12,11 +12,14 @@ import {
 import { performance } from "@fluidframework/common-utils";
 import { ITelemetryLoggerExt } from "./telemetryTypes";
 
+/**
+ * @privateRemarks
+ *
+ * The names of the properties in this interface are the ones that will get stamped in the
+ * telemetry event, changes should be considered carefully. The optional properties should
+ * only be populated if 'includeAggregateMetrics' is true.
+ */
 interface Measurements {
-	// The names of the properties in this interface are the ones that will get stamped in the
-	// telemetry event, changes should be considered carefully. The optional properties should
-	// only be populated if 'includeAggregateMetrics' is true.
-
 	/**
 	 * The duration of the latest execution.
 	 */
@@ -45,7 +48,7 @@ interface Measurements {
 
 /**
  * Helper class that executes a specified code block and writes an
- * {@link @fluidframework/common-definitions#ITelemetryPerformanceEvent} to a specified logger every time a specified
+ * {@link @fluidframework/core-interfaces#ITelemetryPerformanceEvent} to a specified logger every time a specified
  * number of executions is reached (or when the class is disposed). The `duration` field in the telemetry event is
  * the duration of the latest execution (sample) of the specified function. See the documentation of the
  * `includeAggregateMetrics` parameter for additional details that can be included.
@@ -82,12 +85,13 @@ export class SampledTelemetryHelper implements IDisposable {
 	) {}
 
 	/**
-	 * @param codeToMeasure -
-	 * The code to be executed and measured.
-	 * @param bucket -
-	 * A key to track executions of the code block separately. Each different value of this parameter has a separate
-	 * set of executions and metrics tracked by the class. If no such distinction needs to be made, do not provide a
-	 * value.
+	 * Executes the specified code and keeps track of execution time statistics.
+	 * If it's been called enough times (the sampleThreshold for the class) then it generates a log message with the necessary information.
+	 *
+	 * @param codeToMeasure - The code to be executed and measured.
+	 * @param bucket - A key to track executions of the code block separately.
+	 * Each different value of this parameter has a separate set of executions and metrics tracked by the class.
+	 * If no such distinction needs to be made, do not provide a value.
 	 * @returns Whatever the passed-in code block returns.
 	 */
 	public measure<T>(codeToMeasure: () => T, bucket: string = ""): T {
@@ -116,7 +120,7 @@ export class SampledTelemetryHelper implements IDisposable {
 		return returnValue;
 	}
 
-	private flushBucket(bucket: string) {
+	private flushBucket(bucket: string): void {
 		const measurements = this.measurementsMap.get(bucket);
 		if (measurements === undefined) {
 			return;
@@ -137,6 +141,6 @@ export class SampledTelemetryHelper implements IDisposable {
 	}
 
 	public dispose(error?: Error | undefined): void {
-		this.measurementsMap.forEach((_, k) => this.flushBucket(k));
+		for (const [k] of this.measurementsMap.entries()) this.flushBucket(k);
 	}
 }

package/src/telemetryTypes.ts

@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryBaseLogger, TelemetryEventCategory } from "@fluidframework/core-interfaces";
+import {
+	ITelemetryBaseLogger,
+	LogLevel,
+	TelemetryEventCategory,
+} from "@fluidframework/core-interfaces";
 
 /**
  * Property types that can be logged.
@@ -83,18 +87,30 @@ export interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
 	 * Send information telemetry event
 	 * @param event - Event to send
 	 * @param error - optional error object to log
+	 * @param logLevel - optional level of the log.
 	 */
-	sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: any): void;
+	sendTelemetryEvent(
+		event: ITelemetryGenericEventExt,
+		error?: unknown,
+		logLevel?: LogLevel.verbose | LogLevel.default,
+	): void;
 
 	/**
 	 * Send error telemetry event
 	 * @param event - Event to send
+	 * @param error - optional error object to log
 	 */
-	sendErrorEvent(event: ITelemetryErrorEventExt, error?: any): void;
+	sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
 
 	/**
 	 * Send performance telemetry event
 	 * @param event - Event to send
+	 * @param error - optional error object to log
+	 * @param logLevel - optional level of the log.
 	 */
-	sendPerformanceEvent(event: ITelemetryPerformanceEventExt, error?: any): void;
+	sendPerformanceEvent(
+		event: ITelemetryPerformanceEventExt,
+		error?: unknown,
+		logLevel?: LogLevel.verbose | LogLevel.default,
+	): void;
 }

package/src/thresholdCounter.ts

@@ -19,7 +19,7 @@ export class ThresholdCounter {
 	/**
 	 * Sends the value if it's above the treshold.
 	 */
-	public send(eventName: string, value: number) {
+	public send(eventName: string, value: number): void {
 		if (value < this.threshold) {
 			return;
 		}
@@ -36,7 +36,7 @@ export class ThresholdCounter {
 	 * To be used in scenarios where we'd like to record a
 	 * threshold violation while reducing telemetry noise.
 	 */
-	public sendIfMultiple(eventName: string, value: number) {
+	public sendIfMultiple(eventName: string, value: number): void {
 		if (value === this.thresholdMultiple) {
 			this.logger.sendPerformanceEvent({
 				eventName,

package/src/utils.ts

@@ -16,7 +16,7 @@ import {
  * @returns - The outcome of the condition
  */
 export function logIfFalse(
-	condition: any,
+	condition: unknown,
 	logger: ITelemetryBaseLogger,
 	event: string | ITelemetryGenericEvent,
 ): condition is true {