riemann-tools 1.0.0 → 1.2.0

data/lib/riemann/tools/health.rb

@@ -0,0 +1,478 @@
+# frozen_string_literal: true
+
+require 'riemann/tools'
+require 'riemann/tools/utils'
+require 'riemann/tools/uptime_parser.tab'
+
+# Reports current CPU, disk, load average, and memory use to riemann.
+module Riemann
+  module Tools
+    class Health
+      include Riemann::Tools
+      include Riemann::Tools::Utils
+
+      opt :cpu_warning, 'CPU warning threshold (fraction of total jiffies)', default: 0.9
+      opt :cpu_critical, 'CPU critical threshold (fraction of total jiffies)', default: 0.95
+      opt :disk_warning, 'Disk warning threshold (fraction of space used)', default: 0.9
+      opt :disk_critical, 'Disk critical threshold (fraction of space used)', default: 0.95
+      opt :disk_ignorefs, 'A list of filesystem types to ignore',
+          default: %w[anon_inodefs autofs cd9660 devfs devtmpfs fdescfs iso9660 linprocfs linsysfs nfs overlay procfs squashfs tmpfs]
+      opt :load_warning, 'Load warning threshold (load average / core)', default: 3.0
+      opt :load_critical, 'Load critical threshold (load average / core)', default: 8.0
+      opt :memory_warning, 'Memory warning threshold (fraction of RAM)', default: 0.85
+      opt :memory_critical, 'Memory critical threshold (fraction of RAM)', default: 0.95
+      opt :uptime_warning, 'Uptime warning threshold', default: 86_400
+      opt :uptime_critical, 'Uptime critical threshold', default: 3600
+      opt :users_warning, 'Users warning threshold', default: 1
+      opt :users_critical, 'Users critical threshold', default: 1
+      opt :swap_warning, 'Swap warning threshold', default: 0.4
+      opt :swap_critical, 'Swap critical threshold', default: 0.5
+      opt :checks, 'A list of checks to run.', type: :strings, default: %w[cpu load memory disk swap]
+
+      def initialize
+        @limits = {
+          cpu: { critical: opts[:cpu_critical], warning: opts[:cpu_warning] },
+          disk: { critical: opts[:disk_critical], warning: opts[:disk_warning] },
+          load: { critical: opts[:load_critical], warning: opts[:load_warning] },
+          memory: { critical: opts[:memory_critical], warning: opts[:memory_warning] },
+          uptime: { critical: opts[:uptime_critical], warning: opts[:uptime_warning] },
+          users: { critical: opts[:users_critical], warning: opts[:users_warning] },
+          swap: { critical: opts[:swap_critical], warning: opts[:swap_warning] },
+        }
+        case (@ostype = `uname -s`.chomp.downcase)
+        when 'darwin'
+          @cores = `sysctl -n hw.ncpu`.to_i
+          @cpu = method :darwin_cpu
+          @disk = method :disk
+          @load = method :darwin_load
+          @memory = method :darwin_memory
+          @uptime = method :bsd_uptime
+          @swap = method :bsd_swap
+        when 'freebsd'
+          @cores = `sysctl -n hw.ncpu`.to_i
+          @cpu = method :freebsd_cpu
+          @disk = method :disk
+          @load = method :bsd_load
+          @memory = method :freebsd_memory
+          @uptime = method :bsd_uptime
+          @swap = method :bsd_swap
+        when 'openbsd'
+          @cores = `sysctl -n hw.ncpu`.to_i
+          @cpu = method :openbsd_cpu
+          @disk = method :disk
+          @load = method :bsd_load
+          @memory = method :openbsd_memory
+          @uptime = method :bsd_uptime
+          @swap = method :bsd_swap
+        when 'sunos'
+          @cores = `mpstat -a 2>/dev/null`.split[33].to_i
+          @cpu = method :sunos_cpu
+          @disk = method :disk
+          @load = method :bsd_load
+          @memory = method :sunos_memory
+          @uptime = method :bsd_uptime
+          @swap = method :bsd_swap
+        else
+          @cores = `nproc`.to_i
+          puts "WARNING: OS '#{@ostype}' not explicitly supported. Falling back to Linux" unless @ostype == 'linux'
+          @cpu = method :linux_cpu
+          @disk = method :disk
+          @load = method :linux_load
+          @memory = method :linux_memory
+          @uptime = method :linux_uptime
+          @swap = method :linux_swap
+          @supports_exclude_type = `df --help 2>&1 | grep -e "--exclude-type"` != ''
+        end
+        @users = method :users
+
+        opts[:checks].each do |check|
+          case check
+          when 'disk'
+            @disk_enabled = true
+          when 'load'
+            @load_enabled = true
+          when 'cpu'
+            @cpu_enabled = true
+          when 'memory'
+            @memory_enabled = true
+          when 'uptime'
+            @uptime_enabled = true
+          when 'users'
+            @users_enabled = true
+          when 'swap'
+            @swap_enabled = true
+          end
+        end
+      end
+
+      def alert(service, state, metric, description)
+        report(
+          service: service.to_s,
+          state: state.to_s,
+          metric: metric.to_f,
+          description: description,
+        )
+      end
+
+      def report_pct(service, fraction, report)
+        return unless fraction
+
+        if fraction > @limits[service][:critical]
+          alert service, :critical, fraction, "#{format('%.2f', fraction * 100)}% #{report}"
+        elsif fraction > @limits[service][:warning]
+          alert service, :warning, fraction, "#{format('%.2f', fraction * 100)}% #{report}"
+        else
+          alert service, :ok, fraction, "#{format('%.2f', fraction * 100)}% #{report}"
+        end
+      end
+
+      def report_int(service, value, report)
+        return unless value
+
+        if value >= @limits[service][:critical]
+          alert service, :critical, value, "#{value} #{report}"
+        elsif value >= @limits[service][:warning]
+          alert service, :warning, value, "#{value} #{report}"
+        else
+          alert service, :ok, value, "#{value} #{report}"
+        end
+      end
+
+      def report_uptime(uptime)
+        description = uptime_to_human(uptime)
+
+        if uptime < @limits[:uptime][:critical]
+          alert 'uptime', :critical, uptime, description
+        elsif uptime < @limits[:uptime][:warning]
+          alert 'uptime', :warning, uptime, description
+        else
+          alert 'uptime', :ok, uptime, description
+        end
+      end
+
+      def linux_cpu
+        new = File.read('/proc/stat')
+        unless new[/cpu\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)/]
+          alert 'cpu', :unknown, nil, "/proc/stat doesn't include a CPU line"
+          return false
+        end
+        u2, n2, s2, i2 = [Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3),
+                          Regexp.last_match(4),].map(&:to_i)
+
+        if @old_cpu
+          u1, n1, s1, i1 = @old_cpu
+
+          used = (u2 + n2 + s2) - (u1 + n1 + s1)
+          total = used + i2 - i1
+          fraction = used.to_f / total
+
+          report_pct :cpu, fraction, "user+nice+system\n\n#{reverse_numeric_sort_with_header(`ps -eo pcpu,pid,comm`)}"
+        end
+
+        @old_cpu = [u2, n2, s2, i2]
+      end
+
+      def linux_load
+        load = File.read('/proc/loadavg').split(/\s+/)[0].to_f / @cores
+        if load > @limits[:load][:critical]
+          alert 'load', :critical, load, "1-minute load average/core is #{load}"
+        elsif load > @limits[:load][:warning]
+          alert 'load', :warning, load, "1-minute load average/core is #{load}"
+        else
+          alert 'load', :ok, load, "1-minute load average/core is #{load}"
+        end
+      end
+
+      def linux_memory
+        m = File.read('/proc/meminfo').split(/\n/).each_with_object({}) do |line, info|
+          x = line.split(/:?\s+/)
+          # Assume kB...
+          info[x[0]] = x[1].to_i
+        end
+
+        free = m['MemFree'].to_i + m['Buffers'].to_i + m['Cached'].to_i
+        total = m['MemTotal'].to_i
+        fraction = 1 - (free.to_f / total)
+
+        report_pct :memory, fraction, "used\n\n#{reverse_numeric_sort_with_header(`ps -eo pmem,pid,comm`)}"
+      end
+
+      def freebsd_cpu
+        u2, n2, s2, t2, i2 = `sysctl -n kern.cp_time 2>/dev/null`.split.map(&:to_i) # FreeBSD has 5 cpu stats
+
+        if @old_cpu
+          u1, n1, s1, t1, i1 = @old_cpu
+
+          used = (u2 + n2 + s2 + t2) - (u1 + n1 + s1 + t1)
+          total = used + i2 - i1
+          fraction = used.to_f / total
+
+          report_pct :cpu, fraction,
+                     "user+nice+sytem+interrupt\n\n#{reverse_numeric_sort_with_header(`ps -axo pcpu,pid,comm`)}"
+        end
+
+        @old_cpu = [u2, n2, s2, t2, i2]
+      end
+
+      def openbsd_cpu
+        u2, n2, s2, t2, i2 = # OpenBSD separates with ,
+          `sysctl -n kern.cp_time 2>/dev/null`.split(',').map(&:to_i)
+        if @old_cpu
+          u1, n1, s1, t1, i1 = @old_cpu
+
+          used = (u2 + n2 + s2 + t2) - (u1 + n1 + s1 + t1)
+          total = used + i2 - i1
+          fraction = used.to_f / total
+
+          report_pct :cpu, fraction,
+                     "user+nice+sytem+interrupt\n\n#{reverse_numeric_sort_with_header(`ps -axo pcpu,pid,comm`)}"
+        end
+
+        @old_cpu = [u2, n2, s2, t2, i2]
+      end
+
+      def sunos_cpu
+        mpstats = `mpstat -a 2>/dev/null`.split
+        u2 = mpstats[29].to_i
+        s2 = mpstats[30].to_i
+        t2 = mpstats[31].to_i
+        i2 = mpstats[32].to_i
+
+        if @old_cpu
+          u1, s1, t1, i1 = @old_cpu
+
+          used = (u2 + s2 + t2) - (u1 + s1 + t1)
+          total = used + i2 - i1
+          fraction = if i2 == i1 && used.zero? # If the system is <1% used in both samples then total will be 0 + (99 - 99), avoid a div by 0
+                       0
+                     else
+                       used.to_f / total
+                     end
+
+          report_pct :cpu, fraction,
+                     "user+sytem+interrupt\n\n#{reverse_numeric_sort_with_header(`ps -ao pcpu,pid,comm`)}"
+        end
+
+        @old_cpu = [u2, s2, t2, i2]
+      end
+
+      def uptime_parser
+        @uptime_parser ||= UptimeParser.new
+      end
+
+      def uptime
+        @cached_data[:uptime] ||= uptime_parser.parse(`uptime`)
+      end
+
+      def bsd_load
+        load = uptime[:load_averages][1] / @cores
+        if load > @limits[:load][:critical]
+          alert 'load', :critical, load, "1-minute load average/core is #{load}"
+        elsif load > @limits[:load][:warning]
+          alert 'load', :warning, load, "1-minute load average/core is #{load}"
+        else
+          alert 'load', :ok, load, "1-minute load average/core is #{load}"
+        end
+      end
+
+      def freebsd_memory
+        meminfo = `sysctl -n vm.stats.vm.v_page_count vm.stats.vm.v_wire_count vm.stats.vm.v_active_count 2>/dev/null`.chomp.split
+        fraction = (meminfo[1].to_f + meminfo[2].to_f) / meminfo[0].to_f
+
+        report_pct :memory, fraction, "used\n\n#{reverse_numeric_sort_with_header(`ps -axo pmem,pid,comm`)}"
+      end
+
+      def openbsd_memory
+        meminfo = `vmstat 2>/dev/null`.chomp.split
+        fraction = meminfo[28].to_f / meminfo[29] # The ratio of active to free memory unlike the others :(
+
+        report_pct :memory, fraction, "used\n\n#{reverse_numeric_sort_with_header(`ps -axo pmem,pid,comm`)}"
+      end
+
+      def sunos_memory
+        meminfo = `vmstat 2>/dev/null`.chomp.split
+        total_mem = `prtconf | grep Memory`.split[2].to_f * 1024 # reports in GB but vmstat is in MB
+        fraction = (total_mem - meminfo[32].to_f) / total_mem
+
+        report_pct :memory, fraction, "used\n\n#{reverse_numeric_sort_with_header(`ps -ao pmem,pid,comm`)}"
+      end
+
+      def darwin_top
+        return @cached_data[:darwin_top] if @cached_data[:darwin_top]
+
+        raw = `top -l 1 | grep -i "^\\(cpu\\|physmem\\|load\\)"`.chomp
+        topdata = {}
+        raw.each_line do |ln|
+          if ln.match(/Load Avg: [0-9.]+, [0-9.]+, ([0-9.])+/i)
+            topdata[:load] = Regexp.last_match(1).to_f
+          elsif ln.match(/CPU usage: [0-9.]+% user, [0-9.]+% sys, ([0-9.]+)% idle/i)
+            topdata[:cpu] = 1 - (Regexp.last_match(1).to_f / 100)
+          elsif (mdat = ln.match(/PhysMem: ([0-9]+)([BKMGT]) wired, ([0-9]+)([BKMGT]) active, ([0-9]+)([BKMGT]) inactive, ([0-9]+)([BKMGT]) used, ([0-9]+)([BKMGT]) free/i))
+            wired = mdat[1].to_i * (1024**'BKMGT'.index(mdat[2]))
+            active = mdat[3].to_i * (1024**'BKMGT'.index(mdat[4]))
+            inactive = mdat[5].to_i * (1024**'BKMGT'.index(mdat[6]))
+            used = mdat[7].to_i * (1024**'BKMGT'.index(mdat[8]))
+            free = mdat[9].to_i * (1024**'BKMGT'.index(mdat[10]))
+            topdata[:memory] = (wired + active + used).to_f / (wired + active + used + inactive + free)
+          # This is for OSX Mavericks which
+          # uses a different format for top
+          # Example: PhysMem: 4662M used (1328M wired), 2782M unused.
+          elsif (mdat = ln.match(/PhysMem: ([0-9]+)([BKMGT]) used \([0-9]+[BKMGT] wired\), ([0-9]+)([BKMGT]) unused/i))
+            used = mdat[1].to_i * (1024**'BKMGT'.index(mdat[2]))
+            unused = mdat[3].to_i * (1024**'BKMGT'.index(mdat[4]))
+            topdata[:memory] = used.to_f / (used + unused)
+          end
+        end
+        @cached_data[:darwin_top] = topdata
+      end
+
+      def darwin_cpu
+        topdata = darwin_top
+        unless topdata[:cpu]
+          alert 'cpu', :unknown, nil, 'unable to get CPU stats from top'
+          return false
+        end
+        report_pct :cpu, topdata[:cpu], "usage\n\n#{reverse_numeric_sort_with_header(`ps -eo pcpu,pid,comm`)}"
+      end
+
+      def darwin_load
+        topdata = darwin_top
+        unless topdata[:load]
+          alert 'load', :unknown, nil, 'unable to get load ave from top'
+          return false
+        end
+        metric = topdata[:load] / @cores
+        if metric > @limits[:load][:critical]
+          alert 'load', :critical, metric, "1-minute load average per core is #{metric}"
+        elsif metric > @limits[:load][:warning]
+          alert 'load', :warning, metric, "1-minute load average per core is #{metric}"
+        else
+          alert 'load', :ok, metric, "1-minute load average per core is #{metric}"
+        end
+      end
+
+      def darwin_memory
+        topdata = darwin_top
+        unless topdata[:memory]
+          alert 'memory', :unknown, nil, 'unable to get memory data from top'
+          return false
+        end
+        report_pct :memory, topdata[:memory], "usage\n\n#{reverse_numeric_sort_with_header(`ps -eo pmem,pid,comm`)}"
+      end
+
+      def df
+        case @ostype
+        when 'darwin', 'freebsd', 'openbsd'
+          `df -P -t no#{opts[:disk_ignorefs].join(',')}`
+        when 'sunos'
+          `df -P` # Is there a good way to exlude iso9660 here?
+        else
+          if @supports_exclude_type
+            `df -P #{opts[:disk_ignorefs].map { |fstype| "--exclude-type=#{fstype}" }.join(' ')}`
+          else
+            `df -P`
+          end
+        end
+      end
+
+      def disk
+        df.split(/\n/).each do |r|
+          f = r.split(/\s+/)
+          next if f[0] == 'Filesystem'
+
+          # Calculate capacity
+          used = f[2].to_i
+          available = f[3].to_i
+          total_without_reservation = used + available
+
+          x = used.to_f / total_without_reservation
+
+          if x > @limits[:disk][:critical]
+            alert "disk #{f[5]}", :critical, x, "#{f[4]} used"
+          elsif x > @limits[:disk][:warning]
+            alert "disk #{f[5]}", :warning, x, "#{f[4]} used"
+          else
+            alert "disk #{f[5]}", :ok, x, "#{f[4]} used"
+          end
+        end
+      end
+
+      def bsd_uptime
+        value = uptime[:uptime]
+
+        report_uptime(value)
+      end
+
+      def linux_uptime
+        value = File.read('/proc/uptime').split(/\s+/)[0].to_f
+
+        report_uptime(value)
+      end
+
+      def users
+        value = uptime[:users]
+
+        report_int(:users, value, "user#{'s' if value != 1}")
+      end
+
+      def bsd_swap
+        _device, blocks, used, _avail, _capacity = `swapinfo`.lines.last.split(/\s+/)
+
+        value = Float(used) / Integer(blocks)
+
+        report_pct :swap, value, 'used'
+      rescue ArgumentError
+        # Ignore
+      end
+
+      def linux_swap
+        total_size = 0.0
+        total_used = 0.0
+
+        File.read('/proc/swaps').lines.each_with_index do |line, n|
+          next if n.zero?
+
+          _filename, _type, size, used, _priority = line.split(/\s+/)
+
+          total_size += size.to_f
+          total_used += used.to_f
+        end
+
+        return if total_size.zero?
+
+        value = total_used / total_size
+
+        report_pct :swap, value, 'used'
+      end
+
+      def uptime_to_human(value)
+        seconds = value.to_i
+        days = seconds / 86_400
+        seconds %= 86_400
+        hrs = seconds / 3600
+        seconds %= 3600
+        mins = seconds / 60
+        [
+          ("#{days} day#{'s' if days > 1}" unless days.zero?),
+          format('%<hrs>2d:%<mins>02d', hrs: hrs, mins: mins),
+        ].compact.join(' ')
+      end
+
+      def tick
+        invalidate_cache
+
+        @cpu.call if @cpu_enabled
+        @memory.call if @memory_enabled
+        @disk.call if @disk_enabled
+        @load.call if @load_enabled
+        @uptime.call if @uptime_enabled
+        @users.call if @users_enabled
+        @swap.call if @swap_enabled
+      end
+
+      def invalidate_cache
+        @cached_data = {}
+      end
+    end
+  end
+end

data/lib/riemann/tools/kvm.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'riemann/tools'
+
+module Riemann
+  module Tools
+    class Kvm
+      include Riemann::Tools
+
+      def tick
+        # determine how many instances I have according to libvirt
+        kvm_instances = `LANG=C virsh list | grep -c running`
+
+        # submit them to riemann
+        report(
+          service: 'KVM Running VMs',
+          metric: kvm_instances.to_i,
+          state: 'info',
+        )
+      end
+    end
+  end
+end

data/lib/riemann/tools/memcached.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'riemann/tools'
+
+# Gathers memcached STATS and submits them to Riemann.
+module Riemann
+  module Tools
+    class Memcached
+      include Riemann::Tools
+      require 'socket'
+
+      opt :memcached_host, 'Memcached hostname', default: 'localhost'
+      opt :memcached_port, 'Memcached port', default: 11_211
+
+      def tick
+        sock = TCPSocket.new(opts[:memcached_host], opts[:memcached_port])
+        sock.print("stats\r\n")
+        sock.flush
+        stats = sock.gets
+
+        loop do
+          stats = sock.gets
+          break if stats.strip == 'END'
+
+          m = stats.match(/STAT (\w+) (\S+)/)
+          report(
+            host: opts[:memcached_host].dup,
+            service: "memcached #{m[1]}",
+            metric: m[2].to_f,
+            state: 'ok',
+            tags: ['memcached'],
+          )
+        end
+        sock.close
+      end
+    end
+  end
+end

