logstash-output-statsd 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9da4d83403181dcddc46697b046a29321ff02474
-  data.tar.gz: 66dbca4688675a6180443f409fa54a9f8fbff105
+  metadata.gz: af0d69bd56f803ab82b441ae66150c60f78cdb05
+  data.tar.gz: 04e0eac19b5b6b427f8361916e8f5a94b3b7244a
 SHA512:
-  metadata.gz: 2863dd3fea7baa518f443b2df42dd83a879df343fdcca92ce410b0d4cf9c76a0e277a3159fee005fc1ec179da778b6fe5c2700bac8e20a9b60a15b59b5046fd2
-  data.tar.gz: 31b1a728959fdd715d8488ddd6cfd6a8eec7826c1069bffbaa26b133883acd6c56b5c7d27ba2b90f07884826643704f3d5792ad6ce4a1a205d3260da158101b7
+  metadata.gz: 26d6fa69f8e8c5b8ba78b185823d1846789687aa8eff9cc66657fd8b9ab5268933a9756a705aba2d718bfb5eba8f7a969d0b05e9b7d2826e94f70ab938c39557
+  data.tar.gz: e065a04790b47c23f0007cfa850bd9b05bfc163391fe26c4698700412f9b007b8c9d525cfc484546341b10f257540fc6beaa2c00db3b09b9cca2b50160f9a932

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,193 @@
+:plugin: statsd
+:type: output
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Statsd output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+statsd is a network daemon for aggregating statistics, such as counters and timers,
+and shipping over UDP to backend services, such as Graphite or Datadog. The general
+idea is that you send metrics to statsd and every few seconds it will emit the
+aggregated values to the backend. Example aggregates are sums, average and maximum
+values, their standard deviation, etc. This plugin makes it easy to send such
+metrics based on data in Logstash events.
+
+You can learn about statsd here:
+
+* https://codeascraft.com/2011/02/15/measure-anything-measure-everything/[Etsy blog post announcing statsd]
+* https://github.com/etsy/statsd[statsd on github]
+
+Typical examples of how this can be used with Logstash include counting HTTP hits
+by response code, summing the total number of bytes of traffic served, and tracking
+the 50th and 95th percentile of the processing time of requests.
+
+Each metric emitted to statsd has a dot-separated path, a type, and a value. The
+metric path is built from the `namespace` and `sender` options together with the
+metric name that's picked up depending on the type of metric. All in all, the
+metric path will follow this pattern:
+
+    namespace.sender.metric
+
+With regards to this plugin, the default namespace is "logstash", the default
+sender is the `host` field, and the metric name depends on what is set as the
+metric name in the `increment`, `decrement`, `timing`, `count`, `set` or `gauge`
+options. In metric paths, colons (":"), pipes ("|") and at signs ("@") are reserved
+and will be replaced by underscores ("_").
+
+Example:
+[source,ruby]
+output {
+  statsd {
+    host => "statsd.example.org"
+    count => {
+      "http.bytes" => "%{bytes}"
+    }
+  }
+}
+
+If run on a host named hal9000 the configuration above will send the following
+metric to statsd if the current event has 123 in its `bytes` field:
+
+    logstash.hal9000.http.bytes:123|c
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Statsd Output Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-count>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-decrement>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-gauge>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-increment>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-namespace>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-sample_rate>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-sender>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-set>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-timing>> |<<hash,hash>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-count"]
+===== `count` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+A count metric. `metric_name => count` as hash. `%{fieldname}` substitutions are
+allowed in the metric names.
+
+[id="plugins-{type}s-{plugin}-decrement"]
+===== `decrement` 
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+A decrement metric. Metric names as array. `%{fieldname}` substitutions are
+allowed in the metric names.
+
+[id="plugins-{type}s-{plugin}-gauge"]
+===== `gauge` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+A gauge metric. `metric_name => gauge` as hash. `%{fieldname}` substitutions are
+allowed in the metric names.
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+The hostname or IP address of the statsd server.
+
+[id="plugins-{type}s-{plugin}-increment"]
+===== `increment` 
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+An increment metric. Metric names as array. `%{fieldname}` substitutions are
+allowed in the metric names.
+
+[id="plugins-{type}s-{plugin}-namespace"]
+===== `namespace` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash"`
+
+The statsd namespace to use for this metric. `%{fieldname}` substitutions are
+allowed.
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `8125`
+
+The port to connect to on your statsd server.
+
+[id="plugins-{type}s-{plugin}-sample_rate"]
+===== `sample_rate` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+The sample rate for the metric.
+
+[id="plugins-{type}s-{plugin}-sender"]
+===== `sender` 
+
+  * Value type is <<string,string>>
+  * Default value is `"%{host}"`
+
+The name of the sender. Dots will be replaced with underscores. `%{fieldname}`
+substitutions are allowed.
+
+[id="plugins-{type}s-{plugin}-set"]
+===== `set` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+A set metric. `metric_name => "string"` to append as hash. `%{fieldname}`
+substitutions are allowed in the metric names.
+
+[id="plugins-{type}s-{plugin}-timing"]
+===== `timing` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+A timing metric. `metric_name => duration` as hash. `%{fieldname}` substitutions
+are allowed in the metric names.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/outputs/statsd.rb

@@ -131,8 +131,11 @@ class LogStash::Outputs::Statsd < LogStash::Outputs::Base
   end # def receive
 
   def build_stat(metric, sender=@sender)
-    sender = sender.gsub('::','.').gsub(RESERVED_CHARACTERS_REGEX, '_').gsub(".", "_")
-    metric = metric.gsub('::','.').gsub(RESERVED_CHARACTERS_REGEX, '_')
+    sender = sender.to_s.gsub('::','.')
+    sender.gsub!(RESERVED_CHARACTERS_REGEX, '_')
+    sender.gsub!(".", "_")
+    metric = metric.to_s.gsub('::','.')
+    metric.gsub!(RESERVED_CHARACTERS_REGEX, '_')
     @logger.debug? and @logger.debug("Formatted value", :sender => sender, :metric => metric)
     return "#{sender}.#{metric}"
   end

data/logstash-output-statsd.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-statsd'
-  s.version         = '3.1.1'
+  s.version         = '3.1.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Send metrics to StatsD"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

data/spec/outputs/statsd_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-require "logstash/outputs/statsd"
 require_relative "../spec_helper"
+require "logstash/outputs/statsd"
 
 describe LogStash::Outputs::Statsd do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-statsd
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/statsd.rb
 - logstash-output-statsd.gemspec
 - spec/outputs/statsd_spec.rb
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Send metrics to StatsD