sensu-plugin 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a61eebfc31a5b1110afdbc0931b0f24fae2be0b6
-  data.tar.gz: c55bce147df126c8b799f788ccfceeac5b252e53
+  metadata.gz: 8747827e125aa55103dc20ba8217bffea6971346
+  data.tar.gz: 985836889272cfa6c86511c63c764c6fb1697b53
 SHA512:
-  metadata.gz: 25436cf2246717c5c24b9101878d8de2f107198db84744e8f7338445de53b3dc1032af7a2006766d403ac556f7e8cdbfd40f57d619e4dd6c69dd5f9a037c34c6
-  data.tar.gz: 24e159cf2077552ec1cf46e6e973126b533560ff497a9f0168c66dc4b8f89a1f334f0ccb1d1dd7672032b8bd89a7b18ea94b493c59acf680cc575a508bbda716
+  metadata.gz: c044b4e98fae26fb3e04973678d35813a91abfdf5fab1dd379d014e93dace786e43b39d79b9065e33e4054ba4954195e769bd0f31aff8eed3206f24b016a763a
+  data.tar.gz: 5b2d6108d52570617b9d1e2143b83e25ee9747f7e937417bfe0f5bbe8882b90b14da2e0476bf3777a15f98dc8d11734d3010ea0b197e9acbcb6dcc759f800044

data/lib/sensu-plugin.rb

@@ -1,6 +1,6 @@
 module Sensu
   module Plugin
