Class IntervalMetricReader

java.lang.Object

io.opencensus.exporter.metrics.util.IntervalMetricReader

public final class IntervalMetricReader
extends Object

Wrapper of the MetricReader which automatically reads and exports the metrics every export interval.

Since:

0.19

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IntervalMetricReader.Options	Options for IntervalMetricReader.
private static final class	IntervalMetricReader.Worker

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final Duration	DEFAULT_INTERVAL
private final IntervalMetricReader.Worker	worker
private final Thread	workerThread
private static final Duration	ZERO

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IntervalMetricReader(IntervalMetricReader.Worker worker)

Method Summary

Modifier and Type	Method	Description
static IntervalMetricReader	create(MetricExporter metricExporter, MetricReader metricReader, IntervalMetricReader.Options options)	Creates a new IntervalMetricReader.
void	readAndExportNow()	Reads and exports data immediately.
void	stop()	Stops the worker thread by calling Thread.interrupt().

Methods inherited from class Object

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

Field Details

DEFAULT_INTERVAL

static final Duration DEFAULT_INTERVAL

ZERO

private static final Duration ZERO

workerThread

private final Thread workerThread

worker

private final IntervalMetricReader.Worker worker

Constructor Details

IntervalMetricReader

private IntervalMetricReader(IntervalMetricReader.Worker worker)

Method Details

create

public static IntervalMetricReader create(MetricExporter metricExporter,
 MetricReader metricReader,
 IntervalMetricReader.Options options)

Creates a new IntervalMetricReader.

Parameters:

metricExporter - the MetricExporter to be called after.

metricReader - the MetricReader to be used to read metrics.

options - the IntervalMetricReader.Options for the new IntervalMetricReader.

Returns:

a new IntervalMetricReader.

Since:

0.19

readAndExportNow

public void readAndExportNow()

Reads and exports data immediately.

Since:

0.19

stop

public void stop()

Stops the worker thread by calling Thread.interrupt().

Since:

0.19