@fluidframework/telemetry-utils 2.0.0-rc.1.0.4 → 2.0.0-rc.2.0.0

package/src/sampledTelemetryHelper.ts

@@ -3,14 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import {
-	ITelemetryGenericEvent,
-	ITelemetryPerformanceEvent,
-	ITelemetryProperties,
-	IDisposable,
-} from "@fluidframework/core-interfaces";
+import type { ITelemetryBaseProperties, IDisposable } from "@fluidframework/core-interfaces";
 import { performance } from "@fluid-internal/client-utils";
-import { ITelemetryLoggerExt } from "./telemetryTypes";
+import {
+	ITelemetryLoggerExt,
+	type ITelemetryGenericEventExt,
+	type ITelemetryPerformanceEventExt,
+} from "./telemetryTypes.js";
 
 /**
  * @privateRemarks
@@ -77,15 +76,15 @@ export class SampledTelemetryHelper implements IDisposable {
 	 * properties which should be added to the telemetry event for that bucket. If a bucket being measured does not
 	 * have an entry in this map, no additional properties will be added to its telemetry events. The following keys are
 	 * reserved for use by this class: "duration", "count", "totalDuration", "minDuration", "maxDuration". If any of
-	 * them is specified as a key in one of the ITelemetryProperties objects in this map, that key-value pair will be
+	 * them is specified as a key in one of the ITelemetryBaseProperties objects in this map, that key-value pair will be
 	 * ignored.
 	 */
 	public constructor(
-		private readonly eventBase: ITelemetryGenericEvent,
+		private readonly eventBase: ITelemetryGenericEventExt,
 		private readonly logger: ITelemetryLoggerExt,
 		private readonly sampleThreshold: number,
 		private readonly includeAggregateMetrics: boolean = false,
-		private readonly perBucketProperties = new Map<string, ITelemetryProperties>(),
+		private readonly perBucketProperties = new Map<string, ITelemetryBaseProperties>(),
 	) {}
 
 	/**
@@ -133,7 +132,7 @@ export class SampledTelemetryHelper implements IDisposable {
 		if (measurements.count !== 0) {
 			const bucketProperties = this.perBucketProperties.get(bucket);
 
-			const telemetryEvent: ITelemetryPerformanceEvent = {
+			const telemetryEvent: ITelemetryPerformanceEventExt = {
 				...this.eventBase,
 				...bucketProperties, // If the bucket doesn't exist and this is undefined, things work as expected
 				...measurements,

package/src/thresholdCounter.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLoggerExt } from "./telemetryTypes";
+import { ITelemetryLoggerExt } from "./telemetryTypes.js";
 
 /**
  * Utility counter which will send event only if the provided value is above a configured threshold.

package/src/utils.ts

@@ -2,42 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import {
-	ITelemetryBaseEvent,
-	ITelemetryBaseLogger,
-	ITelemetryGenericEvent,
-} from "@fluidframework/core-interfaces";
-import { loggerToMonitoringContext } from "./config";
-import { ITelemetryGenericEventExt, ITelemetryLoggerExt } from "./telemetryTypes";
-
-/**
- * Like assert, but logs only if the condition is false, rather than throwing
- * @param condition - The condition to attest too
- * @param logger - The logger to log with
- * @param event - The string or event to log
- * @returns The outcome of the condition
- *
- * @internal
- *
- * @deprecated
- * This API will be removed in a future release.
- * No replacement API is intended, but reproducing its behavior should be trivial for anyone who needs it.
- */
-export function logIfFalse(
-	condition: unknown,
-	logger: ITelemetryBaseLogger,
-	event: string | ITelemetryGenericEvent,
-): condition is true {
-	if (condition) {
-		return true;
-	}
-	const newEvent: ITelemetryBaseEvent =
-		typeof event === "string"
-			? { eventName: event, category: "error" }
-			: { category: "error", ...event };
-	logger.send(newEvent);
-	return false;
-}
+import { ITelemetryBaseEvent } from "@fluidframework/core-interfaces";
+import { loggerToMonitoringContext } from "./config.js";
+import { ITelemetryGenericEventExt, ITelemetryLoggerExt } from "./telemetryTypes.js";
 
 /**
  * An object that contains a callback used in conjunction with the {@link createSampledLogger} utility function to provide custom logic for sampling events.

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+	// This config must be used in a "type": "commonjs" environment. (Use fluid-tsc commonjs.)
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./dist",
+	},
+}

package/tsconfig.json

@@ -1,10 +1,9 @@
 {
-	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"extends": "../../../common/build/build-common/tsconfig.node16.json",
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {
 		"rootDir": "./src",
-		"outDir": "./dist",
-		"composite": true,
+		"outDir": "./lib",
 	},
 	"include": ["src/**/*"],
 }

package/tsconfig.esnext.json

@@ -1,7 +0,0 @@
-{
-	"extends": "./tsconfig.json",
-	"compilerOptions": {
-		"outDir": "./lib",
-		"module": "esnext",
-	},
-}