riemann-tools 0.2.13 → 1.1.0

data/tools/riemann-riak/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/tools/riemann-riak/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/tools/riemann-riak/Rakefile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'find'
+
+# Don't include resource forks in tarballs on Mac OS X.
+ENV['COPY_EXTENDED_ATTRIBUTES_DISABLE'] = 'true'
+ENV['COPYFILE_DISABLE'] = 'true'
+
+# Gemspec
+gemspec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'riemann-riak'
+
+  s.name = 'riemann-riak'
+  s.version = '0.1.2'
+  s.author = 'Kyle Kingsbury'
+  s.email = 'aphyr@aphyr.com'
+  s.homepage = 'https://github.com/riemann/riemann-tools'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Submits riak stats to riemann.'
+  s.license = 'MIT'
+
+  s.add_dependency 'riemann-tools', '>= 0.2.13'
+  s.add_dependency 'yajl-ruby', '>= 1.1.0'
+
+  s.files = FileList['bin/*', 'LICENSE', 'README.md'].to_a
+  s.executables |= Dir.entries('bin/')
+  s.has_rdoc = false
+
+  s.required_ruby_version = '>= 1.8.7'
+end
+
+Gem::PackageTask.new gemspec do |p|
+end

data/tools/riemann-riak/bin/riemann-riak

