Skip to content
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

Document counter field limitation. #95155

Merged

Conversation

martijnvg
Copy link
Member

@martijnvg martijnvg commented Apr 11, 2023

As is listed here: #93539 (comment)

Relates to #93539

@martijnvg martijnvg added >docs General docs changes :StorageEngine/TSDB You know, for Metrics v8.7.1 v8.8.0 labels Apr 11, 2023
@github-actions
Copy link
Contributor

Documentation preview:

@martijnvg martijnvg marked this pull request as ready for review April 11, 2023 13:52
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Apr 11, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytics-geo (Team:Analytics)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@martijnvg martijnvg requested a review from kilfoyle April 11, 2023 13:54
Note that counter fields do come with a limitation in aggregations. Only the following aggregations are supported with counter field:
`rate`, `histogram`, `range`, `min`, `max`, `top_metrics` and `variable_width_histogram`.
****

Copy link
Contributor

@kilfoyle kilfoyle Apr 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@martijnvg Git won't let me suggest for text higher up in the file, but another option would be at line 150 to insert a note in this format:

NOTE: Counter fields do come with a limitation in aggregations. Only the following aggregations are supported with the `counter` field: `rate`, `histogram`, `range`, `min`, `max`, `top_metrics` and `variable_width_histogram`.

That would render like this, which I think might be more visible for customers as it's closer to the counter field description:

Screenshot 2023-04-11 at 10 56 57 AM

@martijnvg martijnvg requested a review from kilfoyle April 11, 2023 15:15
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just one suggestion to fix the format of the note a little bit.

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
@martijnvg martijnvg added the auto-backport Automatically create backport pull requests when merged label Apr 11, 2023
@martijnvg
Copy link
Member Author

Thanks for the quick review @kilfoyle!

@martijnvg martijnvg added the auto-merge Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) label Apr 11, 2023
@elasticsearchmachine elasticsearchmachine merged commit b41f096 into elastic:main Apr 11, 2023
@martijnvg martijnvg deleted the docs/counter_field_limitation branch April 11, 2023 16:14
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.7

martijnvg added a commit to martijnvg/elasticsearch that referenced this pull request Apr 11, 2023
elasticsearchmachine pushed a commit that referenced this pull request Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged auto-merge Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) >docs General docs changes :StorageEngine/TSDB You know, for Metrics Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v8.7.1 v8.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants