logstash-input-dead_letter_queue 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a9d666fbc7ae336aa2c0559581120cd101a7bc7
+  data.tar.gz: d5dfb0bcdecd94f14c6b94a2213125ecad415aeb
+SHA512:
+  metadata.gz: 58dc4f906ebac0e344b8804aac88a498a14e51f584704714d6853fb3c9dc94a42011804ef2678735291ca618ddf9152146439adc121b96e423482256dbc80bed
+  data.tar.gz: a8118fd932a4e1cf06b454eda92754af425e109d0469c8af43c02abe83291579059943242886e011a3a2a3ac739163005a85f0bfb895fae9064d26c95bddf4a5

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0
+  - init

data/CONTRIBUTORS

@@ -0,0 +1,15 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Joseph Lawson (joekiller)
+* Pere Urbón (purbon)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+* Tal Levy (talevy)
+
+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,20 @@
+logstash-input-dead_letter_queue
+====================
+
+Logstash Dead Letter Queue Input Plugin, This plugin enables reading from Logstash's dead-letter-queue.
+
+Logstash Configuration
+====================
+
+    input {
+        dead_letter_queue {
+            path => ... # string (required) Path to dead letter queue directory containing segment files
+        }
+    }
+
+This plugin uses its own decoding logic and ignores the `codec` options.
+
+Dependencies
+====================
+
+* Logstash >= 5.4

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+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
+
+    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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,100 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-dead_letter_queue.svg)](https://travis-ci.org/logstash-plugins/logstash-input-dead_letter_queue)
+
+This is a plugin for [Logstash](https://github.com/elastic/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
+
+https://www.elastic.co/guide/en/logstash/current/plugins-inputs-dead_letter_queue.html
+
+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.elastic.co/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/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## 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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/dead_letter_queue.rb

@@ -0,0 +1,74 @@
+require 'logstash/namespace'
+require 'logstash/inputs/base'
+require 'logstash-input-dead_letter_queue.jar'
+
+# Logstash input to read events from Logstash's dead letter queue
+# 
+# [source, sh]
+# -----------------------------------------
+# input {
+#   dead_letter_queue {
+#     path => "/var/logstash/data/dead_letter_queue"
+#     timestamp => "2017-04-04T23:40:37"
+#   }
+# }
+# -----------------------------------------
+# 
+class LogStash::Inputs::DeadLetterQueue < LogStash::Inputs::Base
+  config_name 'dead_letter_queue'
+
+  default :codec, 'plain'
+
+  # Path to the dead letter queue directory which was created by a Logstash instance.
+  # This is the path from where "dead" events are read from and is typically configured 
+  # in the original Logstash instance with the setting path.dead_letter_queue.
+  config :path, :validate => :path, :required => true
+  # ID of the pipeline whose events you want to read from.
+  config :pipeline_id, :validate => :string, :default => "main"
+  # Path of the sincedb database file (keeps track of the current position of dead letter queue) that 
+  # will be written to disk. The default will write sincedb files to `<path.data>/plugins/inputs/dead_letter_queue`
+  # NOTE: it must be a file path and not a directory path
+  config :sincedb_path, :validate => :string, :required => false
+  # Should this input commit offsets as it processes the events. `false` value is typically 
+  # used when you want to iterate multiple times over the events in the dead letter queue, but don't want to 
+  # save state. This is when you are exploring the events in the dead letter queue. 
+  config :commit_offsets, :validate => :boolean, :default => true
+  # Timestamp in ISO8601 format from when you want to start processing the events from. 
+  # For example, 2017-04-04T23:40:37
+  config :start_timestamp, :validate => :string, :required => false
+
+  public
+  def register
+    if @sincedb_path.nil?
+      datapath = File.join(LogStash::SETTINGS.get_value("path.data"), "plugins", "inputs", "dead_letter_queue", @pipeline_id)
+      # Ensure that the filepath exists before writing, since it's deeply nested.
+      FileUtils::mkdir_p datapath
+      @sincedb_path = File.join(datapath, ".sincedb_" + Digest::MD5.hexdigest(@path))
+    elsif File.directory?(@sincedb_path)
+        raise ArgumentError.new("The \"sincedb_path\" argument must point to a file, received a directory: \"#{@sincedb_path}\"")
+    end
+
+    dlq_path = java.nio.file.Paths.get(File.join(@path, @pipeline_id))
+    sincedb_path = @sincedb_path ? java.nio.file.Paths.get(@sincedb_path) : nil
+    start_timestamp = @start_timestamp ? org.logstash.Timestamp.new(@start_timestamp) : nil
+    @inner_plugin = org.logstash.input.DeadLetterQueueInputPlugin.new(dlq_path, @commit_offsets, sincedb_path, start_timestamp)
+    @inner_plugin.register
+  end # def register
+
+  public
+  def run(logstash_queue)
+    @inner_plugin.run do |entry|
+      event = LogStash::Event.new(entry.event.toMap())
+      event.set("[@metadata][dead_letter_queue][plugin_type]", entry.plugin_type)
+      event.set("[@metadata][dead_letter_queue][plugin_id]", entry.plugin_id)
+      event.set("[@metadata][dead_letter_queue][reason]", entry.reason)
+      event.set("[@metadata][dead_letter_queue][entry_time]", entry.entry_time)
+      logstash_queue << event
+    end
+  end # def run
+
+  public
+  def stop
+    @inner_plugin.close
+  end
+end

data/logstash-input-dead_letter_queue.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-input-dead_letter_queue'
+  s.version         = '1.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = 'Logstash input to read dead lettered events'
+  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'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*.rb','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # 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', 'group' => 'input'}
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-codec-plain'
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/unit/inputs/dead_letter_queue_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/dead_letter_queue"
+require "concurrent"
+
+describe LogStash::Inputs::DeadLetterQueue do
+  subject { LogStash::Inputs::DeadLetterQueue.new(config) }
+
+  it "should register" do
+    expect {subject.register}.to_not raise_error
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-dead_letter_queue
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  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/logstash-plugin install gemname. This gem is not a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/inputs/dead_letter_queue.rb
+- logstash-input-dead_letter_queue.gemspec
+- spec/unit/inputs/dead_letter_queue_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  group: input
+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: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Logstash input to read dead lettered events
+test_files:
+- spec/unit/inputs/dead_letter_queue_spec.rb