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

Add minimal documentation to the diskio plugin #2296

Merged
merged 4 commits into from
Jan 21, 2017

Conversation

bbczeuz
Copy link
Contributor

@bbczeuz bbczeuz commented Jan 20, 2017

I didn't find any docs about the diskio plugin, so I did some research and wrote it myself. I think this might be helpful for others. I only checked validity of the timing unit (miliseconds) in Linux and FreeBSD, as I only have access to those platforms.

Required for all PRs:

  • CHANGELOG.md updated (we recommend not updating this until the PR has been approved by a maintainer)
  • Sign CLA (if not already signed)
  • README.md updated (if adding a new plugin)

- read_time (integer, miliseconds)
- write_time (integer, miliseconds)
- io_time (integer, miliseconds)
- iops_in_progress (integer, miliseconds) (since #2037, not yet in STABLE)
Copy link
Contributor

Choose a reason for hiding this comment

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

iops_in_progress is not milliseconds. It just a count of operation currently in progress.

Also milLiseconds :) (missing a l)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed, thanks. I only have STABLE installed, so unable to test iops_in_progress.

@sparrc
Copy link
Contributor

sparrc commented Jan 21, 2017

cool, thanks!

@sparrc sparrc merged commit 20bf90e into influxdata:master Jan 21, 2017
njwhite pushed a commit to njwhite/telegraf that referenced this pull request Jan 31, 2017
* Add documentation to diskio plugin

* Update spelling, fix iops_in_progress unit
mlindes pushed a commit to Comcast/telegraf that referenced this pull request Feb 6, 2017
* Add documentation to diskio plugin

* Update spelling, fix iops_in_progress unit
maxunt pushed a commit that referenced this pull request Jun 26, 2018
* Add documentation to diskio plugin

* Update spelling, fix iops_in_progress unit
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants