@fluidframework/container-runtime 2.0.0-dev.4.4.0.161516 → 2.0.0-dev.4.4.0.161784

package/src/gc/gcTelemetry.ts

@@ -6,11 +6,7 @@
 import { ITelemetryGenericEvent, ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IGarbageCollectionData } from "@fluidframework/runtime-definitions";
 import { packagePathToTelemetryProperty } from "@fluidframework/runtime-utils";
-import {
-	generateStack,
-	MonitoringContext,
-	TelemetryDataTag,
-} from "@fluidframework/telemetry-utils";
+import { generateStack, MonitoringContext } from "@fluidframework/telemetry-utils";
 import { ICreateContainerMetadata } from "../summary";
 import {
 	disableSweepLogKey,
@@ -23,6 +19,7 @@ import {
 	runSweepKey,
 } from "./gcDefinitions";
 import { UnreferencedStateTracker } from "./gcUnreferencedStateTracker";
+import { tagAsCodeArtifact } from "./gcHelpers";
 
 type NodeUsageType = "Changed" | "Loaded" | "Revived";
 
@@ -32,25 +29,32 @@ interface ICommonProps {
 	completedGCRuns: number;
 	isTombstoned: boolean;
 	lastSummaryTime?: number;
-	fromId?: string;
 	viaHandle?: boolean;
 }
 
 /** The event that is logged when unreferenced node is used after a certain time. */
 interface IUnreferencedEventProps extends ICreateContainerMetadata, ICommonProps {
 	state: UnreferencedState;
-	id: string;
+	id: {
+		value: string;
+		tag: string;
+	};
 	type: GCNodeType;
 	unrefTime: number;
 	age: number;
 	timeout?: number;
+	fromId?: {
+		value: string;
+		tag: string;
+	};
 }
 
 /** Properties passed to nodeUsed function when a node is used. */
 interface INodeUsageProps extends ICommonProps {
-	nodeId: string;
+	id: string;
 	currentReferenceTimestampMs: number | undefined;
 	packagePath: readonly string[] | undefined;
+	fromId?: string;
 }
 
 /**
@@ -125,18 +129,18 @@ export class GCTelemetryTracker {
 		// If there is no reference timestamp to work with, no ops have been processed after creation. If so, skip
 		// logging as nothing interesting would have happened worth logging.
 		// If the node is not unreferenced, skip logging.
-		const nodeStateTracker = this.getNodeStateTracker(nodeUsageProps.nodeId);
+		const nodeStateTracker = this.getNodeStateTracker(nodeUsageProps.id);
 		if (!nodeStateTracker || nodeUsageProps.currentReferenceTimestampMs === undefined) {
 			return;
 		}
 
 		// We log these events once per event per node. A unique id is generated by joining node state (inactive / sweep ready),
 		// node's id and usage (loaded / changed / revived).
-		const uniqueEventId = `${nodeStateTracker.state}-${nodeUsageProps.nodeId}-${nodeUsageProps.usageType}`;
-		const nodeType = this.getNodeType(nodeUsageProps.nodeId);
+		const uniqueEventId = `${nodeStateTracker.state}-${nodeUsageProps.id}-${nodeUsageProps.usageType}`;
+		const nodeType = this.getNodeType(nodeUsageProps.id);
 		if (
 			!this.shouldLogNonActiveEvent(
-				nodeUsageProps.nodeId,
+				nodeUsageProps.id,
 				nodeType,
 				nodeUsageProps.usageType,
 				nodeStateTracker,
@@ -150,10 +154,10 @@ export class GCTelemetryTracker {
 		this.loggedUnreferencedEvents.add(uniqueEventId);
 
 		const state = nodeStateTracker.state;
-		const { usageType, currentReferenceTimestampMs, packagePath, ...propsToLog } =
+		const { usageType, currentReferenceTimestampMs, packagePath, id, fromId, ...propsToLog } =
 			nodeUsageProps;
 		const eventProps: Omit<IUnreferencedEventProps, "state" | "usageType"> = {
-			id: nodeUsageProps.nodeId,
+			id: tagAsCodeArtifact(id),
 			type: nodeType,
 			unrefTime: nodeStateTracker.unreferencedTimestampMs,
 			age:
@@ -163,6 +167,7 @@ export class GCTelemetryTracker {
 				state === UnreferencedState.Inactive
 					? this.configs.inactiveTimeoutMs
 					: this.configs.sweepTimeoutMs,
+			fromId: fromId ? tagAsCodeArtifact(fromId) : undefined,
 			...propsToLog,
 			...this.createContainerMetadata,
 		};
@@ -175,7 +180,7 @@ export class GCTelemetryTracker {
 				{
 					eventName: `GC_Tombstone_${nodeType}_Revived`,
 					category: "generic",
-					url: nodeUsageProps.nodeId,
+					url: tagAsCodeArtifact(id),
 					gcTombstoneEnforcementAllowed: this.gcTombstoneEnforcementAllowed,
 				},
 				undefined /* packagePath */,
@@ -199,11 +204,16 @@ export class GCTelemetryTracker {
 			// Events generated:
 			// InactiveObject_Loaded, SweepReadyObject_Loaded
 			if (nodeUsageProps.usageType === "Loaded") {
+				const { id: taggedId, fromId: taggedFromId, ...otherProps } = eventProps;
 				const event = {
 					eventName: `${state}Object_${nodeUsageProps.usageType}`,
 					pkg: packagePathToTelemetryProperty(nodeUsageProps.packagePath),
 					stack: generateStack(),
-					...eventProps,
+					id: taggedId,
+					fromId: taggedFromId,
+					details: JSON.stringify({
+						...otherProps,
+					}),
 				};
 
 				// Do not log the inactive object x events as error events as they are not the best signal for
@@ -263,8 +273,8 @@ export class GCTelemetryTracker {
 			if (missingExplicitRoutes.length > 0) {
 				logger.sendErrorEvent({
 					eventName: "gcUnknownOutboundReferences",
-					gcNodeId: nodeId,
-					gcRoutes: JSON.stringify(missingExplicitRoutes),
+					id: tagAsCodeArtifact(nodeId),
+					routes: tagAsCodeArtifact(JSON.stringify(missingExplicitRoutes)),
 				});
 			}
 		}
@@ -281,31 +291,31 @@ export class GCTelemetryTracker {
 		// InactiveObject_Loaded, InactiveObject_Changed, InactiveObject_Revived
 		// SweepReadyObject_Loaded, SweepReadyObject_Changed, SweepReadyObject_Revived
 		for (const eventProps of this.pendingEventsQueue) {
-			const { usageType, state, ...propsToLog } = eventProps;
+			const { usageType, state, id, fromId, ...propsToLog } = eventProps;
 			/**
 			 * Revived event is logged only if the node is active. If the node is not active, the reference to it was
 			 * from another unreferenced node and this scenario is not interesting to log.
 			 * Loaded and Changed events are logged only if the node is not active. If the node is active, it was
 			 * revived and a Revived event will be logged for it.
 			 */
-			const nodeStateTracker = this.getNodeStateTracker(eventProps.id);
+			const nodeStateTracker = this.getNodeStateTracker(eventProps.id.value);
 			const active =
 				nodeStateTracker === undefined ||
 				nodeStateTracker.state === UnreferencedState.Active;
 			if ((usageType === "Revived") === active) {
-				const pkg = await this.getNodePackagePath(eventProps.id);
+				const pkg = await this.getNodePackagePath(eventProps.id.value);
 				const fromPkg = eventProps.fromId
-					? await this.getNodePackagePath(eventProps.fromId)
+					? await this.getNodePackagePath(eventProps.fromId.value)
 					: undefined;
 				const event = {
-					...propsToLog,
 					eventName: `${state}Object_${usageType}`,
-					pkg: pkg
-						? { value: pkg.join("/"), tag: TelemetryDataTag.CodeArtifact }
-						: undefined,
-					fromPkg: fromPkg
-						? { value: fromPkg.join("/"), tag: TelemetryDataTag.CodeArtifact }
-						: undefined,
+					details: JSON.stringify({
+						...propsToLog,
+					}),
+					id,
+					fromId,
+					pkg: pkg ? tagAsCodeArtifact(pkg.join("/")) : undefined,
+					fromPkg: fromPkg ? tagAsCodeArtifact(fromPkg.join("/")) : undefined,
 				};
 
 				if (state === UnreferencedState.Inactive) {
@@ -336,6 +346,7 @@ export class GCTelemetryTracker {
 			return;
 		}
 
+		const deletedNodeIds: string[] = [];
 		for (const [nodeId, nodeStateTracker] of unreferencedNodesState) {
 			if (nodeStateTracker.state !== UnreferencedState.SweepReady) {
 				return;
@@ -352,15 +363,19 @@ export class GCTelemetryTracker {
 				return;
 			}
 			this.loggedUnreferencedEvents.add(uniqueEventId);
+			deletedNodeIds.push(nodeId);
+		}
+
+		if (deletedNodeIds.length > 0) {
 			logger.sendTelemetryEvent({
-				eventName: "GCObjectDeleted",
-				id: nodeId,
-				type: nodeType,
-				age: currentReferenceTimestampMs - nodeStateTracker.unreferencedTimestampMs,
-				timeout: this.configs.sweepTimeoutMs,
-				completedGCRuns,
-				lastSummaryTime,
-				...this.createContainerMetadata,
+				eventName: "GC_SweepReadyObjects_Delete",
+				details: JSON.stringify({
+					timeout: this.configs.sweepTimeoutMs,
+					completedGCRuns,
+					lastSummaryTime,
+					...this.createContainerMetadata,
+				}),
+				id: tagAsCodeArtifact(JSON.stringify(deletedNodeIds)),
 			});
 		}
 	}

package/src/gc/index.ts

@@ -43,6 +43,7 @@ export {
 	shouldAllowGcSweep,
 	trimLeadingAndTrailingSlashes,
 	unpackChildNodesGCDetails,
+	tagAsCodeArtifact,
 } from "./gcHelpers";
 export { runGarbageCollection } from "./gcReferenceGraphAlgorithm";
 export {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.0.0-dev.4.4.0.161516";
+export const pkgVersion = "2.0.0-dev.4.4.0.161784";