sensu-plugins-prometheus-checks 2.3.0

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

@@ -0,0 +1,9 @@
+module Sensu
+  module Plugins
+    module Prometheus
+      module Checks
+        VERSION = '2.3.0'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'json'
+require 'net/http'
+
+require 'sensu/plugins/utils/log'
+
+module Sensu
+  module Plugins
+    module Prometheus
+      # Prometheus http-client, able to query and validate results.
+      class Client
+        include Sensu::Plugins::Utils::Log
+
+        # Instantiates the http-client with `prometheus_endpoint`.
+        def initialize
+          host, port = prometheus_endpoint.split(':')
+          log.info("Prometheus at '#{host}':'#{port}'")
+          @client = Net::HTTP.new(host, port)
+          @client.read_timeout = 3
+          @client.open_timeout = 3
+        end
+
+        # Execute query on Prometheus and validate payload. When successful it
+        # will return payload inner `result`, otherwise nil.
+        def query(prometheus_query)
+          log.debug("Prometheus Query: '#{prometheus_query}'")
+          prometheus_query = CGI.escape(prometheus_query)
+
+          begin
+            get_request = Net::HTTP::Get.new("/api/v1/query?query=#{prometheus_query}")
+            response_body = @client.request(get_request).body
+          rescue SystemCallError => e
+            log.error("Communication error with Prometheus: '#{e}'")
+            raise "Can't send query to Prometheus!"
+          end
+
+          payload = JSON.parse(response_body)
+          if !payload.key?('data') || !payload['data'].key?('result')
+            log.error("Can't find 'data' and/or 'result' keys on query result!")
+            return nil
+          end
+          payload['data']['result']
+        end
+
+        # String placeholders to calculate percentage free.
+        def percent_query_free(total, available)
+          "100-((#{available}/#{total})*100)"
+        end
+
+        private
+
+        # Reads `PROMETHEUS_ENDPOINT` from environment or use default localhost,
+        # applies validation to make sure ':' is present.
+        def prometheus_endpoint
+          endpoint = ENV['PROMETHEUS_ENDPOINT'] || '127.0.0.1:9090'
+          raise "Invalid endpoint 'PROMETHEUS_ENDPOINT=" + endpoint + "'" \
+            unless endpoint.include?(':')
+          endpoint
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,205 @@
+require 'sensu/plugins/utils/log'
+
+module Sensu
+  module Plugins
+    module Prometheus
+      # Represents the queryies that will be fired against Prometheus to collect
+      # information about monitored resources. Ideally all public methods on
+      # this class will be available as a final check.
+      class Metrics
+        include Sensu::Plugins::Utils::Log
+
+        def initialize(prometheus_client)
+          @client = prometheus_client
+        end
+
+        # Execute query informed on check's configuration and makes no
+        # modifications on value.
+        def custom(cfg)
+          metrics = []
+          @client.query(cfg['query']).each do |result|
+            source = if result['metric']['instance'] =~ /^\d+/
+                       result['metric']['app']
+                     else
+                       result['metric']['instance']
+                     end
+
+            metrics << {
+              'source' => source,
+              'value' => result['value'][1]
+            }
+          end
+          metrics
+        end
+
+        # Query percentage of mountpoint total disk space size compared with
+        # avaiable.
+        def disk(cfg)
+          mountpoint = "mountpoint=\"#{cfg['mount']}\""
+          query = @client.percent_query_free(
+            "node_filesystem_size{#{mountpoint}}",
+            "node_filesystem_avail{#{mountpoint}}"
+          )
+          prepare_metrics('disk', @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)
+          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))
+        end
+
+        # Queyr percentage of free inodes on check's configured mountpoint.
+        def inode(cfg)
+          mountpoint = "mountpoint=\"#{cfg['mount']}\""
+          query = @client.percent_query_free(
+            "node_filesystem_files{#{mountpoint}}",
+            "node_filesystem_files_free{#{mountpoint}}"
+          )
+          prepare_metrics('inode', @client.query(query))
+        end
+
+        # Compose query to predict disk usage on the last day.
+        def predict_disk_all(cfg)
+          days = cfg['days'].to_i
+          days_in_seconds = days.to_i * 86_400
+          filter = cfg['filter'] || {}
+          range_vector = cfg['sample_size'] || '24h'
+          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))
+        end
+
+        # Service metrics will contain it's "state" as "value".
+        def service(cfg)
+          defaults = { 'state' => 'active' }
+          cfg = defaults.merge(cfg)
+          query = format(
+            "node_systemd_unit_state{name='%s',state='%s'}",
+            cfg['name'], cfg['state']
+          )
+          prepare_metrics('service', @client.query(query))
+        end
+
+        # Query the percentage free memory.
+        def memory(_)
+          query = @client.percent_query_free(
+            'node_memory_MemTotal',
+            'node_memory_MemAvailable'
+          )
+          prepare_metrics('memory', @client.query(query))
+        end
+
+        # Percentage free memory cluster wide.
+        def memory_per_cluster(cfg)
+          cluster = cfg['cluster']
+          query = @client.percent_query_free(
+            "sum(node_memory_MemTotal{job=\"#{cluster}\"})",
+            "sum(node_memory_MemAvailable{job=\"#{cluster}\"})"
+          )
+
+          metrics = []
+          source = cfg['source']
+          @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 }
+          end
+          metrics
+        end
+
+        # Calculates the load of an entire cluster.
+        def load_per_cluster(cfg)
+          cluster = cfg['cluster']
+          query = format(
+            'sum(node_load5{job="%s"})/count(node_cpu{mode="system",job="%s"})',
+            cluster,
+            cluster
+          )
+
+          result = @client.query(query).first
+          source = cfg['source']
+          value = result['value'][1].to_f.round(2)
+          log.debug(
+            "[load_per_cluster] value: '#{value}', source: '#{source}'"
+          )
+
+          [{ 'source' => source, 'value' => value }]
+        end
+
+        # Returns a single metric entry, with the sum of the total load on
+        # cluster divided by the total amount of CPUs.
+        def load_per_cluster_minus_n(cfg)
+          cluster = cfg['cluster']
+          minus_n = cfg['minus_n']
+          sum_load = "sum(node_load5{job=\"#{cluster}\"})"
+          total_cpus = "count(node_cpu{mode=\"system\",job=\"#{cluster}\"})"
+          total_nodes = "count(node_load5{job=\"#{cluster}\"})"
+
+          query = format(
+            '%s/(%s-(%s/%s)*%d)',
+            sum_load, total_cpus, total_cpus, total_nodes, minus_n
+          )
+          result = @client.query(query).first
+          value = result['value'][1].to_f.round(2)
+          source = cfg['source']
+          log.debug(
+            "[load_per_cluster_minus_n] value: '#{value}', source: '#{source}'"
+          )
+
+          [{ 'source' => source, 'value' => value }]
+        end
+
+        # Current load per CPU.
+        def load_per_cpu(_)
+          cpu_per_source = {}
+          @client.query(
+            '(count(node_cpu{mode="system"})by(instance))'
+          ).each do |result|
+            source = result['metric']['instance']
+            cpu_per_source[source] = result['value'][1]
+          end
+
+          metrics = []
+          @client.query('node_load5').each do |result|
+            source = result['metric']['instance']
+            value = result['value'][1].to_f.round(2)
+            load_on_cpu = value / cpu_per_source[source].to_f
+            log.debug(
+              "[load_per_cpu] value: '#{load_on_cpu}', source: '#{source}'"
+            )
+            metrics << {
+              'source' => source,
+              'value' => load_on_cpu
+            }
+          end
+          metrics
+        end
+
+        private
+
+        # Prepare metrics with integer valutes, the most common case in the class.
+        def prepare_metrics(metric_name, results)
+          metrics = []
+          results.each do |result|
+            source = result['metric']['instance']
+            value = result['value'][1].to_i
+            log.debug("[#{metric_name}] value: '#{value}', source: '#{source}'")
+            metrics << { 'source' => source, 'value' => value }
+          end
+          metrics
+        end
+      end
+    end
+  end
+end

