sensu-plugins-prometheus-checks 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b75a7821c7a2ed839593e5a00daf4c58ffbd4aa2
-  data.tar.gz: 2cd6cd658b27a31d6bb7d595d5f5461d9c70a3af
+  metadata.gz: 2b75d8632e35855807a914b346bd3c8edaaf9aad
+  data.tar.gz: 6177065bc88675d911c9e3e1f8229486e5125ae4
 SHA512:
-  metadata.gz: b212811db55c259cb72319d557fbc5b9ac9252f6c1276c58cfd57f3f5be436079b2f62e8652c845bc1a88df2953a2b01c2b441bda6b79a4cc967dc041001296a
-  data.tar.gz: eed936d3440ecc9eaf5bd98443d81615e7ef70a0e083d8bc8122b9771821a2dd720c70f1322391e20a10c52dc6a54718ddbbe62afa88e126a2c057397a3d9861
+  metadata.gz: b142eec6539074b6e487ce37f98d7586eec24c5bc456cd81b75dba9cefa2368e3709da078d56d0c56d5d58bedfb54527d25fcfe901265674ae33a2c3b227b69a
+  data.tar.gz: 25cfccae7ba869dfac79dccc9583f7e91bb3513c6a131ef3a9aa0ab00f41e5a6bcfb134c421516b8016177f60f8a6e4ab788c62f75fdd9b0adc007689e027ceb

data/.travis.yml

@@ -14,3 +14,6 @@ deploy:
     secure: jcfJuW8IX7qBLIq2wyeXYvq3n4swwGUfs/Gk2IRkmo9AwbbTaNmzbNJgedEueKdNWbaMoW+cVPKWGuY2X7pIETQBsBm2TIJb4s/Y4hv/zGR8GyyHTVZsmX1BrW7tFWTpR16VZZdtql9T21eoTGs302QieE5b+k/iFfvXR6maaGUtLd32YA6QKGJ6WoTIVqhwkdBzGWgseMI6g31JrHQjprHw3mJq4CoDZhwNDCF1+IFtdjEvMf5fuGqcs+duXjjJh1MYU5/dM/WpmT1zsPXCJGp2R59+hI0+4SF3c04o4xM4wIDhrp3q8K409Wy5rQHN+b9kV21sGnMJ1TFmZkarNhTAFxkd7XCXkqUyiOai3d8MZUBxrr0kM+GN0CbBhcc4IRB1+w4b16Hs1HffcVyBCsfsnNtC96TFSMddrQNWm6/UapKe5udcemPz2Kqcj+JawOVQ0cZDW0KtOOeEF13FQEg+uXmAUV6eP6T2oGTge5fY/3aFZp2FUCqnKRVBMGWFuP4LUfdE9EUmciO7PsyQaARJByV9niHUMws62TxY1IvuI2OQFDV+uGKPahWUSvvFkVgttcJDle1t3Qn+FsLEs5ZCXlUQQ0QK/CpZlcpRMZ9WuSNyY3RlaxjemA/w0XjUNneihYaZDISFz/VVpHqZYA15dD3QJuuw39Dvs0Nt7OQ=
   on:
     tags: true
+
+env:
+  secure: ZnbZ9Lh4nMXiW13ExYlbmsCmnivqM33vNJFibeaVhvw8UxPPgP2shGiS8uZPrhOd1kKPFfLbdtcL6XFkaMxu1ujJyli86FcdfjfOuYhFV0GC/XiS0rRXsMbstbiZd8aZWLI/RM2r9j0SQ8kqkA4OHoPr8qv1SomCrWmRpbyAwOcsLQQZbmtX3wlybVMnfDPlVigVY8NamzHzFx0BQ0M7UYt1/PgDBlcEkKrZkcgq7As8ap01N5rrdjklhelgSqgf8P06RgZVuFmxaouFVnt/UxssPmCPlPnGEEBC3Lz1FDGEI/Uf9FZE05N06laqKW0t6jIwwf2OWECTB0h04Tw4pyjPE//Qefadtqd/ijs24l+1XLtueT/Nr2y7PnyA2kEDA3745oKg/g7uU0nXjbMR5TO5tvNF1IbieDNX610Mv5wJcQF0LOFzM88nQ14Y+3N/Ct43JslGq+HQKZrUV/r+bEDEAD9LIY/UnuLNDemBSdtSsQN9HmNKFQ8Mo9xuGIBfGD1UON3ziL721Nflt5iBPfXqE3YdECqlej2KG0qwJya8lkx/fYiCZIMDhBnVvR9LY3tIDbVLXi3NQ/dtoqMDe6XbYhvnVBKbkhdOavc7gwCO6j34Pnfhtompw3Ax/DZB+/ZLV2d5PTos9hO0cCt2WU26gQx7dRm/ShykvZC14Vw=

data/lib/sensu/plugins/prometheus/checks/output.rb

@@ -26,11 +26,7 @@ module Sensu
             'memory' => \
               'Memory <%= value %>% |memory=<%= value %>',
             'memory_per_cluster' => \
-              'Cluster Memory: <%= value %>% |memory=<%= value %>"',
-            'predict_disk_all' => \
-              "Disks to run out of space in the next <%= cfg['days'] %> days: <%= value %>",
-            'service' => \
-              "Service: <%= cfg['name'] %> (<%= cfg['state'] %>=<%= value %>)"
+              'Cluster Memory: <%= value %>% |memory=<%= value %>'
           }.freeze
 
           def render(template_name, vars)

data/lib/sensu/plugins/prometheus/checks/runner.rb

@@ -75,33 +75,30 @@ module Sensu
               check_cfg = check['cfg']
 
               collect_metrics(check_name, check_cfg).each do |metric|
-                status = 0
-
                 # on service it will come with "state_required" flag
-                if check_name == 'service'
-                  # adding defaults in case they are not set
-                  check_cfg = check_cfg.merge(
-                    'state' => 'active',
-                    'state_required' => 1
-                  )
-                  # giving a service hint by adding it's name
-                  check_name = "service_#{check_cfg['name']}"
-                  status = equals(metric['value'], check_cfg['state_required'])
-                else
-                  # normal threshold evaluation
-                  status = evaluate(
-                    metric['value'],
-                    check_cfg['warn'],
-                    check_cfg['crit']
-                  )
-                end
+                status = if metric.key? 'status'
+                           metric['status']
+                         else
+                           # normal threshold evaluation
+                           evaluate(
+                             metric['value'],
+                             check_cfg['warn'],
+                             check_cfg['crit']
+                           )
+                         end
 
                 template_variables = metric
                 template_variables['cfg'] = check_cfg
 
+                if metric.key? 'output'
+                  output = metric['output']
+                else
+                  output = @tmpl.render(check['check'], template_variables)
+                end
+
                 append_event(
-                  "check_#{check_name}",
-                  @tmpl.render(check['check'], template_variables),
+                  "check_#{metric['name']}",
+                  output,
                   status,
                   metric['source']
                 )

data/lib/sensu/plugins/prometheus/checks/version.rb

@@ -2,7 +2,7 @@ module Sensu
   module Plugins
     module Prometheus
       module Checks
-        VERSION = '3.1.0'.freeze
+        VERSION = '3.1.1'.freeze
       end
     end
   end

data/lib/sensu/plugins/prometheus/metrics.rb

@@ -1,4 +1,5 @@
 require 'sensu/plugins/utils/log'
+require 'sensu/plugins/prometheus/checks'
 
 module Sensu
   module Plugins
@@ -8,6 +9,7 @@ module Sensu
       # this class will be available as a final check.
       class Metrics
         include Sensu::Plugins::Utils::Log
+        include Sensu::Plugins::Prometheus::Checks
 
         def initialize(prometheus_client)
           @client = prometheus_client
@@ -36,59 +38,114 @@ module Sensu
         # avaiable.
         def disk(cfg)
           mountpoint = "mountpoint=\"#{cfg['mount']}\""
+          disk_name = cfg['name'] || nice_disk_name(cfg['mount'])
           query = @client.percent_query_free(
             "node_filesystem_size{#{mountpoint}}",
             "node_filesystem_avail{#{mountpoint}}"
           )
-          prepare_metrics('disk', @client.query(query))
+          prepare_metrics("disk_#{disk_name}", @client.query(query))
         end
 
         # Query percentage of free space on file-systems, ignoring by default
         # `tmpfs` or the regexp configured on check.
         def disk_all(cfg)
+          results = []
           ignored = cfg['ignore_fs'] || 'tmpfs'
           ignore_fs = "fstype!~\"#{ignored}\""
-          query = @client.percent_query_free(
-            "node_filesystem_files{#{ignore_fs}}",
-            "node_filesystem_files_free{#{ignore_fs}}"
-          )
-          prepare_metrics('disk_all', @client.query(query))
+
+          queries = [
+            {
+              'used' => 'node_filesystem_size',
+              'free' => 'node_filesystem_avail',
+              'name' => 'disk'
+            },
+            {
+              'used' => 'node_filesystem_files',
+              'free' => 'node_filesystem_files_free',
+              'name' => 'inode'
+            }
+          ]
+          queries.each do |q|
+            query = @client.percent_query_free(
+              "#{q['used']}{#{ignore_fs}}",
+              "#{q['free']}{#{ignore_fs}}"
+            )
+            @client.query(query).each do |result|
+              hostname = result['metric']['instance']
+              mountpoint = result['metric']['mountpoint']
+              disk_name = nice_disk_name(mountpoint)
+              percent = result['value'][1].to_i
+              results << { 'output' => "#{q['name'].capitalize}: #{mountpoint}, Usage: #{percent}% |#{q['name']}=#{percent}",
+                           'name' => "#{q['name']}_#{disk_name}",
+                           'source' => hostname }
+            end
+          end
+          results
         end
 
         # Queyr percentage of free inodes on check's configured mountpoint.
         def inode(cfg)
           mountpoint = "mountpoint=\"#{cfg['mount']}\""
+          disk_name = cfg['name'] || nice_disk_name(cfg['mount'])
           query = @client.percent_query_free(
             "node_filesystem_files{#{mountpoint}}",
             "node_filesystem_files_free{#{mountpoint}}"
           )
-          prepare_metrics('inode', @client.query(query))
+          prepare_metrics("inode_#{disk_name}", @client.query(query))
         end
 
         # Compose query to predict disk usage on the last day.
         def predict_disk_all(cfg)
+          disks = []
           days = cfg['days'].to_i
           days_in_seconds = days.to_i * 86_400
           filter = cfg['filter'] || {}
           range_vector = cfg['sample_size'] || '24h'
+          exit_code = cfg['exit_code'] || 1
           query = format(
             'predict_linear(node_filesystem_avail%s[%s], %i) < 0',
             filter,
             range_vector,
             days_in_seconds
           )
-          prepare_metrics('predict_disk_all', @client.query(query))
+          @client.query(query).each do |result|
+            hostname = result['metric']['instance']
+            disk = result['metric']['mountpoint']
+            disks << "#{hostname}:#{disk}"
+          end
+
+          if disks.empty?
+            [{ 'status' => 0,
+               'output' => "No disks are predicted to run out of space in the next #{days} days",
+               'name' => 'predict_disk_all',
+               'source' => cfg['source'] }]
+          else
+            disks = disks.join(',')
+            [{ 'status' => exit_code.to_i,
+               'output' => "Disks predicted to run out of space in the next #{days} days: #{disks}",
+               'name' => 'predict_disk_all',
+               'source' => cfg['source'] }]
+          end
         end
 
         # Service metrics will contain it's "state" as "value".
         def service(cfg)
-          defaults = { 'state' => 'active' }
+          results = []
+          defaults = {
+            'state' => 'active',
+            'state_required' => 1
+          }
           cfg = defaults.merge(cfg)
           query = format(
             "node_systemd_unit_state{name='%s',state='%s'}",
             cfg['name'], cfg['state']
           )
-          prepare_metrics('service', @client.query(query))
+          prepare_metrics("service_#{cfg['name']}", @client.query(query)).each do |metric|
+            metric['status'] = equals(metric['value'], cfg['state_required'])
+            metric['output'] = "Service: #{cfg['name']} (#{cfg['state']}=#{metric['value']})"
+            results << metric
+          end
+          results
         end
 
         # Query the percentage free memory.
@@ -113,7 +170,7 @@ module Sensu
           @client.query(query).each do |result|
             value = result['value'][1].to_f.round(2)
             log.debug("[memory_per_cluster] value: '#{value}', source: '#{source}'")
-            metrics << { 'source' => source, 'value' => value }
+            metrics << { 'source' => source, 'value' => value, 'name' => "#{cluster}_memory" }
           end
           metrics
         end
@@ -134,7 +191,7 @@ module Sensu
             "[load_per_cluster] value: '#{value}', source: '#{source}'"
           )
 
-          [{ 'source' => source, 'value' => value }]
+          [{ 'source' => source, 'value' => value, 'name' => "#{cluster}_load" }]
         end
 
         # Returns a single metric entry, with the sum of the total load on
@@ -157,7 +214,7 @@ module Sensu
             "[load_per_cluster_minus_n] value: '#{value}', source: '#{source}'"
           )
 
-          [{ 'source' => source, 'value' => value }]
+          [{ 'source' => source, 'value' => value, 'name' => "#{cluster}_load_minus_n" }]
         end
 
         # Current load per CPU.
@@ -180,7 +237,8 @@ module Sensu
             )
             metrics << {
               'source' => source,
-              'value' => load_on_cpu
+              'value' => load_on_cpu,
+              'name' => 'load'
             }
           end
           metrics
@@ -195,10 +253,18 @@ module Sensu
             source = result['metric']['instance']
             value = result['value'][1].to_i
             log.debug("[#{metric_name}] value: '#{value}', source: '#{source}'")
-            metrics << { 'source' => source, 'value' => value }
+            metrics << { 'name' => metric_name, 'source' => source, 'value' => value }
           end
           metrics
         end
+
+        def nice_disk_name(disk)
+          if disk == '/'
+            'root'
+          else
+            disk.gsub(%r{^/}, '').gsub(%r{/$}, '').gsub(%r{/}, '_')
+          end
+        end
       end
     end
   end

data/test.sh

@@ -1,5 +1,5 @@
 #!/bin/bash -e
 
 docker build -t saas/check_prometheus .
-docker run --rm -e TRAVIS=$TRAVIS saas/check_prometheus rspec -c -f d
+docker run --rm -e CODECOV_TOKEN=$CODECOV_TOKEN -e TRAVIS=$TRAVIS saas/check_prometheus rspec -c -f d
 docker run --rm saas/check_prometheus rubocop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-prometheus-checks
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Michael Russell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,9 +192,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Sensu plugin for monitoring servers by querying Prometheus
 test_files: []
-has_rdoc: