logstash-output-elasticsearch_groom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 486c325f8f953643e6326d2108b6751ad1097adb
+  data.tar.gz: 5fa13b6edbcde045d49bd4c8f5e11a353a02e172
+SHA512:
+  metadata.gz: d1ebb214123441133ecdf04bb0fc2d9063b474543e7a49eafd67bdf69019563ba18e8500505acad887db63b085aae05ca9db590611e090d79b148ba4c43f5513
+  data.tar.gz: 9c4cd555da338cff715d26c7db2d504f14fd0b191d3b038ec996fc68d2fe5489b248362c29a2c42a1ce41059d1d16976c073096912bf1cff6df8a0d87baa0019

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+Gemfile.lock
+Gemfile.bak
+.bundle
+vendor
+lib/logstash-output-elasticsearch_groom_jars.rb
+lib/com
+lib/org
+/.idea
+/*.iml

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,17 @@
+# logstash-output-elasticsearch-groom
+
+## On Windows, with Logstash 1.5.0.rc2
+
+Edit the `Gemfile` under the distribution adding a line like:
+
+```
+gem "logstash-output-elasticsearch_groom", :path => "C:\\Users\\YOURNAME\\git\\logstash-output-elasticsearch-groom"
+```
+
+and then run
+
+```
+bin\plugin.bat install --no-verify
+```
+
+This workaround was obtained from [this issue comment](https://github.com/elastic/logstash/issues/2779#issuecomment-77927682).

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   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 {yyyy} {name of copyright owner}
+
+   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

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/circle.yml

@@ -0,0 +1,14 @@
+machine:
+  ruby:
+    version: jruby-1.7.19
+
+test:
+  post:
+    - bundle install
+    - bundle exec rspec
+
+deployment:
+  publish:
+    branch: master
+    commands:
+      - ./gem_publish.sh

data/example.conf

@@ -0,0 +1,38 @@
+input {
+  heartbeat {
+    type => 'groom'
+    interval => 11
+    add_field => {
+      scope => 'open'
+      cutoff => '2w'
+      action => 'close'
+    }
+  }
+
+  heartbeat {
+    type => 'groom'
+    interval => 12
+    add_field => {
+      scope => 'closed'
+      cutoff => '4w'
+      action => 'delete'
+    }
+  }
+}
+
+output {
+
+  if [type] == 'groom' {
+    elasticsearch_groom {
+      host => 'localhost:9200'
+      index => 'logstash-%{+YYYY.MM.dd}'
+      scope => '%{scope}'
+      age_cutoff => '%{cutoff}'
+      action => '%{action}'
+    }
+  }
+
+  stdout {
+    codec => rubydebug
+  }
+}

data/gem_publish.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+mkdir -p ~/.gem
+echo ":rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials
+chmod 600 ~/.gem/credentials
+bundle exec rake publish_gem

data/lib/logstash/outputs/elasticsearch_groom.rb

@@ -0,0 +1,203 @@
+# encoding: utf-8
+require 'logstash/outputs/base'
+require 'logstash/namespace'
+require 'logstash-output-elasticsearch_groom_jars'
+require 'java'
+
+# This output grooms the indices created by the `elasticsearch` output plugin. By leveraging the same timestamp-based
+# `index` specification, this plugin closes or deletes indices that are older than a configured cutoff.
+#
+# The actions of this plugin are event-driven, meaning it only evaluates and grooms indices when an event
+# is received. Combined with the `logstash-input-heartbeat` plugin, there is some interesting configurations you can setup
+# such as:
+#
+# [source]
+# ----------------------------------
+# input {
+#   heartbeat {
+#     type => 'groom'
+#     interval => 86400
+#     add_field => {
+#       scope => 'open'
+#       cutoff => '2w'
+#       action => 'close'
+#     }
+#   }
+#
+#   heartbeat {
+#     type => 'groom'
+#     interval => 86400
+#     add_field => {
+#       scope => 'closed'
+#       cutoff => '4w'
+#       action => 'delete'
+#     }
+#   }
+# }
+#
+# output {
+#   if [type] == 'groom' {
+#     elasticsearch_groom {
+#        host => 'localhost:9200'
+#        index => 'logstash-%{+YYYY.MM.dd}'
+#        scope => '%{scope}'
+#        age_cutoff => '%{cutoff}'
+#        action => '%{action}'
+#     }
+#   }
+# }
+# ----------------------------------
+class LogStash::Outputs::ElasticsearchGroom < LogStash::Outputs::Base
+  config_name 'elasticsearch_groom'
+
+  # Declares a template for matching potential indices to groom. If you're using the output elasticsearch
+  # plugin, which is probably why you're here, then this is the same value as `index` over there.
+  # It needs to include at least a timestamp placeholder like `%{+YYYY.MM.dd}` where the pattern
+  # after the `+` is any http://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html[valid Joda Time pattern].
+  # This can include other event field references via `%{value}` substitution or
+  # `*` to wildcard any part of the index name.
+  config :index, :validate => :string, :required => true, :default => "logstash-%{+YYYY.MM.dd}"
+
+  # The hostname or IP address of the host to use for Elasticsearch unicast discovery
+  # The entries are formatted as `host:port`, where `port` is typically 9200
+  config :host, :validate => :array, :default => "localhost:9200"
+
+  # Specifies if 'open' or 'closed' indices should be considered.
+  # Can include/be an event field reference via `%{value}` substitution
+  config :scope, :validate => :string, :default => 'open'
+
+  # Declares the relative age of indices that will be processed by the action.
+  # The allowed values for this are formed as <<number>><<scale>> where
+  # scale is 'h' (hours), 'd' (days), 'w' (weeks) and the age is relative
+  # to the event's @timestamp.
+  # Can include/be an event field reference via `%{value}` substitution
+  config :age_cutoff, :validate => :string, :default => '4w'
+
+  # For those indices that are older than the age_cutoff, this is the action
+  # to take on those indices. The possible choices are 'close' or 'delete'.
+  # Can include/be an event field reference via `%{value}` substitution
+  config :action, :validate => :string, :default => 'close'
+
+  # Indicates if incoming events that were successfully used should be cancelled
+  config :cancel_when_used, :validate => :boolean, :default => true
+
+  public
+  def register
+    options = {
+        host: @host
+    }
+    @es_access = create_es_accessor(options)
+
+    raise LogStash::ConfigurationError, "A timestamp placeholder %{+___} is required in the 'index' config of elasticsearch_groom" \
+       unless @index.match /%{\+(.+)}/
+  end
+
+  protected
+  def self.create_es_accessor(options)
+    require 'logstash/outputs/elasticsearch_groom/es_accessor'
+
+    LogStash::Outputs::EsGroom::EsAccessor.new(options)
+  end
+
+  # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+
+    ts_wildcarded = @index.gsub /%{\+.+}/, '*'
+    ts_wildcarded = event.sprintf ts_wildcarded
+
+    resolved_scope = event.sprintf(@scope)
+    return unless valid_option? 'scope', resolved_scope, %w(open closed both)
+
+    candidates = @es_access.matching_indices ts_wildcarded, resolved_scope
+    @logger.debug? and @logger.debug "Starting with #{candidates}"
+
+    groomed = []
+    if (ts_bit_matched = @index.match /%{\+(.+)}/)
+      groomed = groom_by_time(event, candidates, ts_bit_matched)
+    else
+      @logger.warn "Only 'index' with a timestamp placeholder is supported. Instead had #{resolvedIndex}"
+    end
+
+    # We consumed it, so cancel it
+    event.cancel if @cancel_when_used
+
+    "Groomed #{groomed}"
+  end
+
+
+  protected
+  def groom_by_time(event, candidates, ts_bit_matched)
+    resolved_cutoff = event.sprintf(@age_cutoff)
+    cutoff_msec = convert_cutoff(resolved_cutoff)
+    return unless cutoff_msec
+
+    event_ts_ms = event.timestamp.to_i*1000
+    event_dt = org.joda.time.DateTime.new
+    event_dt.set_millis event_ts_ms.to_java(:long)
+    abs_cutoff_dt = event_dt.minus cutoff_msec
+
+    @logger.debug? and @logger.debug "Grooming indices older than #{abs_cutoff_dt}"
+
+    dt_format = org.joda.time.format.DateTimeFormat.forPattern ts_bit_matched[1]
+    resolved_index = event.sprintf (ts_bit_matched.pre_match + '(.+)' + ts_bit_matched.post_match)
+    index_parse_regex = Regexp.new resolved_index
+    @logger.debug? and @logger.debug "Index regex is #{index_parse_regex}"
+
+    # Narrow down the candidates to only those that are older than the cutoff
+    needs_grooming = candidates.find_all do |i|
+
+      if (match_data = index_parse_regex.match(i))
+        index_dt = dt_format.parseDateTime match_data[1]
+        @logger.debug? and @logger.debug "Parsed DateTime of #{i} is #{index_dt}"
+        next index_dt.isBefore abs_cutoff_dt
+      end
+
+    end
+
+    unless needs_grooming.empty?
+      resolved_action = event.sprintf @action
+      return unless valid_option? 'action', resolved_action, %w(close delete)
+
+      @logger.info? and @logger.info "Performing the action #{resolved_action} on #{needs_grooming}"
+      case resolved_action
+        when 'close' then
+          @es_access.close_indices needs_grooming
+        when 'delete' then
+          @es_access.delete_indices needs_grooming
+        else
+          @logger.warn "Action resolved to an unexpected value #{resolved_action}"
+      end
+    end
+
+    needs_grooming
+  end
+
+  # Converts the cutoff expression into a duration in milliseconds
+  def convert_cutoff(cutoff_str)
+    match_data = /(\d+)([hdw])/.match(cutoff_str)
+    if match_data
+      value = match_data[1]
+      value.to_i * 1000 * 3600 * case match_data[2]
+              when 'h' then 1
+              when 'd' then 24
+              when 'w' then 24*7
+              else
+                @logger.warn("Invalid cutoff of #{cutoff_str}")
+                nil
+            end
+    else
+      @logger.warn("Invalid cutoff of #{cutoff_str}")
+      nil
+    end
+  end
+
+  def valid_option?(option, given_value, valid_values)
+    valid = valid_values.member?(given_value)
+    @logger.warn "#{option} contained an invalid value: #{given_value}. Valid values are #{valid_values}" \
+        unless valid
+    valid
+  end
+end

data/lib/logstash/outputs/elasticsearch_groom/es_accessor.rb

@@ -0,0 +1,43 @@
+require 'elasticsearch'
+
+module LogStash::Outputs::EsGroom
+
+  # Abstracts the connectivity to Elasticsearch and the ES specific operations.
+  class EsAccessor
+    def initialize(options={})
+      @client = Elasticsearch::Client.new host: options[:host]
+    end
+
+    public
+    def close_indices(indices)
+      return if indices.empty?
+
+      # close doesn't accept a list, so iterate to pull it off
+      indices.each do |i|
+        @client.indices.close index: i
+      end
+    end
+
+    public
+    def delete_indices(indices)
+      return if indices.empty?
+      @client.indices.delete index: indices
+    end
+
+    public
+    def matching_indices(pattern='_all', scope='open')
+
+      # Need to emulate 'both'
+      resolved_scope = scope == 'both' ? %w(open closed) : scope
+
+      begin
+        full_results = @client.indices.get index: pattern, expand_wildcards: resolved_scope
+        full_results.keys
+      rescue Elasticsearch::Transport::Transport::Errors::BadRequest
+        # This gets raised when no indices match the given pattern
+        return []
+      end
+    end
+  end
+
+end

data/logstash-output-elasticsearch_groom.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-elasticsearch_groom'
+  s.version         = "0.1.0"
+  s.licenses = ["Apache License (2.0)"]
+  s.summary = "Grooms time-series Elastichsearch indices."
+  s.description = "A logstash output plugin that will perform event triggered grooming (aka pruning) of time-series indices especially those created by logstash-output-elasticsearch."
+  s.authors = ["Geoff Bourne"]
+  s.email = "itzgeoff@gmail.com"
+  s.homepage = "https://github.com/itzg/logstash-output-elasticsearch-groom"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  s.requirements << "jar 'org.elasticsearch:elasticsearch', '1.4.0'"
+
+  # Gem dependencies
+  s.add_runtime_dependency 'jar-dependencies', '~> 0'
+  s.add_runtime_dependency 'elasticsearch', ['>= 1.0.7', '~> 1.0']
+  s.add_runtime_dependency "logstash-core", ">= 1.4.0", "< 2.0.0"
+  s.add_runtime_dependency 'logstash-codec-plain', '~> 0'
+
+  s.add_development_dependency 'logstash-devutils', '~> 0'
+end

data/spec/outputs/elasticsearch_groom_spec.rb

@@ -0,0 +1,26 @@
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/outputs/elasticsearch_groom'
+require 'logstash/codecs/plain'
+require 'logstash/event'
+require 'rspec/mocks'
+
+describe 'outputs/elasticsearch_groom' do
+  let(:es_accessor) { double 'LogStash::Outputs::EsGroom::EsAccessor' }
+  let(:outputClass) { LogStash::Plugin.lookup("output", "elasticsearch_groom") }
+
+  before do
+    allow_any_instance_of(LogStash::Outputs::ElasticsearchGroom).to receive(:create_es_accessor).and_return(es_accessor)
+  end
+
+  it 'should work with defaults' do
+    output = outputClass.new()
+    output.register
+
+    event = LogStash::Event.new(@timestamp => '2015-04-11T00:00:00')
+
+    expect(es_accessor).to receive(:matching_indices)
+                               .with('logstash-*', 'open')
+                               .and_return(['logstash-2015.04.11'])
+    output.receive event
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-elasticsearch_groom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Bourne
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jar-dependencies
+  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'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  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'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  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'
+  prerelease: false
+  type: :development
+description: A logstash output plugin that will perform event triggered grooming (aka pruning) of time-series indices especially those created by logstash-output-elasticsearch.
+email: itzgeoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- circle.yml
+- example.conf
+- gem_publish.sh
+- lib/logstash/outputs/elasticsearch_groom.rb
+- lib/logstash/outputs/elasticsearch_groom/es_accessor.rb
+- logstash-output-elasticsearch_groom.gemspec
+- spec/outputs/elasticsearch_groom_spec.rb
+homepage: https://github.com/itzg/logstash-output-elasticsearch-groom
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- jar 'org.elasticsearch:elasticsearch', '1.4.0'
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Grooms time-series Elastichsearch indices.
+test_files:
+- spec/outputs/elasticsearch_groom_spec.rb