-    VERSION = '2.3.0'.freeze
+    VERSION = '2.4.0'.freeze
     EXIT_CODES = {
       'OK'       => 0,
       'WARNING'  => 1,

data/lib/sensu-plugin/metric/cli.rb

@@ -4,103 +4,195 @@ require 'json'
 module Sensu
   module Plugin
     class Metric
-      class CLI
-        class JSON < Sensu::Plugin::CLI
-          def output(obj = nil)
-            if obj.is_a?(String) || obj.is_a?(Exception)
-              puts obj.to_s
-            elsif obj.is_a?(Hash)
-              obj['timestamp'] ||= Time.now.to_i
-              puts ::JSON.generate(obj)
-            end
+      class CLI < Sensu::Plugin::CLI
+        # Outputs metrics using raw json format
+        #
+        # @param obj [Hash] there is no strict expectation from the provided object
+        # @return [String] formated metric data
+        def to_json(obj = nil)
+          if obj.is_a?(String) || obj.is_a?(Exception)
+            puts obj.to_s
+          elsif obj.is_a?(Hash)
+            obj['timestamp'] ||= Time.now.to_i
+            puts ::JSON.generate(obj)
           end
         end
 
-        class Graphite < Sensu::Plugin::CLI
-          # Outputs metrics using the Statsd datagram format
-          #
-          # @param args [Array<String, Int>] list of arguments
-          # @note the argument order should be:
-          #   `metric_path`: Mandatory, name for the metric,
-          #   `value`: Mandatory, metric value
-          #   `timestamp`: Optional, unix timestamp, defaults to current time
-          # @return [String] formated metric data
+        # Outputs metrics using the Statsd datagram format
+        #
+        # @param args [Array<String, Int>] list of arguments
+        # @note the argument order should be:
+        #   `metric_path`: Mandatory, name for the metric,
+        #   `value`: Mandatory, metric value
+        #   `timestamp`: Optional, unix timestamp, defaults to current time
+        # @return [String] formated metric data
+        def to_graphite(*args)
+          return if args.join.empty?
+          if args[0].is_a?(Exception) || args[1].nil?
+            puts args[0].to_s
+          else
+            args[2] ||= Time.now.to_i
+            puts args[0..2].join("\s")
+          end
+        end
+
+        # Outputs metrics using the Statsd datagram format
+        #
+        # @param args [Array<String, Int>] list of arguments
+        # @note the argument order should be:
+        #   `metric_name`: Mandatory, name for the metric,
+        #   `value`: Mandatory, metric value
+        #   `type`: Optional, metric type- `c` for counter, `g` for gauge, `ms` for timer, `s` for set
+        # @return [String] formated metric data
+        def to_statsd(*args)
+          return if args.join.empty?
+          if args[0].is_a?(Exception) || args[1].nil?
+            puts args[0].to_s
+          else
+            type = args[2] || 'kv'
+            puts [args[0..1].join(':'), type].join('|')
+          end
+        end
+
+        # Outputs metrics using the DogStatsd datagram format
+        #
+        # @param args [Array<String, Int>] list of arguments
+        # @note the argument order should be:
+        #   `metric_name`: Mandatory, name for the metric,
+        #   `value`: Mandatory, metric value
+        #   `type`: Optional, metric type- `c` for counter, `g` for gauge, `ms` for timer, `h` for histogram, `s` for set
+        #   `tags`: Optional, a comma separated key:value string `tag1:value1,tag2:value2`
+        # @return [String] formated metric data
+        def to_dogstatsd(*args)
+          return if args.join.empty?
+          if args[0].is_a?(Exception) || args[1].nil?
+            puts args[0].to_s
+          else
+            type = args[2] || 'kv'
+            tags = args[3] ? "##{args[3]}" : nil
+            puts [args[0..1].join(':'), type, tags].compact.join('|')
+          end
+        end
+
+        # Outputs metrics using the InfluxDB line protocol format
+        #
+        # @param args [Array<String, Int>] list of arguments
+        # @note the argument order should be:
+        #   `measurement_name`: Mandatory, name for the InfluxDB measurement,
+        #   `fields`: Mandatory, either an integer or a comma separated key=value string `field1=value1,field2=value2`
+        #   `tags`: Optional, a comma separated key=value string `tag1=value1,tag2=value2`
+        #   `timestamp`: Optional, unix timestamp, defaults to current time
+        # @return [String] formated metric data
+        def to_influxdb(*args)
+          return if args.join.empty?
+          if args[0].is_a?(Exception) || args[1].nil?
+            puts args[0].to_s
+          else
+            fields = if args[1].is_a?(Integer)
+                       "value=#{args[1]}"
+                     else
+                       args[1]
+                     end
+            measurement = [args[0], args[2]].compact.join(',')
+            ts = args[3] || Time.now.to_i
+            puts [measurement, fields, ts].join(' ')
+          end
+        end
+
+        class JSON < Sensu::Plugin::Metric::CLI
           def output(*args)
-            return if args.empty?
-            if args[0].is_a?(Exception) || args[1].nil?
-              puts args[0].to_s
-            else
-              args[2] ||= Time.now.to_i
-              puts args[0..2].join("\s")
-            end
+            to_json(*args)
           end
         end
 
-        class Statsd < Sensu::Plugin::CLI
-          # Outputs metrics using the Statsd datagram format
-          #
-          # @param args [Array<String, Int>] list of arguments
-          # @note the argument order should be:
-          #   `metric_name`: Mandatory, name for the metric,
-          #   `value`: Mandatory, metric value
-          #   `type`: Optional, metric type- `c` for counter, `g` for gauge, `ms` for timer, `s` for set
-          # @return [String] formated metric data
+        class Graphite < Sensu::Plugin::Metric::CLI
           def output(*args)
-            return if args.empty?
-            if args[0].is_a?(Exception) || args[1].nil?
-              puts args[0].to_s
-            else
-              type = args[2] || 'kv'
-              puts [args[0..1].join(':'), type].join('|')
-            end
+            to_graphite(*args)
           end
         end
 
-        class Dogstatsd < Sensu::Plugin::CLI
-          # Outputs metrics using the DogStatsd datagram format
-          #
-          # @param args [Array<String, Int>] list of arguments
-          # @note the argument order should be:
-          #   `metric_name`: Mandatory, name for the metric,
-          #   `value`: Mandatory, metric value
-          #   `type`: Optional, metric type- `c` for counter, `g` for gauge, `ms` for timer, `h` for histogram, `s` for set
-          #   `tags`: Optional, a comma separated key:value string `tag1:value1,tag2:value2`
-          # @return [String] formated metric data
+        class Statsd < Sensu::Plugin::Metric::CLI
           def output(*args)
-            return if args.empty?
-            if args[0].is_a?(Exception) || args[1].nil?
-              puts args[0].to_s
-            else
-              type = args[2] || 'kv'
-              tags = args[3] ? "##{args[3]}" : nil
-              puts [args[0..1].join(':'), type, tags].compact.join('|')
-            end
+            to_statsd(*args)
           end
         end
 
-        class Influxdb < Sensu::Plugin::CLI
-          # Outputs metrics using the InfluxDB line protocol format
-          #
-          # @param args [Array<String, Int>] list of arguments
-          # @note the argument order should be:
-          #   `measurement_name`: Mandatory, name for the InfluxDB measurement,
-          #   `fields`: Mandatory, either an integer or a comma separated key=value string `field1=value1,field2=value2`
-          #   `tags`: Optional, a comma separated key=value string `tag1=value1,tag2=value2`
-          #   `timestamp`: Optional, unix timestamp, defaults to current time
-          # @return [String] formated metric data
+        class Dogstatsd < Sensu::Plugin::Metric::CLI
+          def output(*args)
+            to_dogstatsd(*args)
+          end
+        end
+
+        class Influxdb < Sensu::Plugin::Metric::CLI
           def output(*args)
-            return if args.empty?
-            if args[0].is_a?(Exception) || args[1].nil?
-              puts args[0].to_s
-            else
-              fields = if args[1].is_a?(Integer)
-                         "value=#{args[1]}"
-                       else
-                         args[1]
-                       end
-              measurement = [args[0], args[2]].compact.join(',')
-              ts = args[3] || Time.now.to_i
-              puts [measurement, fields, ts].join(' ')
+            to_influxdb(*args)
+          end
+        end
+
+        class Generic < Sensu::Plugin::Metric::CLI
+          option :metric_format,
+                 long: '--metric_format METRIC_FORMAT',
+                 in: ['json', 'graphite', 'statsd', 'dogstatsd', 'influxdb'],
+                 default: 'graphite'
+
+          # Outputs metrics using different metric formats
+          #
+          # @param metric [Hash] the metric hash with keys below
+          # @note the metric could have these fields:
+          #   `metric_name`: Mandatory, name for the metric,
+          #   `value`: Mandatory, metric value
+          #   `type`: Optional, metric type- `c` for counter, `g` for gauge, `ms` for timer, `h` for histogram, `s` for set
+          #   `tags`: Optional, a Hash that includes all tags
+          #   `timestamp`: Optional, unix timestamp, eventually defaults to output's timestamp handling
+          #   `graphite_metric_path`: Optional, `metric_name` will be used if not provided.
+          #   `statsd_metric_name`: Optional, `metric_name` will be used if not provided.
+          #   `statsd_type`: Optional.
+          #   `dogstatsd_metric_name`: Optional, `statsd_metric_name` or `metric_name` will be used if not provided.
+          #   `dogstatsd_type`: Optional, `statsd_type` will be used if not provided.
+          #   `influxdb_measurement`: Optional, class name will be used if not provided.
+          #   `influxdb_field_key`: Optional, the `metric_name` will be used if not provided.
+          # @return [String] formated metric data based on metric_format configuration.
+          def output(metric = {})
+            return if metric.nil? ||
+                      metric.empty? ||
+                      metric[:value].nil?
+
+            tags = metric[:tags] || []
+
+            case config[:metric_format]
+            when 'json'
+              return if metric[:value].nil?
+              json_obj = metric[:json_obj] || {
+                metric_name: metric[:metric_name],
+                value: metric[:value],
+                tags: tags
+              }
+              to_json json_obj
+            when 'graphite'
+              graphite_metric_path = metric[:graphite_metric_path] ||
+                                     metric[:metric_name]
+              to_graphite graphite_metric_path, metric[:value], metric[:timestamp]
+            when 'statsd'
+              statsd_metric_name = metric[:statsd_metric_name] ||
+                                   metric[:metric_name]
+              to_statsd statsd_metric_name, metric[:value], metric[:statsd_type]
+            when 'dogstatsd'
+              dogstatsd_metric_name = metric[:dogstatsd_metric_name] ||
+                                      metric[:statsd_metric_name] ||
+                                      metric[:metric_name]
+              dogstatsd_type = metric[:dogstatsd_type] || metric[:statsd_type]
+              dogstatsd_tags = tags.map { |k, v| "#{k}:#{v}" }.join(',')
+              to_dogstatsd dogstatsd_metric_name, metric[:value],
+                           dogstatsd_type, dogstatsd_tags
+            when 'influxdb'
+              influxdb_measurement = metric[:influxdb_measurement] ||
+                                     self.class.name
+              influxdb_field_key = metric[:influxdb_field_key] ||
+                                   metric[:metric_name]
+              influxdb_field = "#{influxdb_field_key}=#{metric[:value]}"
+              influxdb_tags = tags.map { |k, v| "#{k}=#{v}" }.join(',')
+              to_influxdb influxdb_measurement, influxdb_field,
+                          influxdb_tags, metric[:timestamp]
             end
           end
         end

data/test/external_metric_test.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
 require 'English'
+require 'json'
 
 class TestMetricExternal < MiniTest::Test
   include SensuPluginTestHelper
@@ -81,3 +82,54 @@ class TestInfluxdbMetricExternal < MiniTest::Test
     end
   end
 end
+
+class TestGenericMetricsExternal < MiniTest::Test
+  include SensuPluginTestHelper
+
+  def test_json
+    set_script 'external/generic-metrics --metric_format json'
+    lines = run_script.split("\n")
+    assert lines.size == 8
+    lines.each { |line| assert line.include? 'metric_name' }
+  end
+
+  def test_graphite
+    set_script 'external/generic-metrics --metric_format graphite'
+    lines = run_script.split("\n")
+    assert lines.size == 8
+    assert lines[1].include? 'metric.name 1'
+    assert lines[2].include? 'graphite.metric.path 2'
+  end
+
+  def test_statsd
+    set_script 'external/generic-metrics --metric_format statsd'
+    lines = run_script.split("\n")
+    assert lines.size == 8
+    assert lines[2].include? 'metric.name:2|kv'
+    assert lines[3].include? 'statsd.metric.name:3|s'
+    assert lines[4].include? 'metric.name:4|kv'
+    assert lines[5].include? 'statsd.metric.name:5|kv'
+  end
+
+  def test_dogstatsd
+    set_script 'external/generic-metrics --metric_format dogstatsd'
+    lines = run_script.split("\n")
+    assert lines.size == 8
+    assert lines[1].include? 'metric.name:1|kv|#env:prod,location:us-midwest'
+    assert lines[2].include? 'metric.name:2|kv|#'
+    assert lines[3].include? 'statsd.metric.name:3|s|#'
+    assert lines[4].include? 'statsd.metric.name:4|m|#'
+    assert lines[5].include? 'dogstatsd.metric.name:5|kv|#'
+  end
+
+  def test_influxdb
+    set_script 'external/generic-metrics --metric_format influxdb'
+    lines = run_script.split("\n")
+    assert lines.size == 8
+    assert lines[0].include? 'GenericTestMetric, metric.name=0 '
+    assert lines[1].include? 'GenericTestMetric,env=prod,location=us-midwest metric.name=1 '
+    assert lines[2].include? 'GenericTestMetric, metric.name=2 '
+    assert lines[6].include? 'influxdb.measurement, metric.name=6 '
+    assert lines[7].include? 'GenericTestMetric, influxdb.field=7 '
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugin
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Decklin Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Sensu Plugins