riemann-tools 1.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eab5c1ce9c48820a1d492d8d97d0898078880306553dc89cc9d68b1a9e01d03
-  data.tar.gz: 60b8fbc757e7775df69ea830013d81afc6521343a0abce8a516a176ef795a2bb
+  metadata.gz: 9a03d7a3dbe3175c3c9e3ab9af1ff80cf37affafed4af3f8b8c84dd11a91b2d9
+  data.tar.gz: e789e77e2ceaac35acc00fc3d4136497d3410056d22d4ea1f5c0ab884b05f967
 SHA512:
-  metadata.gz: efc7d885bc02343f17757f52d6f7c7782691a3674180bb564041eda6d5070d2112d55261a6de2d559c3554e853c4384ade03619062e49ea091bd07dbb5ad1ec6
-  data.tar.gz: a0bd87531c1a4f1fbeee5acd3777087a67e6617e516d213989a9675a75c0d570397737dbf3c8e7a22f479b1ce0d242ac354003b9571e2fe9ac3f34ab196062c9
+  metadata.gz: 599e8b4b8923501cad11bce865c3ba9aa6420411d9e515fcd33b349308c3f8ee6200d8db648ad0a8ce1b701fe88e1858dae26a800fb599f5297c7a5175e58f5b
+  data.tar.gz: a34dbd525e45f4c71ad3fec639f81d339848034aeede60efa6de5081e28d1afd6bc18ceb39d67c4dd223d04a2dba006cc74ddc6f288ce612ea16d454577d6e1c

data/.github/workflows/ci.yml

@@ -38,5 +38,7 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
+      - name: Build the parser
+        run: bundle exec rake gen_parser
       - name: Run the test suite
         run: bundle exec rspec

data/.gitignore

@@ -1,6 +1,8 @@
+Gemfile.lock
 pkg/
 ._*
 *~
 .DS_Store
 .*.swp
 *.log
+lib/riemann/tools/*_parser.tab.rb

data/.rubocop.yml

@@ -1,4 +1,10 @@
 ---
+AllCops:
+  Exclude:
+    - lib/riemann/tools/*_parser.tab.rb
+    - vendor/bundle/**/*
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 Layout/HashAlignment:
   EnforcedHashRocketStyle: table
 Layout/LineLength:
@@ -24,6 +30,8 @@ Naming/MethodParameterName:
     - lb # load balancer
 Style/Documentation:
   Enabled: false
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInArrayLiteral:

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/CHANGELOG.md

@@ -1,8 +1,66 @@
 # Changelog
 
-## [1.1.1](https://github.com/riemann/riemann-tools/tree/1.1.1) (2022-07-02)
+## [v1.4.0](https://github.com/riemann/riemann-tools/tree/v1.4.0) (2022-08-30)
 
-[Full Changelog](https://github.com/riemann/riemann-tools/compare/v1.1.0...1.1.1)
+[Full Changelog](https://github.com/riemann/riemann-tools/compare/v1.3.0...v1.4.0)
+
+**Implemented enhancements:**
+
+- Improve zpool state reporting [\#239](https://github.com/riemann/riemann-tools/pull/239) ([smortex](https://github.com/smortex))
+
+**Fixed bugs:**
+
+- Fix zpool/md informational messages reporting [\#238](https://github.com/riemann/riemann-tools/pull/238) ([smortex](https://github.com/smortex))
+- Fix detection of degraded zpool [\#237](https://github.com/riemann/riemann-tools/pull/237) ([smortex](https://github.com/smortex))
+
+## [v1.3.0](https://github.com/riemann/riemann-tools/tree/v1.3.0) (2022-08-29)
+
+[Full Changelog](https://github.com/riemann/riemann-tools/compare/v1.2.0...v1.3.0)
+
+**Implemented enhancements:**
+
+- Add support for configuration file to riemann-wrapper [\#235](https://github.com/riemann/riemann-tools/pull/235) ([smortex](https://github.com/smortex))
+- Add `riemann-md` to monitor Linux RAID/md health [\#232](https://github.com/riemann/riemann-tools/pull/232) ([smortex](https://github.com/smortex))
+- Add `riemann-zpool` to monitor zpool health [\#231](https://github.com/riemann/riemann-tools/pull/231) ([smortex](https://github.com/smortex))
+
+**Fixed bugs:**
+
+- Fix race condition in riemann-wrapper [\#233](https://github.com/riemann/riemann-tools/pull/233) ([smortex](https://github.com/smortex))
+
+**Closed issues:**
+
+- There is some kind of race condition in riemann-wrapper [\#230](https://github.com/riemann/riemann-tools/issues/230)
+
+**Merged pull requests:**
+
+- Stop riemann-wrapper if a tool raise an error [\#234](https://github.com/riemann/riemann-tools/pull/234) ([smortex](https://github.com/smortex))
+
+## [v1.2.0](https://github.com/riemann/riemann-tools/tree/v1.2.0) (2022-08-17)
+
+[Full Changelog](https://github.com/riemann/riemann-tools/compare/v1.1.1...v1.2.0)
+
+**Implemented enhancements:**
+
+- Add users monitoring to riemann-health [\#226](https://github.com/riemann/riemann-tools/pull/226) ([smortex](https://github.com/smortex))
+- Add a wrapper to run multiple tools in a single process [\#225](https://github.com/riemann/riemann-tools/pull/225) ([smortex](https://github.com/smortex))
+- Add swap monitoring to riemann-health [\#222](https://github.com/riemann/riemann-tools/pull/222) ([smortex](https://github.com/smortex))
+- Add uptime monitoring to riemann-health [\#218](https://github.com/riemann/riemann-tools/pull/218) ([smortex](https://github.com/smortex))
+
+**Fixed bugs:**
+
+- Ignore squashfs from disks usage reporting [\#228](https://github.com/riemann/riemann-tools/pull/228) ([smortex](https://github.com/smortex))
+- Fix service name mismatch for rx/tx drop in riemann-net [\#217](https://github.com/riemann/riemann-tools/pull/217) ([smortex](https://github.com/smortex))
+
+**Merged pull requests:**
+
+- Normalize class names [\#224](https://github.com/riemann/riemann-tools/pull/224) ([smortex](https://github.com/smortex))
+- Move all extra tool classes in dedicated files [\#223](https://github.com/riemann/riemann-tools/pull/223) ([smortex](https://github.com/smortex))
+- Removed travis [\#220](https://github.com/riemann/riemann-tools/pull/220) ([jamtur01](https://github.com/jamtur01))
+- Move all base tool classes in dedicated files [\#219](https://github.com/riemann/riemann-tools/pull/219) ([smortex](https://github.com/smortex))
+
+## [v1.1.1](https://github.com/riemann/riemann-tools/tree/v1.1.1) (2022-07-02)
+
+[Full Changelog](https://github.com/riemann/riemann-tools/compare/v1.1.0...v1.1.1)
 
 **Fixed bugs:**
 

data/Rakefile

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
 require 'riemann/tools/version'
-
 require 'bundler/gem_tasks'
-
 require 'github_changelog_generator/task'
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = 'riemann'
   config.project = 'riemann-tools'
   config.exclude_labels = ['skip-changelog']
-  config.future_release = Riemann::Tools::VERSION
+  config.future_release = "v#{Riemann::Tools::VERSION}"
 end
 
 desc 'Recursively build all gems'
@@ -21,3 +19,19 @@ task :rbuild do
     Dir.chdir('../..')
   end
 end
+
+task build: :gen_parser
+
+desc 'Generate parsers'
+task gen_parser: [
+  'lib/riemann/tools/mdstat_parser.tab.rb',
+  'lib/riemann/tools/uptime_parser.tab.rb',
+]
+
+file 'lib/riemann/tools/mdstat_parser.tab.rb' => 'lib/riemann/tools/mdstat_parser.y' do
+  sh 'racc -S lib/riemann/tools/mdstat_parser.y'
+end
+
+file 'lib/riemann/tools/uptime_parser.tab.rb' => 'lib/riemann/tools/uptime_parser.y' do
+  sh 'racc -S lib/riemann/tools/uptime_parser.y'
+end

data/bin/riemann-apache-status

@@ -3,111 +3,6 @@
 
 Process.setproctitle($PROGRAM_NAME)
 
-# Collects Apache metrics and submits them to Riemann
-# More information can be found at http://httpd.apache.org/docs/2.4/mod/mod_status.html
-
-# Removes whitespace from 'Total Accesses' and 'Total kBytes' for output to graphite
-
-require File.expand_path('../lib/riemann/tools', __dir__)
-
-module Riemann
-  module Tools
-    class ApacheStatus
-      include Riemann::Tools
-      require 'net/http'
-      require 'uri'
-
-      opt :uri, 'Apache Server Status URI', default: 'http://localhost/server-status'
-
-      def initialize
-        @uri = "#{URI.parse(opts[:uri])}?auto"
-        # Sample Response with ExtendedStatus On
-        # Total Accesses: 20643
-        # Total kBytes: 36831
-        # CPULoad: .0180314
-        # Uptime: 43868
-        # ReqPerSec: .470571
-        # BytesPerSec: 859.737
-        # BytesPerReq: 1827.01
-        # BusyWorkers: 6
-        # IdleWorkers: 94
-        # Scoreboard: ___K_____K____________W_
-
-        @scoreboard_map = {
-          '_' => 'waiting',
-          'S' => 'starting',
-          'R' => 'reading',
-          'W' => 'sending',
-          'K' => 'keepalive',
-          'D' => 'dns',
-          'C' => 'closing',
-          'L' => 'logging',
-          'G' => 'graceful',
-          'I' => 'idle',
-          '.' => 'open',
-        }
-      end
-
-      def get_scoreboard_metrics(response)
-        results = Hash.new(0)
-
-        response.slice! 'Scoreboard: '
-        response.each_char do |char|
-          results[char] += 1
-        end
-        results.transform_keys { |k| @scoreboard_map[k] }
-      end
-
-      def report_metrics(metrics)
-        metrics.each do |k, v|
-          report(
-            service: "httpd #{k}",
-            metric: v.to_f,
-            state: 'ok',
-            tags: ['httpd'],
-          )
-        end
-      end
-
-      def connection
-        response = nil
-        begin
-          response = Net::HTTP.get(@uri)
-        rescue StandardError => e
-          report(
-            service: 'httpd health',
-            state: 'critical',
-            description: "Httpd connection error: #{e.class} - #{e.message}",
-            tags: ['httpd'],
-          )
-        else
-          report(
-            service: 'httpd health',
-            state: 'ok',
-            description: 'Httpd connection status ok',
-            tags: ['httpd'],
-          )
-        end
-        response
-      end
-
-      def tick
-        return if (response = connection).nil?
-
-        response.each_line do |line|
-          metrics = {}
-
-          if line =~ /Scoreboard/
-            metrics = get_scoreboard_metrics(line.strip)
-          else
-            key, value = line.strip.split(':')
-            metrics[key.gsub(/\s/, '')] = value
-          end
-          report_metrics(metrics)
-        end
-      end
-    end
-  end
-end
+require 'riemann/tools/apache_status'
 
 Riemann::Tools::ApacheStatus.run

data/bin/riemann-bench

@@ -3,74 +3,6 @@
 
 Process.setproctitle($PROGRAM_NAME)
 
-# Connects to a server (first arg) and populates it with a constant stream of
-# events for testing.
+require 'riemann/tools/bench'
 
-require 'rubygems'
-require 'riemann/client'
-require 'pp'
-
-module Riemann
-  class Bench
-    attr_accessor :client, :hosts, :services, :states
-
-    def initialize
-      @hosts = [nil] + (0...10).map { |i| "host#{i}" }
-      @hosts = %w[a b c d e f g h i j]
-      @services = %w[test1 test2 test3 foo bar baz xyzzy attack cat treat]
-      @states = {}
-      @client = Riemann::Client.new(host: (ARGV.first || 'localhost'))
-    end
-
-    def evolve(state)
-      m = state[:metric] + (rand - 0.5) * 0.1
-      m = [[0, m].max, 1].min
-
-      s = case m
-          when 0...0.75
-            'ok'
-          when 0.75...0.9
-            'warning'
-          when 0.9..1.0
-            'critical'
-          end
-
-      {
-        metric: m,
-        state: s,
-        host: state[:host],
-        service: state[:service],
-        description: "at #{Time.now}",
-      }
-    end
-
-    def tick
-      #    pp @states
-      hosts.product(services).each do |id|
-        client << (states[id] = evolve(states[id]))
-      end
-    end
-
-    def run
-      start
-      loop do
-        sleep 0.05
-        tick
-      end
-    end
-
-    def start
-      hosts.product(services).each do |host, service|
-        states[[host, service]] = {
-          metric: 0.5,
-          state: 'ok',
-          description: 'Starting up',
-          host: host,
-          service: service,
-        }
-      end
-    end
-  end
-end
-
-Riemann::Bench.new.run
+Riemann::Tools::Bench.new.run

data/bin/riemann-cloudant

@@ -3,61 +3,6 @@
 
 Process.setproctitle($PROGRAM_NAME)
 
-# Gathers load balancer statistics from Cloudant.com (shared cluster) and submits them to Riemann.
-
-require File.expand_path('../lib/riemann/tools', __dir__)
-
-module Riemann
-  module Tools
-    class Cloudant
-      include Riemann::Tools
-      require 'net/http'
-      require 'json'
-
-      opt :cloudant_username, 'Cloudant username', type: :string, required: true
-      opt :cloudant_password, 'Cloudant pasword', type: :string, required: true
-
-      def tick
-        json.each do |node|
-          break if node['svname'] == 'BACKEND' # this is just a sum of all nodes.
-
-          ns = "cloudant #{node['pxname']}"
-          cluster_name = node['tracked'].split('.')[0] # ie: meritage.cloudant.com
-
-          # report health of each node.
-          report(
-            service: ns,
-            state: (node['status'] == 'UP' ? 'ok' : 'critical'),
-            tags: ['cloudant', cluster_name],
-          )
-
-          # report property->metric of each node.
-          node.each do |property, metric|
-            next if %w[pxname svname status tracked].include?(property)
-
-            report(
-              host: node['tracked'],
-              service: "#{ns} #{property}",
-              metric: metric.to_f,
-              state: (node['status'] == 'UP' ? 'ok' : 'critical'),
-              tags: ['cloudant', cluster_name],
-            )
-          end
-        end
-      end
-
-      def json
-        http = Net::HTTP.new('cloudant.com', 443)
-        http.use_ssl = true
-        http.start do |h|
-          get = Net::HTTP::Get.new('/api/load_balancer')
-          get.basic_auth opts[:cloudant_username], opts[:cloudant_password]
-          h.request get
-        end
-        JSON.parse(http.boby)
-      end
-    end
-  end
-end
+require 'riemann/tools/cloudant'
 
 Riemann::Tools::Cloudant.run

data/bin/riemann-consul

@@ -3,111 +3,6 @@
 
 Process.setproctitle($PROGRAM_NAME)
 
-# Reports service and node status to riemann
-
-require File.expand_path('../lib/riemann/tools', __dir__)
-require 'socket'
-require 'net/http'
-require 'uri'
-require 'json'
-
-module Riemann
-  module Tools
-    class ConsulHealth
-      include Riemann::Tools
-
-      opt :consul_host, 'Consul API Host (default to localhost)', default: 'localhost'
-      opt :consul_port, 'Consul API Host (default to 8500)', default: '8500'
-      opt :prefix, 'prefix to use for all service names when reporting', default: 'consul '
-      opt :minimum_services_per_node, 'minimum services per node (default: 0)', default: 0
-
-      def initialize
-        @hostname = opts[:consul_host]
-        @prefix = opts[:prefix]
-        @minimum_services_per_node = opts[:minimum_services_per_node]
-        @underlying_ip = IPSocket.getaddress(@hostname)
-        @consul_leader_url = URI.parse("http://#{opts[:consul_host]}:#{opts[:consul_port]}/v1/status/leader")
-        @consul_services_url = URI.parse("http://#{opts[:consul_host]}:#{opts[:consul_port]}/v1/catalog/services")
-        @consul_nodes_url = URI.parse("http://#{opts[:consul_host]}:#{opts[:consul_port]}/v1/catalog/nodes")
-        @consul_health_url_prefix = "http://#{opts[:consul_host]}:#{opts[:consul_port]}/v1/health/service/"
-
-        @last_services_read = {}
-      end
-
-      def alert(hostname, service, state, metric, description)
-        opts = {
-          host: hostname,
-          service: service.to_s,
-          state: state.to_s,
-          metric: metric,
-          description: description,
-        }
-
-        report(opts)
-      end
-
-      def get(url)
-        Net::HTTP.get_response(url).body
-      end
-
-      def tick
-        leader = JSON.parse(get(@consul_leader_url))
-        leader_hostname = URI.parse("http://#{leader}").hostname
-
-        return unless leader_hostname == @underlying_ip
-
-        nodes = JSON.parse(get(@consul_nodes_url))
-        services = JSON.parse(get(@consul_services_url))
-        services_by_nodes = {}
-
-        nodes.each do |node|
-          node_name = node['Node']
-          services_by_nodes[node_name] = 0
-        end
-
-        # For every service
-        services.each do |service|
-          service_name = service[0]
-          health_url = URI.parse(@consul_health_url_prefix + service_name)
-          health_nodes = JSON.parse(get(health_url))
-
-          total_count = 0
-          ok_count = 0
-
-          health_nodes.each do |node|
-            hostname = node['Node']['Node']
-            ok = node['Checks'].all? { |check| check['Status'] == 'passing' }
-            alert(hostname, "#{@prefix}#{service_name}", ok ? :ok : :critical, ok ? 1 : 0, JSON.generate(node))
-            total_count += 1
-            ok_count += ok ? 1 : 0
-
-            last_services_by_nodes = services_by_nodes[hostname].to_i
-            services_by_nodes[hostname] = last_services_by_nodes + 1
-          end
-
-          unless @last_services_read[service_name].nil?
-            last_ok = @last_services_read[service_name]
-            if last_ok != ok_count
-              alert(
-                'total', "#{@prefix}#{service_name}-count", ok_count >= last_ok ? :ok : :critical, ok_count,
-                "Number of passing #{service_name} is: #{ok_count}/#{total_count}, Last time it was: #{last_ok}",
-              )
-            end
-          end
-
-          @last_services_read[service_name] = ok_count
-        end
-
-        # For every node
-        services_by_nodes.each do |node, count|
-          alert(
-            node, "#{@prefix}total-services", count >= @minimum_services_per_node ? :ok : :critical, count,
-            "#{count} services in the specified node",
-          )
-        end
-      end
-    end
-  end
-end
+require 'riemann/tools/consul_health'
 
 Riemann::Tools::ConsulHealth.run

data/bin/riemann-dir-files-count

@@ -3,60 +3,6 @@
 
 Process.setproctitle($PROGRAM_NAME)
 
-# Gets the number of files present on a directory and submits it to riemann
-
-require File.expand_path('../lib/riemann/tools', __dir__)
-
-module Riemann
-  module Tools
-    class DirFilesCount
-      include Riemann::Tools
-
-      opt :directory, '', default: '/var/log'
-      opt :service_prefix, 'The first part of the service name, before the directory path', default: 'dir-files-count'
-      opt :warning, 'Dir files number warning threshold', type: Integer
-      opt :critical, 'Dir files number critical threshold', type: Integer
-      opt :alert_on_missing, 'Send a critical metric if the directory is missing?', default: true
-
-      def initialize
-        @dir = opts.fetch(:directory)
-        @service_prefix = opts.fetch(:service_prefix)
-        @warning = opts.fetch(:warning, nil)
-        @critical = opts.fetch(:critical, nil)
-        @alert_on_missing = opts.fetch(:alert_on_missing)
-      end
-
-      def tick
-        if Dir.exist?(@dir)
-          metric = Dir.entries(@dir).size - 2
-          report(
-            service: "#{@service_prefix} #{@dir}",
-            metric: metric,
-            state: state(metric),
-            tags: ['dir_files_count'],
-          )
-        elsif @alert_on_missing
-          report(
-            service: "#{@service_prefix} #{@dir} missing",
-            description: "#{@service_prefix} #{@dir} does not exist",
-            metric: metric,
-            state: 'critical',
-            tags: ['dir_files_count'],
-          )
-        end
-      end
-
-      def state(metric)
-        if @critical && metric > @critical
-          'critical'
-        elsif @warning && metric > @warning
-          'warning'
-        else
-          'ok'
-        end
-      end
-    end
-  end
-end
+require 'riemann/tools/dir_files_count'
 
 Riemann::Tools::DirFilesCount.run

data/bin/riemann-dir-space

@@ -3,60 +3,6 @@
 
 Process.setproctitle($PROGRAM_NAME)
 
-# Gathers the space used by a directory and submits it to riemann
-
-require File.expand_path('../lib/riemann/tools', __dir__)
-
-module Riemann
-  module Tools
-    class DirSpace
-      include Riemann::Tools
-
-      opt :directory, '', default: '/var/log'
-      opt :service_prefix, 'The first part of the service name, before the directory path', default: 'dir-space'
-      opt :warning, 'Dir space warning threshold (in bytes)', type: Integer
-      opt :critical, 'Dir space critical threshold (in bytes)', type: Integer
-      opt :alert_on_missing, 'Send a critical metric if the directory is missing?', default: true
-
-      def initialize
-        @dir = opts.fetch(:directory)
-        @service_prefix = opts.fetch(:service_prefix)
-        @warning = opts.fetch(:warning, nil)
-        @critical = opts.fetch(:critical, nil)
-        @alert_on_missing = opts.fetch(:alert_on_missing)
-      end
-
-      def tick
-        if Dir.exist?(@dir)
-          metric = `du '#{@dir}'`.lines.to_a.last.split("\t")[0].to_i
-          report(
-            service: "#{@service_prefix} #{@dir}",
-            metric: metric,
-            state: state(metric),
-            tags: ['dir_space'],
-          )
-        elsif @alert_on_missing
-          report(
-            service: "#{@service_prefix} #{@dir} missing",
-            description: "#{@service_prefix} #{@dir} does not exist",
-            metric: metric,
-            state: 'critical',
-            tags: ['dir_space'],
-          )
-        end
-      end
-
-      def state(metric)
-        if @critical && metric > @critical
-          'critical'
-        elsif @warning && metric > @warning
-          'warning'
-        else
-          'ok'
-        end
-      end
-    end
-  end
-end
+require 'riemann/tools/dir_space'
 
 Riemann::Tools::DirSpace.run