com.j256.simplemetrics.persister

Class TextFileMetricsPersister

java.lang.Object

com.j256.simplemetrics.persister.TextFileMetricsPersister

All Implemented Interfaces:

MetricValuesPersister

public class TextFileMetricsPersister
extends Object
implements MetricValuesPersister

Publishes metrics to the log file on disk.

Author:

graywatson

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SEPARATING_STRING Default string that separates a metric from its value.

Constructor Summary

Constructors

Constructor and Description
TextFileMetricsPersister()

Method Summary

Modifier and Type	Method and Description
void	cleanMetricFilesOlderThanMillis(long millisOld) Delete the old metrics files that have not been modified in a certain number of milliseconds.
long	getCleanupLogCount() Number of times we have cleaned up old logs.
long	getDumpLogCount() Number of times the logs have been dumped to disk.
String	getLastDumpTimeMillisString() Get the last time we have dumped the metrics to disk.
String	getLogFileNamePrefix() Get the log file name prefix that we are writing.
File	getOutputDirectory() Directory where the output files will be written.
boolean	isAppendSysTimeMillis() Are we appending the system time millis value to the name of the output file.
boolean	isShowDescription() Are we showing the description in the file on the previous line with a "# " prefix.
void	persist(Map<ControlledMetric<?,?>,Number> metricValues, long timeMillis) Dump a log file with all of the metrics into a log file.
void	setAppendSysTimeMillis(boolean appendSysTimeMillis) Set to true to append the system time millis value to the name of the output file.
void	setLogFileNamePrefix(String logFileNamePrefix) Set the log file name prefix.
void	setOutputDirectory(File outputDirectory) Set the directory where the output files will be written.
void	setSeparatingString(String separatingString) Set the separating string between the metric name and value.
void	setShowDescription(boolean showDescription) Set to true to show the description in the file on the previous line with a "# " prefix.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATING_STRING

public static final String DEFAULT_SEPARATING_STRING

Default string that separates a metric from its value. This is exposed so the parser can use it.

See Also:

Constant Field Values

Constructor Detail

TextFileMetricsPersister

public TextFileMetricsPersister()

Method Detail

persist

public void persist(Map<ControlledMetric<?,?>,Number> metricValues,
                    long timeMillis)
             throws IOException

Dump a log file with all of the metrics into a log file.

Specified by:

persist in interface MetricValuesPersister

Parameters:

metricValues - The collection of metric and metric-values we are persisting.

timeMillis - The time in millis when the metrics were collected.

Throws:

IOException - If there was an i/o error while persisting.

cleanMetricFilesOlderThanMillis

public void cleanMetricFilesOlderThanMillis(long millisOld)

Delete the old metrics files that have not been modified in a certain number of milliseconds.

getLogFileNamePrefix

public String getLogFileNamePrefix()

Get the log file name prefix that we are writing.

setLogFileNamePrefix

public void setLogFileNamePrefix(String logFileNamePrefix)

Set the log file name prefix.

isAppendSysTimeMillis

public boolean isAppendSysTimeMillis()

Are we appending the system time millis value to the name of the output file.

setAppendSysTimeMillis

public void setAppendSysTimeMillis(boolean appendSysTimeMillis)

Set to true to append the system time millis value to the name of the output file.

getOutputDirectory

public File getOutputDirectory()

Directory where the output files will be written.

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

Set the directory where the output files will be written.

setSeparatingString

public void setSeparatingString(String separatingString)

Set the separating string between the metric name and value. Default is "=".

isShowDescription

public boolean isShowDescription()

Are we showing the description in the file on the previous line with a "# " prefix.

setShowDescription

public void setShowDescription(boolean showDescription)

Set to true to show the description in the file on the previous line with a "# " prefix.

getDumpLogCount

public long getDumpLogCount()

Number of times the logs have been dumped to disk.

getCleanupLogCount

public long getCleanupLogCount()

Number of times we have cleaned up old logs.

getLastDumpTimeMillisString

public String getLastDumpTimeMillisString()

Get the last time we have dumped the metrics to disk.