vnstat-metrics 0.1.0

data/LICENSE.md

@@ -0,0 +1,3 @@
+# License
+
+MIT

data/README.md

@@ -0,0 +1,11 @@
+# vnstat-metrics
+
+A Sensu plugin to output traffic metrics from vnstat in Graphite format.
+
+##Example
+
+```
+vnstat-metrics.rb -i en0 -p /usr/local/bin/vnstat
+```
+
+Relies on the vnstat command line tool being installed.

data/bin/vnstat-metrics.rb

@@ -0,0 +1,91 @@
+#! /usr/bin/env ruby
+#  encoding: UTF-8
+#
+#   vnstat-metrics
+#
+# DESCRIPTION:
+#
+#  Outputs the results of vnstat -tr in Graphite text format
+#
+# OUTPUT:
+#   metric data about traffic
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#
+#   MIT
+#
+require 'sensu-plugin/metric/cli'
+require 'socket'
+
+#
+# CPU Graphite
+#
+class CpuGraphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.vnstat"
+
+  option :path,
+         description: 'Full path to the vnstat executable to use',
+         short: '-p PATH',
+         long: '--path PATH',
+         default: '/usr/bin/vnstat'
+
+  option :time,
+         description: 'The sample time to pass to the -tr flag',
+         short: '-t TIME',
+         long: '--time TIME',
+         default: 5
+
+  option :interface,
+         description: 'The interface to query',
+         short: '-i INTERFACE',
+         long: '--interface INTERFACE',
+         default: 'eth0'
+
+  def match_and_scale(cmd_output, regular_exp, key)
+    if cmd_output =~ regular_exp
+      scaled_throughput = Regexp.last_match(1).to_f
+      scale      = Regexp.last_match(2)
+
+      case scale
+      when 'kbit/s'
+        throughput = scaled_throughput
+      when 'mbit/s'
+        throughput = scaled_throughput * 1000
+      when 'gbit/s'
+        throughput = scaled_throughput * 1000 * 1000
+      end
+
+      output "#{config[:scheme]}.#{config[:interface]}.#{key}", throughput
+    else
+      warning "#{key} not found in output"
+    end
+  end
+
+
+  def run # rubocop:disable all
+    vnstat_output = %x[#{config[:path]} -i #{config[:interface]} -tr #{config[:time]} 2>/dev/null]
+    exit_code = $?.clone
+
+    if exit_code.exitstatus > 0
+      warning "vnstat returned a non-0 output"
+    else
+      match_and_scale(vnstat_output, /\n\s+rx\s+([\d\.]+)[\t ]+([kKmMbit\/s]+)/, 'rx')
+      match_and_scale(vnstat_output, /\n\s+tx\s+([\d\.]+)[\t ]+([kKmMbit\/s]+)/, 'tx')
+      ok
+    end
+  end
+end

data/lib/vnstat-metrics.rb

@@ -0,0 +1 @@
+require 'vnstat-metrics/version'

data/lib/vnstat-metrics/version.rb

@@ -0,0 +1,9 @@
+module VnstatMetrics
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: vnstat-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Pisarski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Sensu plugins for traffic metrics using vnstat
+email: me@danpisarski.com
+executables:
+- vnstat-metrics.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/vnstat-metrics.rb
+- lib/vnstat-metrics/version.rb
+- lib/vnstat-metrics.rb
+- LICENSE.md
+- README.md
+homepage: http://github.com/danpisarski/vnstat-metrics
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Sensu plugins for traffic metrics using vnstat
+test_files: []