Share via

QueryMetrics Class

  • Reference
Package:
com.microsoft.azure.cosmosdb
  • java.lang.Object
    • com.microsoft.azure.cosmosdb.QueryMetrics

public class QueryMetrics

Query metrics in the Azure Cosmos database service. This metric represents a moving average for a set of queries whose metrics have been aggregated together.

Field Summary

Modifier and Type Field and Description
QueryMetrics ZERO

Constructor Summary

Constructor Description
QueryMetrics(List<String> activities, long retrievedDocumentCount, long retrievedDocumentSize, long outputDocumentCount, long outputDocumentSize, long indexHitCount, Duration totalQueryExecutionTime, QueryPreparationTimes queryPreparationTimes, Duration indexLookupTime, Duration documentLoadTime, Duration vmExecutionTime, RuntimeExecutionTimes runtimeExecutionTimes, Duration documentWriteTime, ClientSideMetrics clientSideMetrics)

Method Summary

Modifier and Type Method and Description
QueryMetrics add(QueryMetrics... queryMetricsArgs)
Duration getDocumentLoadTime()
Duration getDocumentWriteTime()
long getIndexHitDocumentCount()
double getIndexHitRatio()

Gets the index hit ratio by query in the Azure Cosmos database service.
Duration getIndexLookupTime()
long getOutputDocumentCount()
long getOutputDocumentSize()
QueryPreparationTimes getQueryPreparationTimes()
long getRetries()
long getRetrievedDocumentCount()
long getRetrievedDocumentSize()
RuntimeExecutionTimes getRuntimeExecutionTimes()
Duration getTotalQueryExecutionTime()
Duration getVMExecutionTime()
String toString()

Field Details

ZERO

public static QueryMetrics ZERO= new QueryMetrics( new ArrayList<>(), 0, 0, 0, 0, 0, Duration.ZERO, QueryPreparationTimes.ZERO, Duration.ZERO, Duration.ZERO, Duration.ZERO, RuntimeExecutionTimes.ZERO, Duration.ZERO, ClientSideMetrics.ZERO)

Constructor Details

QueryMetrics

public QueryMetrics(List activities, long retrievedDocumentCount, long retrievedDocumentSize, long outputDocumentCount, long outputDocumentSize, long indexHitCount, Duration totalQueryExecutionTime, QueryPreparationTimes queryPreparationTimes, Duration indexLookupTime, Duration documentLoadTime, Duration vmExecutionTime, RuntimeExecutionTimes runtimeExecutionTimes, Duration documentWriteTime, ClientSideMetrics clientSideMetrics)

Parameters:

activities
retrievedDocumentCount
retrievedDocumentSize
outputDocumentCount
outputDocumentSize
indexHitCount
totalQueryExecutionTime
queryPreparationTimes
indexLookupTime
documentLoadTime
vmExecutionTime
runtimeExecutionTimes
documentWriteTime
clientSideMetrics

Method Details

add

public QueryMetrics add(QueryMetrics... queryMetricsArgs)

Parameters:

queryMetricsArgs

getDocumentLoadTime

public Duration getDocumentLoadTime()

Returns:

the documentLoadTime

getDocumentWriteTime

public Duration getDocumentWriteTime()

Returns:

the documentWriteTime

getIndexHitDocumentCount

public long getIndexHitDocumentCount()

Returns:

the indexHitDocumentCount

getIndexHitRatio

public double getIndexHitRatio()

Gets the index hit ratio by query in the Azure Cosmos database service.

Returns:

the IndexHitRatio

getIndexLookupTime

public Duration getIndexLookupTime()

Returns:

the indexLookupTime

getOutputDocumentCount

public long getOutputDocumentCount()

Returns:

the outputDocumentCount

getOutputDocumentSize

public long getOutputDocumentSize()

Returns:

the outputDocumentSize

getQueryPreparationTimes

public QueryPreparationTimes getQueryPreparationTimes()

Returns:

the queryPreparationTimes

getRetries

public long getRetries()

Returns:

number of reties in the Azure Cosmos database service.

getRetrievedDocumentCount

public long getRetrievedDocumentCount()

Returns:

the retrievedDocumentCount

getRetrievedDocumentSize

public long getRetrievedDocumentSize()

Returns:

the retrievedDocumentSize

getRuntimeExecutionTimes

public RuntimeExecutionTimes getRuntimeExecutionTimes()

Returns:

the runtimeExecutionTimes

getTotalQueryExecutionTime

public Duration getTotalQueryExecutionTime()

Returns:

the totalQueryExecutionTime

getVMExecutionTime

public Duration getVMExecutionTime()

Returns:

the vmExecutionTime

toString

public String toString()

Applies to