org.springframework.boot.actuate.metrics.export

Class MetricCopyExporter

java.lang.Object

org.springframework.boot.actuate.metrics.export.AbstractMetricExporter

org.springframework.boot.actuate.metrics.export.MetricCopyExporter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Exporter

public class MetricCopyExporter
extends AbstractMetricExporter

Exporter that "exports" by copying metric data from a source MetricReader to a destination MetricWriter. Actually the output writer can be a GaugeWriter, in which case all metrics are simply output as their current value. If the output writer is also a CounterWriter then metrics whose names begin with "counter." are special: instead of writing them out as simple gauges the writer will increment the counter value. This involves the exporter storing the previous value of the counter so the delta can be computed. For best results with the counters, do not use the exporter concurrently in multiple threads (normally it will only be used periodically and sequentially, even if it is in a background thread, and this is fine).

Since:

1.3.0

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
MetricCopyExporter(MetricReader reader, GaugeWriter writer) Create a new MetricCopyExporter instance.
MetricCopyExporter(MetricReader reader, GaugeWriter writer, String prefix) Create a new MetricCopyExporter instance.

Method Summary

Modifier and Type	Method and Description
void	flush()
protected Iterable<Metric<?>>	next(String group) Get the next group of metrics to write.
void	setExcludes(String... excludes) Set the exclude patterns used to filter metrics.
void	setIncludes(String... includes) Set the include patterns used to filter metrics.
protected void	write(String group, Collection<Metric<?>> values) Write the values associated with a group.

Methods inherited from class org.springframework.boot.actuate.metrics.export.AbstractMetricExporter

close, export, groups, setEarliestTimestamp, setIgnoreTimestamps, setSendLatest

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricCopyExporter

public MetricCopyExporter(MetricReader reader,
                          GaugeWriter writer)

Create a new MetricCopyExporter instance.

Parameters:

reader - the metric reader

writer - the metric writer

MetricCopyExporter

public MetricCopyExporter(MetricReader reader,
                          GaugeWriter writer,
                          String prefix)

Create a new MetricCopyExporter instance.

Parameters:

reader - the metric reader

writer - the metric writer

prefix - the name prefix

Method Detail

setIncludes

public void setIncludes(String... includes)

Set the include patterns used to filter metrics.

Parameters:

includes - the include patterns

setExcludes

public void setExcludes(String... excludes)

Set the exclude patterns used to filter metrics.

Parameters:

excludes - the exclude patterns

next

protected Iterable<Metric<?>> next(String group)

Description copied from class: AbstractMetricExporter

Get the next group of metrics to write.

Specified by:

next in class AbstractMetricExporter

Parameters:

group - the group name to write

Returns:

some metrics to write

write

protected void write(String group,
                     Collection<Metric<?>> values)

Description copied from class: AbstractMetricExporter

Write the values associated with a group.

Specified by:

write in class AbstractMetricExporter

Parameters:

group - the group to write

values - the values to write

flush

public void flush()

Specified by:

flush in interface Flushable

Overrides:

flush in class AbstractMetricExporter