@fluidframework/telemetry-utils 2.103.0 → 2.110.0

package/src/telemetryTypes.ts

@@ -3,7 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import type { ITelemetryBaseLogger, LogLevel, Tagged } from "@fluidframework/core-interfaces";
+import type {
+	ErasedType,
+	ITelemetryBaseLogger,
+	LogLevel,
+	Tagged,
+} from "@fluidframework/core-interfaces";
 
 /**
  * The categories FF uses when instrumenting the code.
@@ -13,9 +18,8 @@ import type { ITelemetryBaseLogger, LogLevel, Tagged } from "@fluidframework/cor
  * error - Error log event, ideally 0 of these are logged during a session
  *
  * performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking
- * @deprecated This type is being removed without a replacement.
- * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for details.
- * @legacy @beta
+ *
+ * @internal
  */
 export type TelemetryEventCategory = "generic" | "error" | "performance";
 
@@ -67,9 +71,7 @@ export interface ITelemetryEventExt extends ITelemetryPropertiesExt {
 /**
  * Informational (non-error) telemetry event
  * @remarks Maps to category = "generic"
- * @deprecated This type is being removed without a replacement.
- * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for details.
- * @legacy @beta
+ * @internal
  */
 export interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
 	/**
@@ -87,9 +89,7 @@ export interface ITelemetryGenericEventExt extends ITelemetryPropertiesExt {
 /**
  * Error telemetry event.
  * @remarks Maps to category = "error"
- * @deprecated This type is being removed without a replacement.
- * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for details.
- * @legacy @beta
+ * @internal
  */
 export interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
 	/**
@@ -101,9 +101,7 @@ export interface ITelemetryErrorEventExt extends ITelemetryPropertiesExt {
 /**
  * Performance telemetry event.
  * @remarks Maps to category = "performance"
- * @deprecated This type is being removed without a replacement.
- * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for details.
- * @legacy @beta
+ * @internal
  */
 export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt {
 	/**
@@ -113,15 +111,9 @@ export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt
 }
 
 /**
- * This is the externally facing type for a FluidFramework internal telemetry logger wrapper.
- *
- * @remarks
- * The methods if this interface are not to be used directly by consumers and are all
- * deprecated to removed without replacement. This type is not deprecated and will
- * transition to an erased type to handle cases where "internal" `ITelemetryLoggerExt`
- * previously leaked out.
+ * Handle for an extended {@link @fluidframework/core-interfaces#ITelemetryBaseLogger} used internally within the Fluid Framework.
  *
- * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for deprecation and breaking change details.
+ * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for past method deprecation and breaking change details.
  *
  * @privateRemarks
  * External APIs taking in an `ITelemetryLoggerExt` ideally should be updated to
@@ -131,46 +123,9 @@ export interface ITelemetryPerformanceEventExt extends ITelemetryGenericEventExt
  * @legacy
  * @beta
  */
-export interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
-	/**
-	 * Send an information telemetry event.
-	 * @param event - Event to send.
-	 * @param error - Optional error object to log.
-	 * @param logLevel - Optional level of the log. If undefined, the logLevel should be treated as {@link @fluidframework/core-interfaces#LogLevel.essential}.
-	 * If the event's category is `error`, the logLevel will be upgraded to {@link @fluidframework/core-interfaces#LogLevel.essential}.
-	 * @deprecated This method is being removed without a replacement.
-	 * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for details.
-	 */
-	sendTelemetryEvent(
-		event: ITelemetryGenericEventExt,
-		error?: unknown,
-		logLevel?: typeof LogLevel.verbose | typeof LogLevel.info,
-	): void;
-
-	/**
-	 * Send an error telemetry event.
-	 * @param event - Event to send.
-	 * @param error - Optional error object to log.
-	 * @deprecated This method is being removed without a replacement.
-	 * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for details.
-	 */
-	sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
-
-	/**
-	 * Send a performance telemetry event.
-	 * @param event - Event to send
-	 * @param error - Optional error object to log.
-	 * @param logLevel - Optional level of the log. If undefined, the logLevel should be treated as {@link @fluidframework/core-interfaces#LogLevel.essential}.
-	 * If the event's category is `error`, the logLevel will be upgraded to {@link @fluidframework/core-interfaces#LogLevel.essential}.
-	 * @deprecated This method is being removed without a replacement.
-	 * @see {@link https://github.com/microsoft/FluidFramework/issues/26910 | Issue #26910} for details.
-	 */
-	sendPerformanceEvent(
-		event: ITelemetryPerformanceEventExt,
-		error?: unknown,
-		logLevel?: typeof LogLevel.verbose | typeof LogLevel.info,
-	): void;
-}
+export interface ITelemetryLoggerExt
+	extends ErasedType<"TelemetryLoggerExt">,
+		ITelemetryBaseLogger {}
 
 /**
  * An extended {@link @fluidframework/core-interfaces#ITelemetryBaseLogger} which allows for more lenient event types.

package/tsconfig.json

@@ -4,7 +4,6 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
-		"exactOptionalPropertyTypes": false,
 	},
 	"include": ["src/**/*"],
 }