Module org.elasticsearch.server

Package org.elasticsearch.action.downsample

Class DownsampleConfig

java.lang.Object

org.elasticsearch.action.downsample.DownsampleConfig

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject

public class DownsampleConfig
extends Object
implements NamedWriteable, ToXContentObject

This class holds the configuration details of a DownsampleAction that downsamples time series (TSDB) indices. We have made great effort to simplify the rollup configuration and currently only requires a fixed time interval and optionally the sampling method. So, it has the following format: { "fixed_interval": "1d", "sampling_method": "aggregate" } fixed_interval is one or multiples of SI units and has no calendar-awareness (e.g. doesn't account for leap corrections, does not have variable length months, etc). Calendar-aware interval is not currently supported. Also, the rollup configuration uses the UTC time zone by default and the "@timestamp" field as the index field that stores the timestamp of the time series index. Finally, we have left methods such as getTimestampField(), getTimeZone() and getIntervalType() for future extensions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DownsampleConfig.SamplingMethod

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final TransportVersion	ADD_LAST_VALUE_DOWNSAMPLE_API
static final String	DEFAULT_TIMEZONE
static final String	FIXED_INTERVAL
static final String	SAMPLING_METHOD
static final String	TIME_ZONE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DownsampleConfig(StreamInput in)
DownsampleConfig(DateHistogramInterval fixedInterval, DownsampleConfig.SamplingMethod samplingMethod)	Create a new DownsampleConfig using the given configuration parameters.

Method Summary

Modifier and Type	Method	Description
Rounding.Prepared	createRounding()	Create the rounding for this date histogram
static Rounding.Prepared	createRounding(String expr, String timeZone)
boolean	equals(Object other)
static DownsampleConfig	fromXContent(XContentParser parser)
static String	generateDownsampleIndexName(String prefix, IndexMetadata sourceIndexMetadata, DateHistogramInterval fixedInterval)	Generates a downsample index name in the format prefix-fixedInterval-baseIndexName Note that this looks for the base index name of the provided index metadata via the IndexMetadata.INDEX_DOWNSAMPLE_ORIGIN_NAME_KEY setting.
DateHistogramInterval	getFixedInterval()	Get the fixed_interval value
DateHistogramInterval	getInterval()	Get the interval value
String	getIntervalType()	Get the interval type.
DownsampleConfig.SamplingMethod	getSamplingMethod()
DownsampleConfig.SamplingMethod	getSamplingMethodOrDefault()
String	getTimestampField()	Get the timestamp field to be used for rolling up data.
String	getTimeZone()	Get the timezone to apply
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentFragment(XContentBuilder builder)
static void	validateSourceAndTargetIntervals(DateHistogramInterval sourceFxedInterval, DateHistogramInterval targetFixedInterval)	This method validates the target downsampling configuration can be applied on an index that has been already downsampled from the source configuration.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

ADD_LAST_VALUE_DOWNSAMPLE_API

public static final TransportVersion ADD_LAST_VALUE_DOWNSAMPLE_API

FIXED_INTERVAL

public static final String FIXED_INTERVAL

See Also:

• Constant Field Values

SAMPLING_METHOD

public static final String SAMPLING_METHOD

See Also:

• Constant Field Values

TIME_ZONE

public static final String TIME_ZONE

See Also:

• Constant Field Values

DEFAULT_TIMEZONE

public static final String DEFAULT_TIMEZONE

Constructor Details

DownsampleConfig

public DownsampleConfig(DateHistogramInterval fixedInterval,
 @Nullable
 DownsampleConfig.SamplingMethod samplingMethod)

Create a new DownsampleConfig using the given configuration parameters.

Parameters:

fixedInterval - the fixed interval to use for computing the date histogram for the rolled up documents (required).

samplingMethod - the method used to downsample metrics, when null it default to DownsampleConfig.SamplingMethod.AGGREGATE.

DownsampleConfig

public DownsampleConfig(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

validateSourceAndTargetIntervals

public static void validateSourceAndTargetIntervals(DateHistogramInterval sourceFxedInterval,
 DateHistogramInterval targetFixedInterval)

This method validates the target downsampling configuration can be applied on an index that has been already downsampled from the source configuration. The requirements are: - The target interval needs to be greater than source interval - The target interval needs to be a multiple of the source interval throws an IllegalArgumentException to signal that the target interval is not acceptable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getTimestampField

public String getTimestampField()

Get the timestamp field to be used for rolling up data. Currently, only the "@timestamp" value is supported.

getIntervalType

public String getIntervalType()

Get the interval type. Currently, only fixed_interval is supported

getInterval

public DateHistogramInterval getInterval()

Get the interval value

getFixedInterval

public DateHistogramInterval getFixedInterval()

Get the fixed_interval value

getTimeZone

public String getTimeZone()

Get the timezone to apply

createRounding

public Rounding.Prepared createRounding()

Create the rounding for this date histogram

getSamplingMethod

@Nullable
public DownsampleConfig.SamplingMethod getSamplingMethod()

Returns:

the user configured sampling method

getSamplingMethodOrDefault

public DownsampleConfig.SamplingMethod getSamplingMethodOrDefault()

Returns:

the sampling method that will be used based on this configuration.

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContentFragment

public XContentBuilder toXContentFragment(XContentBuilder builder)
                                   throws IOException

Throws:

IOException

fromXContent

public static DownsampleConfig fromXContent(XContentParser parser)
                                     throws IOException

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createRounding

public static Rounding.Prepared createRounding(String expr,
 String timeZone)

generateDownsampleIndexName

public static String generateDownsampleIndexName(String prefix,
 IndexMetadata sourceIndexMetadata,
 DateHistogramInterval fixedInterval)

Generates a downsample index name in the format prefix-fixedInterval-baseIndexName Note that this looks for the base index name of the provided index metadata via the IndexMetadata.INDEX_DOWNSAMPLE_ORIGIN_NAME_KEY setting. This means that in case the provided index was already downsampled, we'll use the original source index (of the current provided downsample index) as the base index name.