riemann-riak 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7358bc4125363c3f2774a6579ea6648b9d5efb1b
+  data.tar.gz: ed6e0d58221a1b03e8bd00ff1d2e5649b35b2cd4
+SHA512:
+  metadata.gz: 061832fbfbefa06354c931caea31604d41557157c07deb75b06cdaafbf3e8d9c5e82d223179dfe21e6b0e61821fb65e7a81c8e46c147216fbcf1dad3241a58fd
+  data.tar.gz: 6a0d5f3ded5dd8fc45132d2a8c4f351e0e78adb006737a98ae84644a7b35da47fa30509b53841555821f0203d2911289af36c577cc3e994790b37defb831a05d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Kyle Kingsbury
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,10 @@
+# Riemann Riak
+
+Gathers Riak statistics and submits them to Riemann.
+
+## Getting started
+
+```
+gem install riemann-riak
+riemann-riak --help
+```

data/bin/riemann-riak

@@ -0,0 +1,330 @@
+#!/usr/bin/env ruby
+
+# Forwards information on a Riak node to Riemann.
+
+require 'riemann/tools'
+
+class Riemann::Tools::Riak
+  include Riemann::Tools
+  require 'net/http'
+  require 'net/https'
+  require 'yajl/json_gem'
+
+  opt :riak_host, "Riak host for stats <IP> or SSL http(s)://<IP>", :default => Socket.gethostname
+  opt :data_dir, "Riak data directory", :default => '/var/lib/riak'
+  opt :stats_port, "Riak HTTP port for stats", :default => 8098
+  opt :stats_path, "Riak HTTP stats path", :default => '/stats'
+  opt :node_name, "Riak erlang node name", :default => "riak@#{Socket.gethostname}"
+  opt :cookie, "Riak cookie to use", :default => "riak"
+
+  opt :get_50_warning, "FSM 50% get time warning threshold (ms)", :default => 1000
+  opt :put_50_warning, "FSM 50% put time warning threshold (ms)", :default => 1000
+  opt :get_95_warning, "FSM 95% get time warning threshold (ms)", :default => 2000
+  opt :put_95_warning, "FSM 95% put time warning threshold (ms)", :default => 2000
+  opt :get_99_warning, "FSM 99% get time warning threshold (ms)", :default => 10000
+  opt :put_99_warning, "FSM 99% put time warning threshold (ms)", :default => 10000
+
+  def initialize
+    detect_features
+
+    @httpstatus = true
+
+    begin
+      uri = URI.parse(opts[:riak_host])
+      if uri.host == nil
+        uri.host = opts[:riak_host]
+      end
+      http = Net::HTTP.new(uri.host, opts[:stats_port])
+      http.use_ssl = uri.scheme == 'https'
+      if http.use_ssl?
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http.start do |h|
+        h.get opts[:stats_path]
+      end
+    rescue => _e
+      @httpstatus = false
+    end
+
+    # we're going to override the emulator setting to allow users to
+    # dynamically input the cookie
+    # this is done only once - hopefully it doesn't get overridden.
+    ENV['ERL_AFLAGS'] = "-setcookie #{opts[:cookie]}"
+  end
+
+  # Identifies whether escript and riak-admin are installed
+  def detect_features
+    @escript = true # Whether escript is present on this machine
+    @riakadmin = true # Whether riak-admin is present
+
+    if `which escript` =~ /^\s*$/
+      @escript = false
+    end
+
+    if `which riak-admin` =~ /^\s*$/
+      @riakadmin = false
+    end
+  end
+
+  def check_ring
+    str = if @escript
+      str = `#{File.expand_path(File.dirname(__FILE__))}/riemann-riak-ring #{opts[:node_name]}`.chomp
+    elsif @riakadmin
+      str = `riak-admin ringready`
+    else
+      nil
+    end
+
+    return if str.nil?
+
+    if str =~ /^TRUE/
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak ring',
+        :state => 'ok',
+        :description => str
+      )
+    else
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak ring',
+        :state => 'warning',
+        :description => str
+      )
+    end
+  end
+
+  def check_keys
+    keys = `#{File.expand_path(File.dirname(__FILE__))}/riemann-riak-keys #{opts[:node_name]}`.chomp
+    if keys =~ /^\d+$/
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak keys',
+        :state => 'ok',
+        :metric => keys.to_i,
+        :description => keys
+      )
+    else
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak keys',
+        :state => 'unknown',
+        :description => keys
+      )
+    end
+  end
+
+  def check_transfers
+    str = if @riakadmin
+      `riak-admin transfers`
+    else
+      nil
+    end
+
+    return if str.nil?
+
+    if str =~ /'#{opts[:node_name]}' waiting to handoff (\d+) partitions/
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak transfers',
+        :state   => 'critical',
+        :metric  => $1.to_i,
+        :description => "waiting to handoff #{$1} partitions"
+      )
+    else
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak transfers',
+        :state   => 'ok',
+        :metric  => 0,
+        :description => "No pending transfers"
+      )
+    end
+  end
+
+  def check_disk
+    gb = `du -Ls #{opts[:data_dir]}`.split(/\s+/).first.to_i / (1024.0**2)
+    report(
+      :host => opts[:riak_host],
+      :service => 'riak disk',
+      :state => 'ok',
+      :metric => gb,
+      :description => "#{gb} GB in #{opts[:data_dir]}"
+    )
+  end
+
+  # Returns the riak stat for the given fsm type and percentile.
+  def fsm_stat(type, property, percentile)
+    "node_#{type}_fsm_#{property}_#{percentile == 50 ? 'median' : percentile}"
+  end
+
+  # Returns the alerts state for the given fsm.
+  def fsm_state(type, percentile, val)
+    limit = opts["#{type}_#{percentile}_warning".to_sym]
+    case val
+    when 0 .. limit
+      'ok'
+    when limit .. limit * 2
+      'warning'
+    else
+      'critical'
+    end
+  end
+
+  # Get current stats via HTTP
+  def stats_http
+    begin
+      uri = URI.parse(opts[:riak_host])
+      if uri.host == nil
+        uri.host = opts[:riak_host]
+      end
+      http = Net::HTTP.new(uri.host, opts[:stats_port])
+      http.use_ssl = uri.scheme == 'https'
+      if http.use_ssl?
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      res = http.start do |h|
+        h.get opts[:stats_path]
+      end
+    rescue => e
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak',
+        :state => 'critical',
+        :description => "error fetching #{opts[:riak_host]}:#{opts[:stats_port]} #{e.class}, #{e.message}"
+      )
+      raise
+    end
+
+    if res.code.to_i == 200
+      return JSON.parse(res.body)
+    else
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak',
+        :state => 'critical',
+        :description => "stats returned HTTP #{res.code}:\n\n#{res.body}"
+      )
+      raise "Can't fetch stats via HTTP: #{res.core}:\n\n#{res.body}"
+    end
+  end
+
+  # Get current stats via riak-admin
+  def stats_riak_admin
+    str = `riak-admin status`
+    raise "riak-admin failed" unless $? == 0
+    Hash[str.split(/\n/).map{|i| i.split(/ : /)}]
+  end
+
+  # Get current stats as a hash
+  def stats
+    if @httpstatus
+      stats_http
+    elsif @riakadmin
+      stats_riak_admin
+    else
+      report(
+        :host => opts[:riak_host],
+        :service => 'riak',
+        :state => 'critical',
+        :description => "No mechanism for fetching Riak stats: neither HTTP nor riak-admin available."
+      )
+      raise "No mechanism for fetching Riak stats: neither HTTP nor riak-admin available."
+    end
+  end
+
+  def core_services
+    ['vnode_gets',
+     'vnode_puts',
+     'node_gets',
+     'node_puts',
+     'node_gets_set',
+     'node_puts_set',
+     'read_repairs']
+  end
+
+  def fsm_types
+    [{'get' => 'time'}, {'put' => 'time'},
+     {'get' => 'set_objsize'}]
+  end
+
+  def fsm_percentiles
+    [50, 95, 99]
+  end
+
+  # Reports current stats to Riemann
+  def check_stats
+    begin
+      stats = self.stats
+    rescue => e
+      event = {:state => 'critical',
+               :description => e.message,
+               :host => opts[:riak_host]}
+      # Report errors
+      report(event.merge(:service => 'riak'))
+      core_services.each do |s|
+        report(event.merge(:service => "riak #{s}"))
+      end
+      fsm_types.each do |typespec|
+        typespec.each do |type, prop|
+          fsm_percentiles.each do |percentile|
+            report(event.merge(:service => "riak #{type} #{prop} #{percentile}"))
+          end
+        end
+      end
+      return
+    end
+
+    # Riak itself
+    report(
+      :host => opts[:riak_host],
+      :service => 'riak',
+      :state => 'ok'
+    )
+
+    # Gets/puts/rr
+    core_services.each do |s|
+      report(
+        :host => opts[:riak_host],
+        :service => "riak #{s}",
+        :state => 'ok',
+        :metric => stats[s].to_i/60.0,
+        :description => "#{stats[s].to_i/60.0}/sec"
+      )
+    end
+
+    # FSMs
+    fsm_types.each do |typespec|
+      typespec.each do |type, prop|
+        fsm_percentiles.each do |percentile|
+          val = stats[fsm_stat(type, prop, percentile)].to_i || 0
+          val = 0 if val == 'undefined'
+          val /= 1000.0 if prop == 'time' # Convert us to ms
+          if prop == 'time'
+            state = fsm_state(type,  percentile, val)
+          else
+            state = "ok"
+          end
+          report(
+            :host => opts[:riak_host],
+            :service => "riak #{type} #{prop} #{percentile}",
+            :state => state,
+            :metric => val,
+            :description => "#{val} ms"
+          )
+        end
+      end
+    end
+  end
+
+  def tick
+    # This can utterly destroy a cluster, so we disable
+    # check_keys
+    check_stats
+    check_ring
+    check_disk
+    check_transfers
+  end
+end
+
+Riemann::Tools::Riak.run

