io.engineblock.extensions.csvmetrics

Class CSVMetricsPlugin

java.lang.Object

io.engineblock.extensions.csvmetrics.CSVMetricsPlugin

public class CSVMetricsPlugin
extends Object

Constructor Summary

Constructors

Constructor and Description
CSVMetricsPlugin(org.slf4j.Logger logger, com.codahale.metrics.MetricRegistry metricRegistry, ScriptContext scriptContext)

Method Summary

Modifier and Type	Method and Description
CSVMetrics	log(String filename) Create a new CSV metrics logger, without starting it.
CSVMetrics	start(String filename, long period, String timeUnit, String... pattern) Create a new CSV metrics logger, configure it with a regex filter pattern, and start it.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVMetricsPlugin

public CSVMetricsPlugin(org.slf4j.Logger logger,
                        com.codahale.metrics.MetricRegistry metricRegistry,
                        ScriptContext scriptContext)

Method Detail

log

public CSVMetrics log(String filename)

Create a new CSV metrics logger, without starting it.

Parameters:

filename - The file to write CSV metrics data to

Returns:

the CSVMetrics instance, for method chaining

start

public CSVMetrics start(String filename,
                        long period,
                        String timeUnit,
                        String... pattern)

Create a new CSV metrics logger, configure it with a regex filter pattern, and start it.

Parameters:

filename - the file to write CSV metrics data to

period - The time period to write at

timeUnit - A time unit for the time period, from NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES

pattern - Zero or more patterns to use for filtering metric names

Returns:

the CSVMetrics instance, for method chaining