org.graylog2.indexer.rotation

Class TimeBasedRotationStrategy

java.lang.Object

org.graylog2.indexer.rotation.TimeBasedRotationStrategy

All Implemented Interfaces:

RotationStrategy

@Singleton
public class TimeBasedRotationStrategy
extends Object
implements RotationStrategy

Nested Class Summary

Nested classes/interfaces inherited from interface org.graylog2.plugin.indexer.rotation.RotationStrategy

RotationStrategy.Result

Constructor Summary

Constructors

Constructor and Description
TimeBasedRotationStrategy(ElasticsearchConfiguration configuration, Indices indices)
TimeBasedRotationStrategy(org.joda.time.Period rotationPeriod, Indices indices)

Method Summary

Methods

Modifier and Type	Method and Description
protected static org.joda.time.DateTime	determineRotationPeriodAnchor(org.joda.time.DateTime lastAnchor, org.joda.time.Period period) Determines the starting point ("anchor") for a period.
RotationStrategy.Result	shouldRotate(String index)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeBasedRotationStrategy

@Inject
public TimeBasedRotationStrategy(ElasticsearchConfiguration configuration,
                                Indices indices)

TimeBasedRotationStrategy

public TimeBasedRotationStrategy(org.joda.time.Period rotationPeriod,
                         Indices indices)

Method Detail

determineRotationPeriodAnchor

protected static org.joda.time.DateTime determineRotationPeriodAnchor(@Nullable
                                                   org.joda.time.DateTime lastAnchor,
                                                   org.joda.time.Period period)

Determines the starting point ("anchor") for a period. To produce repeatable rotation points in time, the period is "snapped" to a "grid" of time. For example, an hourly index rotation would be anchored to the last full hour, instead of happening at whatever minute the first rotation was started. This "snapping" is done accordingly with the other parts of a period. For highly irregular periods (those that do not have a small zero component)

Parameters:

period - the rotation period

Returns:

the anchor DateTime to calculate rotation periods from

shouldRotate

@Nonnull
public RotationStrategy.Result shouldRotate(String index)

Specified by:

shouldRotate in interface RotationStrategy