sensu-plugin 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5779d44ecb71e0614dc179fb8ba0db3cd39a3111
-  data.tar.gz: 10795a0823625575f4b1638984a603a65e406eb6
+  metadata.gz: a61eebfc31a5b1110afdbc0931b0f24fae2be0b6
+  data.tar.gz: c55bce147df126c8b799f788ccfceeac5b252e53
 SHA512:
-  metadata.gz: b00f35a4eb526215f5c1f13f3732ebb35519491176be7a87495d30279389d4d72b843c1004312fface38633bb5a6d20c9dabb135f99c309a90d3e417ce68d7fc
-  data.tar.gz: 37d95a80143a85142c43b25d7b5651abc71a5fbc6832ee8e2c8350ef443ae8bec75dede44b76541c37082cd24e2b8a30074cfebd4c2dafa16f2387f3ebd5d759
+  metadata.gz: 25436cf2246717c5c24b9101878d8de2f107198db84744e8f7338445de53b3dc1032af7a2006766d403ac556f7e8cdbfd40f57d619e4dd6c69dd5f9a037c34c6
+  data.tar.gz: 24e159cf2077552ec1cf46e6e973126b533560ff497a9f0168c66dc4b8f89a1f334f0ccb1d1dd7672032b8bd89a7b18ea94b493c59acf680cc575a508bbda716

data/lib/sensu-plugin.rb

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

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

@@ -17,6 +17,14 @@ module Sensu
         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
           def output(*args)
             return if args.empty?
             if args[0].is_a?(Exception) || args[1].nil?
@@ -29,7 +37,16 @@ module Sensu
         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
           def output(*args)
+            return if args.empty?
             if args[0].is_a?(Exception) || args[1].nil?
               puts args[0].to_s
             else
@@ -38,6 +55,55 @@ module Sensu
             end
           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
+          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
+          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
+          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(' ')
+            end
+          end
+        end
       end
     end
   end

data/test/external_metric_test.rb

@@ -23,7 +23,10 @@ class TestGraphiteMetricExternal < MiniTest::Test
 
   def test_multi
     lines = run_script.split("\n")
-    assert lines.size == 2 && lines.all? { |line| line.split("\s").size == 3 }
+    assert lines.size == 2
+    lines.each do |line|
+      assert line.split("\s").size == 3
+    end
   end
 end
 
@@ -43,3 +46,38 @@ class TestStatsdMetricExternal < MiniTest::Test
     end
   end
 end
+
+class TestDogstatsdMetricExternal < MiniTest::Test
+  include SensuPluginTestHelper
+
+  def setup
+    set_script 'external/dogstatsd-output'
+  end
+
+  def test_dogstatsd
+    lines = run_script.split("\n")
+    assert lines.size == 2
+    assert lines.last.split('|').last.split(',').size == 2
+    lines.each do |line|
+      assert line.split('|').size >= 2
+      assert line.split('|').first.split(':').size == 2
+    end
+  end
+end
+
+class TestInfluxdbMetricExternal < MiniTest::Test
+  include SensuPluginTestHelper
+
+  def setup
+    set_script 'external/influxdb-output'
+  end
+
+  def test_dogstatsd
+    lines = run_script.split("\n")
+    assert lines.size == 3
+    lines.each do |line|
+      assert line.split("\s").size == 3
+      assert line.split("\s").first.split(',').size == 3
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugin
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Decklin Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json