org.elasticsearch.search.profile

Class ProfileBreakdown

java.lang.Object

org.elasticsearch.search.profile.ProfileBreakdown

public final class ProfileBreakdown
extends Object

A record of timings for the various operations that may happen during query execution. A node's time may be composed of several internal attributes (rewriting, weighting, scoring, etc).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProfileBreakdown.TimingType Enumeration of all supported timing types.

Constructor Summary

Constructors

Constructor and Description
ProfileBreakdown() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	merge(ProfileBreakdown other) Add other's timings into this breakdown
void	startTime(ProfileBreakdown.TimingType timing) Begin timing a query for a specific Timing context
long	stopAndRecordTime() Halt the timing process and save the elapsed time.
Map<String,Long>	toTimingMap() Convert this record to a map from ProfileBreakdown.TimingType to times.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileBreakdown

public ProfileBreakdown()

Sole constructor.

Method Detail

startTime

public void startTime(ProfileBreakdown.TimingType timing)

Begin timing a query for a specific Timing context

Parameters:

timing - The timing context being profiled

stopAndRecordTime

public long stopAndRecordTime()

Halt the timing process and save the elapsed time. startTime() must be called for a particular context prior to calling stopAndRecordTime(), otherwise the elapsed time will be negative and nonsensical

Returns:

The elapsed time

toTimingMap

public Map<String,Long> toTimingMap()

Convert this record to a map from ProfileBreakdown.TimingType to times.

merge

public void merge(ProfileBreakdown other)

Add other's timings into this breakdown

Parameters:

other - Another Breakdown to merge with this one