Package org.elasticsearch.xpack.esql.telemetry

Class Metrics

java.lang.Object

org.elasticsearch.xpack.esql.telemetry.Metrics

public class Metrics
extends Object

Class encapsulating the metrics collected for ESQL

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	FEATURES_PREFIX
protected static final String	FUNC_PREFIX
protected static final String	QUERIES_PREFIX
protected static final String	SETTINGS_PREFIX
protected static final String	TOOK_PREFIX

Constructor Summary

Constructors

Constructor	Description
Metrics(EsqlFunctionRegistry functionRegistry, boolean isServerless)	Creates a Metrics instance for production use.
Metrics(EsqlFunctionRegistry functionRegistry, boolean isSnapshot, boolean isServerless)	Creates a Metrics instance with explicit environment flags.

Method Summary

Modifier and Type	Method	Description
void	failed(QueryMetric metric)	Increments the "failed" counter for a metric
void	inc(FeatureMetric metric)
void	incFunctionMetric(Class<?> functionType)
void	incSetting(String settingName)
void	recordTook(long tookMillis)
Counters	stats()
void	total(QueryMetric metric)	Increments the "total" counter for a metric This method should be called only once per query.

Methods inherited from class java.lang.Object

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

Field Details

QUERIES_PREFIX

protected static final String QUERIES_PREFIX

See Also:

• Constant Field Values

FEATURES_PREFIX

protected static final String FEATURES_PREFIX

See Also:

• Constant Field Values

SETTINGS_PREFIX

protected static final String SETTINGS_PREFIX

See Also:

• Constant Field Values

FUNC_PREFIX

protected static final String FUNC_PREFIX

See Also:

• Constant Field Values

TOOK_PREFIX

protected static final String TOOK_PREFIX

See Also:

• Constant Field Values

Constructor Details

Metrics

public Metrics(EsqlFunctionRegistry functionRegistry,
 boolean isServerless)

Creates a Metrics instance for production use. Settings metrics are filtered based on the current build type (snapshot vs release) and deployment mode (serverless vs stateful).

Metrics

public Metrics(EsqlFunctionRegistry functionRegistry,
 boolean isSnapshot,
 boolean isServerless)

Creates a Metrics instance with explicit environment flags. This constructor is primarily for testing purposes.

Parameters:

functionRegistry - the function registry

isSnapshot - whether this is a snapshot build

isServerless - whether cross-project search is enabled (serverless mode)

Method Details

total

public void total(QueryMetric metric)

Increments the "total" counter for a metric This method should be called only once per query.

failed

public void failed(QueryMetric metric)

Increments the "failed" counter for a metric

inc

public void inc(FeatureMetric metric)

incSetting

public void incSetting(String settingName)

incFunctionMetric

public void incFunctionMetric(Class<?> functionType)

recordTook

public void recordTook(long tookMillis)

stats

public Counters stats()