sensu-plugins-outlyer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 365da328847c25dfa74e89ed2a70c06722d1412a
-  data.tar.gz: 54d8abc05c44b0c698286db38c26da254bf85c86
+  metadata.gz: 06fefcec9b4ad9d5c308b13f85f547b0bd4b8b53
+  data.tar.gz: e2b9db23d1252b2eeb1874eb3fd13a5c5290af91
 SHA512:
-  metadata.gz: db2bc31a8f84243a8ed3871296678743f303bc18950a9b1ffe6cd071e8a18c101d2411166c9fbc88cccac13e92478aa1958de5a477ef3085131e1186e3bbbb76
-  data.tar.gz: 65193231c64a67b0cf57352057bc8728ec2be48acf1a33ced0f1650b0bfcd65e20c2e6cb5b9d0d5a916095acf94ae6f9064e8dcfd61c0780d1b8277f247efef7
+  metadata.gz: 2219ff7def5ba400bac2ed178d395ce94d786b95b3dc2102a5a86f5ae7c4c440fc0bfa7476ae663597425cea75f46ddd0d852b3c46804fa13555f8063be44da4
+  data.tar.gz: 680a766582636eaf7b826bc8b7eccee35967b66c99ac98804cd9da1a5d039d6c247c740d67eb29e50cd7956a52419a4a75095fbefb9d31ac6f77bce001917113

data/CHANGELOG.md

@@ -3,10 +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.0 - 2018-07-13
-### Added
+## [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
+- Added debug option
+
+## [0.3.0] - 2018-07-13
 - Better logging
 
-## 0.1.0 - 2018-07-12
-### Added
+## [0.1.0] - 2018-07-12
 - initial release

data/README.md

@@ -1,113 +1,47 @@
-Outlyer Sensu Handler Integration
-=================================
+# Sensu Outlyer Handler Plugin
 
-== Description ==
+This readme includes development instructions for building, packaging and testing the Sensu plugin in Ruby.
 
-This integration provides instructions to install and use the Outlyer Sensu Handler Integration
-to push all your check event metrics and check status's from Sensu checks into Outlyer. It supports
-both Nagios checks and Graphite Metric check outputs from Sensu.
+## Packaging and Publishing
 
-Once installed and enabled you should see all your check metrics and check status's in Outlyer to
-use on custom dashboards and alerts.
-
-== Metrics Collected ==
-
-The Sensu integration will push any metric collected by your Sensu checks with metric
-names namespaced to the check name as follows:
+First build the gem:
 
 ```
-<check_name>.<metric_name>
+gem build sensu-plugins-outlyer.gemspec
 ```
 
-In addition the status code of each check is sent as the `service.status` metric
-to Outlyer with the label `service: <check_name>`. You will be able to use this
-metric to configure dashboad status widgets and service check alerts in Outlyer.
-
-For Nagios checks, the timestamp of when the check was executed is used for all the
-metric data points. For Graphite metric checks the timestamp of each metric data
-point is used, apart from the service.status which uses the check execution time
-like Nagios checks.
-
-== Installation ==
-
-Firstly install the Outlyer Sensu plugin on your Sensu machine(s) using the following
-command:
+Then publish the sensu-plugins-outlyer gem to the Outlyer account on the RubyGems server 
+using the following command:
 
 ```bash
-sensu-install -p outlyer
+gem push sensu-plugins-outlyer-<version_number>.gem
 ```
 
-Next, we’ll enable the handlers by adding it to `/etc/sensu/conf.d/outlyer-handlers.json`:
-
-```json
-{
-  "handlers": {
-    "outlyer-graphite": {
-       "type": "pipe",
-       "command": "/opt/sensu/embedded/bin/outlyer-metrics.rb"
-    },
-    "outlyer-nagios": {
-       "type": "pipe",
-       "command": "/opt/sensu/embedded/bin/outlyer-metrics.rb -f nagios"
-    }
-  }
-}
-```
-
-Two handlers have been configured, one for your Nagios checks `outlyer-nagios` and
-one for your Graphite metric checks `outlyer-graphite`. You can refer to these handlers
-in your check configurations to ensure they are handled by the Outlyer handler with
-the correct check output parsing. 
-
-You can also add the optional `-t` parameter to the handler command to change the default
-timeout for Outlyer API requests from 5 seconds. This is useful if you notice the handler
-timing out as your checks send more metrics creating larger payloads.
+## Testing
 
-Finally add your Outlyer API configuration at `/etc/sensu/conf.d/outlyer.json`:
+First copy the example config file under `test/test-config.json` to a path outside your 
+project and set the account and your API key in the new file. Then set the path to your 
+handler configuration file with your API details as an environment variable:
 
