logstash-filter-metrics 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f2bd00bd043a2bf95979960d720f2094fcedb18
-  data.tar.gz: 5482a6465053b99571cc0e2ecb88a2d0ad2fa40f
+  metadata.gz: 6a50be0b406ee5990f6019e289c34a53d3c6045b
+  data.tar.gz: 34a73a6c0117be3127dbd3e76f712f57f9852979
 SHA512:
-  metadata.gz: fa2a32308d42f6dd3247396434287bc78ab50040be8c4da062d290f8b10f281a889d086f6bde779f7ca860e55bf6434bb182cb23825ecd8ab5c330dd94cbf1d3
-  data.tar.gz: 06171b990cc090b758ab8afe49089118919548610f1c9889b6a5af6a74f51c93dd2c8ff01c098f259e14a37d2f7ac8b73fc4d8422ce64bb46895ddca93141280
+  metadata.gz: 0163461d2d0081bb9078a687079230900035e85608cd9119664577bf872baf0f188bb6217660fb4a3837489f2a1036976b934cb350913944443cf3cbc4335da0
+  data.tar.gz: e7ff4132ffd0f0c3085f35fa85e4272e9d475062b9c20b366edf2cf5637ded28ed68d6099114bbdba444cc0fb5da8f1a918fecf33f16cd27334441f06843ab20

data/CHANGELOG.md

@@ -1,8 +1,11 @@
+## 3.0.0
+ - Elasticsearch 2.0 does not allow for dots in field names.  This change changes to use sub-field syntax instead of
+ dotted syntax.  This is a breaking change.
+
 ## 2.0.2
  - Fix test that used deprecated "tags" syntax
 
 ## 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/lib/logstash/filters/metrics.rb

@@ -5,13 +5,18 @@ require "logstash/namespace"
 
 # The metrics filter is useful for aggregating metrics.
 #
+# IMPORTANT: Elasticsearch 2.0 no longer allows field names with dots. Version 3.0
+# of the metrics filter plugin changes behavior to use nested fields rather than
+# dotted notation to avoid colliding with versions of Elasticsearch 2.0+.  Please
+# note the changes in the documentation (underscores and sub-fields used).
+#
 # For example, if you have a field 'response' that is
 # a http response code, and you want to count each
 # kind of response, you can do this:
 # [source,ruby]
 #     filter {
 #       metrics {
-#         meter => [ "http.%{response}" ]
+#         meter => [ "http_%{response}" ]
 #         add_tag => "metric"
 #       }
 #     }
@@ -31,24 +36,24 @@ require "logstash/namespace"
 #
 # For a `meter => "something"` you will receive the following fields:
 #
-# * "thing.count" - the total count of events
-# * "thing.rate_1m" - the 1-minute rate (sliding)
-# * "thing.rate_5m" - the 5-minute rate (sliding)
-# * "thing.rate_15m" - the 15-minute rate (sliding)
+# * "[thing][count]" - the total count of events
+# * "[thing][rate_1m]" - the 1-minute rate (sliding)
+# * "[thing][rate_5m]" - the 5-minute rate (sliding)
+# * "[thing][rate_15m]" - the 15-minute rate (sliding)
 #
 # #### 'timer' values
 #
 # For a `timer => [ "thing", "%{duration}" ]` you will receive the following fields:
 #
-# * "thing.count" - the total count of events
-# * "thing.rate_1m" - the 1-minute rate of events (sliding)
-# * "thing.rate_5m" - the 5-minute rate of events (sliding)
-# * "thing.rate_15m" - the 15-minute rate of events (sliding)
-# * "thing.min" - the minimum value seen for this metric
-# * "thing.max" - the maximum value seen for this metric
-# * "thing.stddev" - the standard deviation for this metric
-# * "thing.mean" - the mean for this metric
-# * "thing.pXX" - the XXth percentile for this metric (see `percentiles`)
+# * "[thing][count]" - the total count of events
+# * "[thing][rate_1m]" - the 1-minute rate of events (sliding)
+# * "[thing][rate_5m]" - the 5-minute rate of events (sliding)
+# * "[thing][rate_15m]" - the 15-minute rate of events (sliding)
+# * "[thing][min]" - the minimum value seen for this metric
+# * "[thing][max]" - the maximum value seen for this metric
+# * "[thing][stddev]" - the standard deviation for this metric
+# * "[thing][mean]" - the mean for this metric
+# * "[thing][pXX]" - the XXth percentile for this metric (see `percentiles`)
 #
 # #### Example: computing event rate
 #
