Skip to content

Commit

Permalink
Update deprecation warning to mention that rollup will be removed as …
Browse files Browse the repository at this point in the history
…part of 10.0 release.
  • Loading branch information
martijnvg committed Jan 17, 2025
1 parent 8454045 commit 7e6fb49
Show file tree
Hide file tree
Showing 23 changed files with 122 additions and 122 deletions.
6 changes: 3 additions & 3 deletions docs/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,7 @@ buildRestTests.setups['sensor_rollup_job'] = '''
type: keyword
- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.put_job:
id: sensor
body: >
Expand Down Expand Up @@ -973,7 +973,7 @@ buildRestTests.setups['sensor_started_rollup_job'] = '''
- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.put_job:
id: sensor
body: >
Expand Down Expand Up @@ -1005,7 +1005,7 @@ buildRestTests.setups['sensor_started_rollup_job'] = '''
}
- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.start_job:
id: sensor
'''
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rollup/apis/delete-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ If we have a rollup job named `sensor`, it can be deleted with:
DELETE _rollup/job/sensor
--------------------------------------------------
// TEST[setup:sensor_rollup_job]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

Which will return the response:

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/rollup/apis/get-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ job can be retrieved with:
GET _rollup/job/sensor
--------------------------------------------------
// TEST[setup:sensor_rollup_job]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

The API yields the following response:

Expand Down Expand Up @@ -199,7 +199,7 @@ PUT _rollup/job/sensor2 <1>
GET _rollup/job/_all <2>
--------------------------------------------------
// TEST[setup:sensor_rollup_job]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]
<1> We create a second job with name `sensor2`
<2> Then request all jobs by using `_all` in the GetJobs API

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rollup/apis/put-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ PUT _rollup/job/sensor
}
--------------------------------------------------
// TEST[setup:sensor_index]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]
<1> This configuration enables date histograms to be used on the `timestamp`
field and `terms` aggregations to be used on the `node` field.
<2> This configuration defines metrics over two fields: `temperature` and
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/rollup/apis/rollup-caps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ PUT _rollup/job/sensor
}
--------------------------------------------------
// TEST[setup:sensor_index]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

We can then retrieve the rollup capabilities of that index pattern (`sensor-*`)
via the following command:
Expand All @@ -99,7 +99,7 @@ via the following command:
GET _rollup/data/sensor-*
--------------------------------------------------
// TEST[continued]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

Which will yield the following response:

Expand Down Expand Up @@ -172,7 +172,7 @@ We could also retrieve the same information with a request to `_all`:
GET _rollup/data/_all
--------------------------------------------------
// TEST[continued]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

But note that if we use the concrete index name (`sensor-1`), we'll retrieve no
rollup capabilities:
Expand All @@ -182,7 +182,7 @@ rollup capabilities:
GET _rollup/data/sensor-1
--------------------------------------------------
// TEST[continued]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

[source,console-result]
----
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/rollup/apis/rollup-index-caps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ PUT _rollup/job/sensor
}
--------------------------------------------------
// TEST[setup:sensor_index]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

If at a later date, we'd like to determine what jobs and capabilities were
stored in the `sensor_rollup` index, we can use the get rollup index API:
Expand All @@ -96,7 +96,7 @@ stored in the `sensor_rollup` index, we can use the get rollup index API:
GET /sensor_rollup/_rollup/data
--------------------------------------------------
// TEST[continued]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

