Package org.elasticsearch.script

Class TimeSeriesCounter

java.lang.Object

org.elasticsearch.script.TimeSeriesCounter

public class TimeSeriesCounter
extends Object

Provides a counter with a history of 5m/15m/24h. Callers increment the counter and query the current state of the TimeSeries. inc() increments the counter to indicate an event happens "now", with metadata about "now" from the given timeProvider. timeSeries() provides a snapshot of the counters at the current time, given by timeProvider. The snapshot includes the number of events in the last five minutes, the last fifteen minutes, the last twenty-four hours and an all-time count. Caveats: * If the timeProvider produces a time stamp value, t[j] that occurs _before_ an earlier invocation t[j] (where j is an invocation that *happens-before*, in the java memory model sense), the time stamp is treated as occurring at the latest time seen, t[latest], EXCEPT if t[latest] - t[j] is earlier than any time covered by the twenty-four counter. If that occurs, time goes backwards more than 24 hours (between 24:00 and 23:45 depending on the circumstance) the history is reset but total is retained. * All counters have a resolution: - 5m resolution is 15s - 15m resolution is 90s - 24h resolution is 15m The counter will drop events between one second and the resolution minus one second during a bucket rollover.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeSeriesCounter.Counter

Field Summary

Fields

Modifier and Type	Field	Description
protected LongAdder	adder
protected TimeSeriesCounter.Counter	fifteenMinutes
protected TimeSeriesCounter.Counter	fiveMinutes
static final int	HOUR
protected ReadWriteLock	lock
static final int	MINUTE
static final int	SECOND
protected final LongSupplier	timeProvider
protected TimeSeriesCounter.Counter	twentyFourHours

Constructor Summary

Constructors

Constructor	Description
TimeSeriesCounter(LongSupplier timeProvider)	Create a TimeSeriesCounter with the given timeProvider.

Method Summary

Modifier and Type	Method	Description
long	count()	The total number of events for all time covered by the counters.
void	inc()	Increment counters at timestamp t, any increment more than 24hours before the current time series resets all historical counters, but the total counter is still increments.
protected long	now()
TimeSeries	timeSeries()	Get the value of the counters for the last 5 minutes, last 15 minutes and the last 24 hours from t.

Methods inherited from class java.lang.Object

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

Field Details

SECOND

public static final int SECOND

See Also:

• Constant Field Values

MINUTE

public static final int MINUTE

See Also:

• Constant Field Values

HOUR

public static final int HOUR

See Also:

• Constant Field Values

adder

protected LongAdder adder

lock

protected ReadWriteLock lock

fiveMinutes

protected TimeSeriesCounter.Counter fiveMinutes

fifteenMinutes

protected TimeSeriesCounter.Counter fifteenMinutes

twentyFourHours

protected TimeSeriesCounter.Counter twentyFourHours

timeProvider

protected final LongSupplier timeProvider

Constructor Details

TimeSeriesCounter

public TimeSeriesCounter(LongSupplier timeProvider)

Create a TimeSeriesCounter with the given timeProvider. The timeProvider must return positive values, in milliseconds. In live code, this is expected to be System.currentTimeMillis() or a proxy such as ThreadPool.absoluteTimeInMillis().

Method Details

inc

public void inc()

Increment counters at timestamp t, any increment more than 24hours before the current time series resets all historical counters, but the total counter is still increments.

timeSeries

public TimeSeries timeSeries()

Get the value of the counters for the last 5 minutes, last 15 minutes and the last 24 hours from t. May include events up to resolution before those durations due to counter granularity.

now

protected long now()

count

public long count()

The total number of events for all time covered by the counters.