sensu-plugins-influxdb-metrics-checker 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2958d13425df17c77a4a87981fd296d80671920d
-  data.tar.gz: 32e02acbf484a02e223db6b56b124cb114cd1617
+  metadata.gz: 86fe26cfb281849f4b73356b47011b08bf1a7960
+  data.tar.gz: dca6df28cc658d7faff6274090ecb5b050b5654a
 SHA512:
-  metadata.gz: 4754bb681f3e2679293466e1ce90a507ebad630ca8a756c539cfcf979d853a75df785f0125068e6d47b23bf56629c70a82da5b5c3ef7d99ed96c7f864a1a8319
-  data.tar.gz: 75534ba3330f532126d1c8e8e06d37911d937b13c5a1f20f4ea60ebce2de35bd8a9a197ba792fdd2b307e8e70302d3b7e62cded889d0fa938e9f176c3598b5f7
+  metadata.gz: 861427b6a1b16058eb9bfc51c0186eed75d765942325762932933ec8d67efb81f0192c2804be9c4c443acd73545ce8a134ae6f5e96de219504a23ebda7b32524
+  data.tar.gz: 74d9af1f5b6de576c991bcece54f24041ca43d2b7128c60e7c5f7f825b4ad90eb6e1dfb49e83f711b3130c95d6c799328b35c694aab67cd7319593a2e82d1f3e

data/CHANGELOG.md

