net.opentsdb.core

Class RateOptions

java.lang.Object

net.opentsdb.core.RateOptions

public class RateOptions
extends Object

Provides additional options that will be used when calculating rates. These options are useful when working with metrics that are raw counter values, where a counter is defined by a value that always increases until it hits a maximum value and then it "rolls over" to start back at 0.

These options will only be utilized if the query is for a rate calculation and if the "counter" options is set to true.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_RESET_VALUE

Constructor Summary

Constructors

Constructor and Description
RateOptions() Ctor
RateOptions(boolean counter, long counter_max, long reset_value) Ctor

Method Summary

Methods

Modifier and Type	Method and Description
long	getCounterMax()
long	getResetValue()
boolean	isCounter()
void	setCounterMax(long counter_max)
void	setIsCounter(boolean counter)
void	setResetValue(long reset_value)
String	toString() Generates a String version of the rate option instance in a format that can be utilized in a query.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESET_VALUE

public static final long DEFAULT_RESET_VALUE

See Also:

Constant Field Values

Constructor Detail

RateOptions

public RateOptions()

Ctor

RateOptions

public RateOptions(boolean counter,
           long counter_max,
           long reset_value)

Ctor

Parameters:

counter - If true, indicates that the rate calculation should assume that the underlying data is from a counter

counter_max - Specifies the maximum value for the counter before it will roll over and restart at 0

reset_value - Specifies the largest rate change that is considered acceptable, if a rate change is seen larger than this value then the counter is assumed to have been reset

Method Detail

isCounter

public boolean isCounter()

Returns:

Whether or not the counter flag is set

getCounterMax

public long getCounterMax()

Returns:

The counter max value

getResetValue

public long getResetValue()

Returns:

The optional reset value for anomaly suppression

setIsCounter

public void setIsCounter(boolean counter)

Parameters:

counter - Whether or not the time series should be considered counters

setCounterMax

public void setCounterMax(long counter_max)

Parameters:

counter_max - The value at which counters roll over

setResetValue

public void setResetValue(long reset_value)

Parameters:

reset_value - A difference that may be an anomaly so suppress it

toString

public String toString()

Generates a String version of the rate option instance in a format that can be utilized in a query.

Overrides:

toString in class Object

Returns:

string version of the rate option instance.