Package com.codingchili.core.metrics

Class MetricCollector

java.lang.Object

com.codingchili.core.metrics.MetricCollector

public class MetricCollector
extends Object

Implementation of metric collection backed by micrometer.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROCESS_NAME

Constructor Summary

Constructors

Constructor	Description
MetricCollector(CoreContext core, MetricSettings settings, String registryName)

Method Summary

Modifier and Type	Method	Description
io.vertx.core.json.JsonObject	metadata()
void	onMetricsSnapshot(io.vertx.core.json.JsonObject metrics)
com.codahale.metrics.MetricRegistry	registry()
MetricSettings	settings()
io.vertx.core.Future<io.vertx.core.json.JsonObject>	snapshot()	Produces a report of the current metric snapshot.
MetricCollector	type(String type)

Methods inherited from class java.lang.Object

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

Field Details

PROCESS_NAME

public static final String PROCESS_NAME

See Also:

Constant Field Values

Constructor Details

MetricCollector

public MetricCollector(CoreContext core,
 MetricSettings settings,
 String registryName)

Parameters:

core - the context to collect metrics from.

settings - settings for the metric collector.

registryName - the name of the metric registry to use.

Method Details

onMetricsSnapshot

public void onMetricsSnapshot(io.vertx.core.json.JsonObject metrics)

Parameters:

metrics - log a metrics snapshot.

metadata

public io.vertx.core.json.JsonObject metadata()

Returns:

metadata for the metric collector, this data will be included in all metric reports.

type

public MetricCollector type(String type)

Parameters:

type - sets the given type as metadata.

Returns:

fluent.

settings

public MetricSettings settings()

Returns:

the settings for this collector.

registry

public com.codahale.metrics.MetricRegistry registry()

Returns:

the metrics registry used to collect metrics. Can be used to add custom generators.

snapshot

public io.vertx.core.Future<io.vertx.core.json.JsonObject> snapshot()

Produces a report of the current metric snapshot.

Returns:

a generated json report with the target fields.