com.azure.cosmos.implementation.QueryMetrics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-cosmos Show documentation
Show all versions of azure-cosmos Show documentation
This Package contains Microsoft Azure Cosmos SDK (with Reactive Extension Reactor support) for Azure Cosmos DB SQL API
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.cosmos.implementation;
import com.azure.cosmos.implementation.query.metrics.ClientSideMetrics;
import com.azure.cosmos.implementation.query.metrics.FetchExecutionRange;
import com.azure.cosmos.implementation.query.metrics.QueryMetricsTextWriter;
import com.azure.cosmos.implementation.query.metrics.SchedulingTimeSpan;
import com.azure.cosmos.implementation.apachecommons.lang.tuple.ImmutablePair;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.concurrent.ConcurrentMap;
/**
* 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.
*/
public final class QueryMetrics {
public final static QueryMetrics ZERO = new QueryMetrics(
new ArrayList<>(), /* */
0, /* retrievedDocumentCount */
0, /* retrievedDocumentSize */
0, /* outputDocumentCount */
0, /* outputDocumentSize */
0, /* indexHitCount */
Duration.ZERO,
QueryPreparationTimes.ZERO,
Duration.ZERO,
Duration.ZERO,
Duration.ZERO,
RuntimeExecutionTimes.ZERO,
Duration.ZERO,
ClientSideMetrics.ZERO,
IndexUtilizationInfo.ZERO);
private final long retrievedDocumentCount;
private final long retrievedDocumentSize;
private final long outputDocumentCount;
private final long outputDocumentSize;
private final long indexHitDocumentCount;
private final Duration totalQueryExecutionTime;
private final QueryPreparationTimes queryPreparationTimes;
private final Duration indexLookupTime;
private final Duration documentLoadTime;
private final Duration vmExecutionTime;
private final RuntimeExecutionTimes runtimeExecutionTimes;
private final Duration documentWriteTime;
private final ClientSideMetrics clientSideMetrics;
private final List activityIds;
private final IndexUtilizationInfo indexUtilizationInfo;
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, IndexUtilizationInfo indexUtilizationInfo) {
this.retrievedDocumentCount = retrievedDocumentCount;
this.retrievedDocumentSize = retrievedDocumentSize;
this.outputDocumentCount = outputDocumentCount;
this.outputDocumentSize = outputDocumentSize;
this.indexHitDocumentCount = indexHitCount;
this.totalQueryExecutionTime = totalQueryExecutionTime;
this.queryPreparationTimes = queryPreparationTimes;
this.indexLookupTime = indexLookupTime;
this.documentLoadTime = documentLoadTime;
this.vmExecutionTime = vmExecutionTime;
this.runtimeExecutionTimes = runtimeExecutionTimes;
this.documentWriteTime = documentWriteTime;
this.clientSideMetrics = clientSideMetrics;
this.activityIds = activities;
this.indexUtilizationInfo = indexUtilizationInfo;
}
/**
* @return the retrievedDocumentCount
*/
public long getRetrievedDocumentCount() {
return retrievedDocumentCount;
}
/**
* @return the retrievedDocumentSize
*/
public long getRetrievedDocumentSize() {
return retrievedDocumentSize;
}
/**
* @return the outputDocumentCount
*/
public long getOutputDocumentCount() {
return outputDocumentCount;
}
/**
* @return the outputDocumentSize
*/
public long getOutputDocumentSize() {
return outputDocumentSize;
}
/**
* @return the indexHitDocumentCount
*/
public long getIndexHitDocumentCount() {
return indexHitDocumentCount;
}
/**
* Gets the index hit ratio by query in the Azure Cosmos database service.
*
* @return the IndexHitRatio
*/
public double getIndexHitRatio() {
return this.retrievedDocumentCount == 0 ? 1 : (double) this.indexHitDocumentCount / this.retrievedDocumentCount;
}
/**
* @return the totalQueryExecutionTime
*/
public Duration getTotalQueryExecutionTime() {
return totalQueryExecutionTime;
}
/**
* @return the queryPreparationTimes
*/
public QueryPreparationTimes getQueryPreparationTimes() {
return queryPreparationTimes;
}
/**
* @return the indexLookupTime
*/
public Duration getIndexLookupTime() {
return indexLookupTime;
}
/**
* @return the documentLoadTime
*/
public Duration getDocumentLoadTime() {
return documentLoadTime;
}
/**
* @return the vmExecutionTime
*/
public Duration getVMExecutionTime() {
return vmExecutionTime;
}
/**
* @return the runtimeExecutionTimes
*/
public RuntimeExecutionTimes getRuntimeExecutionTimes() {
return runtimeExecutionTimes;
}
/**
* @return the documentWriteTime
*/
public Duration getDocumentWriteTime() {
return documentWriteTime;
}
/**
* @return the clientSideMetrics
*/
public ClientSideMetrics getClientSideMetrics() {
return clientSideMetrics;
}
/**
* @return the indexUtilizationInfo
*/
public IndexUtilizationInfo getIndexUtilizationInfo() {
return indexUtilizationInfo;
}
/**
* @return number of reties in the Azure Cosmos database service.
*/
public long getRetries() {
return this.clientSideMetrics.getRetries();
}
public QueryMetrics add(QueryMetrics... queryMetricsArgs) {
ArrayList queryMetricsList = new ArrayList();
for (QueryMetrics queryMetrics : queryMetricsArgs) {
queryMetricsList.add(queryMetrics);
}
queryMetricsList.add(this);
return QueryMetrics.createFromCollection(queryMetricsList);
}
/**
* Utility method to merge two query metrics map.
* @param base metrics map which will be updated with new values.
* @param addOn metrics map whose values will be merge in base map.
*/
public static void mergeQueryMetricsMap(ConcurrentMap base, ConcurrentMap addOn) {
for (ConcurrentMap.Entry entry : addOn.entrySet()) {
if (base.containsKey(entry.getKey())) {
base.get(entry.getKey()).add(entry.getValue());
} else {
base.put(entry.getKey(), entry.getValue());
}
}
}
private String toTextString(int indentLevel) {
StringBuilder stringBuilder = new StringBuilder();
QueryMetricsTextWriter queryMetricsTextWriter = new QueryMetricsTextWriter(stringBuilder);
queryMetricsTextWriter.writeQueryMetrics(this);
return stringBuilder.toString();
}
public static QueryMetrics createFromCollection(Collection queryMetricsCollection) {
long retrievedDocumentCount = 0;
long retrievedDocumentSize = 0;
long outputDocumentCount = 0;
long outputDocumentSize = 0;
long indexHitDocumentCount = 0;
Duration totalQueryExecutionTime = Duration.ZERO;
Collection queryPreparationTimesCollection = new ArrayList();
Duration indexLookupTime = Duration.ZERO;
Duration documentLoadTime = Duration.ZERO;
Duration vmExecutionTime = Duration.ZERO;
Collection runtimeExecutionTimesCollection = new ArrayList();
Duration documentWriteTime = Duration.ZERO;
Collection clientSideMetricsCollection = new ArrayList();
List activityIds = new ArrayList<>();
Collection indexUtilizationInfoCollection = new ArrayList();
for (QueryMetrics queryMetrics : queryMetricsCollection) {
if (queryMetrics == null) {
throw new NullPointerException("queryMetricsList can not have null elements");
}
activityIds.addAll(queryMetrics.activityIds);
retrievedDocumentCount += queryMetrics.retrievedDocumentCount;
retrievedDocumentSize += queryMetrics.retrievedDocumentSize;
outputDocumentCount += queryMetrics.outputDocumentCount;
outputDocumentSize += queryMetrics.outputDocumentSize;
indexHitDocumentCount += queryMetrics.indexHitDocumentCount;
totalQueryExecutionTime = totalQueryExecutionTime.plus(queryMetrics.totalQueryExecutionTime);
queryPreparationTimesCollection.add(queryMetrics.queryPreparationTimes);
indexLookupTime = indexLookupTime.plus(queryMetrics.indexLookupTime);
documentLoadTime = documentLoadTime.plus(queryMetrics.documentLoadTime);
vmExecutionTime = vmExecutionTime.plus(queryMetrics.vmExecutionTime);
runtimeExecutionTimesCollection.add(queryMetrics.runtimeExecutionTimes);
documentWriteTime = documentWriteTime.plus(queryMetrics.documentWriteTime);
clientSideMetricsCollection.add(queryMetrics.clientSideMetrics);
indexUtilizationInfoCollection.add(queryMetrics.indexUtilizationInfo);
}
return new QueryMetrics(activityIds, retrievedDocumentCount, retrievedDocumentSize, outputDocumentCount,
outputDocumentSize,
indexHitDocumentCount, totalQueryExecutionTime,
QueryPreparationTimes.createFromCollection(queryPreparationTimesCollection), indexLookupTime, documentLoadTime,
vmExecutionTime, RuntimeExecutionTimes.createFromCollection(runtimeExecutionTimesCollection),
documentWriteTime, ClientSideMetrics.createFromCollection(clientSideMetricsCollection), IndexUtilizationInfo.createFromCollection(indexUtilizationInfoCollection));
}
public static QueryMetrics createFromDelimitedString(String delimitedString) {
HashMap metrics = QueryMetricsUtils.parseDelimitedString(delimitedString);
return QueryMetrics.createFromDelimitedStringAndClientSideMetrics(delimitedString,
new ClientSideMetrics(0, 0, new ArrayList(),
new ArrayList>()), "", "");
}
public static QueryMetrics createFromDelimitedStringAndClientSideMetrics(String delimitedString, ClientSideMetrics clientSideMetrics,
String activityId, String indexUtilizationInfoJSONString) {
HashMap metrics = QueryMetricsUtils.parseDelimitedString(delimitedString);
double indexHitRatio;
double retrievedDocumentCount;
indexHitRatio = metrics.get(QueryMetricsConstants.IndexHitRatio);
retrievedDocumentCount = metrics.get(QueryMetricsConstants.RetrievedDocumentCount);
long indexHitCount = (long) (indexHitRatio * retrievedDocumentCount);
double outputDocumentCount = metrics.get(QueryMetricsConstants.OutputDocumentCount);
double outputDocumentSize = metrics.get(QueryMetricsConstants.OutputDocumentSize);
double retrievedDocumentSize = metrics.get(QueryMetricsConstants.RetrievedDocumentSize);
Duration totalQueryExecutionTime = QueryMetricsUtils.getDurationFromMetrics(metrics, QueryMetricsConstants.TotalQueryExecutionTimeInMs);
IndexUtilizationInfo indexUtilizationInfo = null;
if (indexUtilizationInfoJSONString != null) {
indexUtilizationInfo = IndexUtilizationInfo.createFromJSONString(Utils.decodeBase64String(indexUtilizationInfoJSONString));
}
List activities = new ArrayList<>();
activities.add(activityId);
return new QueryMetrics(
activities,
(long) retrievedDocumentCount,
(long) retrievedDocumentSize,
(long) outputDocumentCount,
(long) outputDocumentSize,
indexHitCount,
totalQueryExecutionTime,
QueryPreparationTimes.createFromDelimitedString(delimitedString),
QueryMetricsUtils.getDurationFromMetrics(metrics, QueryMetricsConstants.IndexLookupTimeInMs),
QueryMetricsUtils.getDurationFromMetrics(metrics, QueryMetricsConstants.DocumentLoadTimeInMs),
QueryMetricsUtils.getDurationFromMetrics(metrics, QueryMetricsConstants.VMExecutionTimeInMs),
RuntimeExecutionTimes.createFromDelimitedString(delimitedString),
QueryMetricsUtils.getDurationFromMetrics(metrics, QueryMetricsConstants.DocumentWriteTimeInMs),
clientSideMetrics,
indexUtilizationInfo);
}
@Override
public String toString() {
return toTextString(0);
}
}