Package org.elasticsearch.xpack.esql.telemetry

Class PlanTelemetryManager

java.lang.Object

org.elasticsearch.xpack.esql.telemetry.PlanTelemetryManager

public class PlanTelemetryManager
extends Object

This class is responsible for publishing metrics related to ES|QL planning.

See Also:

• METERING

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FEATURE_METRICS	Queries that use a command.
static final String	FEATURE_METRICS_ALL	Number of times a command is used.
static final String	FEATURE_NAME
static final String	FUNCTION_METRICS	Queries that use a function.
static final String	FUNCTION_METRICS_ALL	Number of times a function is used.
static final String	LINKED_PROJECTS_HISTOGRAM	Histogram of linked projects per ES|QL query.
static final String	SETTING_METRICS	Queries that use a setting.
static final String	SETTING_METRICS_ALL	Number of times a setting is used.
static final String	SUCCESS	the query was executed successfully or not

Constructor Summary

Constructors

Constructor	Description
PlanTelemetryManager(MeterRegistry meterRegistry)

Method Summary

Modifier and Type	Method	Description
void	publish(PlanTelemetry metrics, boolean success)	Publishes the collected metrics to the meter registry

Methods inherited from class java.lang.Object

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

Field Details

FEATURE_METRICS_ALL

public static final String FEATURE_METRICS_ALL

Number of times a command is used. If the command is used N times in a single query, this counter will be incremented by N

See Also:

• Constant Field Values

FEATURE_METRICS

public static final String FEATURE_METRICS

Queries that use a command. If a query uses a command N times, this will still be incremented by one only

See Also:

• Constant Field Values

FUNCTION_METRICS_ALL

public static final String FUNCTION_METRICS_ALL

Number of times a function is used. If the function is used N times in a single query, this counter will be incremented by N

See Also:

• Constant Field Values

FUNCTION_METRICS

public static final String FUNCTION_METRICS

Queries that use a function. If a query uses a function N times, this will still be incremented by one only

See Also:

• Constant Field Values

SETTING_METRICS_ALL

public static final String SETTING_METRICS_ALL

Number of times a setting is used. If the setting is used N times in a single query, this counter will be incremented by N

See Also:

• Constant Field Values

SETTING_METRICS

public static final String SETTING_METRICS

Queries that use a setting. If a query uses a setting N times, this will still be incremented by one only

See Also:

• Constant Field Values

LINKED_PROJECTS_HISTOGRAM

public static final String LINKED_PROJECTS_HISTOGRAM

Histogram of linked projects per ES|QL query.

See Also:

• Constant Field Values

FEATURE_NAME

public static final String FEATURE_NAME

See Also:

• Constant Field Values

SUCCESS

public static final String SUCCESS

the query was executed successfully or not

See Also:

• Constant Field Values

Constructor Details

PlanTelemetryManager

public PlanTelemetryManager(MeterRegistry meterRegistry)

Method Details

publish

public void publish(PlanTelemetry metrics,
 boolean success)

Publishes the collected metrics to the meter registry