newrelic_zfs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fdd5091dd94e9ea8d6b2b9ac4a6f856b6a8f8b9
+  data.tar.gz: 4be49358deb4349c9ce20f31cecda0bf79d1e6bf
+SHA512:
+  metadata.gz: 4726fd516e06b68227dbcce1af4cd46c9afa61a3a6dd3f910dd5aadc5673291d587ac221d011481792230ddd7a53b5642236f2acb19b8c573b3eb01d70925b00
+  data.tar.gz: cd7ba440866b75b6fb57ac14a0188b6eb8b94826b9c385baa5f2be0da4b5f9d7cbf3edaea4bdb0ba79825a7c101ed7127e68779d0916ddf7aa5b9778fdc604d5

data/bin/newrelic_zfs

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'newrelic_plugin'
+require 'trollop'
+
+require 'newrelic_zfs'
+require 'newrelic_zfs/config'
+
+module ZfsAgent
+
+  class Agent < NewRelic::Plugin::Agent::Base
+
+    agent_guid 'com.tomreay.newrelic-zfs'
+    agent_version '1.0.0'
+    agent_config_options :instance_name, :print_metrics
+    agent_human_labels("ZFS Agent") { instance_name }
+
+    def poll_cycle
+      collector = ZFSTools::Collector.new
+      stats = collector.collect_stats
+      health_total = 0
+      stats.each do |stat|
+        if stat.name == 'UnhealthyCount'
+          health_total = health_total + stat.value
+        end
+
+        stat_name = 'ZPools/' + stat.name + '/' + stat.pool_name
+        if print_metrics
+          puts 'Reporting metric named ' + stat_name + ' with value ' + stat.value.to_s + ' and unit ' + stat.unit
+        end
+        report_metric stat_name, stat.unit, stat.value
+      end
+
+      stat_name = 'ZPools/UnhealthyCount'
+      if print_metrics
+        puts 'Reporting metric named ' + stat_name + ' with value ' + health_total.to_s + ' and unit Value'
+      end
+      report_metric stat_name, 'Value', health_total
+    end
+  end
+
+
+  opts = Trollop::options do
+    opt :config_file, "Config file", :type => :string
+  end
+
+  config_file_path = ZfsConfig::get_config_location(ARGV[0])
+  if config_file_path.nil?
+    exit
+  end
+
+  NewRelic::Plugin::Config::config_file = config_file_path
+  NewRelic::Plugin::Setup.install_agent :zfs, ZfsAgent
+  NewRelic::Plugin::Run.setup_and_run
+
+  puts 'Newrelic ZFS Agent started'
+end

data/lib/newrelic_zfs.rb

@@ -0,0 +1,116 @@
+module ZFSTools
+  class Stat
+    attr_reader :pool_name
+    attr_reader :name
+    attr_reader :unit
+    attr_reader :value
+    
+    def initialize(pool_name, name, unit, value)
+      @pool_name = pool_name
+      @name = name
+      @unit = unit
+      @value = value
+    end
+  end
+  
+  class Pool
+    BLACK_LIST = ['Altroot']
+  
+    attr_accessor :name
+    attr_reader :values
+
+    def initialize() 
+      @values = {}
+    end
+  
+    def add_value(heading, value)
+      if !BLACK_LIST.include?(heading)
+        @values.merge!({ heading => value })
+      end
+    end
+  end
+
+  class Converter
+    UNITS = { 'B' => 'bytes', 'K' => 'kilobytes', 'M' => 'megabytes', 'G' => 'gigabytes', 'T' => 'terabytes', 'P' => 'petabytes'}
+    HEADINGS = { 'Health' => 'UnhealthyCount' }
+    
+    def convert(heading, value) 
+      values = _split(value)
+      return [ _convert(heading, HEADINGS), _convert_d(values[1], UNITS, 'Value'), values[0] ]
+    end
+  
+    def _split(value)
+      match = /\d+\.?\d*/.match(value)
+      #If numeric value
+      if match
+        numeric_part = match[0]
+        unit = value.slice(numeric_part.length, value.length)
+        return [numeric_part, unit]
+      elsif value == 'ONLINE'
+        return [0, '']
+      else
+        return [1, '']
+      end
+    end
+  
+    def _convert_d(value, hash, default)
+      converted = _convert(value, hash)
+      
+      if converted.nil?
+        converted = default
+      end
+      
+      return converted
+    end
+    
+    def _convert(value, hash)
+      converted = hash[value]
+      
+      #If the converted value is null, use the original unit
+      if converted.nil?
+        converted = value
+      end
+    
+      return converted
+    end
+  end
+
+  class Collector
+    CONVERTER = Converter.new
+  
+    def collect_stats()
+      first = true
+      headings = {}
+      pools = []
+  
+      `zpool list`.each_line do |line|
+      #File.open('/Users/tomreay/Documents/workspaceWebApps/newrelic-zfs/list.txt').each_line do |line|
+        pool = Pool.new
+        line.split(' ').each_with_index do |token, index|
+          if first
+            headings.merge!({ index => token.capitalize})
+          else 
+            if headings[index] == 'Name'
+              pool.name = token
+            else
+              pool.add_value(headings[index], token)
+            end
+          end
+        end  
+        first = false
+        pools << pool
+      end
+
+      stats = []
+      pools.each do |pool|
+        pool.values.each do |heading, value|
+          converted = CONVERTER.convert(heading, value)
+          stat = Stat.new(pool.name, converted[0], converted[1], converted[2])
+          stats << stat
+        end
+      end
+      
+      return stats
+    end
+  end
+end

data/lib/newrelic_zfs/config.rb

@@ -0,0 +1,70 @@
+module ZfsConfig
+  def self.get_config_location(config_file_location)
+    if config_file_location.nil?
+      print "No config file argument given, if you have already generated a config file please rerun using:\n" +
+      "\n" +
+      "newrelic_zfs full/path/to/file \n"+
+      "\n" +
+      'Or, create a config file now? [y/n]: '
+      if user_says_yes?
+        print 'Where should the file be created? '
+        file_path = get_user_input
+        create_config(File.join(file_path, 'config.yml'))
+
+        config_file_location = get_file_path(file_path)
+      end
+    elsif !File.exist?(config_file_location)
+      print 'The specified config file does not exist, do you want to create it now? [y/n]: '
+      if user_says_yes?
+        create_config(config_file_location)
+      else
+        config_file_location = nil
+      end
+    end
+
+    return config_file_location
+  end
+
+  def self.create_config(config_file_name)
+    puts "Writing file #{config_file_name}"
+    print 'Please enter your API key: '
+    api_key = get_user_input
+    raise 'API Key must be non-empty' unless !api_key.nil? && !api_key.empty?
+
+    print 'Please enter a name for this server: '
+    server_name = get_user_input
+    raise 'Server name must be non-empty' unless !server_name.nil? && !server_name.empty?
+
+    File.open(config_file_name, 'w') do |f|
+      f.write ERB.new(
+                  "newrelic: \n" +
+                      "  license_key: '<%= api_key %>' \n" +
+                      "agents:\n" +
+                      "  zfs:\n" +
+                      "    instance_name: '<%= server_name %>'\n" +
+                      "    print_metrics: false").result(binding)
+    end
+    puts 'Config file written, starting newrelic_zfs agent'
+  end
+
+  def self.get_file_path(file_path)
+    if File.directory?(file_path)
+      file_path = File.join(file_path, 'config.yml')
+    end
+
+    if File.extname(file_path).empty?
+      file_path = file_path + '.yml'
+    end
+
+    return file_path
+  end
+
+  def self.user_says_yes?()
+    return get_user_input == 'y'
+  end
+
+  def self.get_user_input()
+    return $stdin.gets.chomp
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_zfs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom Reay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: newrelic_plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Newrelic plugin to monitor ZFS pools
+email: dev@tomreay.co.uk
+executables:
+- newrelic_zfs
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/newrelic_zfs
+- lib/newrelic_zfs.rb
+- lib/newrelic_zfs/config.rb
+homepage: http://rubygems.org/gems/newrelic-zfs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Newrelic ZFS
+test_files: []