logstash-input-http_poller 1.1.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25a9679db9386a407c380a4d321acacf4a40fe84
-  data.tar.gz: 02a990f7c35be4e02feb73d2979cd72e40f999a9
+  metadata.gz: 00bca71c9b7ea90c67ce4a90dc7f70f5c4b1e849
+  data.tar.gz: ce702eac396ec7c0712b8b8897cdc6ed3dc1c5c6
 SHA512:
-  metadata.gz: ea3921bd5e960c25b2c4158a421c06240c2f9ac2911e993d6d831cf2a130b41b73083d04e82421b2fe7bb454a90ee9003e72f4c9192d82dbe915e97f23de925e
-  data.tar.gz: 4da38a804b10b3a76b9a455745771421ad9aec1a44a86d418ccbad4779820fe50d3cfbb449b8a7c1fea8547ed5b2c505eb06f5b7937dbcb6cf3b15c8eee0debf
+  metadata.gz: 5669ad934a4e3178812ff7ea59944634d0b0278d8dc5837fa50e25fa3ee07edef7087d318c26ddc4ffb8a7e25e8bbce0e5120777e3685a7c5a7ad231eace7b19
+  data.tar.gz: a647b151a1b1ed31f637c5362938e1a35f43f2ee155f94995e993a09cc491be1fa3f2ebf5834aede19b12253016003f439fd5f63dbe34afc0a5bc841685a66ab

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+
 * 1.1.2
   - Correctly default to zero connection retries
   - Revert old ineffective code for connection retries

data/README.md

@@ -2,7 +2,7 @@
 
 This plugin is based off [logstash-input-rest](https://github.com/maximede/logstash-input-rest) by @maximede.
 
-This [Logstash](https://github.com/elasticsearch/logstash) input plugin allows you to call an HTTP API, decode the output of it into event(s), and send them on their merry way.
+This [Logstash](https://github.com/elastic/logstash) input plugin allows you to call an HTTP API, decode the output of it into event(s), and send them on their merry way.
 
 The idea behind this plugins came from a need to read springboot metrics endpoint, instead of configuring jmx to monitor my java application memory / gc/ etc.
 
@@ -14,10 +14,10 @@ For config examples see `http_poller.rb` in `lib/logstash/inputs/` in this repo.
 
 ## 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/).
+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/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -91,4 +91,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 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.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/http_poller.rb

@@ -5,11 +5,16 @@ require "logstash/plugin_mixins/http_client"
 require "socket" # for Socket.gethostname
 require "manticore"
 
-# Note. This plugin is a WIP! Things will change and break!
+# This Logstash input plugin allows you to call an HTTP API, decode the output of it into event(s), and
+# send them on their merry way. The idea behind this plugins came from a need to read springboot
+# metrics endpoint, instead of configuring jmx to monitor my java application memory/gc/ etc.
 #
-# Reads from a list of urls and decodes the body of the response with a codec
+# ==== Example
+# Reads from a list of urls and decodes the body of the response with a codec.
 # The config should look like this:
 #
+# [source,ruby]
+# ----------------------------------
 # input {
 #   http_poller {
 #     urls => {
@@ -40,6 +45,7 @@ require "manticore"
 #     codec => rubydebug
 #   }
 # }
+# ----------------------------------
 
 class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
   include LogStash::PluginMixins::HttpClient
@@ -48,18 +54,17 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
 
   default :codec, "json"
 
-  # A Hash of urls in this format : "name" => "url"
+  # A Hash of urls in this format : `"name" => "url"`.
   # The name and the url will be passed in the outputed event
-  #
   config :urls, :validate => :hash, :required => true
 
-  # How often  (in seconds) the urls will be called
+  # How often (in seconds) the urls will be called
   config :interval, :validate => :number, :required => true
 
   # Define the target field for placing the received data. If this setting is omitted, the data will be stored at the root (top level) of the event.
   config :target, :validate => :string
 
-  # If you'd like to work with the request/response metadata
+  # If you'd like to work with the request/response metadata.
   # Set this value to the name of the field you'd like to store a nested
   # hash of metadata.
   config :metadata_target, :validate => :string, :default => '@metadata'
@@ -74,6 +79,10 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
     setup_requests!
   end
 
+  def stop
+    Stud.stop!(@interval_thread) if @interval_thread
+  end
+
   private
   def setup_requests!
     @requests = Hash[@urls.map {|name, url| [name, normalize_request(url)] }]
@@ -124,6 +133,7 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
 
   public
   def run(queue)
+    @interval_thread = Thread.current
     Stud.interval(@interval) do
       run_once(queue)
     end

data/logstash-input-http_poller.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-input-http_poller'
-  s.version         = '1.1.2'
+  s.version         = '2.0.1'
   s.licenses = ['Apache License (2.0)']
   s.summary = "Poll HTTP endpoints with Logstash."
   s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program."
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
    # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
@@ -17,13 +17,12 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.5.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.snapshot", "< 3.0.0"
   s.add_runtime_dependency 'logstash-codec-plain'
-  s.add_runtime_dependency 'logstash-codec-json'
   s.add_runtime_dependency 'logstash-mixin-http_client', ">= 1.0.1"
-  s.add_runtime_dependency 'stud'
-  s.add_runtime_dependency 'manticore'
+  s.add_runtime_dependency 'stud', "~> 0.0.22"
 
+  s.add_development_dependency 'logstash-codec-json'
   s.add_development_dependency 'logstash-devutils'
   s.add_development_dependency 'flores'
 end

data/spec/inputs/http_poller_spec.rb

@@ -321,4 +321,9 @@ describe LogStash::Inputs::HTTP_Poller do
       end
     end
   end
+
+  describe "stopping" do
+    let(:config) { default_opts }
+    it_behaves_like "an interruptible input plugin"
+  end
 end

metadata

@@ -1,148 +1,130 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-http_poller
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.1
 platform: ruby
 authors:
 - andrewvc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
+  name: logstash-core
   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'
+        version: 2.0.0.snapshot
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-codec-plain
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-codec-json
   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'
+        version: 1.0.1
+  name: logstash-mixin-http_client
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-mixin-http_client
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 0.0.22
+  name: stud
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: stud
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-codec-json
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: manticore
+  type: :development
   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'
-  prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
   name: logstash-devutils
+  prerelease: false
+  type: :development
   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: flores
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: flores
   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: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program.
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - DEVELOPER.md
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- examples/ha_proxy.conf
-- examples/local_elasticsearch.conf
 - lib/logstash/inputs/http_poller.rb
 - logstash-input-http_poller.gemspec
 - spec/inputs/http_poller_spec.rb
@@ -168,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Poll HTTP endpoints with Logstash.

data/.gitignore

@@ -1,7 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor
-*~
-.idea
-*.log

data/Rakefile

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

data/examples/ha_proxy.conf

@@ -1,43 +0,0 @@
-input {
-  http_poller {
-    urls => {
-      haproxy => {
-        method => get
-        url => "http://localhost:9201/haproxy?stats;csv"
-        auth => {
-          user => "myuser"
-          password => "mypass"
-        }
-      }
-    }
-    request_timeout => 60
-    interval => 60
-    codec => "plain" # This is CSV data, so just let it be plain for now
-    metadata_target => "_http_poller_metadata"
-  }
-}
-
-filter {
-  split {
-  }
-
-  csv {
-    columns => [ pxname,svname,qcur,qmax,scur,smax,slim,stot,binhttp://localhost:9201/haproxy?stats;csvm,bout,dreq,dresp,ereq,econ,eresp,wretr,wredis,status,weight,act,bck,chkfail,chkdown,lastchg,downtime,qlimit,pid,iid,sid,throttle,lbtot,tracked,type,rate,rate_lim,rate_max,check_status,check_code,check_duration,hrsp_1xx,hrsp_2xx,hrsp_3xx,hrsp_4xx,hrsp_5xx,hrsp_other,hanafail,req_rate,req_rate_max,req_tot,cli_abrt,srv_abrt,comp_in,comp_out,comp_byp,comp_rsp,lastsess,last_chk,last_agt,qtime,ctime,rtime,ttime ]
-  }
-
-  # This is a pointless CSV header
-  if [pxname] == "# pxname" {
-    drop{}
-  }
-}
-
-output {
-  stdout {
-    codec => rubydebug
-  }
-
-  elasticsearch {
-    protocol => "http"
-    cluster => "avc-cluster"
-  }
-}

data/examples/local_elasticsearch.conf

@@ -1,10 +0,0 @@
-input {
-  stdin {}
-}
-
-output {
-  elasticsearch {
-    protocol => http
-    host => "127.0.0.1"
-  }
-}