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

no clear documentation on swap input plugin #4290

Closed
randallt opened this issue Jun 14, 2018 · 2 comments
Closed

no clear documentation on swap input plugin #4290

randallt opened this issue Jun 14, 2018 · 2 comments
Labels
docs Issues related to Telegraf documentation and configuration descriptions
Milestone

Comments

@randallt
Copy link

Relevant telegraf.conf:

[[inputs.swap]]

System info:

[Include Telegraf version, operating system name, and other relevant details]

Telegraf 1.6.4. CentOS 7.4

Steps to reproduce:

  1. Try to find clear documentation on the swap input plugin fields.
  2. Fail

Expected behavior:

I should be able to find clear documentation on what fields the swap input plugin produces, what they mean, and where they come from.

Actual behavior:

I had to use guess and check mode and look at Go code.

@danielnelson danielnelson added the docs Issues related to Telegraf documentation and configuration descriptions label Jun 14, 2018
@danielnelson danielnelson added this to the 1.8.0 milestone Jun 14, 2018
@danielnelson
Copy link
Contributor

We should move this plugin out into it's own file while we are at it, and create a new SWAP_README.md. Longer term I would like to move all the "system" plugins out into the main plugins/inputs directory to increase uniformity.

sdomino added a commit to sdomino/telegraf that referenced this issue Jun 25, 2018
@danielnelson
Copy link
Contributor

Closed in #4342

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

No branches or pull requests

2 participants