@@ -0,0 +1,323 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'English'
+Process.setproctitle($PROGRAM_NAME)
+
+# Forwards information on a Riak node to Riemann.
+
+require 'riemann/tools'
+
+module Riemann
+  module Tools
+    class 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: 10_000
+      opt :put_99_warning, 'FSM 99% put time warning threshold (ms)', default: 10_000
+
+      def initialize
+        detect_features
+
+        @httpstatus = true
+
+        begin
+          uri = URI.parse(opts[:riak_host])
+          uri.host = opts[:riak_host] if uri.host.nil?
+          http = Net::HTTP.new(uri.host, opts[:stats_port])
+          http.use_ssl = uri.scheme == 'https'
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl?
+          http.start do |h|
+            h.get opts[:stats_path]
+          end
+        rescue StandardError => _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
+
+        @escript = false if `which escript` =~ /^\s*$/
+
+        @riakadmin = false if `which riak-admin` =~ /^\s*$/
+      end
+
+      def check_ring
+        str = if @escript
+                `#{__dir__}/riemann-riak-ring #{opts[:node_name]}`.chomp
+              elsif @riakadmin
+                `riak-admin ringready`
+              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 = `#{__dir__}/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 = (`riak-admin transfers` if @riakadmin)
+
+        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: Regexp.last_match(1).to_i,
+            description: "waiting to handoff #{Regexp.last_match(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])
+          uri.host = opts[:riak_host] if uri.host.nil?
+          http = Net::HTTP.new(uri.host, opts[:stats_port])
+          http.use_ssl = uri.scheme == 'https'
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl?
+          res = http.start do |h|
+            h.get opts[:stats_path]
+          end
+        rescue StandardError => 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
+          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 $CHILD_STATUS == 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
+        %w[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 StandardError => 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
+              state = if prop == 'time'
+                        fsm_state(type, percentile, val)
+                      else
+                        '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
+  end
+end
+
+Riemann::Tools::Riak.run

data/tools/riemann-riak/bin/riemann-riak-keys

@@ -0,0 +1,13 @@
+#!/usr/bin/env escript
+Process.setproctitle($0)
+%%! -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/tools/riemann-riak/bin/riemann-riak-ring

@@ -0,0 +1,9 @@
+#!/usr/bin/env escript
+Process.setproctitle($0)
+%%! -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, [[]])
+  ]).

data/tools/riemann-riak/riak_status/key_count.erl

@@ -0,0 +1,13 @@
+#!/usr/bin/env escript
+Process.setproctitle($0)
+%%! -name riakstatuscheck -setcookie riak -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/tools/riemann-riak/riak_status/riak_status.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Process.setproctitle($PROGRAM_NAME)
+
+$LOAD_PATH.unshift File.expand_path("#{File.dirname(__FILE__)}/../vodpod-common/lib")
+require 'rubygems'
+require 'vodpod-common'
+require 'vodpod/alerts'
+require 'vodpod/starling'
+require 'net/http'
+require 'yajl/json_gem'
+
+class RiakStatus
+  PORT = 8098
+  PATH = '/stats'
+  INTERVAL = 10
+
+  FSM_LIMITS = {
+    get: {
+      50 => 1000,
+      95 => 2000,
+      99 => 10_000,
+    },
+    put: {
+      50 => 1000,
+      95 => 2000,
+      99 => 10_000,
+    },
+  }.freeze
+
+  def initialize(opts = {})
+    @host = opts[:host] || `hostname`.chomp
+    @port = opts[:port] || PORT
+    @path = opts[:path] || PATH
+  end
+
+  def alert(subservice, state, metric, description)
+    Vodpod.alert(
+      service: "riak #{subservice}",
+      state: state,
+      metric: metric,
+      description: description,
+    )
+  end
+
+  def check_ring
+    str = %x(#{__dir__}/ringready.erl riak@#{`hostname`}).chomp
+    if str =~ /^TRUE/
+      alert 'ring', :ok, nil, str
+    else
+      alert 'ring', :warning, nil, str
+    end
+  end
+
+  def check_keys
+    keys = %x(#{__dir__}/key_count.erl riak@#{`hostname`}).chomp
+    if keys =~ /^\d+$/
+      alert 'keys', :ok, keys.to_i, keys
+    else
+      alert 'keys', :error, nil, keys
+    end
+  end
+
+  def check_disk
+    gb = `du -s /var/lib/riak/bitcask/`.split(/\s+/).first.to_i / (1024.0**2)
+    alert 'disk', :ok, gb, "#{gb} GB in bitcask"
+  end
+
+  # Returns the riak stat for the given fsm type and percentile.
+  def fsm_stat(type, percentile)
+    "node_#{type}_fsm_time_#{percentile == 50 ? 'median' : percentile}"
+  end
+
+  # Returns the alerts state for the given fsm.
+  def fsm_state(type, percentile, val)
+    limit = FSM_LIMITS[type][percentile]
+    case val
+    when 0..limit
+      :ok
+    when limit..limit * 2
+      :warning
+    else
+      :critical
+    end
+  end
+
+  def check_stats
+    begin
+      res = Net::HTTP.start(@host, @port) do |http|
+        http.get('/stats')
+      end
+    rescue StandardError => e
+      Vodpod.alert(
+        service: 'riak',
+        state: :critical,
+        description: "error fetching /stats: #{e.class}, #{e.message}",
+      )
+      return
+    end
+
+    if res.code.to_i == 200
+      stats = JSON.parse(res.body)
+    else
+      Vodpod.alert(
+        service: 'riak',
+        state: :critical,
+        description: "stats returned HTTP #{res.code}:\n\n#{res.body}",
+      )
+      return
+    end
+
+    Vodpod.alert(
+      service: 'riak',
+      state: :ok,
+    )
+
+    # Gets/puts/rr
+    %w[
+      vnode_gets
+      vnode_puts
+      node_gets
+      node_puts
+      read_repairs
+    ].each do |s|
+      alert s, :ok, stats[s] / 60.0, "#{stats[s] / 60.0}/sec"
+    end
+
+    # FSMs
+    %i[get put].each do |type|
+      [50, 95, 99].each do |percentile|
+        val = stats[fsm_stat(type, percentile)] || 0
+        val = 0 if val == 'undefined'
+        val /= 1000.0 # Convert us to ms
+        state = fsm_state(type, percentile, val)
+        alert "#{type} #{percentile}", state, val, "#{val} ms"
+      end
+    end
+  end
+
+  def run
+    loop do
+      #      check_keys
+      check_stats
+      check_ring
+      check_disk
+      sleep INTERVAL
+    end
+  end
+end
+
+RiakStatus.new.run if $PROGRAM_NAME == __FILE__

data/tools/riemann-riak/riak_status/ringready.erl

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