@@ -3,7 +3,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
-# [0.3.1] - 2016-12-14
+# [0.3.4] - 2017-01-17
+- sixth release
+Allow the usage of regex expressions that we can identify as "/^[your_regex]$". I'll strongly recommend to use this only for exceptions, and always aim for zero-exceptions, or it wouldn't be accurate. At the moment it will fire when the number of exception today is bigger than the number of exceptions yesterday.
+Also, if you have the same number of metrics found (let's say, exceptions) it will compare just the first one. I'll not rely on this tool (yet) for a deep analysis of differences in exceptions.
+Improve feedback when returning null from InfluxDB (usually because the query is pointing to a metric that doesn't exists).
+
+# [0.3.2] - 2016-12-14
 ### Added
 - fifth release
 Rounded float result to 5 decimal places
@@ -33,5 +39,6 @@ Leaving 5 minutes to the data to consolidate.
 [0.1.0]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.1.0...0.2.0
 [0.2.0]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.2.0...0.2.1
 [0.2.1]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.2.1...0.3.0
-[0.3.0]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.3.0...0.3.1
-[0.3.1]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.3.1...HEAD
+[0.3.0]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.3.0...0.3.2
+[0.3.2]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.3.2...0.3.4
+[0.3.3]: https://github.com/pliyosenpai/sensu-plugins-influxdb-metrics-checker/0.3.4...HEAD

data/README.md

@@ -40,12 +40,28 @@ ruby check-influxdb-metrics.rb --host=metrics-influxdb.internal.com --port=8086
 
 ```
 
-Also, you can set the period that you want for your queries, for example:
+You can set the period that you want for your queries, for example:
 ```
 ruby check-influxdb-metrics.rb --host=metrics-influxdb.internal.com --port=8086 --user=admin --password=password -c -20 -w -10 --db=statsd_metrics --metric=api.request.counter --tag=datacenter --filter=ci --period=1440
 
 ```
 
+## Advanced Queries
+
+You can use Regex in your metrics. The spirit behind this feature is to gather information about exceptions only, always aiming for a zero exception policy. So I'll advise against using it for other purposes.
+
+**How it works**
+1. It will understand that is a regex only when the metric name contains '/'. In the bash you'll need to include your metric inside double quotes.
+2. It will compare the number of metrics gathered today vs the number of metrics gathered yesterday.
+3. If today we read more than yesterday, it will blow up as **Critical**.
+4. If today we read the same number of metrics than yesterday, at the moment it will compare only the first one.
+I'll not rely on this tool (yet) for a deep analysis of differences when comparing multiple metrics (such as exceptions) using Regex.
+```
+ruby check-influxdb-metrics.rb --host=metrics-influxdb.internal.com --port=8086 --user=admin --password=password -c -20 -w -10 --db=statsd_metrics --metric="/^prefix.datacenter.([A-Za-z0-9-]+).([A-Za-z0-9-]+).exceptions$/"
+
+```
+
+
 ## Lessons learnt
 The InfluxDb query language that we used is not the latest, you can find it here:
 

data/bin/check-influxdb-metrics.rb

@@ -90,7 +90,24 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
   end
 
   def base_query
-    "SELECT sum(\"value\") from \"#{config[:metric]}\" "
+    'SELECT sum("value") from '
+  end
+
+  def base_query_with_metricname
+    base_query + clean_quotes_when_regex
+  end
+
+  def clean_quotes_when_regex
+    metric = " \"#{config[:metric]}\""
+    clean_metric = ''
+    if metric.include?('/')
+      clean_metric = metric.tr '\"', ''
+      @is_using_regex = true
+    else
+      clean_metric = metric
+    end
+
+    clean_metric
   end
 
   def today_query_for_a_period
@@ -108,13 +125,20 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
   end
 
   def query_for_a_period(start_period, end_period)
-    query = base_query + ' WHERE time > now() - ' + end_period.to_s + 'm AND time < now() - ' + start_period.to_s + 'm'
+    query = base_query_with_metricname + ' WHERE time > now() - ' + end_period.to_s + 'm AND time < now() - ' + start_period.to_s + 'm'
     query + filter_by_environment_when_needed
   end
 
   def encode_parameters(parameters)
     encodedparams = Addressable::URI.escape(parameters)
-    "#{config[:db]}&q=" + encodedparams
+    # this is needed after encoding because Addressable will not encode +. So for ex: ([A-Za-z0-9-]+) will miss the + and with that it will not find the metrics
+    encode_for_regex = if @is_using_regex
+                         encodedparams.gsub! '+', '%2B'
+                       else
+                         encodedparams
+                       end
+
+    "#{config[:db]}&q=" + encode_for_regex
   end
 
   def yesterday_query_encoded
@@ -128,30 +152,108 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
   end
 
   def today_value
-    second_query = today_query_encoded
-    response_to_compare = request(second_query)
-    read_metrics(response_to_compare)
+    response = request(today_query_encoded)
+    metrics = parse_json(response)
+    @today_metric_count = validate_metrics_and_count(metrics)
+    value = if @today_metric_count > 0
+              series = read_series_from_metrics(metrics)
+              @today_metrics = store_metrics(series)
+              read_value_from_series(series)
+            end
+    value
   end
 
   def yesterday_value
-    query = yesterday_query_encoded
-    response = request(query)
-    read_metrics(response)
+    response = request(yesterday_query_encoded)
+    metrics = parse_json(response)
+    @yesterday_metric_count = validate_metrics_and_count(metrics)
+    value = if @today_metric_count > 0
+              series = read_series_from_metrics(metrics)
+              @yesterday_metrics = store_metrics(series)
+              read_value_from_series(series)
+            end
+    value
   end
 
-  def read_metrics(response)
-    metrics = JSON.parse(response.to_str)['results']
-    series = metrics[0]['series']
-    values = series[0]['values'][0][1]
+  def metric_bigger_than_zero?(metric)
+    metric > 0
+  end
 
-    if values.nil?
-      values = 0
+  def using_regex?(using_regex)
+    using_regex == true
+  end
+
+  def read_series_from_metrics(metrics)
+    metrics[0]['series']
+  end
+
+  def validate_metrics_and_count(metrics)
+    if metrics.empty? || metrics.nil? || metrics[0].nil? || metrics[0]['series'].nil? || metrics[0]['series'][0]['values'][0][1].nil?
+      0
+    else
+      metrics[0]['series'].count
+    end
+  end
+
+  def parse_json(response)
+    JSON.parse(response.to_str)['results']
+  end
+
+  def read_value_from_series(series)
+    if series.nil?
+      0
+    elsif series[0]['values'][0][1].nil?
+      0
+    else
+      values = series[0]['values'][0][1]
+      values.to_f
     end
+  end
 
-    values.to_f
+  def store_metrics(series)
+    regex_metrics = Hash.new {}
+    if series.nil? == false && series.count > 0
+      series.each do |values|
+        value = values['values'][0][1]
+        regex_metrics[values['name']] = value.to_f
+      end
+      regex_metrics
+    end
   end
 
-  def calculate_percentage_ofdifference(original, newnumber)
+  def display_metrics
+    puts 'Today metrics analysis: '
+    @today_metrics.each do |key, value|
+      puts 'For: ' + key + ' : ' + value.to_s
+    end
+  end
+
+  def difference_for_regex_and_notify
+    # different or more number of metrics for today could be a problem. Regex is designed to catch exceptions, so more exceptions -> alert
+    if @today_metric_count == 0 && @yesterday_metric_count == 0
+      ok 'no metrics found'
+    elsif @today_metric_count > @yesterday_metric_count
+      display_metrics
+      critical "For \"#{config[:metric]}\" more metrics were tracked today than yesterday. Check them out above"
+    elsif @today_metric_count == @yesterday_metric_count
+      compare_each_metric_in_regex
+    else
+      ok 'regex seems ok ' + @today_metric_count.to_s + ' metrics found today vs ' + @yesterday_metric_count.to_s + ' metrics found yesterday'
+    end
+  end
+
+  def compare_each_metric_in_regex
+    @today_metrics.each do |today_key, today_value|
+      @yesterday_metrics.each do |yesterday_key, yesterday_value|
+        if today_key.eql? yesterday_key
+          puts yesterday_value.to_s + ' vs ' + today_value.to_s + ' for ' + today_key
+          difference_for_standard_queries(today_value, yesterday_value)
+        end
+      end
+    end
+  end
+
+  def difference_between_two_metrics(original, newnumber)
     decrease = original - newnumber
     decrease.to_f / original.to_f * 100
   end
@@ -169,6 +271,7 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
   end
 
   def evaluate_percentage_and_notify(difference)
+    puts 'Difference of: ' + difference.round(4).to_s + ' %  for a period of ' + config[:period].to_s + 'm'
     if difference < config[:crit]
       critical "\"#{config[:metric]}\" difference is below allowed minimum of #{config[:crit]} %"
     elsif difference < config[:warn]
@@ -178,16 +281,39 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
     end
   end
 
-  def run
-    difference = calculate_percentage_ofdifference(today_value, yesterday_value)
-    puts 'Difference of: ' + difference.round(5).to_s + ' %  for a period of ' + config[:period].to_s + 'm'
+  def calculate_difference_and_display_result(today, yesterday)
+    difference = if @is_using_regex
+                   difference_for_regex_and_notify
+                 else
+                   difference_for_standard_queries(today, yesterday)
+                 end
+    difference
+  end
+
+  def difference_for_standard_queries(today, yesterday)
+    difference = difference_between_two_metrics(today, yesterday)
     evaluate_percentage_and_notify(difference)
+  end
+
+  def difference_in_metrics
+    today = today_value
+    yesterday = yesterday_value
+    if today.nil? && yesterday.nil?
+      puts 'No results coming from InfluxDB either for Today nor Yesterday. Please check your query or try again'
+    else
+      calculate_difference_and_display_result(today, yesterday)
+    end
+    exit
+  end
+
+  def run
+    difference_in_metrics
 
   rescue Errno::ECONNREFUSED => e
     critical 'InfluxDB is not responding' + e.message
   rescue RestClient::RequestTimeout
     critical 'InfluxDB Connection timed out'
   rescue StandardError => e
-    unknown 'An exception occurred:' + e.message
+    unknown 'An exception occurred: ' + e.message
   end
 end

data/lib/sensu-plugins-influxdb-metrics-checker/version.rb

@@ -2,7 +2,7 @@ module SensuPluginsInfluxDbMetricsChecker
   module Version
     MAJOR = 0
     MINOR = 3
-    PATCH = 2
+    PATCH = 4
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-influxdb-metrics-checker
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Juanjo Guerrero Cerezuela
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin