sensu-extensions-statsd 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 424c1976524eb35b794354e8ed81a0b1d5aa3342
-  data.tar.gz: 6bff69108c15a02b257d9ca40353028861eb5877
+  metadata.gz: f29a535c461792227243d4fb537d64d1caa4b6ce
+  data.tar.gz: 591c81f2cc090ff22f206395928a120fa72b376e
 SHA512:
-  metadata.gz: fe7847188110c91313a8197a6c2b330c73ae8f22830be67fb56295289545cb6bf04c3d5f914f4842f504487391d4d14f64828c7113daf9be9becde143a6481ca
-  data.tar.gz: 40bbcb68a42d323e862af5b30e349de9ed9a4bcd68f140839677c0208a59fd09ecd98e1bf07430b9e66b6ff4bbec822eb7c9bb4a62ec8dc18fc0c1fd3b61c49c
+  metadata.gz: a8308e1dfd68422cd8bf1ca99735a053dc7ae0b080852361cf86490d46f3cdb85cae364746605cb74917896b73f588199c5e5ee0bdd9caf4c61f203f98e81fc0
+  data.tar.gz: 41505c23361ae902a5874f12b8e8adabcd02339a92fdd09cb6800e6b0cfe9dd965fdc7ad13cc9c398e30af875743aef0924d548e848fad98bd6f83b25f8d672b

data/CHANGELOG.md

@@ -1,30 +1,15 @@
 # Change Log
 
-This project adheres to [Semantic Versioning](http://semver.org/).
+## [Unreleased](https://github.com/sensu-extensions/sensu-extensions-statsd/tree/HEAD)
 
-This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/).
+[Full Changelog](https://github.com/sensu-extensions/sensu-extensions-statsd/compare/v0.0.1...HEAD)
 
-## [Unreleased]
+**Merged pull requests:**
 
-### Fixed
+- Adhere to Etsy's specifications and behaviour [\#4](https://github.com/sensu-extensions/sensu-extensions-statsd/pull/4) ([portertech](https://github.com/portertech))
+- Fix gauge implementation [\#3](https://github.com/sensu-extensions/sensu-extensions-statsd/pull/3) ([corro](https://github.com/corro))
 
-### Added
+## [v0.0.1](https://github.com/sensu-extensions/sensu-extensions-statsd/tree/v0.0.1) (2016-12-09)
 
-### Changed
 
-## [1.0.0] - 2016-01-31
-
-### Fixed
-
-### Added
-
-### Changed
-
-## 0.0.1 - 2016-01-31
-
-### Added
-
-- Initial release.
-
-[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-template/compare/v1.0.0...HEAD
-[1.0.0]: https://github.com/sensu-extensions/sensu-extensions-template/compare/v0.0.1...v1.0.0
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -5,10 +5,19 @@ creates a StatsD TCP & UDP listener, receives StatsD metrics, parses
 them, and flushes them to the Graphite plaintext format for Sensu to
 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)
+
 ## Installation
 
+This extension requires Sensu version >= 0.26.
+
+On a Sensu client machine.
+
 ```
-sensu-install -e statsd
+sensu-install -e statsd:1.0.0
 ```
 
 Edit `/etc/sensu/conf.d/extensions.json` to load it.
@@ -17,12 +26,18 @@ Edit `/etc/sensu/conf.d/extensions.json` to load it.
 {
   "extensions": {
     "statsd": {
-      "version": "0.0.1"
+      "version": "1.0.0"
     }
   }
 }
 ```
 
+Restart the Sensu client.
+
+``` shell
+sudo service sensu-client restart
+```
+
 ## Configuration
 
 Edit `/etc/sensu/conf.d/statsd.json` to change its configuration.
@@ -35,14 +50,31 @@ Edit `/etc/sensu/conf.d/statsd.json` to change its configuration.
 }
 ```
 
-|param|type|default|description|
+The following defaults make the integration behave like Etsy's StatsD
+implementation.
+
+|attribute|type|default|description|
 |----|----|----|---|
-|:bind|:string|"127.0.0.1"|IP to bind the StatsD sockets to|
-|:port|:integer|8125|Port to bind the StatsD sockets to|
-|:flush_interval|:integer|10|The StatsD flush interval|
-|:send_interval|:integer|30|How often Graphite metrics are sent to Sensu|
-|:percentile|:integer|90|The percentile to calculate for StatsD metrics|
-|:add_client_prefix|:boolean|true|If the Sensu client name should prefix the Graphite metric path|
-|:path_prefix|:string|"statsd"|The optional Graphite metric path prefix (after client name)|
-|:add_path_prefix|:boolean|true|If the path_prefix should be used|
-|:handler|:string|"graphite"|Handler to use for the Graphite metrics|
+|bind|string|"127.0.0.1"|IP to bind the StatsD sockets to|
+|port|integer|8125|Port to bind the StatsD sockets to|
+|flush_interval|integer|10|The StatsD flush interval|
+|send_interval|integer|30|How often Graphite metrics are sent to Sensu|
+|percentile|integer|90|The percentile to calculate for StatsD metrics|
+|add_client_prefix|boolean|true|If the Sensu client name should prefix the Graphite metric path|
+|path_prefix|string|"statsd"|The optional Graphite metric path prefix (after client name)|
+|add_path_prefix|boolean|true|If the path_prefix should be used|
+|delete_gauges|boolean|false|If gauges that have not been updated should be deleted instead of flushed|
+|delete_counters|boolean|false|If counters with a value of 0 should be deleted instead of flushed|
+|delete_timers|boolean|false|If timers with a count of 0 should be deleted instead of flushed|
+|reset_gauges|boolean|false|If gauges should be reset to 0 after flushing|
+|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|
+
+## Example
+
+Test the StatsD TCP socket:
+
+``` shell
+echo "orders:1|c" | nc 127.0.0.1 8125
+```

data/lib/sensu/extensions/statsd.rb

@@ -27,6 +27,12 @@ module Sensu
           :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,
@@ -71,6 +77,19 @@ module Sensu
 
       private
 
+      def clean(hash, delete=false, reset=false)
+        if delete
+          hash.delete_if do |key, value|
+            value == 0 || value == []
+          end
+        end
+        if reset
+          hash.each do |key, value|
+            hash[key] = (value.is_a?(Array) ? [] : 0)
+          end
+        end
+      end
+
       def add_metric(*args)
         value = args.pop
         path = []
@@ -94,36 +113,42 @@ module Sensu
 
       def flush!
         @gauges.each do |name, value|
-          add_metric("gauges", name, value)
+          unless value == 0 && options[:delete_gauges]
+            add_metric("gauges", name, value)
+          end
         end
-        @gauges.clear
+        clean(@gauges, options[:delete_gauges], options[:reset_gauges])
         @counters.each do |name, value|
-          add_metric("counters", name, value)
+          unless value == 0 && options[:delete_counters]
+            add_metric("counters", name, value.to_i)
+          end
         end
-        @counters.clear
+        clean(@counters, options[:delete_counters], options[:reset_counters])
         @timers.each do |name, values|
-          values.sort!
-          length = values.length
-          min = values.first
-          max = values.last
-          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
+          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)
           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
-        @timers.clear
+        clean(@timers, options[:delete_timers], options[:reset_timers])
         @logger.debug("flushed statsd metrics")
       end
 
@@ -136,17 +161,23 @@ module Sensu
       def setup_parser
         parser = proc do |data|
           begin
-            nv, type = data.strip.split("|")
-            name, 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)
             case type
             when "g"
-              @gauges[name] = Float(value)
+              if raw_value.start_with?("+")
+                @gauges[name] += value
+              elsif raw_value.start_with?("-")
+                @gauges[name] -= value.abs
+              else
+                @gauges[name] = value
+              end
             when /^c/, "m"
-              _, raw_sample = type.split("@")
-              sample = (raw_sample ? Float(raw_sample) : 1)
-              @counters[name] += Integer(value) * (1 / sample)
-            when "ms", "h"
-              @timers[name] << Float(value)
+              @counters[name] += value * (1 / sample)
+            when "ms", "h", "t"
+              @timers[name] << value * (1 / sample)
             end
           rescue => error
             @logger.error("statsd parser error", :error => error.to_s)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-extensions-statsd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sensu-Extensions and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-extension
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Check extension to run a StatsD implementation
 email:
 - "<sensu-users@googlegroups.com>"