@@ -76,7 +81,7 @@ require "logstash/namespace"
 #       if "metric" in [tags] {
 #         stdout {
 #           codec => line {
-#             format => "rate: %{events.rate_1m}"
+#             format => "rate: %{[events][rate_1m]}"
 #           }
 #         }
 #       }
@@ -98,7 +103,7 @@ require "logstash/namespace"
 # [source,ruby]
 #     output {
 #       graphite {
-#         metrics => [ "events.rate_1m", "%{events.rate_1m}" ]
+#         metrics => [ "events.rate_1m", "%{[events][rate_1m]}" ]
 #       }
 #     }
 class LogStash::Filters::Metrics < LogStash::Filters::Base
@@ -158,7 +163,7 @@ class LogStash::Filters::Metrics < LogStash::Filters::Base
   end # def register
 
   def filter(event)
-    
+
 
     # TODO(piavlo): This should probably be moved to base filter class.
     if @ignore_older_than > 0 && Time.now - event.timestamp.time > @ignore_older_than
@@ -194,14 +199,14 @@ class LogStash::Filters::Metrics < LogStash::Filters::Base
     @metric_timers.each_pair do |name, metric|
       flush_rates event, name, metric
       # These 4 values are not sliding, so they probably are not useful.
-      event["#{name}.min"] = metric.min
-      event["#{name}.max"] = metric.max
+      event["[#{name}][min]"] = metric.min
+      event["[#{name}][max]"] = metric.max
       # timer's stddev currently returns variance, fix it.
-      event["#{name}.stddev"] = metric.stddev ** 0.5
-      event["#{name}.mean"] = metric.mean
+      event["[#{name}][stddev]"] = metric.stddev ** 0.5
+      event["[#{name}][mean]"] = metric.mean
 
       @percentiles.each do |percentile|
-        event["#{name}.p#{percentile}"] = metric.snapshot.value(percentile / 100.0)
+        event["[#{name}][p#{percentile}]"] = metric.snapshot.value(percentile / 100.0)
       end
       metric.clear if should_clear?
     end
@@ -232,10 +237,10 @@ class LogStash::Filters::Metrics < LogStash::Filters::Base
   private
 
   def flush_rates(event, name, metric)
-      event["#{name}.count"] = metric.count
-      event["#{name}.rate_1m"] = metric.one_minute_rate if @rates.include? 1
-      event["#{name}.rate_5m"] = metric.five_minute_rate if @rates.include? 5
-      event["#{name}.rate_15m"] = metric.fifteen_minute_rate if @rates.include? 15
+      event["[#{name}][count]"] = metric.count
+      event["[#{name}][rate_1m]"] = metric.one_minute_rate if @rates.include? 1
+      event["[#{name}][rate_5m]"] = metric.five_minute_rate if @rates.include? 5
+      event["[#{name}][rate_15m]"] = metric.fifteen_minute_rate if @rates.include? 15
   end
 
   def metric_key(key)

data/logstash-filter-metrics.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-metrics'
-  s.version         = '2.0.3'
+  s.version         = '3.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The metrics filter is useful for aggregating metrics."
   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"
@@ -26,4 +26,3 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'logstash-devutils'
 end
-

data/spec/filters/metrics_spec.rb

@@ -6,7 +6,7 @@ describe LogStash::Filters::Metrics do
   context "with basic meter config" do
     context "when no events were received" do
       it "should not flush" do
-        config = {"meter" => ["http.%{response}"]}
+        config = {"meter" => ["http_%{response}"]}
         filter = LogStash::Filters::Metrics.new config
         filter.register
 