data/bin/riemann-riak-keys

@@ -0,0 +1,12 @@
+#!/usr/bin/env escript
+%%! -name riakstatuscheck@127.0.0.1 -hidden
+
+main([]) -> main(["riak@127.0.0.1"]);
+main([Node]) ->
+  io:format("~w\n", [
+    lists:foldl(
+      fun({_VNode, Count}, Sum) -> Sum + Count end,
+      0,
+      rpc:call(list_to_atom(Node), riak_kv_bitcask_backend, key_counts, [])
+    )
+  ]).

data/bin/riemann-riak-ring

@@ -0,0 +1,8 @@
+#!/usr/bin/env escript
+%%! -name riakstatuscheck@127.0.0.1 -hidden
+
+main([]) -> main(["riak@127.0.0.1"]);
+main([Node]) ->
+  io:format("~p\n", [
+    rpc:call(list_to_atom(Node), riak_kv_console, ringready, [[]])
+  ]).

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: riemann-riak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Kingsbury
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riemann-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: 
+email: aphyr@aphyr.com
+executables:
+- riemann-riak
+- riemann-riak-keys
+- riemann-riak-ring
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/riemann-riak
+- bin/riemann-riak-keys
+- bin/riemann-riak-ring
+homepage: https://github.com/riemann/riemann-riak
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: riemann-riak
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Submits riak stats to riemann.
+test_files: []