logstash-output-statsd 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62e988a5f03ea23cf43bbe242d996a2ce782e0a3
-  data.tar.gz: e40e5654a8b0f5ad241fc46f57ce34ffab0ada38
+  metadata.gz: c657a3cd065de2a88a6b864835c2559dd4dd5924
+  data.tar.gz: a901e6c81be6c2a1a695a5897f2ad9ce3bf5823c
 SHA512:
-  metadata.gz: 378e92edf4ebb252cd0f7af48d947662b7b8ddec9afbce62db3f3fb467f0dd725bc306550b1b2dfbbf95ce035b3360b01ad41b55c238d8a8bdef4c01f3946d9d
-  data.tar.gz: 5b9ba12e7aabf47d458598f76b3a0bbefb76a7cd8dbf9c73182ace91c4f41b3bb45bf1b99f7be3a8eeb66054b1e90945dfff39fb7e39e65015ea10b7d7e3f1c5
+  metadata.gz: 537b0f1883a15ebfb612cc01c3336ca99dd80eb30d03951a6a4684f6521ea7aa76dcb508853f4023a81b348ea796e49aea55e2a5961d579d1927d49f8a0c24ff
+  data.tar.gz: 2b3d9bb64089f630de55acf760ce4df4bcbb0d9e70e073c2f60dfef74acfac2cc0305b1f9425347230be999df7a61e82894d1e293fcd77640e3184a2bd9971f0

data/CHANGELOG.md

@@ -1,7 +1,10 @@
+## 2.0.5
+ - Doc improvements.
+
 ## 2.0.2
  - Avoid rspec.configure global after and before :all blocks
 ## 2.0.0
- - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
  - Dependency on logstash-core update to 2.0
 

data/README.md

@@ -1,5 +1,8 @@
 # Logstash Plugin
 
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-statsd-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-statsd-unit/)
+
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.

data/lib/logstash/outputs/statsd.rb

@@ -3,76 +3,90 @@ require "logstash/outputs/base"
 require "logstash/namespace"
 
 # 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 most basic coverage of this plugin is that the 'namespace', 'sender', and
-# 'metric' names are combined into the full metric path like so:
-#
-#     `namespace.sender.metric`
-#
-# The general idea is that you send statsd count or latency data and every few
-# seconds it will emit the aggregated values to the backend. Example aggregates are
-# `average`, `max`, `stddev`, etc.
+# 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:
 #
-# * http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/[Etsy blog post announcing statsd]
+# * https://codeascraft.com/2011/02/15/measure-anything-measure-everything/[Etsy blog post announcing statsd]
 # * https://github.com/etsy/statsd[statsd on github]
 #
-# A simple example usage of this is to count HTTP hits by response code; to learn
-# more about that, check out the ../tutorials/metrics-from-logs[log metrics tutorial]
+# 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.
 #
-# The default final metric sent to statsd would look like this:
+# 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`
+#     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` variable. 
+# 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}"
+#   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
 class LogStash::Outputs::Statsd < LogStash::Outputs::Base
   ## Regex stolen from statsd code
   RESERVED_CHARACTERS_REGEX = /[\:\|\@]/
   config_name "statsd"
 
-  # The address of the statsd server.
+  # The hostname or IP address of the statsd server.
   config :host, :validate => :string, :default => "localhost"
 
   # The port to connect to on your statsd server.
   config :port, :validate => :number, :default => 8125
 
-  # The statsd namespace to use for this metric.
+  # The statsd namespace to use for this metric. `%{fieldname}` substitutions are
+  # allowed.
   config :namespace, :validate => :string, :default => "logstash"
 
-  # The name of the sender. Dots will be replaced with underscores.
+  # The name of the sender. Dots will be replaced with underscores. `%{fieldname}`
+  # substitutions are allowed.
   config :sender, :validate => :string, :default => "%{host}"
 
-  # An increment metric. Metric names as array.
+  # An increment metric. Metric names as array. `%{fieldname}` substitutions are
+  # allowed in the metric names.
   config :increment, :validate => :array, :default => []
 
-  # A decrement metric. Metric names as array.
+  # A decrement metric. Metric names as array. `%{fieldname}` substitutions are
+  # allowed in the metric names.
   config :decrement, :validate => :array, :default => []
 
-  # A timing metric. `metric_name => duration` as hash
+  # A timing metric. `metric_name => duration` as hash. `%{fieldname}` substitutions
+  # are allowed in the metric names.
   config :timing, :validate => :hash, :default => {}
 
-  # A count metric. `metric_name => count` as hash
+  # A count metric. `metric_name => count` as hash. `%{fieldname}` substitutions are
+  # allowed in the metric names.
   config :count, :validate => :hash, :default => {}
 
-  # A set metric. `metric_name => "string"` to append as hash
+  # A set metric. `metric_name => "string"` to append as hash. `%{fieldname}`
+  # substitutions are allowed in the metric names.
   config :set, :validate => :hash, :default => {}
 
-  # A gauge metric. `metric_name => gauge` as hash.
+  # A gauge metric. `metric_name => gauge` as hash. `%{fieldname}` substitutions are
+  # allowed in the metric names.
   config :gauge, :validate => :hash, :default => {}
   
   # The sample rate for the metric.

data/logstash-output-statsd.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-statsd'
-  s.version         = '2.0.4'
+  s.version         = '2.0.5'
   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/plugin install gemname. This gem is not a stand-alone program"
@@ -27,4 +27,3 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'logstash-devutils'
 end
-

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-statsd
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -19,10 +20,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,48 +28,50 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: logstash-input-generator
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-input-generator
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+        version: 1.2.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.2.0
-  name: statsd-ruby
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
   prerelease: false
   type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []