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

docs: clarify the k and fields topk params #10830

Merged
merged 1 commit into from
Mar 24, 2022

Conversation

powersj
Copy link
Contributor

@powersj powersj commented Mar 16, 2022

The k and fields parameters in topk together determine the total number
of results. The current docs were not clear that there was a
relationship between the two that resulted in more than k results from
appearing.

Fixes: #10725

The k and fields parameters in topk together determine the total number
of results. The current docs were not clear that there was a
relationship between the two that resulted in more than k results from
appearing.

Fixes: influxdata#10725
@telegraf-tiger telegraf-tiger bot added the docs Issues related to Telegraf documentation and configuration descriptions label Mar 16, 2022
Copy link

@1tft 1tft left a comment

Choose a reason for hiding this comment

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

The new parameter documentation is very helpful.

@powersj powersj merged commit d89972c into influxdata:master Mar 24, 2022
@powersj powersj deleted the docs/topk-fields branch March 24, 2022 17:56
MyaLongmire pushed a commit that referenced this pull request Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to Telegraf documentation and configuration descriptions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Topk processor plugin - field parameter documentation not correct
3 participants