sensu-extensions-statsd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 424c1976524eb35b794354e8ed81a0b1d5aa3342
+  data.tar.gz: 6bff69108c15a02b257d9ca40353028861eb5877
+SHA512:
+  metadata.gz: fe7847188110c91313a8197a6c2b330c73ae8f22830be67fb56295289545cb6bf04c3d5f914f4842f504487391d4d14f64828c7113daf9be9becde143a6481ca
+  data.tar.gz: 40bbcb68a42d323e862af5b30e349de9ed9a4bcd68f140839677c0208a59fd09ecd98e1bf07430b9e66b6ff4bbec822eb7c9bb4a62ec8dc18fc0c1fd3b61c49c

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/).
+
+## [Unreleased]
+
+### Fixed
+
+### Added
+
+### 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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Sensu-Extensions
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Sensu StatsD Extension
+
+A StatsD implementation for the Sensu client. This check extension
+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.
+
+## Installation
+
+```
+sensu-install -e statsd
+```
+
+Edit `/etc/sensu/conf.d/extensions.json` to load it.
+
+``` json
+{
+  "extensions": {
+    "statsd": {
+      "version": "0.0.1"
+    }
+  }
+}
+```
+
+## Configuration
+
+Edit `/etc/sensu/conf.d/statsd.json` to change its configuration.
+
+``` json
+{
+  "statsd": {
+    "bind": "0.0.0.0"
+  }
+}
+```
+
+|param|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|

data/lib/sensu/extensions/statsd.rb

@@ -0,0 +1,174 @@
+require "sensu/extension"
+
+module Sensu
+  module Extension
+    class StatsDSimpleSocket < EM::Connection
+      attr_accessor :data
+
+      def receive_data(data)
+        @data << data
+      end
+    end
+
+    class StatsD < Check
+      def name
+        "statsd"
+      end
+
+      def description
+        "a statsd implementation"
+      end
+
+      def options
+        return @options if @options
+        @options = {
+          :bind => "127.0.0.1",
+          :port => 8125,
+          :flush_interval => 10,
+          :send_interval => 30,
+          :percentile => 90,
+          :add_client_prefix => true,
+          :path_prefix => "statsd",
+          :add_path_prefix => true,
+          :handler => "graphite"
+        }
+        @options.merge!(@settings[:statsd]) if @settings[:statsd].is_a?(Hash)
+        @options
+      end
+
+      def definition
+        {
+          :type => "metric",
+          :name => name,
+          :interval => options[:send_interval],
+          :standalone => true,
+          :output_format => "graphite_plaintext",
+          :handler => options[:handler]
+        }
+      end
+
+      def post_init
+        @flush_timers = []
+        @data = EM::Queue.new
+        @gauges = Hash.new { |h, k| h[k] = 0 }
+        @counters = Hash.new { |h, k| h[k] = 0 }
+        @timers = Hash.new { |h, k| h[k] = [] }
+        @metrics = []
+        setup_flush_timers
+        setup_parser
+        setup_statsd_socket
+      end
+
+      def run
+        output = ""
+        if @metrics
+          output << @metrics.join("\n") + "\n" unless @metrics.empty?
+          @logger.info("statsd collected metrics", :count => @metrics.count)
+          @metrics = []
+        end
+        yield output, 0
+      end
+
+      private
+
+      def add_metric(*args)
+        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(".")
+        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
+          })
+        else
+          @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|
+          add_metric("gauges", name, value)
+        end
+        @gauges.clear
+        @counters.each do |name, value|
+          add_metric("counters", name, value)
+        end
+        @counters.clear
+        @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
+          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
+        @logger.debug("flushed statsd metrics")
+      end
+
+      def setup_flush_timers
+        @flush_timers << EM::PeriodicTimer.new(options[:flush_interval]) do
+          flush!
+        end
+      end
+
+      def setup_parser
+        parser = proc do |data|
+          begin
+            nv, type = data.strip.split("|")
+            name, value = nv.split(":")
+            case type
+            when "g"
+              @gauges[name] = Float(value)
+            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)
+            end
+          rescue => error
+            @logger.error("statsd parser error", :error => error.to_s)
+          end
+          EM.next_tick do
+            @data.pop(&parser)
+          end
+        end
+        @data.pop(&parser)
+      end
+
+      def setup_statsd_socket
+        @logger.debug("binding statsd tcp and udp sockets", :options => options)
+        bind = options[:bind]
+        port = options[:port]
+        EM.start_server(bind, port, StatsDSimpleSocket) do |socket|
+          socket.data = @data
+        end
+        EM.open_datagram_socket(bind, port, StatsDSimpleSocket) do |socket|
+          socket.data = @data
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: sensu-extensions-statsd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Extensions and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: sensu-logger
+  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'
+- !ruby/object:Gem::Dependency
+  name: sensu-settings
+  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>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sensu/extensions/statsd.rb
+homepage: https://github.com/sensu-extensions/sensu-extensions-statsd
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Check extension to run a StatsD implementation
+test_files: []