sensu-plugins-influxdb-metrics-checker 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe60799563f025075be685429026d01164be54a2
-  data.tar.gz: 4e1b65bedb39167ae07df9e8ac79f5248e12378e
+  metadata.gz: ae9964965f956ab4e09596bae8dcfd2e421ea560
+  data.tar.gz: dc833f54f35dac20514ab2d399527f49bc04f224
 SHA512:
-  metadata.gz: 0fbccdbcd99caa5d8a53ae28879faf6ec50753c9d593e2dea2e9024c30e297987b165669d4488924e7a313b5bb77958999afb51e4acd415891a18540fade14ce
-  data.tar.gz: 720e9cc1537a845dd63742aa7cdc8ef477de1d8d7d8bc21ae103adfd3221cb74ba8aa79c1d7fbba72798ee112a65666f5d4b58e23f58cb4867302449c76cb32a
+  metadata.gz: a7b2d9d1a0832147e9bec1ad820adacccffdc244053a6eca15d3fd02aae8ddf706681744b3d3a8cff8b79a37a35526429fdae460513b6d4f300fde25af99dc43
+  data.tar.gz: 53aa9bbda02dcbeafb580eb94f407f3f679392c4369a77615c85e59eb82993be8022b7f6546e33c5e15fd08df915fa0ab14c3dcd4f2b6897ced67fc94f17bd71

data/CHANGELOG.md

@@ -3,6 +3,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
+# [0.3.0] - 2016-11-21
+### Added
+- fourth release
+Added the possibility to tweak your queries by adding --period in your parameters.
+By default --period will be 10 minutes to work with previous versions
+
 # [0.2.1] - 2016-11-21
 ### Added
 - third release
@@ -21,4 +27,5 @@ 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...HEAD
+[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...HEAD

data/README.md

@@ -1,7 +1,7 @@
 # sensu-plugins-influxdb-metrics-checker
 
 [ ![Build Status](https://travis-ci.org/pliyosenpai/sensu-plugins-influxdb-metrics-checker.svg?branch=master)](https://travis-ci.org/pliyosenpai/sensu-plugins-influxdb-metrics-checker)
-[![Gem Version](https://badge.fury.io/rb/sensu-plugins-influxdb-metrics-checker.svg)](http://badge.fury.io/rb/sensu-plugins-influxdb-metrics-checker.svg)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-influxdb-metrics-checker.svg)](https://rubygems.org/gems/sensu-plugins-influxdb-metrics-checker)
 
 ## Background story
 As soon as we started using InfluxDB we were wondering how we could read a given metric, compare it to its previous days, evaluate the percentage of difference, and act according to it.
@@ -36,7 +36,13 @@ Once in Sensu:
 
 If you have a tag you can filter your metrics by doing, for example:
 ```
-ruby check-influxdb-metrics.rb --host=metrics-influxdb.service.veinternal.com --port=8086 --user=admin --password=password -c -20 -w -10 --db=statsd_metrics --metric=datareceivers.request.counter --tag=datacenter --filter=ci
+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
+
+```
+
+Also, 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
 
 ```
 

data/bin/check-influxdb-metrics.rb

@@ -79,32 +79,51 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
          long: '--filter=VALUE',
          description: 'Set the name of your filter, for example: `datacenter`'
 
-  def encode_parameters(parameters)
-    encodedparams = Addressable::URI.escape(parameters)
-    "#{config[:db]}&q=" + encodedparams
-  end
+  option :period,
+         long: '--period=VALUE',
+         description: 'Filter by a given day period in minutes',
+         proc: proc { |l| l.to_i },
+         default: 10
 
   def filter_by_environment_when_needed
     config[:tag].nil? && config[:filter].nil? ? '' : " AND \"#{config[:tag]}\" =~ /#{config[:filter]}/"
   end
 
-  def yesterday_query # Reads the value from 10 minutes before yesterday at this time.
-    query = "SELECT sum(\"value\") from \"#{config[:metric]}\" WHERE time > now() - 1455m AND time < now() - 1445m"
+  def base_query
+    "SELECT sum(\"value\") from \"#{config[:metric]}\" "
+  end
+
+  def today_query_for_a_period
+    start_period = 5; # starts counting 5 minutes before now() to let influxdb time to aggregate the data
+    end_period = config[:period] + 5; # adds 5 minutes to match with start_period
+    query = query_for_a_period(start_period, end_period)
+    query + filter_by_environment_when_needed
+  end
+
+  def yesterday_query_for_a_period
+    start_period = 1445; # starts counting 1445 minutes before now() [ yesetrday - 5 minutes] to match with today_query_for_a_period start_period
+    end_period = config[:period] + 1445; # adds 1445 minutes to match with start_period
+    query = query_for_a_period(start_period, end_period)
     query + filter_by_environment_when_needed
   end
 
-  def today_query
-    query = "SELECT sum(\"value\") from \"#{config[:metric]}\" WHERE time > now() - 15m AND time < now() - 5m"
+  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 + filter_by_environment_when_needed
   end
 
+  def encode_parameters(parameters)
+    encodedparams = Addressable::URI.escape(parameters)
+    "#{config[:db]}&q=" + encodedparams
+  end
+
   def yesterday_query_encoded
-    query = yesterday_query
+    query = yesterday_query_for_a_period
     encode_parameters(query)
   end
 
   def today_query_encoded
-    query = today_query
+    query = today_query_for_a_period
     encode_parameters(query)
   end
 
@@ -161,7 +180,7 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
 
   def run
     difference = calculate_percentage_ofdifference(today_value, yesterday_value)
-    puts difference
+    puts 'Difference of: ' + difference.to_s + ' %   for a period of ' + config[:period].to_s + 'm'
     evaluate_percentage_and_notify(difference)
 
   rescue Errno::ECONNREFUSED => e
@@ -169,6 +188,6 @@ class CheckInfluxDbMetrics < Sensu::Plugin::Check::CLI
   rescue RestClient::RequestTimeout
     critical 'InfluxDB Connection timed out'
   rescue StandardError => e
-    unknown 'An exception occurred:' + e.message + e.stacktrace
+    unknown 'An exception occurred:' + e.message
   end
 end

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

@@ -1,8 +1,8 @@
 module SensuPluginsInfluxDbMetricsChecker
   module Version
     MAJOR = 0
-    MINOR = 2
-    PATCH = 1
+    MINOR = 3
+    PATCH = 0
 
     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.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Juanjo Guerrero Cerezuela
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -198,7 +198,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.1
-description: This plugin retrieves metrics and evaluate them. Aiming to track downsides.
+description: This plugin retrieves metrics and evaluate them. Aiming to track outages.
 email: "<pliyosan@gmail.com>"
 executables:
 - check-influxdb-metrics.rb