data/lib/riemann/tools/net.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'riemann/tools'
+
+# Gathers network interface statistics and submits them to Riemann.
+module Riemann
+  module Tools
+    class Net
+      include Riemann::Tools
+
+      opt :interfaces, 'Interfaces to monitor', type: :strings, default: nil
+      opt :ignore_interfaces, 'Interfaces to ignore', type: :strings, default: ['lo']
+
+      def initialize
+        @old_state = nil
+        @interfaces = if opts[:interfaces]
+                        opts[:interfaces].reject(&:empty?).map(&:dup)
+                      else
+                        []
+                      end
+        @ignore_interfaces = opts[:ignore_interfaces].reject(&:empty?).map(&:dup)
+      end
+
+      def state
+        f = File.read('/proc/net/dev')
+        state = {}
+        f.split("\n").each do |line|
+          next unless line =~ /\A\s*([[:alnum:]-]+?):\s*([\s\d]+)\s*/
+
+          iface = Regexp.last_match(1)
+
+          next unless @interfaces.empty? || @interfaces.any? { |pattern| iface.match?(pattern) }
+          next if @ignore_interfaces.any? { |pattern| iface.match?(pattern) }
+
+          ['rx bytes',
+           'rx packets',
+           'rx errs',
+           'rx drop',
+           'rx fifo',
+           'rx frame',
+           'rx compressed',
+           'rx multicast',
+           'tx bytes',
+           'tx packets',
+           'tx errs',
+           'tx drop',
+           'tx fifo',
+           'tx colls',
+           'tx carrier',
+           'tx compressed',].map do |service|
+            "#{iface} #{service}"
+          end.zip( # rubocop:disable Style/MultilineBlockChain
+            Regexp.last_match(2).split(/\s+/).map(&:to_i),
+          ).each do |service, value|
+            state[service] = value
+          end
+        end
+
+        state
+      end
+
+      def tick
+        state = self.state
+
+        if @old_state
+          # Report services from `@old_state` that don't exist in `state` as expired
+          @old_state.reject { |k| state.key?(k) }.each do |service, _metric|
+            report(service: service.dup, state: 'expired')
+          end
+
+          # Report delta for services that have values in both `@old_state` and `state`
+          state.each do |service, metric|
+            next unless @old_state.key?(service)
+
+            delta = metric - @old_state[service]
+            svc_state = case service
+                        when /drop$/
+                          if delta.positive?
+                            'warning'
+                          else
+                            'ok'
+                          end
+                        when /errs$/
+                          if delta.positive?
+                            'warning'
+                          else
+                            'ok'
+                          end
+                        else
+                          'ok'
+                        end
+
+            report(
+              service: service.dup,
+              metric: (delta.to_f / opts[:interval]),
+              state: svc_state,
+            )
+          end
+        end
+
+        @old_state = state
+      end
+    end
+  end
+end