Skip to content

Commit 8d07de7

Browse files
kibanamachineCopilotElenaStoeva
authored
[8.19] [Rollups] Add documentation for testing deprecated UI (elastic#240331) (elastic#240838)
# Backport This will backport the following commits from `main` to `8.19`: - [[Rollups] Add documentation for testing deprecated UI (elastic#240331)](elastic#240331) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Copilot","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-10-27T14:47:48Z","message":"[Rollups] Add documentation for testing deprecated UI (elastic#240331)\n\nCloses https://github.com/elastic/kibana/issues/230171\n\n## Summary\n\nThis PR adds comprehensive testing documentation to the Rollups plugin\nREADME to address the challenges of testing the Rollup UI after the\nfeature was deprecated.\n\n---------\n\nCo-authored-by: copilot-swe-agent[bot] <[email protected]>\nCo-authored-by: ElenaStoeva <[email protected]>\nCo-authored-by: Elena Stoeva <[email protected]>","sha":"f2e9706a1d3c8e7cb6c7575101ca53bda2924804","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Kibana Management","release_note:skip","Feature:Rollups","💝community","backport:all-open","v9.3.0"],"title":"[Rollups] Add documentation for testing deprecated UI","number":240331,"url":"https://github.com/elastic/kibana/pull/240331","mergeCommit":{"message":"[Rollups] Add documentation for testing deprecated UI (elastic#240331)\n\nCloses https://github.com/elastic/kibana/issues/230171\n\n## Summary\n\nThis PR adds comprehensive testing documentation to the Rollups plugin\nREADME to address the challenges of testing the Rollup UI after the\nfeature was deprecated.\n\n---------\n\nCo-authored-by: copilot-swe-agent[bot] <[email protected]>\nCo-authored-by: ElenaStoeva <[email protected]>\nCo-authored-by: Elena Stoeva <[email protected]>","sha":"f2e9706a1d3c8e7cb6c7575101ca53bda2924804"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/240331","number":240331,"mergeCommit":{"message":"[Rollups] Add documentation for testing deprecated UI (elastic#240331)\n\nCloses https://github.com/elastic/kibana/issues/230171\n\n## Summary\n\nThis PR adds comprehensive testing documentation to the Rollups plugin\nREADME to address the challenges of testing the Rollup UI after the\nfeature was deprecated.\n\n---------\n\nCo-authored-by: copilot-swe-agent[bot] <[email protected]>\nCo-authored-by: ElenaStoeva <[email protected]>\nCo-authored-by: Elena Stoeva <[email protected]>","sha":"f2e9706a1d3c8e7cb6c7575101ca53bda2924804"}}]}] BACKPORT--> Co-authored-by: Copilot <[email protected]> Co-authored-by: ElenaStoeva <[email protected]> Co-authored-by: Elena Stoeva <[email protected]>
1 parent 74f3986 commit 8d07de7

File tree

1 file changed

+68
-11
lines changed
  • x-pack/platform/plugins/private/rollup

1 file changed

+68
-11
lines changed

x-pack/platform/plugins/private/rollup/README.md

Lines changed: 68 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,74 @@ The rest of this doc dives into the implementation details of each of the above
1515

1616
## Quick steps for testing
1717

18-
The pattern for creating a rollup job and rollup index pattern is:
19-
20-
1. Install sample data (web logs is a good one).
21-
2. Create a rollup job with an index pattern that captures this index (e.g. `k*`).
22-
3. Set frequency to "minute". Clear the latency buffer field.
23-
4. Select the time field which is the same time field selected in the installed index pattern (`timestamp` without an `@` in the case of web logs).
24-
5. Specify a time bucket size (`10m` will do).
25-
6. Select a few terms, histogram, and metrics fields.
26-
7. Create and start the rollup job. Wait a minute for the job to run. You should see the numbers for documents and pages processed change in the detail panel.
27-
8. Create a rollup index pattern in the Index Patterns app.
28-
9. Now you can create visualizations using this index pattern.
18+
**Note:** Since Rollups has been deprecated, the UI is hidden unless there is an existing rollup job in the cluster. To test the Rollup UI, you must first create a rollup job using the workaround described below:
19+
20+
1. **Start Elasticsearch and Kibana**
21+
22+
2. **Add sample data** (e.g., "Sample web logs")
23+
24+
3. **Create a mock rollup index** through Dev Tools Console to simulate rollup usage:
25+
```
26+
PUT /mock_rollup_index
27+
{
28+
"mappings": {
29+
"_meta": {
30+
"_rollup": {
31+
"id": "logs_job"
32+
}
33+
}
34+
}
35+
}
36+
```
37+
38+
4. **Create a rollup job** through Dev Tools Console:
39+
```
40+
PUT _rollup/job/logs_job
41+
{
42+
"id": "logs_job",
43+
"index_pattern": "kibana_sample_data_logs",
44+
"rollup_index": "rollup_logstash",
45+
"cron": "* * * * * ?",
46+
"page_size": 1000,
47+
"groups": {
48+
"date_histogram": {
49+
"interval": "60m",
50+
"delay": "7d",
51+
"time_zone": "UTC",
52+
"field": "@timestamp"
53+
},
54+
"terms": {
55+
"fields": [
56+
"geo.src",
57+
"machine.os.keyword"
58+
]
59+
},
60+
"histogram": {
61+
"interval": "1003",
62+
"fields": [
63+
"bytes",
64+
"memory"
65+
]
66+
}
67+
}
68+
}
69+
```
70+
71+
5. **Delete the mock rollup index** (it causes issues for the rollup API used to fetch rollup indices):
72+
```
73+
DELETE /mock_rollup_index
74+
```
75+
76+
6. **Navigate to Stack Management > Rollup Jobs** to view the list of rollup jobs.
77+
78+
### Steps for creating and running a rollup job in the UI
79+
80+
1. Create a rollup job with an index pattern that captures an existing data (e.g. `kibana_sample_data_logs`).
81+
2. Set frequency to "minute". Clear the latency buffer field.
82+
3. Select the time field which is the same time field selected in the installed index pattern (`timestamp` without an `@` in the case of web logs).
83+
4. Specify a time bucket size (`10m` will do).
84+
5. Select a few terms, histogram, and metrics fields.
85+
6. Create and start the rollup job. Wait a minute for the job to run. You should see the numbers for documents and pages processed change in the detail panel.
2986

3087
---
3188

0 commit comments

Comments
 (0)