com.j256.simplemetrics.persister

Class MetricsPersisterJob

java.lang.Object

com.j256.simplemetrics.persister.MetricsPersisterJob

All Implemented Interfaces:

Runnable

public class MetricsPersisterJob
extends Object
implements Runnable

Metrics persister thread that can be used to call MetricsManager.persistValuesOnly() at a specific frequency. This is used if you don't have another mechanism to call the persisting on your own. If you are using the no-arg constructor (like with Spring) you will need to make sure that initialize() is called.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
MetricsPersisterJob()
MetricsPersisterJob(MetricsManager metricsManager, long delayTimeMillis, long periodTimeMillis, boolean daemonThread) Create the MetricsPersisterThread and calls initialize().

Method Summary

Modifier and Type	Method and Description
void	destroy() Call when you want to shutdown the publisher thread.
void	initialize() Should be called if the no-arg construct is being used and after the file metrics have been set.
void	join() Call when you want to join with the the publisher thread.
void	run() Run by the thread to persist the metrics.
void	setDaemonThread(boolean daemonThread) Whether or not the thread is a daemon thread.
void	setDelayTimeMillis(long delayTimeMillis) Number of millis to sleep when the thread starts before we start persisting.
void	setMetricsManager(MetricsManager metricsManager)
void	setPeriodTimeMillis(long periodTimeMillis) Number of millis to sleep between each persisting call.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsPersisterJob

public MetricsPersisterJob()

MetricsPersisterJob

public MetricsPersisterJob(MetricsManager metricsManager,
                           long delayTimeMillis,
                           long periodTimeMillis,
                           boolean daemonThread)

Create the MetricsPersisterThread and calls initialize().

Method Detail

initialize

public void initialize()

Should be called if the no-arg construct is being used and after the file metrics have been set. Maybe by Springs init mechanism?

destroy

public void destroy()

Call when you want to shutdown the publisher thread.

join

public void join()

Call when you want to join with the the publisher thread.

run

public void run()

Run by the thread to persist the metrics.

Specified by:

run in interface Runnable

setMetricsManager

public void setMetricsManager(MetricsManager metricsManager)

setDelayTimeMillis

public void setDelayTimeMillis(long delayTimeMillis)

Number of millis to sleep when the thread starts before we start persisting. By default this is the same as the period-time-millis.

setPeriodTimeMillis

public void setPeriodTimeMillis(long periodTimeMillis)

Number of millis to sleep between each persisting call.

setDaemonThread

public void setDaemonThread(boolean daemonThread)

Whether or not the thread is a daemon thread. If true then the JVM will quit even if this thread is still running.