Module org.elasticsearch.compute
Package org.elasticsearch.compute.operator

Class MetricsInfoOperator

java.lang.Object
org.elasticsearch.compute.operator.MetricsInfoOperator
All Implemented Interfaces:
Closeable, AutoCloseable, Operator, org.elasticsearch.core.Releasable
public class MetricsInfoOperator extends Object implements Operator
Operator for the ESQL METRICS_INFO command.

Operates in two modes, mirroring the two-phase INITIAL/FINAL pattern used by aggregations:

  • INITIAL (data nodes) – created via MetricsInfoOperator.Factory. Expects deduplicated input (one row per _tsid) from an upstream DistinctByOperator, with blocks for _timeseries_metadata and _index. Groups metrics by (metricName, dataStreamName) so that different backing indices of the same data stream share one entry. Conflicting unit/metric_type/field_type values across backing indices become multi-valued. Dimension keys are assigned only to the metrics that actually appeared in each tsid's metadata. Produces one row per distinct metric signature within the local shards.
  • FINAL (coordinator) – created via MetricsInfoOperator.FinalFactory. Receives the 6-column output pages produced by INITIAL instances on each data node and merges rows that share the same MetricsInfoOperator.MetricSignature, unioning multi-valued fields (data_stream, dimension_fields, etc.).

Output columns (both modes)

  • metric_name – keyword (single-valued)
  • data_stream – keyword (multi-valued); data stream names that have this metric with the same signature (backing index names are resolved to their parent data stream)
  • unit – keyword (multi-valued when backing indices differ; may be null)
  • metric_type – keyword (multi-valued when definitions differ across data)
  • field_type – keyword (multi-valued when definitions differ across data)
  • dimension_fields – keyword (multi-valued); union of dimension keys for this row

  • Field Details

  • Method Details

    • needsInput

      public boolean needsInput()
      Description copied from interface: Operator
      whether the given operator can accept more input pages
      Specified by:
      needsInput in interface Operator

    • addInput

      public void addInput(Page page)
      Description copied from interface: Operator
      adds an input page to the operator. only called when needsInput() == true and isFinished() == false
      Specified by:
      addInput in interface Operator

    • finish

      public void finish()
      Description copied from interface: Operator
      notifies the operator that it won't receive any more input pages
      Specified by:
      finish in interface Operator

    • isFinished

      public boolean isFinished()
      Description copied from interface: Operator
      whether the operator has finished processing all input pages and made the corresponding output pages available
      Specified by:
      isFinished in interface Operator

    • canProduceMoreDataWithoutExtraInput

      public boolean canProduceMoreDataWithoutExtraInput()
      Description copied from interface: Operator
      Returns true if the operator can produce more output pages without requiring additional input pages. This is useful for operators that buffer data or have internal state that can produce multiple output pages.

      Operators that do not buffer data should return false - they cannot produce pages out of thin air. Examples of operators that may return true:

      • Operators with internal buffers (e.g., AsyncOperator with pending results)
      • Operators processing a single input page into multiple output pages
      • Aggregation operators that buffer partial results
      Specified by:
      canProduceMoreDataWithoutExtraInput in interface Operator
      Returns:
      true if the operator has buffered data that can produce output, false otherwise

    • getOutput

      public Page getOutput()
      Description copied from interface: Operator
      returns non-null if output page available. Only called when isFinished() == false
      Specified by:
      getOutput in interface Operator

    • close

      public void close()
      Description copied from interface: Operator
      notifies the operator that it won't be used anymore (i.e. none of the other methods called), and its resources can be cleaned up
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface Operator
      Specified by:
      close in interface org.elasticsearch.core.Releasable

    • status

      public Operator.Status status()
      Description copied from interface: Operator
      The status of the operator.
      Specified by:
      status in interface Operator

    • toString

      public String toString()
      Overrides:
      toString in class Object