-```json
-{
-    "outlyer": {
-       "api_key": "<API_KEY>",
-       "account": "<ACCOUNT_NAME>" 
-    }
-}
+```bash
+export SENSU_CONFIG_FILES='/Users/dgildeh/Development/Outlyer/sensu-config.json'
 ```
 
-Where:
-
-* **api_key**: Your user's API key generated under user settings
-* **account**: The unique account name of the account you want to push metrics too (you will see this in the URL when using the app)
-
-Finally restart your Sensu server so the new handler is enabled:
+Then you can use the following command to test the handler with example Nagios
+output data using the following command:
 
 ```bash
-systemctl restart sensu-{server,api}
+cat ./test/test-nagios-data.json | ruby ./bin/outlyer-metrics.rb -f nagios
 ```
-
-You will need to add the handler to all the checks you want metrics sent to Outlyer for by adding
-`outlyer-nagios` or `outlyer-graphite` to your check handlers configuration as appropriate. Once
-your checks have been configured to use the Outlyer handler you should start seeing all your
-metrics from your configured Sensu checks appearing in Outlyer shortly afterwards.
-
-Also ensure any Sensu checks that send metrics have type `metric` otherwise the output will not
-be processed everytime the check runs.
-
-Please read the Metrics Collected section of this guide to understand how your check metrics
-are sent to Outlyer.
-
-## Troubleshooting
-
-If you don't see metrics appearing in Outlyer after enabling the handlers and checks 
-you should use the following command to view the Sensu server logs to see if any
-errors are being output by the hander:
+For Graphite metric test:
 
 ```bash
