Add auto-date histogram aggregations documentation #7630
Conversation
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
vagimeli
added
Needs SME
Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
changed the title
vagimeli
added
4 - Doc review
There was a problem hiding this comment.
Thank you, @vagimeli! Can we add more info about these parameters? Is there granularity to the returned intervals? What are the formats for dates/times and time zones? Is there a default time zone?
@bowenlan-amzn Please provide technical input about the above questions. Where can I find these details?
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| #### Example response |
There was a problem hiding this comment.
Instead of this heading, I would use a sentence describing what the response contains.
There was a problem hiding this comment.
@bowenlan-amzn Please help me address the information gap. Can you explain the response from a novice user point of view?
There was a problem hiding this comment.
If you can provide the data you have indexed, this can just be the response of the previous search request
There was a problem hiding this comment.
@bowenlan-amzn Please verify the revised text is technically accurate. Thank you.
| "auto_date_histogram": { | ||
| "field": "timestamp", | ||
| "buckets": 2, | ||
| "minimum_interval": "day", |
There was a problem hiding this comment.
What does this parameter specify?
There was a problem hiding this comment.
@bowenlan-amzn Please help me address the information gap. See comment above.
There was a problem hiding this comment.
The accepted units for minimum_interval are:
year
month
day
hour
minute
second
auto date histogram won't try the interval shorter than the one specified.
There was a problem hiding this comment.
@bowenlan-amzn Please confirm the revised text is technically accurate. Thank you.
| "field": "timestamp", | ||
| "buckets": 2, | ||
| "minimum_interval": "day", | ||
| "time_zone": "America/Los_Angeles", |
There was a problem hiding this comment.
What are the possible formats for time_zone?
There was a problem hiding this comment.
@bowenlan-amzn Please help me address the information gap. See comment above.
| "buckets": 2, | ||
| "minimum_interval": "day", | ||
| "time_zone": "America/Los_Angeles", | ||
| "format": "yyyy-MM-dd HH:mm:ss" |
There was a problem hiding this comment.
What are the possible formats for dates?
There was a problem hiding this comment.
@bowenlan-amzn Please help me address the information gap. See comment above.
There was a problem hiding this comment.
For any time data (date field), format and timezone are consistent. I would expect we have a different documentation page about these
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Hi @bowenlan-amzn @kolchfa-aws I've addressed feedback comments. Please review and approve at your availability. Thank you :) |
vagimeli
added
2 - In progress
Description
Closes content gaps for the following bucket aggregations:
Auto-interval date histogram
Children
Composite
Parent
Rare terms
Issues Resolved
#4293
Version
Backport to latest version
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.