[Docs] Tweaks and fixes to rollup docs

- Missing links to new IndexCaps API
- Incorrect security permissions on IndexCaps API
- GetJobs API must supply a job (or `_all`), omitting throws error
- Link to search/agg limitations from RollupSearch API
- Tweak URLs in quick reference
- Formatting of overview page
This commit is contained in:
Zachary Tong 2018-08-17 13:33:12 -04:00
parent a608205510
commit 899e94a29b
7 changed files with 24 additions and 13 deletions

View File

@ -16,6 +16,7 @@
=== Data
* <<rollup-get-rollup-caps,Get Rollup Capabilities>>
* <<rollup-get-rollup-index-caps,Get Rollup Index Capabilities>>
[float]
[[rollup-search-endpoint]]
@ -31,5 +32,6 @@ include::rollup/put-job.asciidoc[]
include::rollup/start-job.asciidoc[]
include::rollup/stop-job.asciidoc[]
include::rollup/rollup-caps.asciidoc[]
include::rollup/rollup-index-caps.asciidoc[]
include::rollup/rollup-search.asciidoc[]
include::rollup/rollup-job-config.asciidoc[]

View File

@ -27,8 +27,8 @@ live?
==== Path Parameters
`index`::
(string) Index, indices or index-pattern to return rollup capabilities for. If omitted (or `_all` is used) all available
rollup job capabilities will be returned
(string) Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch
rollup capabilities from all jobs
==== Request Body

View File

@ -26,15 +26,13 @@ This API will allow you to determine:
`index`::
(string) Index or index-pattern of concrete rollup indices to check for capabilities.
==== Request Body
There is no request body for the Get Jobs API.
==== Authorization
You must have `monitor`, `monitor_rollup`, `manage` or `manage_rollup` cluster privileges to use this API.
You must have the `read` index privilege on the index that stores the rollup results.
For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].

View File

@ -82,6 +82,12 @@ In the above example, there are several pieces of logistical configuration for t
will tend to execute faster, but will require more memory during processing. This has no effect on how the data is rolled up, it is
merely used for tweaking the speed/memory cost of the indexer.
[NOTE]
The `index_pattern` cannot be a pattern that would also match the destination `rollup_index`. E.g. the pattern
`"foo-*"` would match the rollup index `"foo-rollup"`. This causes problems because the rollup job would attempt
to rollup it's own data at runtime. If you attempt to configure a pattern that matches the `rollup_index`, an exception
will be thrown to prevent this behavior.
[[rollup-groups-config]]
==== Grouping Config

View File

@ -34,7 +34,7 @@ or using `_all`, is not permitted
The request body supports a subset of features from the regular Search API. It supports:
- `query` param for specifying an DSL query, subject to some limitations
- `query` param for specifying an DSL query, subject to some limitations (see <<rollup-search-limitations>> and <<rollup-agg-limitations>>
- `aggregations` param for specifying aggregations
Functionality that is not available:

View File

@ -15,18 +15,19 @@ Most {rollup} endpoints have the following base:
[[rollup-api-jobs]]
=== /job/
* {ref}/rollup-put-job.html[PUT /job/<job_id+++>+++]: Create a job
* {ref}/rollup-get-job.html[GET /job]: List jobs
* {ref}/rollup-get-job.html[GET /job/<job_id+++>+++]: Get job details
* {ref}/rollup-start-job.html[POST /job/<job_id>/_start]: Start a job
* {ref}/rollup-stop-job.html[POST /job/<job_id>/_stop]: Stop a job
* {ref}/rollup-delete-job.html[DELETE /job/<job_id+++>+++]: Delete a job
* {ref}/rollup-put-job.html[PUT /_xpack/rollup/job/<job_id+++>+++]: Create a job
* {ref}/rollup-get-job.html[GET /_xpack/rollup/job]: List jobs
* {ref}/rollup-get-job.html[GET /_xpack/rollup/job/<job_id+++>+++]: Get job details
* {ref}/rollup-start-job.html[POST /_xpack/rollup/job/<job_id>/_start]: Start a job
* {ref}/rollup-stop-job.html[POST /_xpack/rollup/job/<job_id>/_stop]: Stop a job
* {ref}/rollup-delete-job.html[DELETE /_xpack/rollup/job/<job_id+++>+++]: Delete a job
[float]
[[rollup-api-data]]
=== /data/
* {ref}/rollup-get-rollup-caps.html[GET /data/<index_name+++>/_rollup_caps+++]: Get Rollup Capabilities
* {ref}/rollup-get-rollup-caps.html[GET /_xpack/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]]

View File

@ -20,6 +20,7 @@ So while the cost of storing a millisecond of sensor data from ten years ago is
reading often diminishes with time. It's not useless -- it could easily contribute to a useful analysis -- but it's reduced
value often leads to deletion rather than paying the fixed storage cost.
[float]
=== Rollup store historical data at reduced granularity
That's where Rollup comes into play. The Rollup functionality summarizes old, high-granularity data into a reduced
@ -35,6 +36,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
The Rollup feature exposes a new search endpoint (`/_rollup_search` vs the standard `/_search`) which knows how to search
@ -48,6 +50,7 @@ are covered more in <<rollup-search-limitations, Rollup Search limitations>>.
But if your queries, aggregations and dashboards only use the available functionality, redirecting them to historical
data is trivial.
[float]
=== 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
@ -61,6 +64,7 @@ would only see data older than a month. The RollupSearch endpoint, however, sup
It will take the results from both data sources and merge them together. If there is overlap between the "live" and
"rolled" data, live data is preferred to increase accuracy.
[float]
=== Rollup is multi-interval aware
Finally, Rollup is capable of intelligently utilizing the best interval available. If you've worked with summarizing