logstash-filter-metrics 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57bfe0e3b3d5fdd1ea24b7bad5576e6d1689e661
-  data.tar.gz: b2c9a453d532be098be076b6a3af4b1d8961645a
+  metadata.gz: ae073bd8a88f8fdc36369ac0fbc804e2da56f23e
+  data.tar.gz: 8f9f726f6edb421cb0e52eb891cf123bf12dd720
 SHA512:
-  metadata.gz: 1e7521606f0700ae3c18af48c833f7eee82671ba9a4cdcebb2026eb38a74a106167350c64712bae09329783e64e042492eca94d351048d2e828c6374b6cb458e
-  data.tar.gz: 8ed0fdea1046750ca4c515f5ce5e28e765e5f8a35cc0d8854af697a61294f3fb36b9d5ee89ac58a37504fbcd2b421241918fd15deecb0b3edecec4c428548f5f
+  metadata.gz: 10c21adaf28dc15b484a915c29217a8a5e1861a8bbbd77a020857fc587927197fc0e4dc6040513a77ff4fd634878d69159ccb6c44efb659d1322b38d90d6cb98
+  data.tar.gz: 2b8823c3a5ed75523097408c792193f4b5d08ab84aa9726f2cf65b6b67a93275537cd1ebaac8ed71f9ecbee8218959f738c9161f3aad1e8f617b4a23294ac047

data/CHANGELOG.md

@@ -3,12 +3,16 @@
 
 ## 4.0.1
   - Republish all the gems under jruby.
+
 ## 4.0.0
   - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
+
 # 3.0.2
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+
 # 3.0.1
   - New dependency requirements for logstash-core for the 5.0 release
+
 ## 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.

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,228 @@
+:plugin: metrics
+:type: filter
+
+///////////////////////////////////////////
+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}"]
+
+=== Metrics filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+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}" ]
+        add_tag => "metric"
+      }
+    }
+
+Metrics are flushed every 5 seconds by default or according to
+`flush_interval`. Metrics appear as
+new events in the event stream and go through any filters
+that occur after as well as outputs.
+
+In general, you will want to add a tag to your metrics and have an output
+explicitly look for that tag.
+
+The event that is flushed will include every 'meter' and 'timer'
+metric in the following way:
+
+==== `meter` values
+
+For a `meter => "something"` you will receive the following fields:
+
+* "[thing][count]" - the total count of events
+* "[thing][rate_1m]" - the per-second event rate in a 1-minute sliding window
+* "[thing][rate_5m]" - the per-second event rate in a 5-minute sliding window
+* "[thing][rate_15m]" - the per-second event rate in a 15-minute sliding window
+
+==== `timer` values
+
+For a `timer => [ "thing", "%{duration}" ]` you will receive the following fields:
+
+* "[thing][count]" - the total count of events
+* "[thing][rate_1m]" - the per-second event rate in a 1-minute sliding window
+* "[thing][rate_5m]" - the per-second event rate in a 5-minute sliding window
+* "[thing][rate_15m]" - the per-second event rate in a 15-minute sliding window
+* "[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`)
+
+The default lengths of the event rate window (1, 5, and 15 minutes)
+can be configured with the `rates` option.
+
+==== Example: Computing event rate
+
+For a simple example, let's track how many events per second are running
+through logstash:
+[source,ruby]
+----
+    input {
+      generator {
+        type => "generated"
+      }
+    }
+
+    filter {
+      if [type] == "generated" {
+        metrics {
+          meter => "events"
+          add_tag => "metric"
+        }
+      }
+    }
+
+    output {
+      # only emit events with the 'metric' tag
+      if "metric" in [tags] {
+        stdout {
+          codec => line {
+            format => "rate: %{[events][rate_1m]}"
+          }
+        }
+      }
+    }
+----
+
+Running the above:
+[source,ruby]
+    % bin/logstash -f example.conf
+    rate: 23721.983566819246
+    rate: 24811.395722536377
+    rate: 25875.892745934525
+    rate: 26836.42375967113
+
+We see the output includes our events' 1-minute rate.
+
+In the real world, you would emit this to graphite or another metrics store,
+like so:
+[source,ruby]
+    output {
+      graphite {
+        metrics => [ "events.rate_1m", "%{[events][rate_1m]}" ]
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Metrics Filter 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}-clear_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-flush_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-ignore_older_than>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-meter>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-percentiles>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-rates>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-timer>> |<<hash,hash>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-clear_interval"]
+===== `clear_interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `-1`
+
+The clear interval, when all counter are reset.
+
+If set to -1, the default value, the metrics will never be cleared.
+Otherwise, should be a multiple of 5s.
+
+[id="plugins-{type}s-{plugin}-flush_interval"]
+===== `flush_interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `5`
+
+The flush interval, when the metrics event is created. Must be a multiple of 5s.
+
+[id="plugins-{type}s-{plugin}-ignore_older_than"]
+===== `ignore_older_than` 
+
+  * Value type is <<number,number>>
+  * Default value is `0`
+
+Don't track events that have `@timestamp` older than some number of seconds.
+
+This is useful if you want to only include events that are near real-time
+in your metrics.
+
+For example, to only count events that are within 10 seconds of real-time, you
+would do this:
+
+    filter {
+      metrics {
+        meter => [ "hits" ]
+        ignore_older_than => 10
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-meter"]
+===== `meter` 
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+syntax: `meter => [ "name of metric", "name of metric" ]`
+
+[id="plugins-{type}s-{plugin}-percentiles"]
+===== `percentiles` 
+
+  * Value type is <<array,array>>
+  * Default value is `[1, 5, 10, 90, 95, 99, 100]`
+
+The percentiles that should be measured and emitted for timer values.
+
+[id="plugins-{type}s-{plugin}-rates"]
+===== `rates` 
+
+  * Value type is <<array,array>>
+  * Default value is `[1, 5, 15]`
+
+The rates that should be measured, in minutes.
+Possible values are 1, 5, and 15.
+
+[id="plugins-{type}s-{plugin}-timer"]
+===== `timer` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+syntax: `timer => [ "name of metric", "%{time_value}" ]`
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-metrics.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-metrics'
-  s.version         = '4.0.2'
+  s.version         = '4.0.3'
   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/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)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-metrics
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 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/filters/metrics.rb
 - logstash-filter-metrics.gemspec
 - spec/filters/metrics_spec.rb
@@ -109,7 +110,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: The metrics filter is useful for aggregating metrics.