-tail -f /var/log/sensu/sensu-server.log | grep outlyer
+cat ./test/test-graphite-data.json | ruby ./bin/outlyer-metrics.rb
 ```
 
-== Changelog ==
+Note you will have to override the check timestamp to the current time so your
+metrics will appear in Outlyer using the test above:
 
-|Version|Release Date|Description                                          |
-|-------|------------|-----------------------------------------------------|
-|1.0    |12-Jul-2018 |Initial version of the Outlyer Sensu Handler.        |
+```ruby
+timestamp =  Time.now.to_i * 1000
+```

data/bin/outlyer-metrics.rb

@@ -51,6 +51,12 @@ class OutlyerMetrics < Sensu::Handler
          short: '-t TIMEOUT',
          long: '--timeout TIMEOUT',
          default: '5'
+       
+  option :debug,
+       description: 'Enable debug for more verbose output',
+       short: '-d DEBUG',
+       long: '--debug DEBUG',
+       default: 'false'
   
   # Override filters from Sensu::Handler.
   # They are not appropriate for metric handlers
@@ -62,16 +68,22 @@ class OutlyerMetrics < Sensu::Handler
   #
   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']
-    @host = @event['client']['name']
+    @host = @event['client']['name'].strip.to_s
     @environment = @event['client']['environment']
+    if @environment.kind_of?(Array)
+      # environment can be an array, so merge values with hyphens
+      @environment = @environment.join("-")
+    end
     timestamp = @event['check']['executed'].to_i * 1000
     
-    # Uncomment this line for local testing outside Sensu
-    #@settings = { "outlyer" => {"account" => "", "api_key" => ""}}
-
     # Parse output for metric data
     metrics = if config[:output_format] == 'nagios' then
              parse_nagios_output(output, timestamp)
@@ -80,7 +92,7 @@ class OutlyerMetrics < Sensu::Handler
           end 
     
     # Add a service status metric
-    metrics.push(create_datapoint('service.status', check_status, timestamp, {service: "sensu.#{@check_name}"}))
+    metrics.push(create_datapoint('service.status', check_status, timestamp, {service: "sensu.#{sanitize_value(@check_name)}"}))
     # Post metrics to Outlyer
     push_metrics(metrics)
   end
@@ -127,10 +139,11 @@ class OutlyerMetrics < Sensu::Handler
       begin
         name = metric_parts[0]
         value = metric_parts[1].split(";")[0].to_f
-        data.push(create_datapoint(@check_name + '.' + name, value, timestamp))
+        labels = {service: "sensu.#{sanitize_value(@check_name)}"}
+        data.push(create_datapoint(name, value, timestamp, labels))
       rescue => error
         # Raised when any metrics could not be parsed
-        puts "[OutlyerHandler] The Nagios metric '#{metric}' could not be parsed: #{error.message}"
+        puts "The Nagios metric '#{metric}' could not be parsed: #{error.message}"
       end 
     end
     data
@@ -145,17 +158,71 @@ class OutlyerMetrics < Sensu::Handler
   #
   def parse_graphite_output(output)
     data = []
+    
+    # Get Scheme to parse Graphite metrics if exists
+    scheme = nil
+    if settings['outlyer'].key?('schemes') && settings['outlyer']['schemes'] != nil
+      if settings['outlyer']['schemes'].key?(@check_name)
+        scheme = settings['outlyer']['schemes'][@check_name]
+      else
+        # Get default scheme if check specific scheme not defined
+        scheme = settings['outlyer']['schemes']['default']
+      end
+    end
+    
+    # Parse the metric on each line in graphite format
     output.split("\n").each do |metric|
       m = metric.split
       next unless m.count == 3
-      name = m[0].split('.', 2)[1]
+      # Get name and extract labels - we remove hostname if in metric name
+      # as it contains dots and breaks parsing
+      metric_parts = m[0].gsub("#{@host}", 'host').split('.')     
+      labels = {service: "sensu.#{sanitize_value(@check_name)}"}
+      if scheme
+        metric_name = metric_parts.last(scheme['metric_name_length'].to_i).join('.')
+        # 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]"
+          return []
+        end
+        schema_parts.each_with_index do |val,index|
+          if val != 'host' && val != 'hostname' && val != 'name'
+            labels.merge!(Hash[sanitize_value(val, 40),sanitize_value(metric_parts[index])])
+          end
+        end
+      else
+        metric_name = sanitize_value(metric_parts.join('.'))
+      end
       value = m[1].to_f
-      time = m[2].to_i * 1000
-      point = create_datapoint(@check_name + '.' + name, value, time)
+      time = Time.now.to_i * 1000
+      point = create_datapoint(metric_name, value, time, labels)
       data.push(point)
     end
     data
   end
+  
+  # Ensures all label values conform to Outlyer's data format requirements:
+  #   
+  #   * values can only contain the characters `-._A-Za-z0-9`, other characters 
+  #     will be replaced by underscore including spaces
+  #   * values can only be 80 characters or less
+  #
+  # @param value      [String] The value to sanitize
+  # @param max_length [Integer] The maximum length of string, default 80
+  #
+  def sanitize_value(value, max_length = 80)
+    if !value
+      return ''
+    end
+    value = value.gsub(/[^-._A-Za-z0-9]/i, '_').downcase
+    if value.length > max_length
+      puts "Warning: value '#{value}' is greater than 80 characters and will be truncated to last 80 characters"
+      value = value.split(//).last(max_length).join
+    end
+    value
+  end
 
   # Post check metrics to Outlyer's Series API:
   #   
@@ -166,7 +233,7 @@ class OutlyerMetrics < Sensu::Handler
   def push_metrics(datapoints)
     Timeout.timeout(config[:api_timeout].to_i) do
       uri = URI.parse("https://api2.outlyer.com/v2/accounts/#{settings['outlyer']['account']}/series")
-
+      
       # Create the HTTP objects
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -176,13 +243,17 @@ class OutlyerMetrics < Sensu::Handler
       request.add_field("accept", "application/json") 
       request.add_field("Content-Type", "application/json")
       request.body = {samples: datapoints}.to_json
-
+      
+      if @debug
+        puts "DEBUG: Outlyer API Payload: #{request.body}"
+      end
+      
       # Send the request
       response = http.request(request)
       if response.code.to_i != 200
-        puts "[OutlyerHandler] Outlyer API Error -- API responded with status code #{response.code}"
-        puts "[OutlyerHandler] Outlyer API Response: #{response.body}"
-        puts "[OutlyerHandler] Outlyer API Request Body: #{request.body}"
+        puts "Outlyer API Error -- API responded with status code #{response.code}"
+        puts "Outlyer API Response: #{response.body}"
+        puts "Outlyer API Request Body: #{request.body}"
         return
       end
       puts "Successfully pushed #{datapoints.length} metrics to Outlyer"
@@ -190,9 +261,9 @@ class OutlyerMetrics < Sensu::Handler
   # Raised when any metrics could not be sent
   #
   rescue Timeout::Error
-    puts '[OutlyerHandler] Outlyer API Error -- timed out while sending metrics'
+    puts 'Outlyer API Error -- timed out while sending metrics'
   rescue => error
-    puts "[OutlyerHandler] Outlyer API Error -- failed to send metrics: #{error.message}"
+    puts "Outlyer API Error -- failed to send metrics: #{error.message}"
     puts " #{error.backtrace.join("\n\t")}"
   end
 end

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

@@ -1,7 +1,7 @@
 module SensuPluginsOutlyer
   module Version
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dataloop Software, INC. Trading as Outlyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin