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(inputs.swap): Add message about plugin limitation #14139

Merged
merged 2 commits into from
Oct 24, 2023
Merged

docs(inputs.swap): Add message about plugin limitation #14139

merged 2 commits into from
Oct 24, 2023

Conversation

damianszczepanik
Copy link
Contributor

@damianszczepanik damianszczepanik commented Oct 18, 2023

Based on https://docs.influxdata.com/telegraf/v1/plugins/#input-swap and personal experience

@telegraf-tiger telegraf-tiger bot added docs Issues related to Telegraf documentation and configuration descriptions plugin/input 1. Request for new input plugins 2. Issues/PRs that are related to input plugins labels Oct 18, 2023
Copy link
Contributor

@powersj powersj left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I would prefer we ensure arch limitations are in the configuration that users interact with as well. Can you add a comment about this to the sample config and run make docs.

For example, what we do in most of the other plugins that have limitations like this is do:

# Read metrics about swap memory usage
# This plugin ONLY supports Linux
[[inputs.swap]]

Thanks!

@powersj powersj self-assigned this Oct 18, 2023
@damianszczepanik
Copy link
Contributor Author

Thanks for the PR. I would prefer we ensure arch limitations are in the configuration that users interact with as well. Can you add a comment about this to the sample config and run make docs.

Adding this information to both location

@powersj powersj added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Oct 23, 2023
@powersj powersj assigned srebhan and unassigned powersj Oct 23, 2023
@telegraf-tiger
Copy link
Contributor

Copy link
Member

@srebhan srebhan left a comment

Choose a reason for hiding this comment

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

Thanks for the update @damianszczepanik!

@srebhan srebhan merged commit a7d1172 into influxdata:master Oct 24, 2023
@github-actions github-actions bot added this to the v1.28.4 milestone Oct 24, 2023
powersj pushed a commit that referenced this pull request Nov 13, 2023
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 plugin/input 1. Request for new input plugins 2. Issues/PRs that are related to input plugins ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants