sensu-plugins-outlyer 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c1c2455d4122918ce986502ba90d6305f5d36edd67d4d98168183d596947f6
-  data.tar.gz: d7bdb065ab7a39cc84cc5b565450aa3df401bcce8cda35cf8a158b6c76a8de0c
+  metadata.gz: a52cd273a16bb979d729d59b18b362fea57a28e2735b66b3a4b85cf210d8d4da
+  data.tar.gz: 57bbeafe4ee42dd5cdd9eebb8ce32382e10270b10cb8d048f3d967159d3851dd
 SHA512:
-  metadata.gz: a61588c67195ff17deedc7a6d8c2c67696c76e68f867984fd4518bfbfe26729cc903b66883d198578b3dbc7012b060c0e56d532e7e3be19ee77b9cbba6f60a5a
-  data.tar.gz: b1b4f5348d643858473e4e9ad11fa21aa25aaf9d8b0a0706e34b316c403ebfe75b34976ab60b852707ba1fc32ff93abfc11a501534f8c12864cc2feb2b90333b
+  metadata.gz: 9bcb06a1122343f198587265b870a38c1518a1cb52590f59c8f577fd97bfdd65fed132616e5ea8535d9f9086e4ab10add59e90ac4972e77d38092f138ee851da
+  data.tar.gz: d7ff052d31f96d246b5ba5d09f03df74797c30c76172176939a740abc5b4cf30f61eef459bff0e8ae32d479096fe600df6505fbf009ece055f7f829e6b8097de

data/CHANGELOG.md

@@ -3,10 +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
+## [0.6.0] - 2018-07-16
 - Made debug flag boolean
 - Added additional debug logging for troubleshooting
 - Added Unit Tests
+- Added new Graphite parsing method with filters
 
 ## [0.4.0] - 2018-07-13
 - Added handling for client environments set as array of values

data/bin/outlyer-metrics.rb

@@ -75,10 +75,6 @@ class OutlyerMetrics < Sensu::Handler
     @check_name = @event['check']['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
     
     if config[:debug]
@@ -91,7 +87,7 @@ class OutlyerMetrics < Sensu::Handler
           else
              parse_graphite_output(output)
           end 
-    
+      
     # Add a service status metric
     metrics.push(create_datapoint('service.status', check_status, timestamp, {service: "sensu.#{sanitize_value(@check_name)}"}))
     # Post metrics to Outlyer
@@ -100,23 +96,21 @@ class OutlyerMetrics < Sensu::Handler
   
   # Create a single data point
   #
-  # @param name     [String] metric name
-  # @param value    [Float] metric value
-  # @param time     [Integer] epoch timestamp of metric in milliseconds
-  # @param labels   [HashMap] (Optional) Additional labels to append to data point
+  # @param name         [String] metric name
+  # @param value        [Float] metric value
+  # @param time         [Integer] epoch timestamp of metric in milliseconds
+  # @param labels       [HashMap] (Optional) Additional labels to append to data point
+  # @param metric_host  [String] (Optional) Set a host for the metric
   #
-  def create_datapoint(name, value, time, labels = nil)
+  def create_datapoint(name, value, time, labels = {}, metric_host=@host)
     datapoint = {
-                  host: @host,
-                  labels: {
-                            environment: @environment,
-                          },
+                  host: metric_host,
+                  labels: labels,
                   name: name,
                   timestamp: time,
                   type: 'gauge',
                   value: value
                 }
-    datapoint[:labels].merge!(labels) unless labels.nil?
     datapoint
   end
 
@@ -160,49 +154,77 @@ class OutlyerMetrics < Sensu::Handler
   def parse_graphite_output(output)
     data = []
     
-    # Get Scheme to parse Graphite metrics if exists
-    scheme = nil
+    # Get Schemes to parse Graphite metrics if exists
+    schemes = 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
+        schemes = settings['outlyer']['schemes']
     end
     
     # Parse the metric on each line in graphite format
     output.split("\n").each do |metric|
       m = metric.split
       next unless m.count == 3
-      # 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 "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)}"
+        labels = {service: "sensu.#{sanitize_value(@check_name)}"}
+        metric_host = @host
+        
+        # Check to see if we have a scheme filter that matches the metric name
+        template = nil
+        if schemes
+          schemes.each do |scheme|
+            filter = Regexp.new("^#{Regexp.escape(scheme['filter']).gsub('\*','[^\.]*?')}$")
+            if m[0] =~ filter
+              template = scheme['template']
+              if config[:debug]
+                puts "Template Found: '#{template}' with REGEX '#{filter.inspect}'"
+              end
+              break
+            end
           end
-          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])])
+          
+          # Found a template to parse metric
+          if template
+            metric_parts = m[0].split('.')
+            template_parts = template.split('.')
+            
+            # Iterate through the template to parse the metric labels
+            template_parts.each_with_index do |val,index|
+              key = sanitize_value(val, 40)
+              value = sanitize_value(metric_parts[index])
+              if labels.key?(key)
+                # If value is spread over multiple parts re-append the value
+                labels[key] += ".#{value}"
+              else
+                labels.merge!(Hash[key,value])
+              end
+            end
+            
+            # Now we have all the labels extracted, need to ensure a
+            # name was given and optional host
+            if labels.key?('name')
+              metric_name = labels['name']
+              labels.delete('name')
+            end
+            if labels.key?('host')
+              metric_host = labels['host']
+              labels.delete('host')
+            end
+            
+          else
+            # If no template found, ignore metric and put warning in handler
+            # this avoids un-configured checks sending bad data to Outlyer
+            puts "No scheme was found that matches the metric '#{m[0]}.'"
+            puts "Please configure a scheme for the check '#{@check_name}' "\
+              "on the Sensu client '#{@host}'."
+            exit(2)
+            metric_name = sanitize_value(m[0])
           end
+        else
+          metric_name = sanitize_value(m[0])
         end
-      else
-        metric_name = sanitize_value(metric_parts.join('.'))
-      end
+        
       value = m[1].to_f
       time = m[2].to_i * 1000
-      point = create_datapoint(metric_name, value, time, labels)
+      point = create_datapoint(metric_name, value, time, labels, metric_host)
       data.push(point)
     end
     data

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-outlyer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Dataloop Software, INC. Trading as Outlyer