logstash-input-http_poller 3.3.4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 510d4c5db5222815c8af25d28a88199ad7f777b3
-  data.tar.gz: 013097dc6abeb229fc0928b9dc8018c7b38de19d
+  metadata.gz: 81e33eb7700b8e32405f5e6560c673d9e267e720
+  data.tar.gz: 66fdfbd250e994f9af430efe2a247f0817d9eeaa
 SHA512:
-  metadata.gz: 06d85c637163581b719c3819bfd4a0efc59a548a86352ac003382454c4fee031a66a9083573191a534e54856a41b3fd3e26565e58fd39ba827d822b5e6ac77f6
-  data.tar.gz: 6dd62b76ea1bbeffec57c9248fbecc995c5babd296d329d0cd96ba7e46160b8d40f1386e2cc92406333e95f4890082a613610aefdcccbe3fd4b2996d0d374143
+  metadata.gz: 0153c85b2138939833e3a88127ab445d4968de32cf9e33a84813f3ec05415bc4e63c734d2da85894c90cbc8bb73e5e27af7d7104a9a44fda8a63b36971b42fb9
+  data.tar.gz: 79e243ac0a8bf5cf66cc80e36dc1f090775029c89b695bd60b317f869aefe30773de4ffd11e221d6c82b423a7fede3efa4f150c8c1b27867df079387b385a583

data/CHANGELOG.md

@@ -1,11 +1,6 @@
-## 3.3.4
-  - Docs: Remove ssl_certificate_validation option from the docs
-
-## 3.3.3
- - Don't bleed URls credentials on startup or on exception #82
-
-## 3.3.2
- - Documentation fixes
+## 4.0.0
+ - Mark deprecated field `interval` as obsolete
+ - bump dependency in logstash-mixin-http_client
 
 ## 3.3.0
  - Add top level user/password options that apply to all URLs by default.
@@ -19,7 +14,6 @@
 
 ## 3.1.1
  - Handle empty bodies correctly
