Module org.elasticsearch.server
Package org.elasticsearch.monitor.metrics

Class NodeMetrics

java.lang.Object
org.elasticsearch.common.component.AbstractLifecycleComponent
org.elasticsearch.monitor.metrics.NodeMetrics
All Implemented Interfaces:
Closeable, AutoCloseable, LifecycleComponent, Releasable
public class NodeMetrics extends AbstractLifecycleComponent
NodeMetrics monitors various statistics of an Elasticsearch node and exposes them as metrics through the provided MeterRegistry. It includes counters for indices operations, memory usage, transport statistics, and more. The metrics are periodically updated based on a schedule.

  • Constructor Details

    • NodeMetrics

      public NodeMetrics(MeterRegistry meterRegistry, NodeService nodeService, TimeValue metricsInterval)
      Constructs a new NodeMetrics instance.
      Parameters:
      meterRegistry - The MeterRegistry used to register metrics.
      nodeService - The NodeService for interacting with the Elasticsearch node and extracting statistics.
      metricsInterval - The interval at which the agent sends metrics to the APM Server

  • Method Details

    • doStart

      protected void doStart()
      Description copied from class: AbstractLifecycleComponent
      Start this component. Typically that means doing things like launching background processes and registering listeners on other components. Other components have been initialized by this point, but may not yet be started.

      If this method throws an exception then the startup process will fail, but this component will not be stopped before it is closed.

      This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, although it may not be called at all if the startup process encountered some kind of fatal error, such as the failure of some other component to initialize or start.

      Specified by:
      doStart in class AbstractLifecycleComponent

    • doStop

      protected void doStop()
      Description copied from class: AbstractLifecycleComponent
      Stop this component. Typically that means doing the reverse of whatever AbstractLifecycleComponent.doStart() does.

      This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after calling AbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.

      Specified by:
      doStop in class AbstractLifecycleComponent

    • doClose

      protected void doClose() throws IOException
      Description copied from class: AbstractLifecycleComponent
      Close this component. Typically that means doing the reverse of whatever happened during initialization, such as releasing resources acquired there.

      This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is called once in the lifetime of a component. If the component was started then it will be stopped before it is closed, and once it is closed it will not be started or stopped.

      Specified by:
      doClose in class AbstractLifecycleComponent
      Throws:
      IOException