data/lib/sensu/plugins/utils/log.rb

@@ -0,0 +1,24 @@
+require 'logger'
+
+module Sensu
+  module Plugins
+    module Utils
+      # Helper class to handle application logging. To be included in other
+      # classes and referenced by `log`.
+      module Log
+        def log
+          Log.log
+        end
+
+        # Creates a new logger instance a single time and set the log level. The
+        # level is determined by 'PROM_DEBUG' environment variable, when set the
+        # logger will use `0` (DEEBUG) otherwise `1` (INFO).
+        def self.log
+          @log ||= Logger.new(STDOUT)
+          @log.level = 1 if @log && !ENV.key?('PROM_DEBUG')
+          @log
+        end
+      end
+    end
+  end
+end

data/sensu-plugins-prometheus-checks.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sensu/plugins/prometheus/checks/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sensu-plugins-prometheus-checks'
+  spec.version = Sensu::Plugins::Prometheus::Checks::VERSION
+  spec.authors = ['Michael Russell', 'Otávio Fernandes']
+  spec.email = ['mrussell@schubergphilis.com', 'ofernandes@schubergphilis.com']
+
+  spec.summary = 'Sensu plugin for monitoring servers by querying Prometheus'
+  spec.description = 'Sensu plugin to compose complex Prometheus queries and ' \
+    'execute result-set evaluation'
+  spec.homepage = 'https://github.com/schubergphilis/sensu-plugins-prometheus-checks'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'codecov', '~> 0.1.10'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/test.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'net/http'
+
+`docker network create check_prometheus`
+`docker-compose stop`
+`docker-compose rm -f`
+`docker-compose build`
+`docker-compose create`
+`docker-compose start`
+
+prom_endpoint = '127.0.0.1:19090'
+ENV['PROMETHEUS_ENDPOINT'] = prom_endpoint
+
+count = 0
+until count == 10
+  host, port = prom_endpoint.split(':')
+  http = Net::HTTP.new(host, port)
+  http.read_timeout = 3
+  http.open_timeout = 3
+  request = Net::HTTP::Get.new('/api/v1/query?query=count(up)')
+  begin
+    value = JSON.load(http.request(request).body)['data']['result'][0]['value'][1]
+  rescue
+    puts "Prometheus not ready yet ... #{count}"
+  end
+  break if value == '3'
+  count += 1
+  sleep(3)
+end
+
+if count == 10
+  puts 'ERROR: Prometheus failed to start'
+  exit(1)
+end
+
+puts 'starting rspec'
+puts `rspec -c`
+exit_code = `echo $?`
+exit(exit_code.to_i)

data/test.sh

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

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-prometheus-checks
+version: !ruby/object:Gem::Version
+  version: 2.3.0
+platform: ruby
+authors:
+- Michael Russell
+- Otávio Fernandes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Sensu plugin to compose complex Prometheus queries and execute result-set
+  evaluation
+email:
+- mrussell@schubergphilis.com
+- ofernandes@schubergphilis.com
+executables:
+- check_prometheus.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/check_prometheus.rb
+- docker-compose.yml
+- lib/sensu/plugins/events/dispatcher.rb
+- lib/sensu/plugins/prometheus/checks.rb
+- lib/sensu/plugins/prometheus/checks/namespace.rb
+- lib/sensu/plugins/prometheus/checks/output.rb
+- lib/sensu/plugins/prometheus/checks/runner.rb
+- lib/sensu/plugins/prometheus/checks/version.rb
+- lib/sensu/plugins/prometheus/client.rb
+- lib/sensu/plugins/prometheus/metrics.rb
+- lib/sensu/plugins/utils/log.rb
+- sensu-plugins-prometheus-checks.gemspec
+- test.rb
+- test.sh
+homepage: https://github.com/schubergphilis/sensu-plugins-prometheus-checks
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Sensu plugin for monitoring servers by querying Prometheus
+test_files: []