-
Notifications
You must be signed in to change notification settings - Fork 25k
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
Convert metric aggs docs runtime fields #71260
Convert metric aggs docs runtime fields #71260
Conversation
This replaces the `script` docs for bucket aggregations with runtime fields. We expect runtime fields to be nicer to work with because you can also fetch them or filter on them. We expect them to be faster because their don't need this sort of `instanceof` tree: https://github.com/elastic/elasticsearch/blob/a92a647b9f17d1bddf5c707490a19482c273eda3/server/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java#L42 Relates to elastic#69291
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-analytics-geo (Team:Analytics) |
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.
LGTM. Thanks for jumping on this.
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.
LGTM. I left a few suggestions to avoid second person (mostly "we") wording. Those are non-blocking, and you can ignore them if wanted. Thanks for handling this @nik9000.
docs/reference/aggregations/metrics/boxplot-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/aggregations/metrics/cardinality-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/aggregations/metrics/extendedstats-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/aggregations/metrics/median-absolute-deviation-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/aggregations/metrics/string-stats-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/aggregations/metrics/t-test-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/aggregations/metrics/weighted-avg-aggregation.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: James Rodewig <[email protected]>
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.
Started a review with non-blocking changes while James was reviewing, so might be some overlap.
If you need to create a boxplot for values that aren't indexed exactly you | ||
should create a <<runtime,runtime field>> and get the boxplot of that. For | ||
example, if our load times are in milliseconds but we want values calculated | ||
in seconds, we could use a runtime field to convert them on-the-fly: |
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.
If you need to create a boxplot for values that aren't indexed exactly you | |
should create a <<runtime,runtime field>> and get the boxplot of that. For | |
example, if our load times are in milliseconds but we want values calculated | |
in seconds, we could use a runtime field to convert them on-the-fly: | |
If you need to create a boxplot for values that differ from the indexed values, | |
create a <<runtime,runtime field>> and then compute the boxplot. For | |
example, if your load times are in milliseconds but you want values calculated | |
in seconds, use a runtime field to convert values within a query: |
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 know that "on-the-fly" was in these docs before you made changes, but we try to avoid idioms like these because they don't translate well beyond English.
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.
👍
Co-authored-by: Adam Locke <[email protected]>
Thanks for the reviews folks! |
This replaces the `script` docs for bucket aggregations with runtime fields. We expect runtime fields to be nicer to work with because you can also fetch them or filter on them. We expect them to be faster because their don't need this sort of `instanceof` tree: https://github.com/elastic/elasticsearch/blob/a92a647b9f17d1bddf5c707490a19482c273eda3/server/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java#L42 Relates to elastic#69291 Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Adam Locke <[email protected]>
This replaces the `script` docs for bucket aggregations with runtime fields. We expect runtime fields to be nicer to work with because you can also fetch them or filter on them. We expect them to be faster because their don't need this sort of `instanceof` tree: https://github.com/elastic/elasticsearch/blob/a92a647b9f17d1bddf5c707490a19482c273eda3/server/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java#L42 Relates to elastic#69291 Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Adam Locke <[email protected]>
This replaces the `script` docs for bucket aggregations with runtime fields. We expect runtime fields to be nicer to work with because you can also fetch them or filter on them. We expect them to be faster because their don't need this sort of `instanceof` tree: https://github.com/elastic/elasticsearch/blob/a92a647b9f17d1bddf5c707490a19482c273eda3/server/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java#L42 Relates to #69291 Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Adam Locke <[email protected]>
This replaces the `script` docs for bucket aggregations with runtime fields. We expect runtime fields to be nicer to work with because you can also fetch them or filter on them. We expect them to be faster because their don't need this sort of `instanceof` tree: https://github.com/elastic/elasticsearch/blob/a92a647b9f17d1bddf5c707490a19482c273eda3/server/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java#L42 Relates to #69291 Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Adam Locke <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Adam Locke <[email protected]>
This replaces the
script
docs for bucket aggregations with runtimefields. We expect runtime fields to be nicer to work with because you
can also fetch them or filter on them. We expect them to be faster
because their don't need this sort of
instanceof
tree:elasticsearch/server/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java
Line 42 in a92a647
Relates to #69291