com.netflix.servo.monitor

Class DynamicTimer

java.lang.Object

com.netflix.servo.monitor.AbstractMonitor<java.lang.Long>

com.netflix.servo.monitor.DynamicTimer

All Implemented Interfaces:

CompositeMonitor<java.lang.Long>, Monitor<java.lang.Long>

public final class DynamicTimer
extends AbstractMonitor<java.lang.Long>
implements CompositeMonitor<java.lang.Long>

Utility class that dynamically creates BasicTimers based on an arbitrary (name, tagList), or MonitorConfig. Timers are automatically expired after 15 minutes of inactivity.

Field Summary

Fields inherited from class com.netflix.servo.monitor.AbstractMonitor

config

Method Summary

Modifier and Type	Method and Description
java.util.List<Monitor<?>>	getMonitors() Returns a list of sub-monitors for this composite.
java.lang.Long	getValue(int pollerIdx) Returns the current value for the monitor for the nth poller.
static void	record(MonitorConfig config, long duration) Record result to the dynamic timer indicated by the provided config with a TimeUnit of milliseconds.
static void	record(MonitorConfig config, long duration, java.util.concurrent.TimeUnit unit) Deprecated. Use record(MonitorConfig, java.util.concurrent.TimeUnit, long, java.util.concurrent.TimeUnit) instead. The new method allows you to be specific about the units used for reporting the timer and the units in which the duration is measured.
static void	record(MonitorConfig config, java.util.concurrent.TimeUnit reportUnit, long duration, java.util.concurrent.TimeUnit durationUnit) Record a duration to the dynamic timer indicated by the provided config/reportUnit.
static Stopwatch	start(MonitorConfig config) Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config.
static Stopwatch	start(MonitorConfig config, java.util.concurrent.TimeUnit unit) Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config.
static Stopwatch	start(java.lang.String name, java.lang.String... tags) Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given name, and sequence of (key, value) pairs.
static Stopwatch	start(java.lang.String name, TagList list) Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config.
static Stopwatch	start(java.lang.String name, TagList list, java.util.concurrent.TimeUnit unit) Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config.
java.lang.String	toString()

Methods inherited from class com.netflix.servo.monitor.AbstractMonitor

getConfig, getValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.servo.monitor.Monitor

getConfig, getValue

Method Detail

start

public static Stopwatch start(MonitorConfig config,
                              java.util.concurrent.TimeUnit unit)

Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config.

Parameters:

config - Config to identify a particular timer instance to update.

unit - The unit to use when reporting values to observers. For example if sent to a typical time series graphing system this would be the unit for the y-axis. It is generally recommended to use base units for reporting, so TimeUnit.SECONDS is the preferred value.

start

public static Stopwatch start(MonitorConfig config)

Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config. The timer will report the times in milliseconds to observers.

See Also:

start(MonitorConfig, TimeUnit)

record

public static void record(MonitorConfig config,
                          long duration)

Record result to the dynamic timer indicated by the provided config with a TimeUnit of milliseconds.

record

public static void record(MonitorConfig config,
                          long duration,
                          java.util.concurrent.TimeUnit unit)

Deprecated. Use record(MonitorConfig, java.util.concurrent.TimeUnit, long, java.util.concurrent.TimeUnit) instead. The new method allows you to be specific about the units used for reporting the timer and the units in which the duration is measured.

Record a duration to the dynamic timer indicated by the provided config. The units in which the timer is reported and the duration unit are the same.

record

public static void record(MonitorConfig config,
                          java.util.concurrent.TimeUnit reportUnit,
                          long duration,
                          java.util.concurrent.TimeUnit durationUnit)

Record a duration to the dynamic timer indicated by the provided config/reportUnit.

Parameters:

config - Config to identify a particular timer instance to update.

reportUnit - The unit to use when reporting values to observers. For example if sent to a typical time series graphing system this would be the unit for the y-axis. It is generally recommended to use base units for reporting, so TimeUnit.SECONDS is the preferred value.

duration - Measured duration to record.

durationUnit - Unit for the measured duration. This should typically be the unit used for timing source. For example if using System.nanoTime() the unit would be nanoseconds.

start

public static Stopwatch start(java.lang.String name,
                              java.lang.String... tags)

Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given name, and sequence of (key, value) pairs. The timer uses a TimeUnit of milliseconds.

start

public static Stopwatch start(java.lang.String name,
                              TagList list)

Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config. The timer uses a TimeUnit of milliseconds.

start

public static Stopwatch start(java.lang.String name,
                              TagList list,
                              java.util.concurrent.TimeUnit unit)

Returns a stopwatch that has been started and will automatically record its result to the dynamic timer specified by the given config. The timer uses a TimeUnit of milliseconds.

getMonitors

public java.util.List<Monitor<?>> getMonitors()

Returns a list of sub-monitors for this composite.

Specified by:

getMonitors in interface CompositeMonitor<java.lang.Long>

getValue

public java.lang.Long getValue(int pollerIdx)

Returns the current value for the monitor for the nth poller.

Specified by:

getValue in interface Monitor<java.lang.Long>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object