@fluidframework/container-runtime 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/dist/connectionTelemetry.js

@@ -1,178 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReportOpPerfTelemetry = exports.latencyThreshold = void 0;
-const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
-const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
-const common_utils_1 = require("@fluidframework/common-utils");
-/**
- * We report various latency-related errors when waiting for op roundtrip takes longer than that amout of time.
- */
-exports.latencyThreshold = 5000;
-class OpPerfTelemetry {
-    constructor(clientId, deltaManager, logger) {
-        this.clientId = clientId;
-        this.deltaManager = deltaManager;
-        this.pongCount = 0;
-        this.msnTrackingTimestamp = 0;
-        this.opProcessingTimes = {};
-        // Performance Data to be reported for ops round trips and processing.
-        this.opPerfData = {};
-        this.firstConnection = true;
-        this.bootTime = common_utils_1.performance.now();
-        this.connectionStartTime = 0;
-        this.gap = 0;
-        this.logger = telemetry_utils_1.ChildLogger.create(logger, "OpPerf");
-        this.deltaManager.on("pong", (latency) => this.recordPingTime(latency));
-        this.deltaManager.on("submitOp", (message) => this.beforeOpSubmit(message));
-        this.deltaManager.on("op", (message) => this.afterProcessingOp(message));
-        this.deltaManager.on("connect", (details, opsBehind) => {
-            this.clientId = details.clientId;
-            if (opsBehind !== undefined) {
-                this.connectionOpSeqNumber = this.deltaManager.lastKnownSeqNumber;
-                this.gap = opsBehind;
-                this.connectionStartTime = common_utils_1.performance.now();
-                // We might be already up-today. If so, report it right away.
-                if (this.gap <= 0) {
-                    this.reportGettingUpToDate();
-                }
-            }
-        });
-        this.deltaManager.on("disconnect", () => {
-            this.sequenceNumberForMsnTracking = undefined;
-            this.clientSequenceNumberForLatencyStatistics = undefined;
-            this.opProcessingTimes = {};
-            this.opPerfData = {};
-            this.connectionOpSeqNumber = undefined;
-            this.firstConnection = false;
-            this.pongCount = 0;
-        });
-        this.deltaManager.outbound.on("push", (messages) => {
-            for (const msg of messages) {
-                if (msg.type === protocol_definitions_1.MessageType.Operation &&
-                    this.clientSequenceNumberForLatencyStatistics === msg.clientSequenceNumber) {
-                    (0, common_utils_1.assert)(this.opProcessingTimes.outboundPushEventTime === undefined, 0x2c8 /* "outboundPushEventTime should be undefined" */);
-                    (0, common_utils_1.assert)(this.opPerfData.durationNetwork === undefined, 0x2c9 /* "durationNetwork should be undefined" */);
-                    this.opProcessingTimes.outboundPushEventTime = Date.now();
-                    (0, common_utils_1.assert)(this.opPerfData.durationOutboundBatching === undefined, 0x2ca /* "durationOutboundBatching should be undefined" */);
-                    (0, common_utils_1.assert)(this.opProcessingTimes.submitOpEventTime !== undefined, 0x2cb /* "submitOpEventTime should be undefined" */);
-                    this.opPerfData.durationOutboundBatching = this.opProcessingTimes.outboundPushEventTime
-                        - this.opProcessingTimes.submitOpEventTime;
-                }
-            }
-        });
-        this.deltaManager.inbound.on("push", (message) => {
-            if (this.clientId === message.clientId &&
-                message.type === protocol_definitions_1.MessageType.Operation &&
-                this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber &&
-                this.opProcessingTimes.outboundPushEventTime !== undefined) {
-                this.opProcessingTimes.inboundPushEventTime = Date.now();
-                this.opPerfData.durationNetwork = this.opProcessingTimes.inboundPushEventTime
-                    - this.opProcessingTimes.outboundPushEventTime;
-                this.opProcessingTimes.outboundPushEventTime = undefined;
-                this.opPerfData.lengthInboundQueue = this.deltaManager.inbound.length;
-            }
-        });
-        this.deltaManager.inbound.on("idle", (count, duration) => {
-            // Do not want to log zero for sure.
-            // We are more interested in aggregates, so logging only if we are processing some number of ops
-            // Cut-off is arbitrary - can be increased or decreased based on amount of data collected and questions we
-            // want to get answered
-            // back-compat: Once 0.36 loader version saturates (count & duration args were added there),
-            // we can remove typeof check.
-            if (typeof count === "number" && count >= 100) {
-                this.logger.sendPerformanceEvent({
-                    eventName: "GetDeltas_OpProcessing",
-                    count,
-                    duration,
-                });
-            }
-        });
-    }
-    reportGettingUpToDate() {
-        this.connectionOpSeqNumber = undefined;
-        this.logger.sendPerformanceEvent({
-            eventName: "ConnectionSpeed",
-            duration: common_utils_1.performance.now() - this.connectionStartTime,
-            ops: this.gap,
-            // track time to connect only for first connection.
-            timeToConnect: this.firstConnection ?
-                telemetry_utils_1.TelemetryLogger.formatTick(this.connectionStartTime - this.bootTime) :
-                undefined,
-            firstConnection: this.firstConnection,
-        });
-    }
-    recordPingTime(latency) {
-        this.pingLatency = latency;
-        // logging one in every 1000 pongs, including the first time, if it is a "write" client.
-        if (this.pongCount % 100 === 0 && this.deltaManager.active) {
-            this.logger.sendPerformanceEvent({
-                eventName: "DeltaLatency",
-                duration: latency,
-            });
-        }
-        this.pongCount++;
-    }
-    beforeOpSubmit(message) {
-        // start with first client op and measure latency every 500 client ops
-        if (this.clientSequenceNumberForLatencyStatistics === undefined &&
-            message.clientSequenceNumber % 500 === 1) {
-            (0, common_utils_1.assert)(this.opProcessingTimes.outboundPushEventTime === undefined, 0x2cc /* "OpTimeSittingInboundQueue should be undefined" */);
-            (0, common_utils_1.assert)(this.opPerfData.durationNetwork === undefined, 0x2cd /* "durationNetwork should be undefined" */);
-            this.opProcessingTimes.submitOpEventTime = Date.now();
-            this.clientSequenceNumberForLatencyStatistics = message.clientSequenceNumber;
-        }
-    }
-    afterProcessingOp(message) {
-        const sequenceNumber = message.sequenceNumber;
-        if (sequenceNumber === this.connectionOpSeqNumber) {
-            this.reportGettingUpToDate();
-        }
-        // Record collab window max size after every 1000th op.
-        if (this.sequenceNumberForMsnTracking === undefined && sequenceNumber % 1000 === 0) {
-            this.sequenceNumberForMsnTracking = sequenceNumber;
-            this.msnTrackingTimestamp = message.timestamp;
-        }
-        if (this.sequenceNumberForMsnTracking !== undefined &&
-            message.minimumSequenceNumber >= this.sequenceNumberForMsnTracking) {
-            (0, common_utils_1.assert)(this.msnTrackingTimestamp !== undefined, 0x2ce /* "msnTrackingTimestamp should not be undefined" */);
-            this.logger.sendPerformanceEvent({
-                eventName: "MsnStatistics",
-                sequenceNumber,
-                msnDistance: sequenceNumber - this.sequenceNumberForMsnTracking,
-                duration: message.timestamp - this.msnTrackingTimestamp,
-            });
-            this.sequenceNumberForMsnTracking = undefined;
-        }
-        if (this.clientId === message.clientId &&
-            this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber) {
-            (0, common_utils_1.assert)(this.opProcessingTimes.submitOpEventTime !== undefined, 0x120 /* "Undefined latency statistics (op send time)" */);
-            const currentTime = Date.now();
-            if (this.opProcessingTimes.inboundPushEventTime !== undefined) {
-                this.opPerfData.durationInboundToProcessing = currentTime
-                    - this.opProcessingTimes.inboundPushEventTime;
-            }
-            const duration = currentTime - this.opProcessingTimes.submitOpEventTime;
-            // One of the core expectations for Fluid service is to be fast.
-            // When it's not the case, we want to learn about it and be able to investigate, so
-            // raise awareness.
-            // This also helps identify cases where it's due to client behavior (sending too many ops)
-            // that results in overwhelming ordering service and thus starting to see long latencies.
-            // The threshold could be adjusted, but ideally it stays  workload-agnostic, as service
-            // performance impacts all workloads relying on service.
-            const category = duration > exports.latencyThreshold ? "error" : "performance";
-            this.logger.sendPerformanceEvent(Object.assign({ eventName: "OpRoundtripTime", sequenceNumber, referenceSequenceNumber: message.referenceSequenceNumber, duration,
-                category, pingLatency: this.pingLatency, msnDistance: this.deltaManager.lastSequenceNumber - this.deltaManager.minimumSequenceNumber }, this.opPerfData));
-            this.clientSequenceNumberForLatencyStatistics = undefined;
-            this.opPerfData = {};
-        }
-    }
-}
-function ReportOpPerfTelemetry(clientId, deltaManager, logger) {
-    new OpPerfTelemetry(clientId, deltaManager, logger);
-}
-exports.ReportOpPerfTelemetry = ReportOpPerfTelemetry;
-//# sourceMappingURL=connectionTelemetry.js.map

package/dist/connectionTelemetry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"connectionTelemetry.js","sourceRoot":"","sources":["../src/connectionTelemetry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,qEAA+E;AAE/E,+EAI8C;AAC9C,+DAAmE;AAEnE;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAI,CAAC;AAgCrC,MAAM,eAAe;IAuBjB,YACY,QAA4B,EACnB,YAAwE,EACzF,MAAwB;QAFhB,aAAQ,GAAR,QAAQ,CAAoB;QACnB,iBAAY,GAAZ,YAAY,CAA4D;QAxBrF,cAAS,GAAW,CAAC,CAAC;QAKtB,yBAAoB,GAAW,CAAC,CAAC;QAIjC,sBAAiB,GAA4B,EAAE,CAAC;QAExD,sEAAsE;QAC9D,eAAU,GAAwC,EAAE,CAAC;QAErD,oBAAe,GAAG,IAAI,CAAC;QAEd,aAAQ,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;QACtC,wBAAmB,GAAG,CAAC,CAAC;QACxB,QAAG,GAAG,CAAC,CAAC;QAQZ,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEnD,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QAE5E,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;QAEzE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE;YACnD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YACjC,IAAI,SAAS,KAAK,SAAS,EAAE;gBACzB,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC;gBAClE,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;gBACrB,IAAI,CAAC,mBAAmB,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;gBAE7C,6DAA6D;gBAC7D,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE;oBACf,IAAI,CAAC,qBAAqB,EAAE,CAAC;iBAChC;aACJ;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YACpC,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;YAC9C,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;YACvC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;YAC/C,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;gBACxB,IAAI,GAAG,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS;oBAClC,IAAI,CAAC,wCAAwC,KAAK,GAAG,CAAC,oBAAoB,EAAE;oBAC5E,IAAA,qBAAM,EAAC,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAC7D,KAAK,CAAC,iDAAiD,CAAC,CAAC;oBAC7D,IAAA,qBAAM,EAAC,IAAI,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,EAChD,KAAK,CAAC,2CAA2C,CAAC,CAAC;oBACvD,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAE1D,IAAA,qBAAM,EAAC,IAAI,CAAC,UAAU,CAAC,wBAAwB,KAAK,SAAS,EACzD,KAAK,CAAC,oDAAoD,CAAC,CAAC;oBAEhE,IAAA,qBAAM,EAAC,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EACzD,KAAK,CAAC,6CAA6C,CAAC,CAAC;oBAEzD,IAAI,CAAC,UAAU,CAAC,wBAAwB,GAAG,IAAI,CAAC,iBAAiB,CAAC,qBAAqB;0BACjF,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;iBAClD;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAkC,EAAE,EAAE;YACxE,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;gBAClC,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS;gBACtC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB;gBAC9E,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAAE;gBAC5D,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACzD,IAAI,CAAC,UAAU,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,oBAAoB;sBACtD,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,CAAC;gBACpE,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,GAAG,SAAS,CAAC;gBACzD,IAAI,CAAC,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC;aACzE;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,QAAgB,EAAE,EAAE;YACrE,oCAAoC;YACpC,gGAAgG;YAChG,0GAA0G;YAC1G,uBAAuB;YACvB,4FAA4F;YAC5F,8BAA8B;YAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,GAAG,EAAE;gBAC3C,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,wBAAwB;oBACnC,KAAK;oBACL,QAAQ;iBACX,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB;QACzB,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YAC7B,SAAS,EAAE,iBAAiB;YAC5B,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,mBAAmB;YACtD,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,mDAAmD;YACnD,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;gBACjC,iCAAe,CAAC,UAAU,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtE,SAAS;YACb,eAAe,EAAE,IAAI,CAAC,eAAe;SACxC,CAAC,CAAC;IACP,CAAC;IAEO,cAAc,CAAC,OAAe;QAClC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAC3B,wFAAwF;QACxF,IAAI,IAAI,CAAC,SAAS,GAAG,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAC7B,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,OAAO;aACpB,CAAC,CAAC;SACN;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;IACrB,CAAC;IAEO,cAAc,CAAC,OAAyB;QAC5C,sEAAsE;QACtE,IAAI,IAAI,CAAC,wCAAwC,KAAK,SAAS;YAC3D,OAAO,CAAC,oBAAoB,GAAG,GAAG,KAAK,CAAC,EAAE;YAC1C,IAAA,qBAAM,EAAC,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAC7D,KAAK,CAAC,qDAAqD,CAAC,CAAC;YACjE,IAAA,qBAAM,EAAC,IAAI,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,EAChD,KAAK,CAAC,2CAA2C,CAAC,CAAC;YACvD,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACtD,IAAI,CAAC,wCAAwC,GAAG,OAAO,CAAC,oBAAoB,CAAC;SAChF;IACL,CAAC;IAEO,iBAAiB,CAAC,OAAkC;QACxD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAE9C,IAAI,cAAc,KAAK,IAAI,CAAC,qBAAqB,EAAE;YAC/C,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAChC;QAED,uDAAuD;QACvD,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,EAAE;YAChF,IAAI,CAAC,4BAA4B,GAAG,cAAc,CAAC;YACnD,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;SACjD;QACD,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS;YAC3C,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC,4BAA4B,EAAE;YACxE,IAAA,qBAAM,EAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAC1C,KAAK,CAAC,oDAAoD,CAAC,CAAC;YAChE,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAC7B,SAAS,EAAE,eAAe;gBAC1B,cAAc;gBACd,WAAW,EAAE,cAAc,GAAG,IAAI,CAAC,4BAA4B;gBAC/D,QAAQ,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,oBAAoB;aAC1D,CAAC,CAAC;YACH,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;SACjD;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAClC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB,EAAE;YAChF,IAAA,qBAAM,EAAC,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EACzD,KAAK,CAAC,mDAAmD,CAAC,CAAC;YAC/D,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE/B,IAAI,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,KAAK,SAAS,EAAE;gBAC3D,IAAI,CAAC,UAAU,CAAC,2BAA2B,GAAG,WAAW;sBACvD,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;aACjD;YAED,MAAM,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;YAExE,gEAAgE;YAChE,mFAAmF;YACnF,mBAAmB;YACnB,0FAA0F;YAC1F,yFAAyF;YACzF,uFAAuF;YACvF,wDAAwD;YACxD,MAAM,QAAQ,GAAG,QAAQ,GAAG,wBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC;YAEvE,IAAI,CAAC,MAAM,CAAC,oBAAoB,iBAC5B,SAAS,EAAE,iBAAiB,EAC5B,cAAc,EACd,uBAAuB,EAAE,OAAO,CAAC,uBAAuB,EACxD,QAAQ;gBACR,QAAQ,EACR,WAAW,EAAE,IAAI,CAAC,WAAW,EAC7B,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,qBAAqB,IACxF,IAAI,CAAC,UAAU,EACpB,CAAC;YACH,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;SACxB;IACL,CAAC;CACJ;AAuBD,SAAgB,qBAAqB,CACjC,QAA4B,EAC5B,YAAwE,EACxE,MAAwB;IACxB,IAAI,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AACxD,CAAC;AALD,sDAKC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ChildLogger, TelemetryLogger } from \"@fluidframework/telemetry-utils\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport {\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    MessageType,\n} from \"@fluidframework/protocol-definitions\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\n\n/**\n * We report various latency-related errors when waiting for op roundtrip takes longer than that amout of time.\n */\nexport const latencyThreshold = 5000;\n\n// Phases in OpPerfTelemetry:\n// 1.\tOp is added to DeltaManager (DM) buffer.\n// 2.\tOp is sent to service (op leaves outbound queue).\n// \t - Note: We do not know for sure when op is sent, we only track when it is added to outbound queue.\n//     If outbound queue is paused, time queue is paused is counted as network time.\n// 3.\tOp received from service back (pushed to inbound queue).\n// 4.\tOp is processed.\ninterface IOpPerfTelemetryProperties {\n    /** Measure time between (1) and (2) - Measure time outbound op is sitting in queue due to active batch */\n    durationOutboundBatching: number; // was durationOutboundQueue in previous versions\n    /** Measure time between (2) and (3) - Track how long it took for op to be acked by service */\n    durationNetwork: number; // was durationInboundQueue\n    /** Measure time between (3) and (4) - Time between DM's inbound \"push\" event until DM's \"op\" event */\n    durationInboundToProcessing: number;\n    /** Length of the DeltaManager's inbound queue at the time of the DM's inbound \"push\" event (3) */\n    lengthInboundQueue: number;\n}\n\n/**\n * Timings collected at various moments during the op processing.\n */\n interface IOpPerfTimings {\n     /** Starting time for (1) */\n    submitOpEventTime: number;\n     /** Starting time for (2) */\n     outboundPushEventTime: number;\n     /** Starting time for (3) */\n     inboundPushEventTime: number;\n}\n\nclass OpPerfTelemetry {\n    private pongCount: number = 0;\n    private pingLatency: number | undefined;\n\n    // Collab window tracking. This is timestamp of %1000 message.\n    private sequenceNumberForMsnTracking: number | undefined;\n    private msnTrackingTimestamp: number = 0;\n    // To track round trip time for every %500 client message.\n    private clientSequenceNumberForLatencyStatistics: number | undefined;\n\n    private opProcessingTimes: Partial<IOpPerfTimings> = {};\n\n    // Performance Data to be reported for ops round trips and processing.\n    private opPerfData: Partial<IOpPerfTelemetryProperties> = {};\n\n    private firstConnection = true;\n    private connectionOpSeqNumber: number | undefined;\n    private readonly bootTime = performance.now();\n    private connectionStartTime = 0;\n    private gap = 0;\n\n    private readonly logger: ITelemetryLogger;\n\n    public constructor(\n        private clientId: string | undefined,\n        private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n        logger: ITelemetryLogger) {\n        this.logger = ChildLogger.create(logger, \"OpPerf\");\n\n        this.deltaManager.on(\"pong\", (latency) => this.recordPingTime(latency));\n        this.deltaManager.on(\"submitOp\", (message) => this.beforeOpSubmit(message));\n\n        this.deltaManager.on(\"op\", (message) => this.afterProcessingOp(message));\n\n        this.deltaManager.on(\"connect\", (details, opsBehind) => {\n            this.clientId = details.clientId;\n            if (opsBehind !== undefined) {\n                this.connectionOpSeqNumber = this.deltaManager.lastKnownSeqNumber;\n                this.gap = opsBehind;\n                this.connectionStartTime = performance.now();\n\n                // We might be already up-today. If so, report it right away.\n                if (this.gap <= 0) {\n                    this.reportGettingUpToDate();\n                }\n            }\n        });\n        this.deltaManager.on(\"disconnect\", () => {\n            this.sequenceNumberForMsnTracking = undefined;\n            this.clientSequenceNumberForLatencyStatistics = undefined;\n            this.opProcessingTimes = {};\n            this.opPerfData = {};\n            this.connectionOpSeqNumber = undefined;\n            this.firstConnection = false;\n            this.pongCount = 0;\n        });\n\n        this.deltaManager.outbound.on(\"push\", (messages) => {\n            for (const msg of messages) {\n                if (msg.type === MessageType.Operation &&\n                    this.clientSequenceNumberForLatencyStatistics === msg.clientSequenceNumber) {\n                    assert(this.opProcessingTimes.outboundPushEventTime === undefined,\n                        0x2c8 /* \"outboundPushEventTime should be undefined\" */);\n                    assert(this.opPerfData.durationNetwork === undefined,\n                        0x2c9 /* \"durationNetwork should be undefined\" */);\n                    this.opProcessingTimes.outboundPushEventTime = Date.now();\n\n                    assert(this.opPerfData.durationOutboundBatching === undefined,\n                        0x2ca /* \"durationOutboundBatching should be undefined\" */);\n\n                    assert(this.opProcessingTimes.submitOpEventTime !== undefined,\n                        0x2cb /* \"submitOpEventTime should be undefined\" */);\n\n                    this.opPerfData.durationOutboundBatching = this.opProcessingTimes.outboundPushEventTime\n                        - this.opProcessingTimes.submitOpEventTime;\n                }\n            }\n        });\n\n        this.deltaManager.inbound.on(\"push\", (message: ISequencedDocumentMessage) => {\n            if (this.clientId === message.clientId &&\n                message.type === MessageType.Operation &&\n                this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber &&\n                this.opProcessingTimes.outboundPushEventTime !== undefined) {\n                this.opProcessingTimes.inboundPushEventTime = Date.now();\n                this.opPerfData.durationNetwork = this.opProcessingTimes.inboundPushEventTime\n                                     - this.opProcessingTimes.outboundPushEventTime;\n                this.opProcessingTimes.outboundPushEventTime = undefined;\n                this.opPerfData.lengthInboundQueue = this.deltaManager.inbound.length;\n            }\n        });\n\n        this.deltaManager.inbound.on(\"idle\", (count: number, duration: number) => {\n            // Do not want to log zero for sure.\n            // We are more interested in aggregates, so logging only if we are processing some number of ops\n            // Cut-off is arbitrary - can be increased or decreased based on amount of data collected and questions we\n            // want to get answered\n            // back-compat: Once 0.36 loader version saturates (count & duration args were added there),\n            // we can remove typeof check.\n            if (typeof count === \"number\" && count >= 100) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"GetDeltas_OpProcessing\",\n                    count,\n                    duration,\n                });\n            }\n        });\n    }\n\n    private reportGettingUpToDate() {\n        this.connectionOpSeqNumber = undefined;\n        this.logger.sendPerformanceEvent({\n            eventName: \"ConnectionSpeed\",\n            duration: performance.now() - this.connectionStartTime,\n            ops: this.gap,\n            // track time to connect only for first connection.\n            timeToConnect: this.firstConnection ?\n                TelemetryLogger.formatTick(this.connectionStartTime - this.bootTime) :\n                undefined,\n            firstConnection: this.firstConnection,\n        });\n    }\n\n    private recordPingTime(latency: number) {\n        this.pingLatency = latency;\n        // logging one in every 1000 pongs, including the first time, if it is a \"write\" client.\n        if (this.pongCount % 100 === 0 && this.deltaManager.active) {\n            this.logger.sendPerformanceEvent({\n                eventName: \"DeltaLatency\",\n                duration: latency,\n            });\n        }\n        this.pongCount++;\n    }\n\n    private beforeOpSubmit(message: IDocumentMessage) {\n        // start with first client op and measure latency every 500 client ops\n        if (this.clientSequenceNumberForLatencyStatistics === undefined &&\n            message.clientSequenceNumber % 500 === 1) {\n            assert(this.opProcessingTimes.outboundPushEventTime === undefined,\n                0x2cc /* \"OpTimeSittingInboundQueue should be undefined\" */);\n            assert(this.opPerfData.durationNetwork === undefined,\n                0x2cd /* \"durationNetwork should be undefined\" */);\n            this.opProcessingTimes.submitOpEventTime = Date.now();\n            this.clientSequenceNumberForLatencyStatistics = message.clientSequenceNumber;\n        }\n    }\n\n    private afterProcessingOp(message: ISequencedDocumentMessage) {\n        const sequenceNumber = message.sequenceNumber;\n\n        if (sequenceNumber === this.connectionOpSeqNumber) {\n            this.reportGettingUpToDate();\n        }\n\n        // Record collab window max size after every 1000th op.\n        if (this.sequenceNumberForMsnTracking === undefined && sequenceNumber % 1000 === 0) {\n            this.sequenceNumberForMsnTracking = sequenceNumber;\n            this.msnTrackingTimestamp = message.timestamp;\n        }\n        if (this.sequenceNumberForMsnTracking !== undefined &&\n                message.minimumSequenceNumber >= this.sequenceNumberForMsnTracking) {\n            assert(this.msnTrackingTimestamp !== undefined,\n                0x2ce /* \"msnTrackingTimestamp should not be undefined\" */);\n            this.logger.sendPerformanceEvent({\n                eventName: \"MsnStatistics\",\n                sequenceNumber,\n                msnDistance: sequenceNumber - this.sequenceNumberForMsnTracking,\n                duration: message.timestamp - this.msnTrackingTimestamp,\n            });\n            this.sequenceNumberForMsnTracking = undefined;\n        }\n\n        if (this.clientId === message.clientId &&\n            this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber) {\n            assert(this.opProcessingTimes.submitOpEventTime !== undefined,\n                0x120 /* \"Undefined latency statistics (op send time)\" */);\n            const currentTime = Date.now();\n\n            if (this.opProcessingTimes.inboundPushEventTime !== undefined) {\n                this.opPerfData.durationInboundToProcessing = currentTime\n                - this.opProcessingTimes.inboundPushEventTime;\n            }\n\n            const duration = currentTime - this.opProcessingTimes.submitOpEventTime;\n\n            // One of the core expectations for Fluid service is to be fast.\n            // When it's not the case, we want to learn about it and be able to investigate, so\n            // raise awareness.\n            // This also helps identify cases where it's due to client behavior (sending too many ops)\n            // that results in overwhelming ordering service and thus starting to see long latencies.\n            // The threshold could be adjusted, but ideally it stays  workload-agnostic, as service\n            // performance impacts all workloads relying on service.\n            const category = duration > latencyThreshold ? \"error\" : \"performance\";\n\n            this.logger.sendPerformanceEvent({\n                eventName: \"OpRoundtripTime\",\n                sequenceNumber,\n                referenceSequenceNumber: message.referenceSequenceNumber,\n                duration,\n                category,\n                pingLatency: this.pingLatency,\n                msnDistance: this.deltaManager.lastSequenceNumber - this.deltaManager.minimumSequenceNumber,\n                ...this.opPerfData,\n            });\n            this.clientSequenceNumberForLatencyStatistics = undefined;\n            this.opPerfData = {};\n        }\n    }\n}\nexport interface IPerfSignalReport {\n    /**\n     * Identifier for the signal being submitted in order to\n     * allow collection of data around the roundtrip of signal messages.\n     */\n    signalSequenceNumber: number;\n    /**\n     * Number of signals that were expected but not received.\n     */\n    signalsLost: number;\n\n    /**\n     * Timestamp before submitting the signal we will trace.\n     */\n    signalTimestamp: number;\n\n    /**\n     * Expected Signal Sequence to be received.\n     */\n    trackingSignalSequenceNumber: number | undefined;\n}\n\nexport function ReportOpPerfTelemetry(\n    clientId: string | undefined,\n    deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n    logger: ITelemetryLogger) {\n    new OpPerfTelemetry(clientId, deltaManager, logger);\n}\n"]}

