logstash-filter-metrics 4.0.2 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57bfe0e3b3d5fdd1ea24b7bad5576e6d1689e661
-  data.tar.gz: b2c9a453d532be098be076b6a3af4b1d8961645a
+SHA256:
+  metadata.gz: 9379ed1561f2bde000eee4c6289c083e865ea96fbf6a7b412bb40d5dd409e3f1
+  data.tar.gz: 88fc5a1c029371b91ade8909baa93b7ccea76e23ddb07b8a73c64a05adf04c14
 SHA512:
-  metadata.gz: 1e7521606f0700ae3c18af48c833f7eee82671ba9a4cdcebb2026eb38a74a106167350c64712bae09329783e64e042492eca94d351048d2e828c6374b6cb458e
-  data.tar.gz: 8ed0fdea1046750ca4c515f5ce5e28e765e5f8a35cc0d8854af697a61294f3fb36b9d5ee89ac58a37504fbcd2b421241918fd15deecb0b3edecec4c428548f5f
+  metadata.gz: 0f9b9fb72c5c3a47f53de359e4566210ff4e0ab03fa16fb38804473bfe14b5ea3a2519c42bebcfb347ed356b3fe9f32fc3b7c5ec17428a8c698f13febc9722ef
+  data.tar.gz: 439b34a69f783cecc820e51e4bb46aee3b876cc265c55187db909bc95c756864e20a9f895d7e84ee55af8527976645aa6f26c87ef6a96ecde55faf5e51c74885

data/CHANGELOG.md

@@ -1,14 +1,30 @@
+## 4.0.7
+  - Fixed typo in documentation
+
+## 4.0.6
+  - Fixed two minor typos in documentation
+
+## 4.0.5
+  - Update gemspec summary
+
+## 4.0.4
+  - Fix some documentation issues
+
 ## 4.0.2
   - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
 
 ## 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/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-metrics.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-metrics)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-metrics.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-metrics)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

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}s-{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 => "thing"` 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 average value in a 1-minute sliding window
+* "[thing][rate_5m]" - the per-second average value in a 5-minute sliding window
+* "[thing][rate_15m]" - the per-second average value 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 counters 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/lib/logstash/filters/metrics.rb

@@ -34,7 +34,7 @@ require "logstash/namespace"
 #
 # ==== `meter` values
 #
-# For a `meter => "something"` you will receive the following fields:
+# For a `meter => "thing"` 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
@@ -158,6 +158,8 @@ class LogStash::Filters::Metrics < LogStash::Filters::Base
     @last_flush = Atomic.new(0) # how many seconds ago the metrics where flushed.
     @last_clear = Atomic.new(0) # how many seconds ago the metrics where cleared.
     @random_key_preffix = SecureRandom.hex
+    # Same as logstash-input-file
+    @host = Socket.gethostname.force_encoding(Encoding::UTF_8)
     unless (@rates - [1, 5, 15]).empty?
       raise LogStash::ConfigurationError, "Invalid rates configuration. possible rates are 1, 5, 15. Rates: #{rates}."
     end
@@ -193,7 +195,7 @@ class LogStash::Filters::Metrics < LogStash::Filters::Base
     return unless should_flush?
 
     event = LogStash::Event.new
-    event.set("message", Socket.gethostname)
+    event.set("message", @host)
     @metric_meters.each_pair do |name, metric|
       flush_rates event, name, metric
       metric.clear if should_clear?

data/logstash-filter-metrics.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-metrics'
-  s.version         = '4.0.2'
+  s.version         = '4.0.7'
   s.licenses        = ['Apache License (2.0)']
-  s.summary         = "The metrics filter is useful for aggregating metrics."
+  s.summary         = "Aggregates 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"
   s.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
@@ -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)/})
@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "thread_safe"
 
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'insist'
 end

data/spec/filters/metrics_spec.rb

@@ -1,4 +1,5 @@
 require "logstash/devutils/rspec/spec_helper"
+require "insist"
 require "logstash/filters/metrics"
 
 describe LogStash::Filters::Metrics do
@@ -42,6 +43,11 @@ describe LogStash::Filters::Metrics do
             end
           end
         end
+
+        it "should have host in message" do
+          insist { subject.length } == 1
+          reject { subject.first.get("message") }.nil?
+        end
       end
 
       context "on the second flush" do

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.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,23 @@ dependencies:
     - - ">="
       - !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/logstash-plugin install gemname. This gem is not a stand-alone program
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: insist
+  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/logstash-plugin install gemname. This
+  gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
@@ -84,6 +100,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,9 +126,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
-summary: The metrics filter is useful for aggregating metrics.
+summary: Aggregates metrics
 test_files:
 - spec/filters/metrics_spec.rb