Package org.elasticsearch.xpack.esql.action

Class EsqlQueryProfile

java.lang.Object

org.elasticsearch.xpack.esql.action.EsqlQueryProfile

All Implemented Interfaces:

Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

public class EsqlQueryProfile
extends Object
implements Writeable, org.elasticsearch.xcontent.ToXContentFragment

Tracks profiling for the planning phase

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANALYSIS
static final String	ENRICH_RESOLUTION
static final String	INDICES_RESOLUTION
static final String	INFERENCE_RESOLUTION
static final String	PARSING
static final String	PLANNING
static final String	PRE_ANALYSIS
static final String	QUERY
static final String	VIEW_RESOLUTION

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
EsqlQueryProfile()
EsqlQueryProfile(TimeSpan query, TimeSpan planning, TimeSpan parsing, TimeSpan viewResolution, TimeSpan preAnalysis, TimeSpan indicesResolution, TimeSpan enrichResolution, TimeSpan inferenceResolution, TimeSpan analysis, int fieldCapsCalls)

Method Summary

Modifier and Type	Method	Description
TimeSpanMarker	analysis()	Span for the plan analysis phase - this does not include plan optimizations, which come later and are part of each individual plan profiling
TimeSpanMarker	enrichResolutionMarker()
boolean	equals(Object o)
int	fieldCapsCalls()
int	hashCode()
void	incFieldCapsCalls()
TimeSpanMarker	indicesResolutionMarker()
TimeSpanMarker	inferenceResolutionMarker()
TimeSpanMarker	parsing()	Span for the parsing phase, that covers the ES|QL query parsing
TimeSpanMarker	planning()	Span for the ES|QL "planning" phase - when it is complete, query execution (in ComputeService) is about to start.
TimeSpanMarker	preAnalysis()	Span for the preanalysis phase
static EsqlQueryProfile	readFrom(StreamInput in)
EsqlQueryProfile	start()
EsqlQueryProfile	stop()
void	stopAllStartedMarkers()	Safely stops all markers that were started but not yet stopped.
Collection<TimeSpanMarker>	timeSpanMarkers()
String	toString()
TimeSpanMarker	total()
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
TimeSpanMarker	viewResolution()	Span for resolving views in the logical plan (between parsing and pre-analysis).
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

QUERY

public static final String QUERY

See Also:

• Constant Field Values

PLANNING

public static final String PLANNING

See Also:

• Constant Field Values

PARSING

public static final String PARSING

See Also:

• Constant Field Values

VIEW_RESOLUTION

public static final String VIEW_RESOLUTION

See Also:

• Constant Field Values

PRE_ANALYSIS

public static final String PRE_ANALYSIS

See Also:

• Constant Field Values

INDICES_RESOLUTION

public static final String INDICES_RESOLUTION

See Also:

• Constant Field Values

ENRICH_RESOLUTION

public static final String ENRICH_RESOLUTION

See Also:

• Constant Field Values

INFERENCE_RESOLUTION

public static final String INFERENCE_RESOLUTION

See Also:

• Constant Field Values

ANALYSIS

public static final String ANALYSIS

See Also:

• Constant Field Values

Constructor Details

EsqlQueryProfile

public EsqlQueryProfile()

EsqlQueryProfile

public EsqlQueryProfile(TimeSpan query,
 TimeSpan planning,
 TimeSpan parsing,
 TimeSpan viewResolution,
 TimeSpan preAnalysis,
 TimeSpan indicesResolution,
 TimeSpan enrichResolution,
 TimeSpan inferenceResolution,
 TimeSpan analysis,
 int fieldCapsCalls)

Method Details

readFrom

public static EsqlQueryProfile readFrom(StreamInput in)
                                 throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

start

public EsqlQueryProfile start()

stop

public EsqlQueryProfile stop()

total

public TimeSpanMarker total()

planning

public TimeSpanMarker planning()

Span for the ES|QL "planning" phase - when it is complete, query execution (in ComputeService) is about to start. Note this is currently only built for a single phase planning/execution model. When INLINE STATS moves towards GA we may need to revisit this model. Currently, it should never be called more than once.

parsing

public TimeSpanMarker parsing()

Span for the parsing phase, that covers the ES|QL query parsing

viewResolution

public TimeSpanMarker viewResolution()

Span for resolving views in the logical plan (between parsing and pre-analysis).

preAnalysis

public TimeSpanMarker preAnalysis()

Span for the preanalysis phase

indicesResolutionMarker

public TimeSpanMarker indicesResolutionMarker()

enrichResolutionMarker

public TimeSpanMarker enrichResolutionMarker()

inferenceResolutionMarker

public TimeSpanMarker inferenceResolutionMarker()

analysis

public TimeSpanMarker analysis()

Span for the plan analysis phase - this does not include plan optimizations, which come later and are part of each individual plan profiling

fieldCapsCalls

public int fieldCapsCalls()

incFieldCapsCalls

public void incFieldCapsCalls()

timeSpanMarkers

public Collection<TimeSpanMarker> timeSpanMarkers()

stopAllStartedMarkers

public void stopAllStartedMarkers()

Safely stops all markers that were started but not yet stopped. This is useful in error paths where we need to ensure all timing data is captured.

toXContent

public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                      throws IOException

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException