logstash-input-dead_letter_queue 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a9d666fbc7ae336aa2c0559581120cd101a7bc7
-  data.tar.gz: d5dfb0bcdecd94f14c6b94a2213125ecad415aeb
+  metadata.gz: 52ee819033d61997dc53412e5df0a50b80ea81e9
+  data.tar.gz: 7defbd2c0f09d4871eecded6fe880cf5cf5f7ad9
 SHA512:
-  metadata.gz: 58dc4f906ebac0e344b8804aac88a498a14e51f584704714d6853fb3c9dc94a42011804ef2678735291ca618ddf9152146439adc121b96e423482256dbc80bed
-  data.tar.gz: a8118fd932a4e1cf06b454eda92754af425e109d0469c8af43c02abe83291579059943242886e011a3a2a3ac739163005a85f0bfb895fae9064d26c95bddf4a5
+  metadata.gz: 3628c14bbbe3c3436b08174261b223d975f81a3e495a4e9950d2f1d1f4efb7f3610e3d750e90b2cd6a8ff3133fbcec30d19ac7cbb9c0bedcb029154590c4ea07
+  data.tar.gz: d54bf94e03819f2aea92a6f4c99c5f9b6cd2212664a89ae71ba23053724e89c9e094234006b97190dd1b6d9c8708229692e3cdc3a00cc4bed7b2498a6aa420c6

data/CHANGELOG.md

@@ -1,2 +1,11 @@
+## 1.0.3
+ - Docs: Fixed error in example plus made a few edits
+ 
+## 1.0.2
+ - internal: renamed DeadLetterQueueWriteManager to DeadLetterQueueWriter in tests
+ 
+## 1.0.1
+  - internal: rename DeadLetterQueueManager to DeadLetterQueueReader
+
 ## 1.0.0
-  - init
+  - init

data/Gemfile

@@ -1,3 +1,11 @@
 source 'https://rubygems.org'
 
 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/README.md

@@ -8,6 +8,16 @@ It is fully free and fully open source. The license is Apache 2.0, meaning you a
 
 ## Documentation
 
+```sh
+ input {
+   dead_letter_queue {
+     path => "/var/logstash/data/dead_letter_queue"
+     timestamp => "2017-04-04T23:40:37"
+   }
+ }
+```
+
+
 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/).

data/docs/index.asciidoc

@@ -0,0 +1,108 @@
+:plugin: dead_letter_queue
+:type: input
+
+///////////////////////////////////////////
+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}"]
+
+=== Dead_letter_queue
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Logstash input to read events from Logstash's dead letter queue.
+
+[source, sh]
+-----------------------------------------
+input {
+  dead_letter_queue {
+    path => "/var/logstash/data/dead_letter_queue"
+    start_timestamp => "2017-04-04T23:40:37"
+  }
+}
+-----------------------------------------
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Dead_letter_queue Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-commit_offsets>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-path>> |a valid filesystem path|Yes
+| <<plugins-{type}s-{plugin}-pipeline_id>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-start_timestamp>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-commit_offsets"]
+===== `commit_offsets` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Specifies whether this input should commit offsets as it processes the events.
+Typically you specify `false` 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. 
+
+[id="plugins-{type}s-{plugin}-path"]
+===== `path` 
+
+  * This is a required setting.
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+Path to the dead letter queue directory that was created by a Logstash instance.
+This is the path from which "dead" events are read and is typically configured 
+in the original Logstash instance with the setting `path.dead_letter_queue`.
+
+[id="plugins-{type}s-{plugin}-pipeline_id"]
+===== `pipeline_id` 
+
+  * Value type is <<string,string>>
+  * Default value is `"main"`
+
+ID of the pipeline whose events you want to read from.
+
+[id="plugins-{type}s-{plugin}-sincedb_path"]
+===== `sincedb_path` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+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: This value must be a file path and not a directory path.
+
+[id="plugins-{type}s-{plugin}-start_timestamp"]
+===== `start_timestamp` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Timestamp in ISO8601 format from when you want to start processing the events from. 
+For example, `2017-04-04T23:40:37`.
+
+
+
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-dead_letter_queue.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-input-dead_letter_queue'
-  s.version         = '1.0.0'
+  s.version         = '1.0.3'
   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"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   # Files
-  s.files = Dir['lib/**/*.rb','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)/})

data/spec/unit/inputs/dead_letter_queue_spec.rb

@@ -4,9 +4,23 @@ require "logstash/inputs/dead_letter_queue"
 require "concurrent"
 
 describe LogStash::Inputs::DeadLetterQueue do
-  subject { LogStash::Inputs::DeadLetterQueue.new(config) }
+  let(:pipeline_id) { SecureRandom.hex(8)}
+  let(:path) { Dir.tmpdir }
+  let(:directory) { File.join(path, pipeline_id)}
 
-  it "should register" do
+  subject { LogStash::Inputs::DeadLetterQueue.new({ "path" => path,
+                                                    "pipeline_id" => pipeline_id}) }
+
+  before(:each) do
+    Dir.mkdir(directory)
+  end
+
+  it 'should register' do
     expect {subject.register}.to_not raise_error
   end
+
+
+  after(:each) do
+    FileUtils.remove_entry_secure directory
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-dead_letter_queue
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,8 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
+- lib/logstash-input-dead_letter_queue.jar
 - lib/logstash/inputs/dead_letter_queue.rb
 - logstash-input-dead_letter_queue.gemspec
 - spec/unit/inputs/dead_letter_queue_spec.rb