org.elasticsearch.search.profile

Class Profiler

java.lang.Object

org.elasticsearch.search.profile.Profiler

public final class Profiler
extends Object

This class acts as a thread-local storage for profiling a query. It also builds a representation of the query tree which is built constructed "online" as the weights are wrapped by ContextIndexSearcher. This allows us to know the relationship between nodes in tree without explicitly walking the tree or pre-wrapping everything A Profiler is associated with every Search, not per Search-Request. E.g. a request may execute two searches (query + global agg). A Profiler just represents one of those

Constructor Summary

Constructors

Constructor and Description
Profiler()

Method Summary

Methods

Modifier and Type	Method and Description
static List<ProfileShardResult>	buildShardResults(List<Profiler> profilers) Helper method to convert Profiler into InternalProfileShardResults, which can be serialized to other nodes, emitted as JSON, etc.
CollectorResult	getCollector() Return the current root Collector for this search
ProfileBreakdown	getQueryBreakdown(org.apache.lucene.search.Query query) Get the ProfileBreakdown for the given query, potentially creating it if it did not exist.
List<org.elasticsearch.search.profile.ProfileResult>	getQueryTree()
long	getRewriteTime()
void	pollLastQuery() Removes the last (e.g.
void	setCollector(InternalProfileCollector collector) Set the collector that is associated with this profiler.
void	startRewriteTime() Begin timing the rewrite phase of a request.
long	stopAndAddRewriteTime() Stop recording the current rewrite and add it's time to the total tally, returning the cumulative time so far.

Methods inherited from class java.lang.Object

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

Constructor Detail

Profiler

public Profiler()

Method Detail

setCollector

public void setCollector(InternalProfileCollector collector)

Set the collector that is associated with this profiler.

getQueryBreakdown

public ProfileBreakdown getQueryBreakdown(org.apache.lucene.search.Query query)

Get the ProfileBreakdown for the given query, potentially creating it if it did not exist. This should only be used for queries that will be undergoing scoring. Do not use it to profile the rewriting phase

startRewriteTime

public void startRewriteTime()

Begin timing the rewrite phase of a request. All rewrites are accumulated together into a single metric

stopAndAddRewriteTime

public long stopAndAddRewriteTime()

Stop recording the current rewrite and add it's time to the total tally, returning the cumulative time so far.

Returns:

cumulative rewrite time

pollLastQuery

public void pollLastQuery()

Removes the last (e.g. most recent) query on the stack. This should only be called for scoring queries, not rewritten queries

getQueryTree

public List<org.elasticsearch.search.profile.ProfileResult> getQueryTree()

Returns:

a hierarchical representation of the profiled query tree

getRewriteTime

public long getRewriteTime()

Returns:

total time taken to rewrite all queries in this profile

getCollector

public CollectorResult getCollector()

Return the current root Collector for this search

buildShardResults

public static List<ProfileShardResult> buildShardResults(List<Profiler> profilers)

Helper method to convert Profiler into InternalProfileShardResults, which can be serialized to other nodes, emitted as JSON, etc.

Parameters:

profilers - A list of Profilers to convert into InternalProfileShardResults

Returns:

A list of corresponding InternalProfileShardResults