-
 ## 3.1.0
  - Use rufus-scheduler for more flexible scheduling. Many thanks to [@hummingV](https://github.com/hummingV) for this contribution. ([#58](https://github.com/logstash-plugins/logstash-input-http_poller/pull/58))
 

data/docs/index.asciidoc

@@ -81,7 +81,7 @@ The above snippet will create two files `downloaded_cert.pem` and `downloaded_tr
    }
    truststore => "/path/to/downloaded_truststore.jks"
    truststore_password => "mypassword"
-   interval => 30
+   schedule => { cron => "* * * * * UTC"}
  }
 ----------------------------------
 
@@ -115,6 +115,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-retry_non_idempotent>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-schedule>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-socket_timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-ssl_certificate_validation>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-truststore>> |a valid filesystem path|No
 | <<plugins-{type}s-{plugin}-truststore_password>> |<<password,password>>|No
@@ -204,18 +205,6 @@ across requests as a normal web browser would. Enabled by default
 
 Should redirects be followed? Defaults to `true`
 
-[id="plugins-{type}s-{plugin}-interval"]
-===== `interval`  (DEPRECATED)
-
-  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
-  * Value type is <<number,number>>
-  * There is no default value for this setting.
-
-How often (in seconds) the urls will be called
-DEPRECATED. Use 'schedule' option instead.
-If both interval and schedule options are specified, interval
-option takes higher precedence
-
 [id="plugins-{type}s-{plugin}-keepalive"]
 ===== `keepalive` 
 

data/lib/logstash/inputs/http_poller.rb

@@ -17,11 +17,7 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
   # 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
-  # DEPRECATED. Use 'schedule' option instead.
-  # If both interval and schedule options are specified, interval
-  # option takes higher precedence
-  config :interval, :validate => :number, :deprecated => true
+  config :interval, :validate => :number, :obsolete => "The interval options is obsolete. Use schedule instead"
 
   # Schedule of when to periodically poll from the urls
   # Format: A hash with
@@ -31,7 +27,7 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
   #   a) { "every" => "1h" }
   #   b) { "cron" => "* * * * * UTC" }
   # See: rufus/scheduler for details about different schedule options and value string format
-  config :schedule, :validate => :hash
+  config :schedule, :validate => :hash, :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
@@ -46,7 +42,8 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
   def register
     @host = Socket.gethostname.force_encoding(Encoding::UTF_8)
 
-    @logger.info("Registering http_poller Input", :type => @type, :interval => @interval, :schedule => @schedule, :timeout => @timeout)
+    @logger.info("Registering http_poller Input", :type => @type,
+                 :urls => @urls, :schedule => @schedule, :timeout => @timeout)
 
     setup_requests!
   end
@@ -123,28 +120,7 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
 
   public
   def run(queue)
-    #interval or schedule must be provided. Must be exclusively either one. Not neither. Not both.
-    raise LogStash::ConfigurationError, "Invalid config. Neither interval nor schedule was specified." \
-      unless @interval ||  @schedule
-    raise LogStash::ConfigurationError, "Invalid config. Specify only interval or schedule. Not both." \
-      if @interval && @schedule
-
-    if @interval
-      setup_interval(queue)
-    elsif @schedule
-      setup_schedule(queue)
-    else
-      #should not reach here
-      raise LogStash::ConfigurationError, "Invalid config. Neither interval nor schedule was specified."
-    end
-  end
-
-  private
-  def setup_interval(queue)
-    @interval_thread = Thread.current
-    Stud.interval(@interval) do
-      run_once(queue)
-    end
+    setup_schedule(queue)
   end
 
   def setup_schedule(queue)
@@ -242,13 +218,6 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
                                       :name => name,
                                       :url => request
       )
-
-      @logger.debug? && @logger.debug("Cannot read URL or send the error as an event!",
-                                      :exception => e,
-                                      :exception_message => e.message,
-                                      :exception_backtrace => e.backtrace,
-                                      :name => name,
-                                      :url => request)
   end
 
   private

data/logstash-input-http_poller.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'logstash-input-http_poller'
-  s.version         = '3.3.4'
+  s.version         = '4.0.0'
   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/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_runtime_dependency 'logstash-codec-plain'
-  s.add_runtime_dependency 'logstash-mixin-http_client', ">= 5.0.0", "< 6.0.0"
+  s.add_runtime_dependency 'logstash-mixin-http_client', ">= 6.0.0", "< 7.0.0"
   s.add_runtime_dependency 'stud', "~> 0.0.22"
   s.add_runtime_dependency 'rufus-scheduler', "~>3.0.9"
 

data/spec/inputs/http_poller_spec.rb

@@ -177,56 +177,6 @@ describe LogStash::Inputs::HTTP_Poller do
   end
 
   describe "scheduler configuration" do
-    context "given an interval" do
-      let(:opts) {
-        {
-          "interval" => 2,
-          "urls" => default_urls,
-          "codec" => "json",
-          "metadata_target" => metadata_target
-        }
-      }
-      it "should run once in each interval" do
-        instance = klass.new(opts)
-        instance.register
-        queue = Queue.new
-        runner = Thread.new do
-          instance.run(queue)
-        end
-        #T       0123456
-        #events  x x x x
-        #expects 3 events at T=5
-        sleep 5
-        instance.stop
-        runner.kill
-        runner.join
-        expect(queue.size).to eq(3)
-      end
-    end
-
-    context "given both interval and schedule options" do
-      let(:opts) {
-        {
-          "interval" => 1,
-          "schedule" => { "every" => "5s" },
-          "urls" => default_urls,
-          "codec" => "json",
-          "metadata_target" => metadata_target
-        }
-      }
-      it "should raise ConfigurationError" do
-        instance = klass.new(opts)
-        instance.register
-        queue = Queue.new
-        runner = Thread.new do
-          expect{instance.run(queue)}.to raise_error(LogStash::ConfigurationError)
-        end
-        instance.stop
-        runner.kill
-        runner.join
-      end
-    end
-
     context "given 'cron' expression" do
       let(:opts) {
         {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-http_poller
 version: !ruby/object:Gem::Version
-  version: 3.3.4
+  version: 4.0.0
 platform: ruby
 authors:
 - Elastic
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -50,10 +50,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
   name: logstash-mixin-http_client
   prerelease: false
   type: :runtime
@@ -61,10 +61,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: