sensu-plugins-outlyer 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06fefcec9b4ad9d5c308b13f85f547b0bd4b8b53
-  data.tar.gz: e2b9db23d1252b2eeb1874eb3fd13a5c5290af91
+SHA256:
+  metadata.gz: 46c1c2455d4122918ce986502ba90d6305f5d36edd67d4d98168183d596947f6
+  data.tar.gz: d7bdb065ab7a39cc84cc5b565450aa3df401bcce8cda35cf8a158b6c76a8de0c
 SHA512:
-  metadata.gz: 2219ff7def5ba400bac2ed178d395ce94d786b95b3dc2102a5a86f5ae7c4c440fc0bfa7476ae663597425cea75f46ddd0d852b3c46804fa13555f8063be44da4
-  data.tar.gz: 680a766582636eaf7b826bc8b7eccee35967b66c99ac98804cd9da1a5d039d6c247c740d67eb29e50cd7956a52419a4a75095fbefb9d31ac6f77bce001917113
+  metadata.gz: a61588c67195ff17deedc7a6d8c2c67696c76e68f867984fd4518bfbfe26729cc903b66883d198578b3dbc7012b060c0e56d532e7e3be19ee77b9cbba6f60a5a
+  data.tar.gz: b1b4f5348d643858473e4e9ad11fa21aa25aaf9d8b0a0706e34b316c403ebfe75b34976ab60b852707ba1fc32ff93abfc11a501534f8c12864cc2feb2b90333b

data/CHANGELOG.md

@@ -3,6 +3,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
+## [0.5.0] - 2018-07-16
+- Made debug flag boolean
+- Added additional debug logging for troubleshooting
+- Added Unit Tests
+
 ## [0.4.0] - 2018-07-13
 - Added handling for client environments set as array of values
 - Added schemas so graphite metric names can be parsed into dimensional metrics

data/README.md

@@ -27,21 +27,14 @@ handler configuration file with your API details as an environment variable:
 export SENSU_CONFIG_FILES='/Users/dgildeh/Development/Outlyer/sensu-config.json'
 ```
 
-Then you can use the following command to test the handler with example Nagios
-output data using the following command:
+Ensure your handler has execution permissions set:
 
 ```bash
-cat ./test/test-nagios-data.json | ruby ./bin/outlyer-metrics.rb -f nagios
+chmod +x ./bin/outlyer-metrics.rb
 ```
-For Graphite metric test:
+
+The run the unit tests:
 
 ```bash
-cat ./test/test-graphite-data.json | ruby ./bin/outlyer-metrics.rb
+ruby test/test_outlyer_handler.rb 
 ```
-
-Note you will have to override the check timestamp to the current time so your
-metrics will appear in Outlyer using the test above:
-
-```ruby
-timestamp =  Time.now.to_i * 1000
-```

data/bin/outlyer-metrics.rb

@@ -22,6 +22,7 @@
 #   
 #     -f: set the Handler's check output format to parse. Can either be `graphite` (default) or `nagios`.
 #     -t: Set the timeout in seconds for the Outlyer API requests
+#     -d: Enable debugging to see additional logging in Output
 #   
 # NOTES:
 #
@@ -53,10 +54,11 @@ class OutlyerMetrics < Sensu::Handler
          default: '5'
        
   option :debug,
-       description: 'Enable debug for more verbose output',
-       short: '-d DEBUG',
-       long: '--debug DEBUG',
-       default: 'false'
+         description: 'Enable debug for more verbose output',
+         boolean: true,
+         short: '-d',
+         long: '--debug', 
+         default: false
   
   # Override filters from Sensu::Handler.
   # They are not appropriate for metric handlers
@@ -67,12 +69,7 @@ class OutlyerMetrics < Sensu::Handler
   # Create a handle and event set
   #
   def handle
-    
-    @debug = false
-    if config[:debug] == 'true'
-      @debug = true
-    end
-    
+
     output = @event['check']['output']
     check_status = @event['check']['status'].to_f
     @check_name = @event['check']['name']
@@ -84,6 +81,10 @@ class OutlyerMetrics < Sensu::Handler
     end
     timestamp = @event['check']['executed'].to_i * 1000
     
+    if config[:debug]
+      puts "Handling check #{@check_name} for host #{@host} in environment #{@environment}"
+    end
+    
     # Parse output for metric data
     metrics = if config[:output_format] == 'nagios' then
              parse_nagios_output(output, timestamp)
@@ -183,8 +184,12 @@ class OutlyerMetrics < Sensu::Handler
         # Get dimensions from metric name
         schema_parts = scheme['scheme'].split('.')
         if (metric_parts.length - scheme['metric_name_length'].to_i) != schema_parts.length
-          puts "Schema Parsing Error: metric parts (#{metric_parts.length - scheme['metric_name_length'].to_i}) is not same length as schema (#{schema_parts.length})"
-          puts "Example metric: m[0]"
+          puts "Scheme Parsing Error: metric parts (#{metric_parts.length - scheme['metric_name_length'].to_i}) is not same length as schema (#{schema_parts.length})"
+          puts "Scheme: #{scheme['scheme']}"
+          puts "Example metric: #{m[0]}"
+          if config[:debug]
+            puts "Event Data: \n#{JSON.pretty_generate(@event)}"
+          end
           return []
         end
         schema_parts.each_with_index do |val,index|
@@ -196,7 +201,7 @@ class OutlyerMetrics < Sensu::Handler
         metric_name = sanitize_value(metric_parts.join('.'))
       end
       value = m[1].to_f
-      time = Time.now.to_i * 1000
+      time = m[2].to_i * 1000
       point = create_datapoint(metric_name, value, time, labels)
       data.push(point)
     end
@@ -242,9 +247,9 @@ class OutlyerMetrics < Sensu::Handler
       request.add_field("Authorization", "Bearer #{settings['outlyer']['api_key']}")
       request.add_field("accept", "application/json") 
       request.add_field("Content-Type", "application/json")
-      request.body = {samples: datapoints}.to_json
+      request.body = JSON.pretty_generate({samples: datapoints})
       
-      if @debug
+      if config[:debug]
         puts "DEBUG: Outlyer API Payload: #{request.body}"
       end
       
@@ -262,8 +267,13 @@ class OutlyerMetrics < Sensu::Handler
   #
   rescue Timeout::Error
     puts 'Outlyer API Error -- timed out while sending metrics'
+    exit(2)
   rescue => error
     puts "Outlyer API Error -- failed to send metrics: #{error.message}"
     puts " #{error.backtrace.join("\n\t")}"
+    if config[:debug]
+      puts "Event Data: \n#{JSON.pretty_generate(@event)}"
+    end
+    exit(2)
   end
 end

data/lib/sensu-plugins-outlyer/version.rb

@@ -1,7 +1,7 @@
 module SensuPluginsOutlyer
   module Version
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-outlyer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dataloop Software, INC. Trading as Outlyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-15 00:00:00.000000000 Z
+date: 2018-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -189,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for Outlyer