package/dist/containerHandleContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"containerHandleContext.js","sourceRoot":"","sources":["../src/containerHandleContext.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,iFAAoE;AACpE,iEAA0E;AAG1E,MAAa,2BAA2B;IAIpC;;;;;OAKG;IACH,YACoB,IAAY,EACX,OAAyB,EAC1B,YAAkC;QAFlC,SAAI,GAAJ,IAAI,CAAQ;QACX,YAAO,GAAP,OAAO,CAAkB;QAC1B,iBAAY,GAAZ,YAAY,CAAsB;QAElD,IAAI,CAAC,YAAY,GAAG,IAAA,yCAAyB,EAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;IAfD,IAAW,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAiB1C,WAAW;QACd,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC7E,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,CAAC;IAC7D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAiB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;CACJ;AA7BD,kEA6BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidHandleContext,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\nimport { ContainerRuntime } from \"./containerRuntime\";\n\nexport class ContainerFluidHandleContext implements IFluidHandleContext {\n    public get IFluidHandleContext() { return this; }\n    public readonly absolutePath: string;\n\n    /**\n     * Creates a new ContainerFluidHandleContext.\n     * @param path - The path to this handle relative to the routeContext.\n     * @param runtime - The IRuntime object this context represents.\n     * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n     */\n    constructor(\n        public readonly path: string,\n        private readonly runtime: ContainerRuntime,\n        public readonly routeContext?: IFluidHandleContext,\n    ) {\n        this.absolutePath = generateHandleContextPath(path, this.routeContext);\n    }\n\n    public attachGraph(): void {\n        throw new Error(\"can't attach container runtime form within container!\");\n    }\n\n    public get isAttached() {\n        return this.runtime.attachState !== AttachState.Detached;\n    }\n\n    public async resolveHandle(request: IRequest): Promise<IResponse> {\n        return this.runtime.resolveHandle(request);\n    }\n}\n"]}