bin/metrics-iostat-extended.rb in sensu-plugins-io-checks-1.0.0 vs bin/metrics-iostat-extended.rb in sensu-plugins-io-checks-1.0.1
- old
+ new
@@ -1,9 +1,9 @@
#! /usr/bin/env ruby
# encoding: UTF-8
#
-# iostat-extended-metrics
+# metrics-iostat-extended
#
# DESCRIPTION:
# This plugin collects iostat data for a specified disk or all disks.
# Output is in Graphite format. See `man iostat` for detailed
# explaination of each field.
@@ -17,11 +17,18 @@
# DEPENDENCIES:
# gem: sensu-plugin
# gem: socket
#
# USAGE:
+# Collect metrics for all disks
+# metrics-iostat-extended.rb
#
+# Collect metrics for /dev/sda for 3 seconds
+# metrics-iostat-extended.rb -d /dev/sda -i 3
+#
# NOTES:
+# The iostat command must be installed. On Debian/Redhat systems
+# iostat is part of the sysstat package.
#
# LICENSE:
# Peter Fern <ruby@0xc0dedbad.com>
# Released under the same terms as Sensu (the MIT license); see LICENSE
# for details.