Module org.elasticsearch.server

Package org.elasticsearch.monitor.metrics

Class IndicesMetrics

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.monitor.metrics.IndicesMetrics

All Implemented Interfaces:

Closeable, AutoCloseable, LifecycleComponent, Releasable

public class IndicesMetrics
extends AbstractLifecycleComponent

IndicesMetrics monitors index statistics on an Elasticsearch node and exposes them as metrics through the provided MeterRegistry. It tracks the current total number of indices, document count, and store size (in bytes) for each index mode.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USER_INDEX_TOTAL_METRIC_NAME

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
IndicesMetrics(MeterRegistry meterRegistry, IndicesService indicesService, TimeValue metricsInterval, ClusterService clusterService, SystemIndices systemIndices)

Method Summary

Modifier and Type	Method	Description
protected void	doClose()	Close this component.
protected void	doStart()	Start this component.
protected void	doStop()	Stop this component.

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, start, stop

Methods inherited from class java.lang.Object

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

Field Details

USER_INDEX_TOTAL_METRIC_NAME

public static final String USER_INDEX_TOTAL_METRIC_NAME

See Also:

• Constant Field Values

Constructor Details

IndicesMetrics

public IndicesMetrics(MeterRegistry meterRegistry,
 IndicesService indicesService,
 TimeValue metricsInterval,
 ClusterService clusterService,
 SystemIndices systemIndices)

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