@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
126 lines • 5.3 kB
JavaScript
;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.getEmptyCosmosDiagnostics = getEmptyCosmosDiagnostics;
exports.addDiagnosticChild = addDiagnosticChild;
exports.withMetadataDiagnostics = withMetadataDiagnostics;
exports.withDiagnostics = withDiagnostics;
const CosmosDiagnostics_js_1 = require("../CosmosDiagnostics.js");
const DiagnosticNodeInternal_js_1 = require("../diagnostics/DiagnosticNodeInternal.js");
const time_js_1 = require("./time.js");
const CosmosDbDiagnosticLevel_js_1 = require("../diagnostics/CosmosDbDiagnosticLevel.js");
const core_util_1 = require("@azure/core-util");
/**
* @hidden
* Utility function to create an Empty CosmosDiagnostic object.
*/
function getEmptyCosmosDiagnostics() {
return new CosmosDiagnostics_js_1.CosmosDiagnostics({
requestDurationInMs: 0,
requestStartTimeUTCInMs: (0, time_js_1.getCurrentTimestampInMs)(),
totalRequestPayloadLengthInBytes: 0,
totalResponsePayloadLengthInBytes: 0,
locationEndpointsContacted: [],
retryDiagnostics: {
failedAttempts: [],
},
metadataDiagnostics: {
metadataLookups: [],
},
gatewayStatistics: [],
}, {
id: (0, core_util_1.randomUUID)(),
nodeType: DiagnosticNodeInternal_js_1.DiagnosticNodeType.CLIENT_REQUEST_NODE,
children: [],
data: {},
startTimeUTCInMs: (0, time_js_1.getCurrentTimestampInMs)(),
durationInMs: 0,
});
}
/**
* A supporting utility wrapper function, to be used inside a diagnostic session started
* by `withDiagnostics` function.
* Created a Diagnostic node and add it as a child to existing diagnostic session.
* @hidden
*/
async function addDiagnosticChild(callback, node, type, data = {}) {
const childNode = node.initializeChildNode(type, CosmosDbDiagnosticLevel_js_1.CosmosDbDiagnosticLevel.debug, data);
try {
const response = await callback(childNode);
childNode.updateTimestamp();
return response;
}
catch (e) {
childNode.addData({
failure: true,
});
childNode.updateTimestamp();
throw e;
}
}
/**
* A supporting utility wrapper function, to be used inside a diagnostic session started
* by `withDiagnostics` function.
* Treats requests originating in provided `callback` as metadata calls.
* To realize this, starts a temporary diagnostic session, after execution of callback is
* finished. Merges this temporary diagnostic session to the original diagnostic session
* represented by the input parameter `node`.
* @hidden
*/
async function withMetadataDiagnostics(callback, node, type) {
const diagnosticNodeForMetadataCall = new DiagnosticNodeInternal_js_1.DiagnosticNodeInternal(node.diagnosticLevel, DiagnosticNodeInternal_js_1.DiagnosticNodeType.METADATA_REQUEST_NODE, null);
try {
const response = await callback(diagnosticNodeForMetadataCall);
node.addChildNode(diagnosticNodeForMetadataCall, CosmosDbDiagnosticLevel_js_1.CosmosDbDiagnosticLevel.debug, type);
return response;
}
catch (e) {
node.addChildNode(diagnosticNodeForMetadataCall, CosmosDbDiagnosticLevel_js_1.CosmosDbDiagnosticLevel.debug, type);
throw e;
}
}
/**
* Utility wrapper function to managed lifecycle of a Diagnostic session.
* Meant to be used at the root of the client operation. i.e. item.read(),
* queryIterator.fetchAll().
*
* This utility starts a new diagnostic session. So using it any where else
* other than start of operation, will result is different diagnostic sessions.
*
* Workings :
* 1. Takes a callback function as input.
* 2. Creates a new instance of DiagnosticNodeInternal, which can be though as starting
* a new diagnostic session.
* 3. Executes the callback function.
* 4. If execution was successful. Converts DiagnosticNodeInternal to CosmosDiagnostics
* and injects it to the response object and returns this object.
* 5. If execution threw an exception. Sill converts DiagnosticNodeInternal to CosmosDiagnostics
* and injects it to the Error object, and rethrows the Error object.
*
* @hidden
*/
async function withDiagnostics(callback, clientContext, type = DiagnosticNodeInternal_js_1.DiagnosticNodeType.CLIENT_REQUEST_NODE) {
const diagnosticNode = new DiagnosticNodeInternal_js_1.DiagnosticNodeInternal(clientContext.diagnosticLevel, type, null);
try {
const response = await callback(diagnosticNode);
diagnosticNode.updateTimestamp();
const diagnostics = diagnosticNode.toDiagnostic(clientContext.getClientConfig());
if (typeof response === "object" && response !== null) {
response.diagnostics = diagnostics;
}
clientContext.recordDiagnostics(diagnostics);
return response;
}
catch (e) {
diagnosticNode.updateTimestamp();
diagnosticNode.addData({
failure: true,
});
const diagnostics = diagnosticNode.toDiagnostic(clientContext.getClientConfig());
e.diagnostics = diagnostics;
clientContext.recordDiagnostics(diagnostics);
throw e;
}
}
//# sourceMappingURL=diagnostics.js.map