Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation

Class WriteLoadMetrics

java.lang.Object

org.elasticsearch.cluster.routing.allocation.WriteLoadMetrics

public class WriteLoadMetrics
extends Object

Publishes metrics about write loads: the distribution of shard write loads per node, and the average write load (utilisation × thread-pool size) for each node's WRITE thread pool.

Shard write-load data comes from ClusterInfo.getShardWriteLoads(); node write-load data comes from ClusterInfo.getNodeUsageStatsForThreadPools(). Both are made available via the ClusterInfoService listener on the master node.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NODE_WRITE_LOAD_METRIC_NAME
static final Setting<Boolean>	SHARD_WRITE_LOAD_METRICS_ENABLED_SETTING
static final String	WRITE_LOAD_PRIORITISATION_THRESHOLD_METRIC_NAME
static final String	WRITE_LOAD_PRIORITISATION_THRESHOLD_PERCENTILE_RANK_METRIC_NAME
static final String	WRITE_LOAD_SUM_METRIC_NAME

Constructor Summary

Constructors

Constructor	Description
WriteLoadMetrics(MeterRegistry meterRegistry, ClusterService clusterService)
WriteLoadMetrics(MeterRegistry meterRegistry, ClusterService clusterService, int numberOfSignificantDigits, int... trackedPercentiles)

Method Summary

Modifier and Type	Method	Description
void	onNewInfo(ClusterInfo clusterInfo)
static String	shardWriteLoadDistributionMetricName(int percentile)	Get the metric name for the shard write load distribution metric for the specified percentile.

Methods inherited from class java.lang.Object

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

Field Details

WRITE_LOAD_PRIORITISATION_THRESHOLD_METRIC_NAME

public static final String WRITE_LOAD_PRIORITISATION_THRESHOLD_METRIC_NAME

See Also:

• Constant Field Values

WRITE_LOAD_PRIORITISATION_THRESHOLD_PERCENTILE_RANK_METRIC_NAME

public static final String WRITE_LOAD_PRIORITISATION_THRESHOLD_PERCENTILE_RANK_METRIC_NAME

See Also:

• Constant Field Values

WRITE_LOAD_SUM_METRIC_NAME

public static final String WRITE_LOAD_SUM_METRIC_NAME

See Also:

• Constant Field Values

NODE_WRITE_LOAD_METRIC_NAME

public static final String NODE_WRITE_LOAD_METRIC_NAME

See Also:

• Constant Field Values

SHARD_WRITE_LOAD_METRICS_ENABLED_SETTING

public static final Setting<Boolean> SHARD_WRITE_LOAD_METRICS_ENABLED_SETTING

Constructor Details

WriteLoadMetrics

public WriteLoadMetrics(MeterRegistry meterRegistry,
 ClusterService clusterService)

WriteLoadMetrics

public WriteLoadMetrics(MeterRegistry meterRegistry,
 ClusterService clusterService,
 int numberOfSignificantDigits,
 int... trackedPercentiles)

Method Details

onNewInfo

public void onNewInfo(ClusterInfo clusterInfo)

shardWriteLoadDistributionMetricName

public static String shardWriteLoadDistributionMetricName(int percentile)

Get the metric name for the shard write load distribution metric for the specified percentile.

Parameters:

percentile - The desired percentile

Returns:

The metric name