@fluidframework/container-runtime 2.74.0-370705 → 2.80.0

package/src/summary/summaryDelayLoadedModule/summarizer.ts

@@ -301,7 +301,7 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 			this.runtime,
 		);
 		this.runningSummarizer = runningSummarizer;
-		this.setupForwardedEvents();
+		this.setupForwardedEvents(runningSummarizer);
 		this.starting = false;
 		return runningSummarizer;
 	}
@@ -399,24 +399,26 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
 		this._heuristicData?.recordAttempt(summaryRefSeqNum);
 	}
 
-	private readonly forwardedEvents = new Map<string, () => void>();
+	private readonly forwardedEventsCleanup: (() => void)[] = [];
 
-	private setupForwardedEvents(): void {
-		for (const event of ["summarize", "summarizeAllAttemptsFailed"]) {
+	private setupForwardedEvents(runningSummarizer: RunningSummarizer): void {
+		for (const event of [
+			"summarize",
+			"summarizeAllAttemptsFailed",
+			"summarizeTimeout",
+		] as const) {
 			const listener = (...args: unknown[]): void => {
 				this.emit(event, ...args);
 			};
-			// TODO: better typing here
-			// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
-			this.runningSummarizer?.on(event as any, listener);
-			this.forwardedEvents.set(event, listener);
+			runningSummarizer.on(event, listener);
+			this.forwardedEventsCleanup.push(() => runningSummarizer.off(event, listener));
 		}
 	}
 
 	private cleanupForwardedEvents(): void {
-		for (const [event, listener] of this.forwardedEvents.entries()) {
-			this.runningSummarizer?.off(event, listener);
+		for (const cleanup of this.forwardedEventsCleanup) {
+			cleanup();
 		}
-		this.forwardedEvents.clear();
+		this.forwardedEventsCleanup.length = 0;
 	}
 }

package/src/summary/summaryDelayLoadedModule/summaryGenerator.ts

@@ -3,9 +3,12 @@
  * Licensed under the MIT License.
  */
 
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import type { ISummarizerEvents } from "@fluidframework/container-runtime-definitions/internal";
 import { assert, type IPromiseTimer, Timer } from "@fluidframework/core-utils/internal";
 import { DriverErrorTypes, MessageType } from "@fluidframework/driver-definitions/internal";
 import { getRetryDelaySecondsFromError } from "@fluidframework/driver-utils/internal";
+import { TelemetryContext } from "@fluidframework/runtime-utils/internal";
 import {
 	isFluidError,
 	type ITelemetryLoggerExt,
@@ -40,8 +43,9 @@ const maxSummarizeTimeoutCount = 5; // Double and resend 5 times
 /**
  * This class generates and tracks a summary attempt.
  */
-export class SummaryGenerator {
+export class SummaryGenerator extends TypedEventEmitter<ISummarizerEvents> {
 	private readonly summarizeTimer: Timer;
+	private activeTelemetryContext?: TelemetryContext;
 	constructor(
 		private readonly pendingAckTimer: IPromiseTimer,
 		private readonly heuristicData: ISummarizeHeuristicData,
@@ -55,6 +59,7 @@ export class SummaryGenerator {
 		private readonly summaryWatcher: Pick<IClientSummaryWatcher, "watchSummary">,
 		private readonly logger: ITelemetryLoggerExt,
 	) {
+		super();
 		this.summarizeTimer = new Timer(maxSummarizeTimeoutTime, () =>
 			this.summarizeTimerHandler(maxSummarizeTimeoutTime, 1),
 		);
@@ -85,7 +90,16 @@ export class SummaryGenerator {
 		submitSummaryOptions: ISubmitSummaryOptions,
 		resultsBuilder: SummarizeResultBuilder,
 	): Promise<void> {
-		const { summaryLogger, cancellationToken, ...summarizeOptions } = submitSummaryOptions;
+		const {
+			summaryLogger,
+			cancellationToken,
+			telemetryContext = new TelemetryContext(),
+			...summarizeOptions
+		} = submitSummaryOptions;
+
+		telemetryContext.setCurrentSummarizeStep("submitSummary");
+		const submitOptions = { ...submitSummaryOptions, telemetryContext };
+		this.activeTelemetryContext = telemetryContext;
 
 		// Note: timeSinceLastAttempt and timeSinceLastSummary for the
 		// first summary are basically the time since the summarizer was loaded.
@@ -97,6 +111,8 @@ export class SummaryGenerator {
 			fullTree: summarizeOptions.fullTree ?? false,
 			timeSinceLastAttempt,
 			timeSinceLastSummary,
+			nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps,
+			runtimeOpsSinceLastSummary: this.heuristicData.numRuntimeOps,
 		};
 
 		const summarizeEvent = PerformanceEvent.start(
@@ -148,10 +164,12 @@ export class SummaryGenerator {
 		// Wait to generate and send summary
 		this.summarizeTimer.start();
 		try {
+			telemetryContext.setCurrentSummarizeStep("generateSummary");
 			// Need to save refSeqNum before we record new attempt (happens as part of submitSummaryCallback)
 			const lastAttemptRefSeqNum = this.heuristicData.lastAttempt.refSequenceNumber;
 
-			summaryData = await this.submitSummaryCallback(submitSummaryOptions);
+			summaryData = await this.submitSummaryCallback(submitOptions);
+			telemetryContext.setCurrentSummarizeStep("submitSummaryOp");
 
 			// Cumulatively add telemetry properties based on how far generateSummary went.
 			const referenceSequenceNumber = summaryData.referenceSequenceNumber;
@@ -189,6 +207,7 @@ export class SummaryGenerator {
 			 * exceed the number of ops since last summary + number of data store whose reference state changed.
 			 */
 			if (submitSummaryOptions.fullTree !== true) {
+				telemetryContext.setCurrentSummarizeStep("watchSummary");
 				const { summarizedDataStoreCount, gcStateUpdatedDataStoreCount = 0 } =
 					summaryData.summaryStats;
 				if (
@@ -227,6 +246,8 @@ export class SummaryGenerator {
 			this.summarizeTimer.clear();
 		}
 
+		telemetryContext.setCurrentSummarizeStep("waitForSummaryAck");
+
 		try {
 			const pendingTimeoutP = this.pendingAckTimer.start();
 			const summary = this.summaryWatcher.watchSummary(summaryData.clientSequenceNumber);
@@ -300,6 +321,7 @@ export class SummaryGenerator {
 				...summarizeTelemetryProps,
 			};
 			if (ackNackOp.type === MessageType.SummaryAck) {
+				telemetryContext.setCurrentSummarizeStep("ackReceived");
 				this.heuristicData.markLastAttemptAsSuccessful();
 				this.successfulSummaryCallback();
 				summarizeEvent.end({
@@ -324,6 +346,7 @@ export class SummaryGenerator {
 			} else {
 				// Check for retryDelay in summaryNack response.
 				assert(ackNackOp.type === MessageType.SummaryNack, 0x274 /* "type check" */);
+				telemetryContext.setCurrentSummarizeStep("nackReceived");
 				const summaryNack = ackNackOp.contents;
 				const errorMessage = summaryNack?.message;
 				const retryAfterSeconds = summaryNack?.retryAfter;
@@ -350,6 +373,7 @@ export class SummaryGenerator {
 			}
 		} finally {
 			this.pendingAckTimer.clear();
+			this.activeTelemetryContext = undefined;
 		}
 	}
 
@@ -390,8 +414,6 @@ export class SummaryGenerator {
 					clientSequenceNumber: summaryData.clientSequenceNumber,
 					hasMissingOpData: this.heuristicData.hasMissingOpData,
 					opsSizesSinceLastSummary: this.heuristicData.totalOpsSize,
-					nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps,
-					runtimeOpsSinceLastSummary: this.heuristicData.numRuntimeOps,
 				};
 			}
 
@@ -408,6 +430,13 @@ export class SummaryGenerator {
 			eventName: "SummarizeTimeout",
 			timeoutTime: time,
 			timeoutCount: count,
+			currentSummarizeStep: this.activeTelemetryContext?.getCurrentSummarizeStep(),
+		});
+		this.emit("summarizeTimeout", {
+			timeoutCount: count,
+			currentSummarizeStep: this.activeTelemetryContext?.getCurrentSummarizeStep(),
+			numUnsummarizedRuntimeOps: this.heuristicData.numRuntimeOps,
+			numUnsummarizedNonRuntimeOps: this.heuristicData.numNonRuntimeOps,
 		});
 		if (count < maxSummarizeTimeoutCount) {
 			// Double and start a new timer
@@ -420,5 +449,6 @@ export class SummaryGenerator {
 
 	public dispose(): void {
 		this.summarizeTimer.clear();
+		this.activeTelemetryContext = undefined;
 	}
 }

package/src/summary/summaryManager.ts

@@ -274,7 +274,7 @@ export class SummaryManager
 
 				const summarizer = await this.createSummarizerFn();
 				this.summarizer = summarizer;
-				this.setupForwardedEvents();
+				this.setupForwardedEvents(summarizer);
 
 				// Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore
 				// If we can't run the LastSummary, simply return as to avoid paying the cost of launching
@@ -456,31 +456,32 @@ export class SummaryManager
 		this._disposed = true;
 	}
 
-	private readonly forwardedEvents = new Map<string, () => void>();
+	private readonly forwardedEventsCleanup: (() => void)[] = [];
 
-	private setupForwardedEvents(): void {
+	private setupForwardedEvents(summarizer: ISummarizer): void {
 		for (const event of [
 			"summarize",
 			"summarizeAllAttemptsFailed",
 			"summarizerStop",
 			"summarizerStart",
 			"summarizerStartupFailed",
-		]) {
+			"summarizeTimeout",
+		] as const) {
 			const listener = (...args: unknown[]): void => {
 				this.emit(event, ...args);
 			};
 			// TODO: better typing here
 			// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
-			this.summarizer?.on(event as any, listener);
-			this.forwardedEvents.set(event, listener);
+			summarizer.on(event as any, listener);
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
+			this.forwardedEventsCleanup.push(() => summarizer.off(event as any, listener));
 		}
 	}
 
 	private cleanupForwardedEvents(): void {
-		for (const [event, listener] of this.forwardedEvents.entries()) {
-			// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
-			this.summarizer?.off(event as any, listener);
+		for (const cleanup of this.forwardedEventsCleanup) {
+			cleanup();
 		}
-		this.forwardedEvents.clear();
+		this.forwardedEventsCleanup.length = 0;
 	}
 }