Skip to content

[WIP] Add downsampling method to the data stream lifecycle #5594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

[WIP] Add downsampling method to the data stream lifecycle #5594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e4ed38
Fix data stream lifecycle type, to correctly handle downsampling.
gmarouli Oct 31, 2025
8fa3d9f
Add sampling method to data stream lifecycle
gmarouli Oct 31, 2025
de05f62
Merge branch 'main' into downsampling/add-sampling-method-in-dlm
pquentin Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 24 additions & 17 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

64 changes: 33 additions & 31 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 3 additions & 5 deletions output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 9 additions & 3 deletions specification/indices/_types/DataStreamLifecycle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
import { ByteSize } from '@_types/common'
import { long } from '@_types/Numeric'
import { Duration } from '@_types/Time'
import { DataStreamLifecycleDownsampling } from '@indices/_types/DataStreamLifecycleDownsampling'
import { SamplingMethod } from '@indices/_types/Downsample'
import { DownsamplingRound } from '@indices/_types/DownsamplingRound'

/**
* Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.
Expand All @@ -33,9 +34,14 @@ export class DataStreamLifecycle {
*/
data_retention?: Duration
/**
* The downsampling configuration to execute for the managed backing index after rollover.
* The list of downsampling rounds to execute as part of this downsampling configuration
*/
downsampling?: DataStreamLifecycleDownsampling
downsampling?: DownsamplingRound[]
/**
* The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires
* `downsampling` to be defined. Defaults to `aggregate`.
*/
downsampling_method?: SamplingMethod
/**
* If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
* that's disabled (enabled: `false`) will have no effect on the data stream.
Expand Down
27 changes: 0 additions & 27 deletions specification/indices/_types/DataStreamLifecycleDownsampling.ts
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion specification/indices/_types/Downsample.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export class DownsampleConfig {
sampling_method?: SamplingMethod
}

enum SamplingMethod {
export enum SamplingMethod {
aggregate,
last_value
}
8 changes: 7 additions & 1 deletion specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import { RequestBase } from '@_types/Base'
import { DataStreamNames, ExpandWildcards } from '@_types/common'
import { Duration } from '@_types/Time'
import { SamplingMethod } from '@indices/_types/Downsample'
import { DownsamplingRound } from '@indices/_types/DownsamplingRound'

/**
Expand Down Expand Up @@ -70,7 +71,7 @@ export interface Request extends RequestBase {
}
/*
* This is DataStreamLifecycle from @indices/_types/DataStreamLifecycle.ts,
* but kept as a properties body to avoid a breaking change
* but kept as separate properties to avoid a breaking change
*/
body: {
/**
Expand All @@ -83,6 +84,11 @@ export interface Request extends RequestBase {
* The downsampling configuration to execute for the managed backing index after rollover.
*/
downsampling?: DownsamplingRound[]
/**
* The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires
* `downsampling` to be defined. Defaults to `aggregate`.
*/
downsampling_method?: SamplingMethod
/**
* If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
* that's disabled (enabled: `false`) will have no effect on the data stream.
Expand Down