@@ -18,7 +18,7 @@ describe LogStash::Filters::Metrics do
     context "when events are received" do
       context "on the first flush" do
         subject {
-          config = {"meter" => ["http.%{response}"]}
+          config = {"meter" => ["http_%{response}"]}
           filter = LogStash::Filters::Metrics.new config
           filter.register
           filter.filter LogStash::Event.new({"response" => 200})
@@ -29,22 +29,24 @@ describe LogStash::Filters::Metrics do
 
         it "should flush counts" do
           insist { subject.length } == 1
-          insist { subject.first["http.200.count"] } == 2
-          insist { subject.first["http.404.count"] } == 1
+          insist { subject.first["http_200"]["count"] } == 2
+          insist { subject.first["http_404"]["count"] } == 1
         end
 
         it "should include rates and percentiles" do
-          metrics = ["http.200.rate_1m", "http.200.rate_5m", "http.200.rate_15m",
-                     "http.404.rate_1m", "http.404.rate_5m", "http.404.rate_15m"]
-          metrics.each do |metric|
-            insist { subject.first }.include? metric
+          meters = [ "http_200", "http_404" ]
+          rates = [ "rate_1m", "rate_5m", "rate_15m" ]
+          meters.each do |meter|
+            rates.each do |rate|
+              insist { subject.first[meter] }.include? rate
+            end
           end
         end
       end
 
       context "on the second flush" do
         it "should not reset counts" do
-          config = {"meter" => ["http.%{response}"]}
+          config = {"meter" => ["http_%{response}"]}
           filter = LogStash::Filters::Metrics.new config
           filter.register
           filter.filter LogStash::Event.new({"response" => 200})
@@ -54,8 +56,8 @@ describe LogStash::Filters::Metrics do
           events = filter.flush
           events = filter.flush
           insist { events.length } == 1
-          insist { events.first["http.200.count"] } == 2
-          insist { events.first["http.404.count"] } == 1
+          insist { events.first["http_200"]["count"] } == 2
+          insist { events.first["http_404"]["count"] } == 1
         end
       end
     end
@@ -64,7 +66,7 @@ describe LogStash::Filters::Metrics do
       context "on the first flush" do
         subject {
           config = {
-            "meter" => ["http.%{response}"],
+            "meter" => ["http_%{response}"],
             "rates" => [1]
           }
           filter = LogStash::Filters::Metrics.new config
@@ -76,9 +78,9 @@ describe LogStash::Filters::Metrics do
         }
 
         it "should include only the requested rates" do
-          rate_fields = subject.first.to_hash.keys.select {|field| field.start_with?("http.200.rate") }
+          rate_fields = subject.first["http_200"].to_hash.keys.select {|field| field.start_with?("rate") }
           insist { rate_fields.length } == 1
-          insist { rate_fields }.include? "http.200.rate_1m"
+          insist { rate_fields }.include? "rate_1m"
         end
       end
     end
@@ -86,8 +88,8 @@ describe LogStash::Filters::Metrics do
 
   context "with multiple instances" do
     it "counts should be independent" do
-      config1 = {"meter" => ["http.%{response}"]}
-      config2 = {"meter" => ["http.%{response}"]}
+      config1 = {"meter" => ["http_%{response}"]}
+      config2 = {"meter" => ["http_%{response}"]}
       filter1 = LogStash::Filters::Metrics.new config1
       filter2 = LogStash::Filters::Metrics.new config2
       events1 = [
@@ -112,17 +114,17 @@ describe LogStash::Filters::Metrics do
       events1 = filter1.flush
       events2 = filter2.flush
 
-      insist { events1.first["http.200.count"] } == 1
-      insist { events2.first["http.200.count"] } == 2
-      insist { events1.first["http.404.count"] } == 1
-      insist { events2.first["http.404.count"] } == nil
+      insist { events1.first["http_200"]["count"] } == 1
+      insist { events2.first["http_200"]["count"] } == 2
+      insist { events1.first["http_404"]["count"] } == 1
+      insist { events2.first["http_404"] } == nil
     end
   end
 
   context "with timer config" do
     context "on the first flush" do
       subject {
-        config = {"timer" => ["http.request_time", "%{request_time}"]}
+        config = {"timer" => ["http_request_time", "%{request_time}"]}
         filter = LogStash::Filters::Metrics.new config
         filter.register
         filter.filter LogStash::Event.new({"request_time" => 10})
@@ -133,34 +135,34 @@ describe LogStash::Filters::Metrics do
 
       it "should flush counts" do
         insist { subject.length } == 1
-        insist { subject.first["http.request_time.count"] } == 3
+        insist { subject.first["http_request_time"]["count"] } == 3
       end
 
       it "should include rates and percentiles keys" do
         metrics = ["rate_1m", "rate_5m", "rate_15m", "p1", "p5", "p10", "p90", "p95", "p99"]
         metrics.each do |metric|
-          insist { subject.first }.include? "http.request_time.#{metric}"
+          insist { subject.first["http_request_time"] }.include? metric
         end
       end
 
       it "should include min value" do
-        insist { subject.first['http.request_time.min'] } == 10.0
+        insist { subject.first['http_request_time']['min'] } == 10.0
       end
 
       it "should include mean value" do
-        insist { subject.first['http.request_time.mean'] } == 20.0
+        insist { subject.first['http_request_time']['mean'] } == 20.0
       end
 
       it "should include stddev value" do
-        insist { subject.first['http.request_time.stddev'] } == Math.sqrt(10.0)
+        insist { subject.first['http_request_time']['stddev'] } == Math.sqrt(10.0)
       end
 
       it "should include max value" do
-        insist { subject.first['http.request_time.max'] } == 30.0
+        insist { subject.first['http_request_time']['max'] } == 30.0
       end
 
       it "should include percentile value" do
-        insist { subject.first['http.request_time.p99'] } == 30.0
+        insist { subject.first['http_request_time']['p99'] } == 30.0
       end
     end
   end
@@ -169,7 +171,7 @@ describe LogStash::Filters::Metrics do
     context "on the first flush" do
       subject {
         config = {
-          "timer" => ["http.request_time", "request_time"],
+          "timer" => ["http_request_time", "request_time"],
           "rates" => [1],
           "percentiles" => [1, 2]
         }
@@ -181,20 +183,20 @@ describe LogStash::Filters::Metrics do
 
       it "should flush counts" do
         insist { subject.length } == 1
-        insist { subject.first["http.request_time.count"] } == 1
+        insist { subject.first["http_request_time"]["count"] } == 1
       end
 
       it "should include only the requested rates" do
-        rate_fields = subject.first.to_hash.keys.select {|field| field.start_with?("http.request_time.rate") }
+        rate_fields = subject.first["http_request_time"].to_hash.keys.select {|field| field.start_with?("rate") }
         insist { rate_fields.length } == 1
-        insist { rate_fields }.include? "http.request_time.rate_1m"
+        insist { rate_fields }.include? "rate_1m"
       end
 
       it "should include only the requested percentiles" do
-        percentile_fields = subject.first.to_hash.keys.select {|field| field.start_with?("http.request_time.p") }
+        percentile_fields = subject.first["http_request_time"].to_hash.keys.select {|field| field.start_with?("p") }
         insist { percentile_fields.length } == 2
-        insist { percentile_fields }.include? "http.request_time.p1"
-        insist { percentile_fields }.include? "http.request_time.p2"
+        insist { percentile_fields }.include? "p1"
+        insist { percentile_fields }.include? "p2"
       end
     end
   end
@@ -202,7 +204,7 @@ describe LogStash::Filters::Metrics do
 
   context "when a custom flush_interval is set" do
     it "should flush only when required" do
-      config = {"meter" => ["http.%{response}"], "flush_interval" => 15}
+      config = {"meter" => ["http_%{response}"], "flush_interval" => 15}
       filter = LogStash::Filters::Metrics.new config
       filter.register
       filter.filter LogStash::Event.new({"response" => 200})
@@ -218,21 +220,21 @@ describe LogStash::Filters::Metrics do
 
   context "when a custom clear_interval is set" do
     it "should clear the metrics after interval has passed" do
-      config = {"meter" => ["http.%{response}"], "clear_interval" => 15}
+      config = {"meter" => ["http_%{response}"], "clear_interval" => 15}
       filter = LogStash::Filters::Metrics.new config
       filter.register
       filter.filter LogStash::Event.new({"response" => 200})
 
-      insist { filter.flush.first["http.200.count"] } == 1 # 5s
-      insist { filter.flush.first["http.200.count"] } == 1 # 10s
-      insist { filter.flush.first["http.200.count"] } == 1 # 15s
+      insist { filter.flush.first["http_200"]["count"] } == 1 # 5s
+      insist { filter.flush.first["http_200"]["count"] } == 1 # 10s
+      insist { filter.flush.first["http_200"]["count"] } == 1 # 15s
       insist { filter.flush }.nil?                         # 20s
     end
   end
 
   context "when invalid rates are set" do
     subject {
-      config = {"meter" => ["http.%{response}"], "rates" => [90]}
+      config = {"meter" => ["http_%{response}"], "rates" => [90]}
       filter = LogStash::Filters::Metrics.new config
     }
 

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-metrics
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-10-20 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,63 +28,65 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: metriks
+  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: metriks
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: thread_safe
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: thread_safe
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   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: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/logstash/filters/metrics.rb
+- spec/filters/metrics_spec.rb
+- logstash-filter-metrics.gemspec
 - CHANGELOG.md
+- README.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
-- README.md
-- lib/logstash/filters/metrics.rb
-- logstash-filter-metrics.gemspec
-- spec/filters/metrics_spec.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: The metrics filter is useful for aggregating metrics.