Package org.elasticsearch.xpack.esql.plan.physical

Class MetricsInfoExec

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.QueryPlan<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.physical.PhysicalPlan

org.elasticsearch.xpack.esql.plan.physical.UnaryExec

org.elasticsearch.xpack.esql.plan.physical.MetricsInfoExec

All Implemented Interfaces:

NamedWriteable, Writeable

public class MetricsInfoExec
extends UnaryExec

Physical plan node for METRICS_INFO command.

Operates in two modes, similar to AggregateExec:

• MetricsInfoExec.Mode.INITIAL — runs on data nodes. Extracts metric metadata from shards (_tsid, _timeseries_metadata, mappings) and produces one row per distinct metric signature within the local shards.
• MetricsInfoExec.Mode.FINAL — runs on the coordinator. Receives per-data-node results via the exchange and merges rows that share the same metric signature, unioning multi-valued fields (data_stream, dimension_fields, etc.).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MetricsInfoExec.Mode	Execution mode, mirroring the three-phase pattern used by aggregations.

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

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 NamedWriteableRegistry.Entry	ENTRY

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
MetricsInfoExec(Source source, PhysicalPlan child, List<Attribute> outputAttrs, List<Attribute> intermediateAttributes, MetricsInfoExec.Mode mode)

Method Summary

Modifier and Type	Method	Description
protected AttributeSet	computeReferences()	This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting.
boolean	equals(Object obj)
String	getWriteableName()
int	hashCode()
protected NodeInfo<MetricsInfoExec>	info()	Normally, you want to use one of the static create methods to implement this.
List<Attribute>	intermediateAttributes()
MetricsInfoExec.Mode	mode()
List<Attribute>	output()	The ordered list of attributes (i.e.
List<Attribute>	outputAttrs()
MetricsInfoExec	replaceChild(PhysicalPlan newChild)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.UnaryExec

child, inputSet, outputSet, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

computeExpressions, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUp

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, toString, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

MetricsInfoExec

public MetricsInfoExec(Source source,
 PhysicalPlan child,
 List<Attribute> outputAttrs,
 List<Attribute> intermediateAttributes,
 MetricsInfoExec.Mode mode)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

mode

public MetricsInfoExec.Mode mode()

outputAttrs

public List<Attribute> outputAttrs()

intermediateAttributes

public List<Attribute> intermediateAttributes()

info

protected NodeInfo<MetricsInfoExec> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<PhysicalPlan>

replaceChild

public MetricsInfoExec replaceChild(PhysicalPlan newChild)

Specified by:

replaceChild in class UnaryExec

output

public List<Attribute> output()

Description copied from class: QueryPlan

The ordered list of attributes (i.e. columns) this plan produces when executed. Must be called only on resolved plans, otherwise may throw an exception or return wrong results.

Overrides:

output in class UnaryExec

computeReferences

protected AttributeSet computeReferences()

Description copied from class: QueryPlan

This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting. This can be called on unresolved plans and therefore must not rely on calls to QueryPlan.output().

Overrides:

computeReferences in class QueryPlan<PhysicalPlan>

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryExec

equals

public boolean equals(Object obj)

Overrides:

equals in class UnaryExec