Class ServerSideMetrics

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Metrics received for queries from the backend.

public abstract class ServerSideMetrics

Inheritance

object

ServerSideMetrics

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

ServerSideMetrics()

protected ServerSideMetrics()

Properties

DocumentLoadTime

Gets the document loading time during query in the Azure Cosmos database service.

public abstract TimeSpan DocumentLoadTime { get; }

Property Value

TimeSpan

DocumentWriteTime

Gets the output writing/serializing time during query in the Azure Cosmos database service.

public abstract TimeSpan DocumentWriteTime { get; }

Property Value

TimeSpan

IndexHitRatio

Gets the index hit ratio by query in the Azure Cosmos database service. Value is within the range [0,1].

public abstract double IndexHitRatio { get; }

Property Value

double

IndexLookupTime

Gets the query index lookup time in the Azure Cosmos database service.

public abstract TimeSpan IndexLookupTime { get; }

Property Value

TimeSpan

OutputDocumentCount

Gets the number of documents returned by query in the Azure Cosmos DB service.

public abstract long OutputDocumentCount { get; }

Property Value

long

OutputDocumentSize

Gets the size of documents outputted in bytes during query in the Azure Cosmos database service.

public abstract long OutputDocumentSize { get; }

Property Value

long

QueryPreparationTime

Gets the query preparation time in the Azure Cosmos database service.

public abstract TimeSpan QueryPreparationTime { get; }

Property Value

TimeSpan

RetrievedDocumentCount

Gets the number of documents retrieved during query in the Azure Cosmos database service.

public abstract long RetrievedDocumentCount { get; }

Property Value

long

RetrievedDocumentSize

Gets the size of documents retrieved in bytes during query in the Azure Cosmos DB service.

public abstract long RetrievedDocumentSize { get; }

Property Value

long

RuntimeExecutionTime

Gets the query runtime execution time during query in the Azure Cosmos database service.

public abstract TimeSpan RuntimeExecutionTime { get; }

Property Value

TimeSpan

TotalTime

Gets the total query time in the Azure Cosmos database service.

public abstract TimeSpan TotalTime { get; }

Property Value

TimeSpan

VMExecutionTime

Gets the VMExecution Time.

public abstract TimeSpan VMExecutionTime { get; }

Property Value

TimeSpan