@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
74 lines • 2.94 kB
TypeScript
import { DiagnosticNode, MetadataLookUpType } from "../CosmosDiagnostics.js";
import { CosmosDbDiagnosticLevel } from "./CosmosDbDiagnosticLevel.js";
import type { CosmosHeaders } from "../queryExecutionContext/CosmosHeaders.js";
import type { OperationType, ResourceType } from "../common/index.js";
/**
* @hidden
* This is Internal Representation for DiagnosticNode. It contains useful helper functions to collect
* diagnostic information throughout the lifetime of Diagnostic session.
* The functions toDiagnosticNode() & toDiagnostic() are given to convert it to public facing counterpart.
*/
export declare class DiagnosticNodeInternal implements DiagnosticNode {
id: string;
nodeType: DiagnosticNodeType;
parent: DiagnosticNodeInternal;
children: DiagnosticNodeInternal[];
data: Partial<DiagnosticDataValue>;
startTimeUTCInMs: number;
durationInMs: number;
diagnosticLevel: CosmosDbDiagnosticLevel;
private diagnosticCtx;
private encryptionDiagnostics;
}
/**
* @hidden
*/
export type DiagnosticDataValue = {
selectedLocation: string;
activityId: string;
requestAttempNumber: number;
requestPayloadLengthInBytes: number;
responsePayloadLengthInBytes: number;
responseStatus: number;
readFromCache: boolean;
operationType: OperationType;
metadatOperationType: MetadataLookUpType;
resourceType: ResourceType;
failedAttempty: boolean;
successfulRetryPolicy: string;
partitionKeyRangeId: string;
stateful: boolean;
queryRecordsRead: number;
queryMethodIdentifier: string;
log: string[];
failure: boolean;
startTimeUTCInMs: number;
durationInMs: number;
requestData: Partial<{
requestPayloadLengthInBytes: number;
responsePayloadLengthInBytes: number;
operationType: OperationType;
resourceType: ResourceType;
headers: CosmosHeaders;
requestBody: any;
responseBody: any;
url: string;
}>;
partitionKeyRangeFailoverInfo: string;
excludedLocations: string[];
};
/**
* @hidden
*/
export declare enum DiagnosticNodeType {
CLIENT_REQUEST_NODE = "CLIENT_REQUEST_NODE",// Top most node representing client operations.
METADATA_REQUEST_NODE = "METADATA_REQUEST_NODE",// Node representing a metadata request.
HTTP_REQUEST = "HTTP_REQUEST",// Node representing REST call to backend services.
BATCH_REQUEST = "BATCH_REQUEST",// Node representing batch request.
PARALLEL_QUERY_NODE = "PARALLEL_QUERY_NODE",// Node representing parallel query execution.
DEFAULT_QUERY_NODE = "DEFAULT_QUERY_NODE",// Node representing default query execution.
QUERY_REPAIR_NODE = "QUERY_REPAIR_NODE",// Node representing query repair.
BACKGROUND_REFRESH_THREAD = "BACKGROUND_REFRESH_THREAD",// Node representing background refresh.
REQUEST_ATTEMPTS = "REQUEST_ATTEMPTS"
}
//# sourceMappingURL=DiagnosticNodeInternal.d.ts.map