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:
  • Field Details

    • ESQL_PREFIX

      public static String ESQL_PREFIX
    • FEATURES_PREFIX

      public static String FEATURES_PREFIX
    • FUNCTIONS_PREFIX

      public static String FUNCTIONS_PREFIX
    • 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
    • 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
    • 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
    • FUNCTION_METRICS

      public static final String FUNCTION_METRICS
      Queries that use a command. If a query uses a command N times, this will still be incremented by one only
    • FEATURE_NAME

      public static final String FEATURE_NAME
      See Also:
    • SUCCESS

      public static final String SUCCESS
      the query was executed successfully or not
      See Also:
  • 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