sensu-extensions-statsd 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f29a535c461792227243d4fb537d64d1caa4b6ce
-  data.tar.gz: 591c81f2cc090ff22f206395928a120fa72b376e
+  metadata.gz: 3690d2d8fba2db12035bf6a0fd96865e682ce7cc
+  data.tar.gz: a0cfe9cccde8e9be923555449dfc2528b3c300b8
 SHA512:
-  metadata.gz: a8308e1dfd68422cd8bf1ca99735a053dc7ae0b080852361cf86490d46f3cdb85cae364746605cb74917896b73f588199c5e5ee0bdd9caf4c61f203f98e81fc0
-  data.tar.gz: 41505c23361ae902a5874f12b8e8adabcd02339a92fdd09cb6800e6b0cfe9dd965fdc7ad13cc9c398e30af875743aef0924d548e848fad98bd6f83b25f8d672b
+  metadata.gz: f92582be13f461bb0876a859cff9d857fa8f829f40ba33a474aee660de5953c23d45fb01963aabd1bbad36298ba8d79be345e7e2d26ce50330042108f54e121b
+  data.tar.gz: 315b55ff68d05e47c32b50de854bf11e15acad58412bfa9d4290d946775208b0190ccfa2b7c04c578bd622f740caaef3f8ce1e9a22eec10de87ee7681958e609

data/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Change Log
 
-## [Unreleased](https://github.com/sensu-extensions/sensu-extensions-statsd/tree/HEAD)
+## [2.0.0] - 2017-02-01
+### Changed
+- The definition of statsd.rb to include truncate_output as a configurable option.
+(@TQaztec)
 
-[Full Changelog](https://github.com/sensu-extensions/sensu-extensions-statsd/compare/v0.0.1...HEAD)
+### Security
+- update 'rubocop' dependency to '~> 0.51.0' per:
+https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-8418.
+(@TQaztec)
+
+### Breaking Change
+- Dropping ruby 2.0 support after updating rubocop dependency.
+
+## [v1.0.0](https://github.com/sensu-extensions/sensu-extensions-statsd/tree/v1.0.0) (2017-03-21)
+[Full Changelog](https://github.com/sensu-extensions/sensu-extensions-statsd/compare/v0.0.1...v1.0.0)
 
 **Merged pull requests:**
 
@@ -12,4 +24,4 @@
 ## [v0.0.1](https://github.com/sensu-extensions/sensu-extensions-statsd/tree/v0.0.1) (2016-12-09)
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -8,7 +8,7 @@ send to Graphite or another TSDB.
 This StatsD implementation attempts to adhere to [Etsy's metric type
 specifications](https://github.com/etsy/statsd/blob/master/docs/metric_types.md).
 
-[![Build Status](https://travis-ci.org/sensu-extensions/sensu-extensions-statsd.svg?branch=master)](https://travis-ci.org/sensu/sensu-extensions-statsd)
+[![Build Status](https://travis-ci.org/sensu-extensions/sensu-extensions-statsd.svg?branch=master)](https://travis-ci.org/sensu-extensions/sensu-extensions-statsd)
 
 ## Installation
 
@@ -70,6 +70,7 @@ implementation.
 |reset_counters|boolean|true|If counters should be reset to 0 after flushing|
 |reset_timers|boolean|true|If timers should be reset/cleared after flushing|
 |handler|string|"graphite"|Handler to use for the Graphite metrics|
+|truncate_output|boolean|true|If output should be truncated|
 
 ## Example
 

data/lib/sensu/extensions/statsd.rb

@@ -1,4 +1,4 @@
-require "sensu/extension"
+require 'sensu/extension'
 
 module Sensu
   module Extension
@@ -10,33 +10,34 @@ module Sensu
       end
     end
 
-    class StatsD < Check
+    class StatsD < Check # rubocop:disable Metrics/ClassLength
       def name
-        "statsd"
+        'statsd'
       end
 
       def description
-        "a statsd implementation"
+        'a statsd implementation'
       end
 
-      def options
+      def options # rubocop:disable Metrics/MethodLength
         return @options if @options
         @options = {
-          :bind => "127.0.0.1",
-          :port => 8125,
-          :flush_interval => 10,
-          :send_interval => 30,
-          :percentile => 90,
-          :delete_gauges => false,
-          :delete_counters => false,
-          :delete_timers => false,
-          :reset_gauges => false,
-          :reset_counters => true,
-          :reset_timers => true,
-          :add_client_prefix => true,
-          :path_prefix => "statsd",
-          :add_path_prefix => true,
-          :handler => "graphite"
+          bind: '127.0.0.1',
+          port: 8125,
+          flush_interval: 10,
+          send_interval: 30,
+          percentile: 90,
+          delete_gauges: false,
+          delete_counters: false,
+          delete_timers: false,
+          reset_gauges: false,
+          reset_counters: true,
+          reset_timers: true,
+          add_client_prefix: true,
+          path_prefix: 'statsd',
+          add_path_prefix: true,
+          handler: 'graphite',
+          truncate_output: true
         }
         @options.merge!(@settings[:statsd]) if @settings[:statsd].is_a?(Hash)
         @options
@@ -44,12 +45,13 @@ module Sensu
 
       def definition
         {
-          :type => "metric",
-          :name => name,
-          :interval => options[:send_interval],
-          :standalone => true,
-          :output_format => "graphite_plaintext",
-          :handler => options[:handler]
+          type: 'metric',
+          name: name,
+          interval: options[:send_interval],
+          standalone: true,
+          output_format: 'graphite_plaintext',
+          handler: options[:handler],
+          truncate_output: options[:truncate_output]
         }
       end
 
@@ -66,10 +68,10 @@ module Sensu
       end
 
       def run
-        output = ""
+        output = ''
         if @metrics
           output << @metrics.join("\n") + "\n" unless @metrics.empty?
-          @logger.info("statsd collected metrics", :count => @metrics.count)
+          @logger.info('statsd collected metrics', count: @metrics.count)
           @metrics = []
         end
         yield output, 0
@@ -77,9 +79,9 @@ module Sensu
 
       private
 
-      def clean(hash, delete=false, reset=false)
+      def clean(hash, delete = false, reset = false)
         if delete
-          hash.delete_if do |key, value|
+          hash.delete_if do |_key, value|
             value == 0 || value == []
           end
         end
@@ -90,66 +92,61 @@ module Sensu
         end
       end
 
-      def add_metric(*args)
+      def add_metric(*args) # rubocop:disable Metrics/MethodLength
         value = args.pop
         path = []
         path << @settings[:client][:name] if options[:add_client_prefix]
         path << options[:path_prefix] if options[:add_path_prefix]
-        path = (path + args).join(".")
+        path = (path + args).join('.')
         if path !~ /^[A-Za-z0-9\._-]*$/
-          @logger.info("invalid statsd metric", {
-            :reason => "metric path must only consist of alpha-numeric characters, periods, underscores, and dashes",
-            :path => path,
-            :value => value
-          })
+          @logger.info('invalid statsd metric', reason: 'metric path must only consist of alpha-numeric characters, periods, underscores, and dashes',
+                                                path: path,
+                                                value: value)
         else
-          @logger.debug("adding statsd metric", {
-            :path => path,
-            :value => value
-          })
-          @metrics << [path, value, Time.now.to_i].join(" ")
+          @logger.debug('adding statsd metric', path: path,
+                                                value: value)
+          @metrics << [path, value, Time.now.to_i].join(' ')
         end
       end
 
       def flush!
         @gauges.each do |name, value|
           unless value == 0 && options[:delete_gauges]
-            add_metric("gauges", name, value)
+            add_metric('gauges', name, value)
           end
         end
         clean(@gauges, options[:delete_gauges], options[:reset_gauges])
         @counters.each do |name, value|
           unless value == 0 && options[:delete_counters]
-            add_metric("counters", name, value.to_i)
+            add_metric('counters', name, value.to_i)
           end
         end
         clean(@counters, options[:delete_counters], options[:reset_counters])
         @timers.each do |name, values|
-          unless values.empty? && options[:delete_timers]
-            values.sort!
-            length = values.length
-            min = values.first || 0
-            max = values.last || 0
-            mean = min
-            max_at_threshold = min
-            percentile = options[:percentile]
-            if length > 1
-              threshold_index = ((100 - percentile) / 100.0) * length
-              threshold_count = length - threshold_index.round
-              valid_values = values.slice(0, threshold_count)
-              max_at_threshold = valid_values[-1]
-              sum = 0
-              valid_values.each { |v| sum += v }
-              mean = sum / valid_values.length
-            end
-            add_metric("timers", name, "lower", min)
-            add_metric("timers", name, "mean", mean)
-            add_metric("timers", name, "upper", max)
-            add_metric("timers", name, "upper_#{percentile}", max_at_threshold)
+          next if values.empty? && options[:delete_timers]
+          values.sort!
+          length = values.length
+          min = values.first || 0
+          max = values.last || 0
+          mean = min
+          max_at_threshold = min
+          percentile = options[:percentile]
+          if length > 1
+            threshold_index = ((100 - percentile) / 100.0) * length
+            threshold_count = length - threshold_index.round
+            valid_values = values.slice(0, threshold_count)
+            max_at_threshold = valid_values[-1]
+            sum = 0
+            valid_values.each { |v| sum += v }
+            mean = sum / valid_values.length
           end
+          add_metric('timers', name, 'lower', min)
+          add_metric('timers', name, 'mean', mean)
+          add_metric('timers', name, 'upper', max)
+          add_metric('timers', name, "upper_#{percentile}", max_at_threshold)
         end
         clean(@timers, options[:delete_timers], options[:reset_timers])
-        @logger.debug("flushed statsd metrics")
+        @logger.debug('flushed statsd metrics')
       end
 
       def setup_flush_timers
@@ -158,29 +155,30 @@ module Sensu
         end
       end
 
-      def setup_parser
+      # TODO: come back and refactor me
+      def setup_parser # rubocop:disable Metrics/MethodLength
         parser = proc do |data|
           begin
-            nv, type, raw_sample = data.strip.split("|")
-            name, raw_value = nv.split(":")
+            nv, type, raw_sample = data.strip.split('|')
+            name, raw_value = nv.split(':')
             value = Float(raw_value)
-            sample = Float(raw_sample ? raw_sample.split("@").last : 1)
+            sample = Float(raw_sample ? raw_sample.split('@').last : 1)
             case type
-            when "g"
-              if raw_value.start_with?("+")
+            when 'g'
+              if raw_value.start_with?('+')
                 @gauges[name] += value
-              elsif raw_value.start_with?("-")
+              elsif raw_value.start_with?('-')
                 @gauges[name] -= value.abs
               else
                 @gauges[name] = value
               end
-            when /^c/, "m"
+            when /^c/, 'm'
               @counters[name] += value * (1 / sample)
-            when "ms", "h", "t"
+            when 'ms', 'h', 't'
               @timers[name] << value * (1 / sample)
             end
           rescue => error
-            @logger.error("statsd parser error", :error => error.to_s)
+            @logger.error('statsd parser error', error: error.to_s)
           end
           EM.next_tick do
             @data.pop(&parser)
@@ -190,7 +188,7 @@ module Sensu
       end
 
       def setup_statsd_socket
-        @logger.debug("binding statsd tcp and udp sockets", :options => options)
+        @logger.debug('binding statsd tcp and udp sockets', options: options)
         bind = options[:bind]
         port = options[:port]
         EM.start_server(bind, port, StatsDSimpleSocket) do |socket|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-extensions-statsd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sensu-Extensions and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-extension
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sensu-logger
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sensu-settings
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: sensu-logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: github_changelog_generator
+  name: sensu-settings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -130,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -138,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Check extension to run a StatsD implementation