Package org.apache.druid.query.search

Class DefaultSearchQueryMetrics

java.lang.Object

org.apache.druid.query.search.DefaultSearchQueryMetrics

All Implemented Interfaces:

QueryMetrics<SearchQuery>, SearchQueryMetrics

public class DefaultSearchQueryMetrics
extends Object
implements SearchQueryMetrics

This class is implemented with delegation to another QueryMetrics for compatibility, see "Making subinterfaces of QueryMetrics for emitting custom dimensions and/or metrics for specific query types" section in QueryMetrics javadoc.

Constructor Summary

Constructors

Constructor	Description
DefaultSearchQueryMetrics(QueryMetrics<Query<?>> queryMetrics)

Method Summary

Modifier and Type	Method	Description
void	context(SearchQuery query)	Sets Query.getContext() of the given query as dimension.
void	dataSource(SearchQuery query)	Sets Query.getDataSource() of the given query as dimension.
void	duration(SearchQuery query)	Sets Query.getDuration() of the given query as dimension.
void	emit(ServiceEmitter emitter)	Emits all metrics, registered since the last emit() call on this QueryMetrics object.
void	filterBundle(FilterBundle.BundleInfo bundleInfo)
void	granularity(SearchQuery query)	Sets the granularity of BaseQuery.getGranularity() of the given query as dimension.
void	hasFilters(SearchQuery query)	Sets Query.hasFilters() of the given query as dimension.
void	identity(String identity)	Sets identity of the requester for a query.
void	interval(SearchQuery query)	Sets Query.getIntervals() of the given query as dimension.
BitmapResultFactory<?>	makeBitmapResultFactory(BitmapFactory factory)	Creates a BitmapResultFactory which may record some information along bitmap construction from QueryMetrics.filterBundle(FilterBundle.BundleInfo).
void	parallelMergeParallelism(int parallelism)	Sets broker merge parallelism, if parallel merges are enabled.
void	projection(String projection)	If a projection was used during segment processing, set its name as the projection dimension
void	query(SearchQuery query)	Pulls all information from the query object into dimensions of future metrics.
void	queryId(String queryId)	Sets id of the given query as dimension.
void	queryId(SearchQuery query)	Sets Query.getId() of the given query as dimension.
void	queryType(SearchQuery query)	Sets Query.getType() of the given query as dimension.
void	remoteAddress(String remoteAddress)
QueryMetrics	reportBackPressureTime(long timeNs)	Registers "time that channel is unreadable (backpressure)" metric.
QueryMetrics	reportBitmapConstructionTime(long timeNs)	Reports the time spent constructing bitmap from QueryMetrics.filterBundle(FilterBundle.BundleInfo) of the query.
QueryMetrics	reportCpuTime(long timeNs)	Registers "cpu time" metric.
QueryMetrics	reportNodeBytes(long byteCount)	Registers "node bytes" metric.
QueryMetrics	reportNodeTime(long timeNs)	Registers "node time" metric.
QueryMetrics	reportNodeTimeToFirstByte(long timeNs)	Registers "time to first byte" metric.
QueryMetrics	reportParallelMergeFastestPartitionTime(long timeNs)	Reports broker "wall" time in nanoseconds for the fastest parallel merge sequence partition to be 'initialized', where 'initialized' is time to the first result batch is populated from data servers and merging can begin.
QueryMetrics	reportParallelMergeInputRows(long numRows)	Reports total number of input rows processed by the broker during parallel merge.
QueryMetrics	reportParallelMergeInputSequences(long numSequences)	Reports total number of input sequences processed by the broker during parallel merge.
QueryMetrics	reportParallelMergeOutputRows(long numRows)	Reports broker total number of output rows after merging and combining input sequences (should be less than or equal to the value supplied to QueryMetrics.reportParallelMergeInputRows(long).
QueryMetrics	reportParallelMergeParallelism(int parallelism)	Reports number of parallel tasks the broker used to process the query during parallel merge.
QueryMetrics	reportParallelMergeSlowestPartitionTime(long timeNs)	Reports broker "wall" time in nanoseconds for the slowest parallel merge sequence partition to be 'initialized', where 'initialized' is time to the first result batch is populated from data servers and merging can begin.
QueryMetrics	reportParallelMergeTaskCount(long numTasks)	Reports broker total number of fork join pool tasks required to complete query
QueryMetrics	reportParallelMergeTotalCpuTime(long timeNs)	Reports broker total CPU time in nanoseconds where fork join merge combine tasks were doing work
QueryMetrics	reportParallelMergeTotalTime(long timeNs)	Reports broker total "wall" time in nanoseconds from parallel merge start sequence creation to total consumption.
QueryMetrics	reportPreFilteredRows(long numRows)	Reports the number of rows to scan in the segment after applying QueryMetrics.filterBundle(FilterBundle.BundleInfo).
QueryMetrics	reportQueriedSegmentCount(long segmentCount)	Registers "segments queried count" metric.
QueryMetrics	reportQueryBytes(long byteCount)	Registers "query bytes" metric.
QueryMetrics	reportQueryTime(long timeNs)	Registers "query time" metric.
QueryMetrics	reportResultCachePoll(boolean hit)	Emits iff a given query polled the result-level cache and the success of that operation.
QueryMetrics	reportSegmentAndCacheTime(long timeNs)	Registers "segmentAndCache time" metric.
QueryMetrics	reportSegmentOnDemandLoadBytes(long byteCount)	Registers the total number of bytes added to the cache when loading segments on demand, summing the sizes loaded by individual segement load threads.
QueryMetrics	reportSegmentOnDemandLoadCount(long count)	Registers the total numer of segments loaded on demand.
QueryMetrics	reportSegmentOnDemandLoadTime(long timeNs)	Registers the apparent time spent loading segments on demand, before queing up for processing.
QueryMetrics	reportSegmentOnDemandLoadTimeAvg(long timeNs)	Registers the average time spent loading segments on demand across threads.
QueryMetrics	reportSegmentOnDemandLoadTimeMax(long timeNs)	Registers the maximum time spent waiting for a thread to start loading segments on demand across all load threads.
QueryMetrics	reportSegmentOnDemandLoadWaitTimeAvg(long timeNs)	Registers the average time spent waiting for a thread to start loading segments on demand across threads.
QueryMetrics	reportSegmentOnDemandLoadWaitTimeMax(long timeNs)	Registers the maximum time spent loading segments on demand across all load threads.
QueryMetrics	reportSegmentRows(long numRows)	Reports the total number of rows in the processed segment.
QueryMetrics	reportSegmentTime(long timeNs)	Registers "segment time" metric.
QueryMetrics	reportWaitTime(long timeNs)	Registers "wait time" metric.
void	segment(String segmentIdentifier)
void	server(String host)
void	sqlQueryId(String sqlQueryId)	Sets sqlQueryId as a dimension
void	sqlQueryId(SearchQuery query)	Sets Query.getSqlQueryId() of the given query as dimension
void	status(String status)
void	statusCode(int code)	Sets the query status code See DruidMetrics.computeStatusCode(java.lang.Throwable).
void	subQueryId(SearchQuery query)	Sets Query.getSubQueryId() of the given query as dimension.
void	success(boolean success)
void	vectorized(boolean vectorized)	Sets whether or not a segment scan has been vectorized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.druid.query.QueryMetrics

postFilters, preFilters

Constructor Details

DefaultSearchQueryMetrics

public DefaultSearchQueryMetrics(QueryMetrics<Query<?>> queryMetrics)

Method Details

query

public void query(SearchQuery query)

Description copied from interface: QueryMetrics

Pulls all information from the query object into dimensions of future metrics.

Specified by:

query in interface QueryMetrics<SearchQuery>

dataSource

public void dataSource(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getDataSource() of the given query as dimension.

Specified by:

dataSource in interface QueryMetrics<SearchQuery>

queryType

public void queryType(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getType() of the given query as dimension.

Specified by:

queryType in interface QueryMetrics<SearchQuery>

interval

public void interval(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getIntervals() of the given query as dimension.

Specified by:

interval in interface QueryMetrics<SearchQuery>

hasFilters

public void hasFilters(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.hasFilters() of the given query as dimension.

Specified by:

hasFilters in interface QueryMetrics<SearchQuery>

duration

public void duration(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getDuration() of the given query as dimension.

Specified by:

duration in interface QueryMetrics<SearchQuery>

queryId

public void queryId(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getId() of the given query as dimension.

Specified by:

queryId in interface QueryMetrics<SearchQuery>

queryId

public void queryId(String queryId)

Description copied from interface: QueryMetrics

Sets id of the given query as dimension.

Specified by:

queryId in interface QueryMetrics<SearchQuery>

subQueryId

public void subQueryId(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getSubQueryId() of the given query as dimension.

Specified by:

subQueryId in interface QueryMetrics<SearchQuery>

sqlQueryId

public void sqlQueryId(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getSqlQueryId() of the given query as dimension

Specified by:

sqlQueryId in interface QueryMetrics<SearchQuery>

sqlQueryId

public void sqlQueryId(String sqlQueryId)

Description copied from interface: QueryMetrics

Sets sqlQueryId as a dimension

Specified by:

sqlQueryId in interface QueryMetrics<SearchQuery>

granularity

public void granularity(SearchQuery query)

Description copied from interface: SearchQueryMetrics

Sets the granularity of BaseQuery.getGranularity() of the given query as dimension. This method is going to be used in "full" metrics impl, see https://github.com/apache/druid/pull/4570#issuecomment-319458229

Specified by:

granularity in interface SearchQueryMetrics

context

public void context(SearchQuery query)

Description copied from interface: QueryMetrics

Sets Query.getContext() of the given query as dimension.

Specified by:

context in interface QueryMetrics<SearchQuery>

server

public void server(String host)

Specified by:

server in interface QueryMetrics<SearchQuery>

remoteAddress

public void remoteAddress(String remoteAddress)

Specified by:

remoteAddress in interface QueryMetrics<SearchQuery>

status

public void status(String status)

Specified by:

status in interface QueryMetrics<SearchQuery>

success

public void success(boolean success)

Specified by:

success in interface QueryMetrics<SearchQuery>

statusCode

public void statusCode(int code)

Description copied from interface: QueryMetrics

Sets the query status code See DruidMetrics.computeStatusCode(java.lang.Throwable).

Specified by:

statusCode in interface QueryMetrics<SearchQuery>

segment

public void segment(String segmentIdentifier)

Specified by:

segment in interface QueryMetrics<SearchQuery>

projection

public void projection(String projection)

Description copied from interface: QueryMetrics

If a projection was used during segment processing, set its name as the projection dimension

Specified by:

projection in interface QueryMetrics<SearchQuery>

filterBundle

public void filterBundle(FilterBundle.BundleInfo bundleInfo)

Specified by:

filterBundle in interface QueryMetrics<SearchQuery>

identity

public void identity(String identity)

Description copied from interface: QueryMetrics

Sets identity of the requester for a query. See AuthenticationResult.

Specified by:

identity in interface QueryMetrics<SearchQuery>

vectorized

public void vectorized(boolean vectorized)

Description copied from interface: QueryMetrics

Sets whether or not a segment scan has been vectorized. Generally expected to only be attached to segment-level metrics, since at whole-query level we might have a mix of vectorized and non-vectorized segment scans.

Specified by:

vectorized in interface QueryMetrics<SearchQuery>

parallelMergeParallelism

public void parallelMergeParallelism(int parallelism)

Description copied from interface: QueryMetrics

Sets broker merge parallelism, if parallel merges are enabled. This will only appear in broker level metrics. This value is identical to the QueryMetrics.reportParallelMergeParallelism(int) metric value, but optionally also available as a dimension.

Specified by:

parallelMergeParallelism in interface QueryMetrics<SearchQuery>

makeBitmapResultFactory

public BitmapResultFactory<?> makeBitmapResultFactory(BitmapFactory factory)

Description copied from interface: QueryMetrics

Creates a BitmapResultFactory which may record some information along bitmap construction from QueryMetrics.filterBundle(FilterBundle.BundleInfo). The returned BitmapResultFactory may add some dimensions to this QueryMetrics from it's BitmapResultFactory.toImmutableBitmap(Object) method. See BitmapResultFactory Javadoc for more information.

Specified by:

makeBitmapResultFactory in interface QueryMetrics<SearchQuery>

reportQueryTime

public QueryMetrics reportQueryTime(long timeNs)

Description copied from interface: QueryMetrics

Registers "query time" metric. Measures the time between a Jetty thread starting to handle a query, and the response being fully written to the response output stream. Does not include time spent waiting in a queue before the query runs.

Specified by:

reportQueryTime in interface QueryMetrics<SearchQuery>

reportQueryBytes

public QueryMetrics reportQueryBytes(long byteCount)

Description copied from interface: QueryMetrics

Registers "query bytes" metric. Measures the total number of bytes written by the query server thread to the response output stream. Emitted once per query.

Specified by:

reportQueryBytes in interface QueryMetrics<SearchQuery>

reportWaitTime

public QueryMetrics reportWaitTime(long timeNs)

Description copied from interface: QueryMetrics

Registers "wait time" metric. Measures the total time segment-processing runnables spent waiting for execution in the processing thread pool. Emitted once per segment.

Specified by:

reportWaitTime in interface QueryMetrics<SearchQuery>

reportSegmentTime

public QueryMetrics reportSegmentTime(long timeNs)

Description copied from interface: QueryMetrics

Registers "segment time" metric. Measures the total wall-clock time spent operating on segments in processing threads. Emitted once per segment.

Specified by:

reportSegmentTime in interface QueryMetrics<SearchQuery>

reportSegmentAndCacheTime

public QueryMetrics reportSegmentAndCacheTime(long timeNs)

Description copied from interface: QueryMetrics

Registers "segmentAndCache time" metric. Measures the total wall-clock time spent in processing threads, either operating on segments or retrieving items from cache. Emitted once per segment.

Specified by:

reportSegmentAndCacheTime in interface QueryMetrics<SearchQuery>

reportSegmentOnDemandLoadTime

public QueryMetrics reportSegmentOnDemandLoadTime(long timeNs)

Description copied from interface: QueryMetrics

Registers the apparent time spent loading segments on demand, before queing up for processing. This measurement is wall-clock time to when the last segment is finished loading and ready for processing.

Emitted once per query

Specified by:

reportSegmentOnDemandLoadTime in interface QueryMetrics<SearchQuery>

reportSegmentOnDemandLoadTimeAvg

public QueryMetrics reportSegmentOnDemandLoadTimeAvg(long timeNs)

Description copied from interface: QueryMetrics

Registers the average time spent loading segments on demand across threads.

Emitted once per query

Specified by:

reportSegmentOnDemandLoadTimeAvg in interface QueryMetrics<SearchQuery>

reportSegmentOnDemandLoadWaitTimeMax

public QueryMetrics reportSegmentOnDemandLoadWaitTimeMax(long timeNs)

Description copied from interface: QueryMetrics

Registers the maximum time spent loading segments on demand across all load threads.

Emitted once per query

Specified by:

reportSegmentOnDemandLoadWaitTimeMax in interface QueryMetrics<SearchQuery>

reportSegmentOnDemandLoadWaitTimeAvg

public QueryMetrics reportSegmentOnDemandLoadWaitTimeAvg(long timeNs)

Description copied from interface: QueryMetrics

Registers the average time spent waiting for a thread to start loading segments on demand across threads.

Emitted once per query

Specified by:

reportSegmentOnDemandLoadWaitTimeAvg in interface QueryMetrics<SearchQuery>

reportSegmentOnDemandLoadTimeMax

public QueryMetrics reportSegmentOnDemandLoadTimeMax(long timeNs)

Description copied from interface: QueryMetrics

Registers the maximum time spent waiting for a thread to start loading segments on demand across all load threads.

Emitted once per query

Specified by:

reportSegmentOnDemandLoadTimeMax in interface QueryMetrics<SearchQuery>

reportSegmentOnDemandLoadBytes

public QueryMetrics reportSegmentOnDemandLoadBytes(long byteCount)

Description copied from interface: QueryMetrics

Registers the total number of bytes added to the cache when loading segments on demand, summing the sizes loaded by individual segement load threads.

Emitted once per query

Specified by:

reportSegmentOnDemandLoadBytes in interface QueryMetrics<SearchQuery>

reportSegmentOnDemandLoadCount

public QueryMetrics reportSegmentOnDemandLoadCount(long count)

Description copied from interface: QueryMetrics

Registers the total numer of segments loaded on demand.

Emitted once per query

Specified by:

reportSegmentOnDemandLoadCount in interface QueryMetrics<SearchQuery>

reportResultCachePoll

public QueryMetrics reportResultCachePoll(boolean hit)

Description copied from interface: QueryMetrics

Emits iff a given query polled the result-level cache and the success of that operation.

Specified by:

reportResultCachePoll in interface QueryMetrics<SearchQuery>

reportCpuTime

public QueryMetrics reportCpuTime(long timeNs)

Description copied from interface: QueryMetrics

Registers "cpu time" metric.

Specified by:

reportCpuTime in interface QueryMetrics<SearchQuery>

reportNodeTimeToFirstByte

public QueryMetrics reportNodeTimeToFirstByte(long timeNs)

Description copied from interface: QueryMetrics

Registers "time to first byte" metric.

Specified by:

reportNodeTimeToFirstByte in interface QueryMetrics<SearchQuery>

reportBackPressureTime

public QueryMetrics reportBackPressureTime(long timeNs)

Description copied from interface: QueryMetrics

Registers "time that channel is unreadable (backpressure)" metric.

Specified by:

reportBackPressureTime in interface QueryMetrics<SearchQuery>

reportNodeTime

public QueryMetrics reportNodeTime(long timeNs)

Description copied from interface: QueryMetrics

Registers "node time" metric.

Specified by:

reportNodeTime in interface QueryMetrics<SearchQuery>

reportNodeBytes

public QueryMetrics reportNodeBytes(long byteCount)

Description copied from interface: QueryMetrics

Registers "node bytes" metric.

Specified by:

reportNodeBytes in interface QueryMetrics<SearchQuery>

reportBitmapConstructionTime

public QueryMetrics reportBitmapConstructionTime(long timeNs)

Description copied from interface: QueryMetrics

Reports the time spent constructing bitmap from QueryMetrics.filterBundle(FilterBundle.BundleInfo) of the query. Not reported, if there are no indexes.

Specified by:

reportBitmapConstructionTime in interface QueryMetrics<SearchQuery>

reportSegmentRows

public QueryMetrics reportSegmentRows(long numRows)

Description copied from interface: QueryMetrics

Reports the total number of rows in the processed segment.

Specified by:

reportSegmentRows in interface QueryMetrics<SearchQuery>

reportPreFilteredRows

public QueryMetrics reportPreFilteredRows(long numRows)

Description copied from interface: QueryMetrics

Reports the number of rows to scan in the segment after applying QueryMetrics.filterBundle(FilterBundle.BundleInfo). If the are no indexes, this metric is equal to QueryMetrics.reportSegmentRows(long).

Specified by:

reportPreFilteredRows in interface QueryMetrics<SearchQuery>

reportParallelMergeParallelism

public QueryMetrics reportParallelMergeParallelism(int parallelism)

Description copied from interface: QueryMetrics

Reports number of parallel tasks the broker used to process the query during parallel merge. This value is identical to the QueryMetrics.parallelMergeParallelism(int) dimension value, but optionally also available as a metric.

Specified by:

reportParallelMergeParallelism in interface QueryMetrics<SearchQuery>

reportParallelMergeInputSequences

public QueryMetrics reportParallelMergeInputSequences(long numSequences)

Description copied from interface: QueryMetrics

Reports total number of input sequences processed by the broker during parallel merge.

Specified by:

reportParallelMergeInputSequences in interface QueryMetrics<SearchQuery>

reportParallelMergeInputRows

public QueryMetrics reportParallelMergeInputRows(long numRows)

Description copied from interface: QueryMetrics

Reports total number of input rows processed by the broker during parallel merge.

Specified by:

reportParallelMergeInputRows in interface QueryMetrics<SearchQuery>

reportParallelMergeOutputRows

public QueryMetrics reportParallelMergeOutputRows(long numRows)

Description copied from interface: QueryMetrics

Reports broker total number of output rows after merging and combining input sequences (should be less than or equal to the value supplied to QueryMetrics.reportParallelMergeInputRows(long).

Specified by:

reportParallelMergeOutputRows in interface QueryMetrics<SearchQuery>

reportParallelMergeTaskCount

public QueryMetrics reportParallelMergeTaskCount(long numTasks)

Description copied from interface: QueryMetrics

Reports broker total number of fork join pool tasks required to complete query

Specified by:

reportParallelMergeTaskCount in interface QueryMetrics<SearchQuery>

reportParallelMergeTotalCpuTime

public QueryMetrics reportParallelMergeTotalCpuTime(long timeNs)

Description copied from interface: QueryMetrics

Reports broker total CPU time in nanoseconds where fork join merge combine tasks were doing work

Specified by:

reportParallelMergeTotalCpuTime in interface QueryMetrics<SearchQuery>

reportParallelMergeTotalTime

public QueryMetrics reportParallelMergeTotalTime(long timeNs)

Description copied from interface: QueryMetrics

Reports broker total "wall" time in nanoseconds from parallel merge start sequence creation to total consumption.

Specified by:

reportParallelMergeTotalTime in interface QueryMetrics<SearchQuery>

reportParallelMergeFastestPartitionTime

public QueryMetrics reportParallelMergeFastestPartitionTime(long timeNs)

Description copied from interface: QueryMetrics

Reports broker "wall" time in nanoseconds for the fastest parallel merge sequence partition to be 'initialized', where 'initialized' is time to the first result batch is populated from data servers and merging can begin. Similar to query 'time to first byte' metrics, except is a composite of the whole group of data servers which are present in the merge partition, which all must supply an initial result batch before merging can actually begin.

Specified by:

reportParallelMergeFastestPartitionTime in interface QueryMetrics<SearchQuery>

reportParallelMergeSlowestPartitionTime

public QueryMetrics reportParallelMergeSlowestPartitionTime(long timeNs)

Description copied from interface: QueryMetrics

Reports broker "wall" time in nanoseconds for the slowest parallel merge sequence partition to be 'initialized', where 'initialized' is time to the first result batch is populated from data servers and merging can begin. Similar to query 'time to first byte' metrics, except is a composite of the whole group of data servers which are present in the merge partition, which all must supply an initial result batch before merging can actually begin.

Specified by:

reportParallelMergeSlowestPartitionTime in interface QueryMetrics<SearchQuery>

reportQueriedSegmentCount

public QueryMetrics reportQueriedSegmentCount(long segmentCount)

Description copied from interface: QueryMetrics

Registers "segments queried count" metric.

Specified by:

reportQueriedSegmentCount in interface QueryMetrics<SearchQuery>

emit

public void emit(ServiceEmitter emitter)

Description copied from interface: QueryMetrics

Emits all metrics, registered since the last emit() call on this QueryMetrics object.

Specified by:

emit in interface QueryMetrics<SearchQuery>