-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[DOCS] Group rollup and transform content #46882
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| [[data-rollup-transform]] | ||
| = Roll up or transform your data | ||
|
|
||
| [partintro] | ||
| -- | ||
|
|
||
| {es} offers the following methods for manipulating your data: | ||
|
|
||
| * <<xpack-rollup,Rolling up your historical data>> | ||
| + | ||
| include::rollup/index.asciidoc[tag=rollup-intro] | ||
| * {stack-ov}/ml-dataframes.html[Transforming your data] | ||
|
|
||
| -- | ||
|
|
||
| include::rollup/index.asciidoc[] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,10 @@ | ||
| [role="xpack"] | ||
| [testenv="basic"] | ||
| [[rollup-api-quickref]] | ||
| == API Quick Reference | ||
| === {rollup-cap} API quick reference | ||
| ++++ | ||
| <titleabbrev>API quick reference</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental[] | ||
|
|
||
|
|
@@ -15,7 +18,7 @@ Most rollup endpoints have the following base: | |
|
|
||
| [float] | ||
| [[rollup-api-jobs]] | ||
| === /job/ | ||
| ==== /job/ | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are the slashes consistent with other APIs? |
||
| * {ref}/rollup-put-job.html[PUT /_rollup/job/<job_id+++>+++]: Create a {rollup-job} | ||
| * {ref}/rollup-get-job.html[GET /_rollup/job]: List {rollup-jobs} | ||
|
|
@@ -26,13 +29,13 @@ Most rollup endpoints have the following base: | |
|
|
||
| [float] | ||
| [[rollup-api-data]] | ||
| === /data/ | ||
| ==== /data/ | ||
|
|
||
| * {ref}/rollup-get-rollup-caps.html[GET /_rollup/data/<index_pattern+++>/_rollup_caps+++]: Get Rollup Capabilities | ||
| * {ref}/rollup-get-rollup-index-caps.html[GET /<index_name+++>/_rollup/data/+++]: Get Rollup Index Capabilities | ||
|
|
||
| [float] | ||
| [[rollup-api-index]] | ||
| === /<index_name>/ | ||
| ==== /<index_name>/ | ||
|
|
||
| * {ref}/rollup-search.html[GET /<index_name>/_rollup_search]: Search rollup data | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,10 @@ | ||
| [role="xpack"] | ||
| [testenv="basic"] | ||
| [[rollup-overview]] | ||
| == Overview | ||
| === {rollup-cap} overview | ||
| ++++ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Structurally, I think it would be better if we could incorporate the "overview" material into the top level section landing pages, instead of just making them link farms. Or make the top-level headings just landmarks and not actually navigable links in the TOC (as @gchaps suggested). Then this content would have the "overview" keyword for SEO, but we'd get rid of the extra click to get to meaningful content.) For now, this is consistent with other topics.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree that this will be worth discussing in more detail as we roll out the reorg and strive for consistency, but for now I'll leave as-is. |
||
| <titleabbrev>Overview</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental[] | ||
|
|
||
|
|
@@ -23,7 +26,7 @@ reading often diminishes with time. It's not useless -- it could easily contrib | |
| value often leads to deletion rather than paying the fixed storage cost. | ||
|
|
||
| [float] | ||
| === Rollup store historical data at reduced granularity | ||
| ==== Rollup stores historical data at reduced granularity | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Rollup store historical data" is clunky. Rollup stores? Roll up to store? Or maybe "Storing historical data at reduced granularity"? (The pattern here of repeating Rollup in every heading kind seems like overkill.)
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've updated it to match the other sections, but I agree this page could do with an edit. Will defer and just stick to structural changes here, however. |
||
| That's where Rollup comes into play. The Rollup functionality summarizes old, high-granularity data into a reduced | ||
| granularity format for long-term storage. By "rolling" the data up into a single summary document, historical data | ||
|
|
@@ -39,7 +42,7 @@ automates this process of summarizing historical data. | |
| Details about setting up and configuring Rollup are covered in <<rollup-put-job,Create Job API>> | ||
|
|
||
| [float] | ||
| === Rollup uses standard query DSL | ||
| ==== Rollup uses standard query DSL | ||
|
|
||
| The Rollup feature exposes a new search endpoint (`/_rollup_search` vs the standard `/_search`) which knows how to search | ||
| over rolled-up data. Importantly, this endpoint accepts 100% normal {es} Query DSL. Your application does not need to learn | ||
|
|
@@ -53,7 +56,7 @@ But if your queries, aggregations and dashboards only use the available function | |
| data is trivial. | ||
|
|
||
| [float] | ||
| === Rollup merges "live" and "rolled" data | ||
| ==== Rollup merges "live" and "rolled" data | ||
|
|
||
| A useful feature of Rollup is the ability to query both "live", realtime data in addition to historical "rolled" data | ||
| in a single query. | ||
|
|
@@ -67,7 +70,7 @@ It will take the results from both data sources and merge them together. If the | |
| "rolled" data, live data is preferred to increase accuracy. | ||
|
|
||
| [float] | ||
| === Rollup is multi-interval aware | ||
| ==== Rollup is multi-interval aware | ||
|
|
||
| Finally, Rollup is capable of intelligently utilizing the best interval available. If you've worked with summarizing | ||
| features of other products, you'll find that they can be limiting. If you configure rollups at daily intervals... your | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,10 @@ | ||
| [role="xpack"] | ||
| [testenv="basic"] | ||
| [[rollup-getting-started]] | ||
| == Getting Started | ||
| === Getting started with {rollups} | ||
| ++++ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ultimately, I think this is an example of a place we don't want to use the "Getting started" terminology. |
||
| <titleabbrev>Getting started</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental[] | ||
|
|
||
|
|
@@ -23,7 +26,7 @@ look like this: | |
| // NOTCONSOLE | ||
|
|
||
| [float] | ||
| === Creating a Rollup Job | ||
| ==== Creating a rollup job | ||
|
|
||
| We'd like to rollup these documents into hourly summaries, which will allow us to generate reports and dashboards with any time interval | ||
| one hour or greater. A rollup job might look like this: | ||
|
|
@@ -103,7 +106,7 @@ After you execute the above command and create the job, you'll receive the follo | |
| ---- | ||
|
|
||
| [float] | ||
| === Starting the job | ||
| ==== Starting the job | ||
|
|
||
| After the job is created, it will be sitting in an inactive state. Jobs need to be started before they begin processing data (this allows | ||
| you to stop them later as a way to temporarily pause, without deleting the configuration). | ||
|
|
@@ -117,7 +120,7 @@ POST _rollup/job/sensor/_start | |
| // TEST[setup:sensor_rollup_job] | ||
|
|
||
| [float] | ||
| === Searching the Rolled results | ||
| ==== Searching the rolled results | ||
|
|
||
| After the job has run and processed some data, we can use the <<rollup-search>> endpoint to do some searching. The Rollup feature is designed | ||
| so that you can use the same Query DSL syntax that you are accustomed to... it just happens to run on the rolled up data instead. | ||
|
|
@@ -292,7 +295,7 @@ In addition to being more complicated (date histogram and a terms aggregation, p | |
| the date_histogram uses a `7d` interval instead of `60m`. | ||
|
|
||
| [float] | ||
| === Conclusion | ||
| ==== Conclusion | ||
|
|
||
| This quickstart should have provided a concise overview of the core functionality that Rollup exposes. There are more tips and things | ||
| to consider when setting up Rollups, which you can find throughout the rest of this section. You may also explore the <<rollup-api-quickref,REST API>> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd match the revised anchor-text.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, thanks!