dogstatsd.rb in logstash-output-dogstatsd-2.0.0

- old
+ new

@@ -17,54 +17,61 @@
 # running as part of the Datadog Agent. Dogstatsd adds support for metric tags,
 # which are used to slice metrics along various dimensions.
 #
 # 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.
 #
 # Example:
 # [source,ruby]
 # output {
-#  dogstatsd {
-#   metric_tags => ["host:%{host}","role:foo"]
-#   count => {
-#    "http.bytes" => "%{bytes}"
+#   dogstatsd {
+#     metric_tags => ["host:%{host}","role:foo"]
+#     count => {
+#       "http.bytes" => "%{bytes}"
+#     }
 #   }
-#  }
 # }
 class LogStash::Outputs::Dogstatsd < LogStash::Outputs::Base
   ## Regex stolen from statsd code
   RESERVED_CHARACTERS_REGEX = /[\:\|\@]/
   config_name "dogstatsd"
 
-  # The address of the dogstatsd server.
+  # The hostname or IP address of the dogstatsd server.
   config :host, :validate => :string, :default => "localhost"
 
   # The port to connect to on your dogstatsd server.
   config :port, :validate => :number, :default => 8125
 
-  # 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 histogram metric, which a statsd timing but conceptually maps to any
-  # numeric value, not just durations. `metric_name => value` as hash
+  # numeric value, not just durations. `metric_name => value` as hash. `%{fieldname}`
+  # substitutions are allowed in the metric names.
   config :histogram, :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.
   config :sample_rate, :validate => :number, :default => 1
 
@@ -76,11 +83,10 @@
     @client = Datadog::Statsd.new(@host, @port)
   end # def register
 
   public
   def receive(event)
-    return unless output?(event)
     @logger.debug? and @logger.debug("Event: #{event}")
 
     metric_opts = {
       :sample_rate => @sample_rate,
       :tags => @metric_tags.map { |t| event.sprintf(t) }
@@ -108,6 +114,11 @@
 
     @gauge.each do |metric, val|
       @client.gauge(event.sprintf(metric), event.sprintf(val), metric_opts)
     end
   end # def receive
+
+  public
+  def close
+    @client.close
+  end # def close
 end # class LogStash::Outputs::Statsd