Note how we are requesting the concrete rollup index name (`sensor_rollup`) as
the first part of the URL. This will yield the following response:
Expand Down Expand Up @@ -172,4 +172,4 @@ instead of explicit indices:
GET /*_rollup/_rollup/data
--------------------------------------------------
// TEST[continued]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]
8 changes: 4 additions & 4 deletions docs/reference/rollup/apis/rollup-search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ PUT _rollup/job/sensor
}
--------------------------------------------------
// TEST[setup:sensor_index]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

This rolls up the `sensor-*` pattern and stores the results in `sensor_rollup`.
To search this rolled up data, we need to use the `_rollup_search` endpoint.
Expand All @@ -134,7 +134,7 @@ GET /sensor_rollup/_rollup_search
--------------------------------------------------
// TEST[setup:sensor_prefab_data]
// TEST[s/_rollup_search/_rollup_search?filter_path=took,timed_out,terminated_early,_shards,hits,aggregations/]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

The query is targeting the `sensor_rollup` data, since this contains the rollup
data as configured in the job. A `max` aggregation has been used on the
Expand Down Expand Up @@ -190,7 +190,7 @@ GET sensor_rollup/_rollup_search
--------------------------------------------------
// TEST[continued]
// TEST[catch:/illegal_argument_exception/]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

[source,console-result]
----
Expand Down Expand Up @@ -234,7 +234,7 @@ GET sensor-1,sensor_rollup/_rollup_search <1>
--------------------------------------------------
// TEST[continued]
// TEST[s/_rollup_search/_rollup_search?filter_path=took,timed_out,terminated_early,_shards,hits,aggregations/]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]
<1> Note the URI now searches `sensor-1` and `sensor_rollup` at the same time

When the search is executed, the rollup search endpoint does two things:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rollup/apis/start-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If we have already created a {rollup-job} named `sensor`, it can be started with
POST _rollup/job/sensor/_start
--------------------------------------------------
// TEST[setup:sensor_rollup_job]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

Which will return the response:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rollup/apis/stop-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ the indexer has fully stopped. This is accomplished with the
POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s
--------------------------------------------------
// TEST[setup:sensor_started_rollup_job]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

The parameter blocks the API call from returning until either the job has moved
to `STOPPED` or the specified time has elapsed. If the specified time elapses
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rollup/migrating-to-downsampling.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ PUT _rollup/job/sensor
}
--------------------------------------------------
// TEST[setup:sensor_index]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

The equivalent <<tsds,time series data stream (TSDS)>> setup that uses downsampling via DSL:

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/rollup/rollup-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ PUT _rollup/job/sensor
}
--------------------------------------------------
// TEST[setup:sensor_index]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

We give the job the ID of "sensor" (in the url: `PUT _rollup/job/sensor`), and tell it to rollup the index pattern `"sensor-*"`.
This job will find and rollup any index that matches that pattern. Rollup summaries are then stored in the `"sensor_rollup"` index.
Expand Down Expand Up @@ -144,7 +144,7 @@ To start the job, execute this command:
POST _rollup/job/sensor/_start
--------------------------------------------------
// TEST[setup:sensor_rollup_job]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

[discrete]
==== Searching the rolled results
Expand All @@ -169,7 +169,7 @@ GET /sensor_rollup/_rollup_search
}
--------------------------------------------------
// TEST[setup:sensor_prefab_data]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

It's a simple aggregation that calculates the maximum of the `temperature` field. But you'll notice that it is being sent to the `sensor_rollup`
index instead of the raw `sensor-*` indices. And you'll also notice that it is using the `_rollup_search` endpoint. Otherwise the syntax
Expand Down Expand Up @@ -201,7 +201,7 @@ If you were to execute that query, you'd receive a result that looks like a norm
----
// TESTRESPONSE[s/"took" : 102/"took" : $body.$_path/]
// TESTRESPONSE[s/"_shards" : \.\.\. /"_shards" : $body.$_path/]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

The only notable difference is that Rollup search results have zero `hits`, because we aren't really searching the original, live data any
more. Otherwise it's identical syntax.
Expand Down Expand Up @@ -248,7 +248,7 @@ GET /sensor_rollup/_rollup_search
}
--------------------------------------------------
// TEST[setup:sensor_prefab_data]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

Which returns a corresponding response:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rollup/rollup-search-limitations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ GET sensor_rollup/_rollup_search
--------------------------------------------------
// TEST[setup:sensor_prefab_data]
// TEST[catch:/illegal_argument_exception/]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.]
// TEST[warning:The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.]

The response will tell you that the field and aggregation were not possible, because no rollup jobs were found which contained them:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ public abstract class ESRestTestCase extends ESTestCase {
private static final Logger SUITE_LOGGER = LogManager.getLogger(ESRestTestCase.class);

private static final String EXPECTED_ROLLUP_WARNING_MESSAGE =
"The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.";
"The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.";
public static final RequestOptions.Builder ROLLUP_REQUESTS_OPTIONS = RequestOptions.DEFAULT.toBuilder().setWarningsHandler(warnings -> {
// Either no warning, because of bwc integration test OR
// the expected warning, because on current version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
public class Rollup extends Plugin implements ActionPlugin, PersistentTaskPlugin {

public static final String DEPRECATION_MESSAGE =
"The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.";
"The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.";
public static final String DEPRECATION_KEY = "rollup_removal";

// Introduced in ES version 6.3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@
- do:
# Should not raise error
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.get_rollup_index_caps:
index: "logs*"
- do:
Expand Down Expand Up @@ -476,7 +476,7 @@

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.rollup_search:
index: "simple-data-stream1"
body:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ setup:
]
}
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."

---
"Test basic delete_job":
- requires:
test_runner_features: ["allowed_warnings"]
- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.get_jobs:
id: foo

Expand Down Expand Up @@ -101,14 +101,14 @@ setup:

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.delete_job:
id: foo
- is_true: acknowledged

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.get_jobs:
id: foo
- match:
Expand All @@ -119,7 +119,7 @@ setup:

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.get_jobs:
id: foo

Expand Down Expand Up @@ -161,14 +161,14 @@ setup:

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.delete_job:
id: foo
- is_true: acknowledged

- do:
allowed_warnings:
- The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information.
- The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information.
rollup.get_jobs:
id: foo
- match:
Expand All @@ -179,7 +179,7 @@ setup:

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.get_jobs:
id: foo

Expand Down Expand Up @@ -221,14 +221,14 @@ setup:

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
rollup.start_job:
id: foo
- is_true: started

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
catch: request
rollup.delete_job:
id: foo
Expand All @@ -241,7 +241,7 @@ setup:

- do:
allowed_warnings:
- "The rollup functionality will be removed in in Elasticsearch 9.0. See docs for more information."
- "The rollup functionality will be removed in in Elasticsearch 10.0. See docs for more information."
catch: /the task with id \[does_not_exist\] doesn't exist/
headers:
Authorization: "Basic eF9wYWNrX3Jlc3RfdXNlcjp4LXBhY2stdGVzdC1wYXNzd29yZA==" # run as x_pack_rest_user, i.e. the test setup superuser
Expand Down
Loading

0 comments on commit 7e6fb49

Please sign in to comment.