DefaultQueryMetrics (io.druid:druid 0.12.0 API)

java.lang.Object
- io.druid.query.DefaultQueryMetrics<QueryType>

All Implemented Interfaces:

QueryMetrics<QueryType>

Direct Known Subclasses:

DefaultGroupByQueryMetrics, DefaultTimeseriesQueryMetrics, DefaultTopNQueryMetrics
```
public class DefaultQueryMetrics<QueryType extends Query<?>>
extends Object
implements QueryMetrics<QueryType>
```
DefaultQueryMetrics is unsafe for use from multiple threads. It fails with RuntimeException on access not from the thread where it was constructed. To "transfer" DefaultQueryMetrics from one thread to another ownerThread field should be updated.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ServiceMetricEvent.Builder`	`builder`
`protected com.fasterxml.jackson.databind.ObjectMapper`	`jsonMapper`
`protected Map<String,Number>`	`metrics`
`protected Thread`	`ownerThread` Non final to give subclasses ability to reassign it.

Constructor Summary

Constructors
Constructor and Description

DefaultQueryMetrics(com.fasterxml.jackson.databind.ObjectMapper jsonMapper)

Constructors
Constructor and Description
`DefaultQueryMetrics(com.fasterxml.jackson.databind.ObjectMapper jsonMapper)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkModifiedFromOwnerThread()`
`void`	`chunkInterval(org.joda.time.Interval interval)`
`void`	`context(QueryType query)` Sets `Query.getContext()` of the given query as dimension.
`void`	`dataSource(QueryType query)` Sets `Query.getDataSource()` of the given query as dimension.
`void`	`duration(QueryType 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`	`hasFilters(QueryType query)` Sets `Query.hasFilters()` of the given query as dimension.
`void`	`identity(String identity)` Sets identity of the requester for a query.
`void`	`interval(QueryType 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.preFilters(List)`.
`void`	`postFilters(List<Filter> postFilters)`
`void`	`preFilters(List<Filter> preFilters)`
`void`	`query(QueryType query)` Pulls all information from the query object into dimensions of future metrics.
`void`	`queryId(QueryType query)` Sets `Query.getId()` of the given query as dimension.
`void`	`queryType(QueryType query)` Sets `Query.getType()` of the given query as dimension.
`void`	`remoteAddress(String remoteAddress)`
`QueryMetrics<QueryType>`	`reportBitmapConstructionTime(long timeNs)` Reports the time spent constructing bitmap from `QueryMetrics.preFilters(List)` of the query.
`QueryMetrics<QueryType>`	`reportCpuTime(long timeNs)` Registers "cpu time" metric.
`QueryMetrics<QueryType>`	`reportIntervalChunkTime(long timeNs)` Registers "interval chunk time" metric.
`protected QueryMetrics<QueryType>`	`reportMetric(String metricName, Number value)`
`QueryMetrics<QueryType>`	`reportNodeBytes(long byteCount)` Registers "node bytes" metric.
`QueryMetrics<QueryType>`	`reportNodeTime(long timeNs)` Registers "node time" metric.
`QueryMetrics<QueryType>`	`reportNodeTimeToFirstByte(long timeNs)` Registers "time to first byte" metric.
`QueryMetrics<QueryType>`	`reportPreFilteredRows(long numRows)` Reports the number of rows to scan in the segment after applying `QueryMetrics.preFilters(List)`.
`QueryMetrics<QueryType>`	`reportQueryBytes(long byteCount)` Registers "query bytes" metric.
`QueryMetrics<QueryType>`	`reportQueryTime(long timeNs)` Registers "query time" metric.
`QueryMetrics<QueryType>`	`reportSegmentAndCacheTime(long timeNs)` Registers "segmentAndCache time" metric.
`QueryMetrics<QueryType>`	`reportSegmentRows(long numRows)` Reports the total number of rows in the processed segment.
`QueryMetrics<QueryType>`	`reportSegmentTime(long timeNs)` Registers "segment time" metric.
`QueryMetrics<QueryType>`	`reportWaitTime(long timeNs)` Registers "wait time" metric.
`void`	`segment(String segmentIdentifier)`
`void`	`server(String host)`
`protected void`	`setDimension(String dimension, String value)`
`void`	`status(String status)`
`void`	`success(boolean success)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - jsonMapper
```
protected final com.fasterxml.jackson.databind.ObjectMapper jsonMapper
```
  - builder
```
protected final ServiceMetricEvent.Builder builder
```
  - metrics
```
protected final Map<String,Number> metrics
```
  - ownerThread
```
protected Thread ownerThread
```
    Non final to give subclasses ability to reassign it.
- Constructor Detail
  - DefaultQueryMetrics
```
public DefaultQueryMetrics(com.fasterxml.jackson.databind.ObjectMapper jsonMapper)
```
- Method Detail
  - checkModifiedFromOwnerThread
```
protected void checkModifiedFromOwnerThread()
```
  - setDimension
```
protected void setDimension(String dimension,
                            String value)
```
  - query
```
public void query(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Pulls all information from the query object into dimensions of future metrics.
    
    Specified by:
    
    query in interface QueryMetrics<QueryType extends Query<?>>
  - dataSource
```
public void dataSource(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Sets Query.getDataSource() of the given query as dimension.
    
    Specified by:
    
    dataSource in interface QueryMetrics<QueryType extends Query<?>>
  - queryType
```
public void queryType(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Sets Query.getType() of the given query as dimension.
    
    Specified by:
    
    queryType in interface QueryMetrics<QueryType extends Query<?>>
  - interval
```
public void interval(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Sets Query.getIntervals() of the given query as dimension.
    
    Specified by:
    
    interval in interface QueryMetrics<QueryType extends Query<?>>
  - hasFilters
```
public void hasFilters(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Sets Query.hasFilters() of the given query as dimension.
    
    Specified by:
    
    hasFilters in interface QueryMetrics<QueryType extends Query<?>>
  - duration
```
public void duration(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Sets Query.getDuration() of the given query as dimension.
    
    Specified by:
    
    duration in interface QueryMetrics<QueryType extends Query<?>>
  - queryId
```
public void queryId(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Sets Query.getId() of the given query as dimension.
    
    Specified by:
    
    queryId in interface QueryMetrics<QueryType extends Query<?>>
  - context
```
public void context(QueryType query)
```
    Description copied from interface: QueryMetrics
    
    Sets Query.getContext() of the given query as dimension.
    
    Specified by:
    
    context in interface QueryMetrics<QueryType extends Query<?>>
  - server
```
public void server(String host)
```
    Specified by:
    
    server in interface QueryMetrics<QueryType extends Query<?>>
  - remoteAddress
```
public void remoteAddress(String remoteAddress)
```
    Specified by:
    
    remoteAddress in interface QueryMetrics<QueryType extends Query<?>>
  - status
```
public void status(String status)
```
    Specified by:
    
    status in interface QueryMetrics<QueryType extends Query<?>>
  - success
```
public void success(boolean success)
```
    Specified by:
    
    success in interface QueryMetrics<QueryType extends Query<?>>
  - segment
```
public void segment(String segmentIdentifier)
```
    Specified by:
    
    segment in interface QueryMetrics<QueryType extends Query<?>>
  - chunkInterval
```
public void chunkInterval(org.joda.time.Interval interval)
```
    Specified by:
    
    chunkInterval in interface QueryMetrics<QueryType extends Query<?>>
  - preFilters
```
public void preFilters(List<Filter> preFilters)
```
    Specified by:
    
    preFilters in interface QueryMetrics<QueryType extends Query<?>>
  - postFilters
```
public void postFilters(List<Filter> postFilters)
```
    Specified by:
    
    postFilters in interface QueryMetrics<QueryType extends Query<?>>
  - 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<QueryType extends Query<?>>
  - makeBitmapResultFactory
```
public BitmapResultFactory<?> makeBitmapResultFactory(BitmapFactory factory)
```
    Description copied from interface: QueryMetrics
    
    Creates a BitmapResultFactory which may record some information along bitmap construction from QueryMetrics.preFilters(List). 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<QueryType extends Query<?>>
  - reportQueryTime
```
public QueryMetrics<QueryType> reportQueryTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "query time" metric.
    
    Specified by:
    
    reportQueryTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportQueryBytes
```
public QueryMetrics<QueryType> reportQueryBytes(long byteCount)
```
    Description copied from interface: QueryMetrics
    
    Registers "query bytes" metric.
    
    Specified by:
    
    reportQueryBytes in interface QueryMetrics<QueryType extends Query<?>>
  - reportWaitTime
```
public QueryMetrics<QueryType> reportWaitTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "wait time" metric.
    
    Specified by:
    
    reportWaitTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportSegmentTime
```
public QueryMetrics<QueryType> reportSegmentTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "segment time" metric.
    
    Specified by:
    
    reportSegmentTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportSegmentAndCacheTime
```
public QueryMetrics<QueryType> reportSegmentAndCacheTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "segmentAndCache time" metric.
    
    Specified by:
    
    reportSegmentAndCacheTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportIntervalChunkTime
```
public QueryMetrics<QueryType> reportIntervalChunkTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "interval chunk time" metric.
    
    Specified by:
    
    reportIntervalChunkTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportCpuTime
```
public QueryMetrics<QueryType> reportCpuTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "cpu time" metric.
    
    Specified by:
    
    reportCpuTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportNodeTimeToFirstByte
```
public QueryMetrics<QueryType> reportNodeTimeToFirstByte(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "time to first byte" metric.
    
    Specified by:
    
    reportNodeTimeToFirstByte in interface QueryMetrics<QueryType extends Query<?>>
  - reportNodeTime
```
public QueryMetrics<QueryType> reportNodeTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Registers "node time" metric.
    
    Specified by:
    
    reportNodeTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportMetric
```
protected QueryMetrics<QueryType> reportMetric(String metricName,
                                               Number value)
```
  - reportNodeBytes
```
public QueryMetrics<QueryType> reportNodeBytes(long byteCount)
```
    Description copied from interface: QueryMetrics
    
    Registers "node bytes" metric.
    
    Specified by:
    
    reportNodeBytes in interface QueryMetrics<QueryType extends Query<?>>
  - reportBitmapConstructionTime
```
public QueryMetrics<QueryType> reportBitmapConstructionTime(long timeNs)
```
    Description copied from interface: QueryMetrics
    
    Reports the time spent constructing bitmap from QueryMetrics.preFilters(List) of the query. Not reported, if there are no preFilters.
    
    Specified by:
    
    reportBitmapConstructionTime in interface QueryMetrics<QueryType extends Query<?>>
  - reportSegmentRows
```
public QueryMetrics<QueryType> reportSegmentRows(long numRows)
```
    Description copied from interface: QueryMetrics
    
    Reports the total number of rows in the processed segment.
    
    Specified by:
    
    reportSegmentRows in interface QueryMetrics<QueryType extends Query<?>>
  - reportPreFilteredRows
```
public QueryMetrics<QueryType> reportPreFilteredRows(long numRows)
```
    Description copied from interface: QueryMetrics
    
    Reports the number of rows to scan in the segment after applying QueryMetrics.preFilters(List). If the are no preFilters, this metric is equal to QueryMetrics.reportSegmentRows(long).
    
    Specified by:
    
    reportPreFilteredRows in interface QueryMetrics<QueryType extends Query<?>>
  - 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<QueryType extends Query<?>>

Class DefaultQueryMetrics<QueryType extends Query<?>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jsonMapper

builder

metrics

ownerThread

Constructor Detail

DefaultQueryMetrics

Method Detail

checkModifiedFromOwnerThread

setDimension

query

dataSource

queryType

interval

hasFilters

duration

queryId

context

server

remoteAddress

status

success

segment

chunkInterval

preFilters

postFilters

identity

makeBitmapResultFactory

reportQueryTime

reportQueryBytes

reportWaitTime

reportSegmentTime

reportSegmentAndCacheTime

reportIntervalChunkTime

reportCpuTime

reportNodeTimeToFirstByte

reportNodeTime

reportMetric

reportNodeBytes

reportBitmapConstructionTime

reportSegmentRows

reportPreFilteredRows

emit