logstash-output-http 4.4.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c86f426c1122a3a0883cbe6da6b103147dfd642f
-  data.tar.gz: 9e4a45eb530aeb912330e5f0a2158c9e7e00150c
+  metadata.gz: ab516b2caaebac6c6d423968cfa798482bc30397
+  data.tar.gz: b7d9d5435af8105187cfb60e17dd4290d588bed1
 SHA512:
-  metadata.gz: 2a70f44491c198f1f7573c7619008c55217c1cc5b8fd8b6e46ee5873d4f4ee380c25a39a5dd4f48f5694b61b68f6cbcf63f480e5addf6cb5cf2c2feee7e7f85c
-  data.tar.gz: f92ca3b533be5831a41b9586a091f3a27aac2fcb2a6ef7678bc4986318bc3e79874d47d2c91292fe4d6efc4bdbecd9de3cadeaca040acde50ca6acbdcc4aa79a
+  metadata.gz: 8ed52d96ab31cd98af7e053325ccc1bb4c209e281b10045ca504013c27a0924f53243ec5a88bdc72e5c57a892153a0006abc9a07f38e3a77eb02cc16352e8af8
+  data.tar.gz: 225f67b2638399123dd8ea26702f56cc1fd8c5aff8482eff33d6e28d3d81b1c7b27998ce26f5ad0821756743120c0e4cc36218c7de11e01467a2143cd016f0ba

data/CHANGELOG.md

@@ -1,8 +1,5 @@
-## 4.4.0
-  - Adding a new option `http_compression` for sending compressed payload with the `Content-Encoding: gzip` header to the configured http endpoint #66
-
-## 4.3.4
- - Docs fixes
+## 5.0.0
+ - Breaking: bump dependency in breaking version of logstash-mixin-http_client
 
 ## 4.3.3
  - Docs: Add plugin description.

data/docs/index.asciidoc

@@ -48,7 +48,6 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-follow_redirects>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-format>> |<<string,string>>, one of `["json", "form", "message"]`|No
 | <<plugins-{type}s-{plugin}-headers>> |<<hash,hash>>|No
-| <<plugins-{type}s-{plugin}-http_compression>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-http_method>> |<<string,string>>, one of `["put", "post", "patch", "delete", "get", "head"]`|Yes
 | <<plugins-{type}s-{plugin}-ignorable_codes>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-keepalive>> |<<boolean,boolean>>|No
@@ -65,7 +64,6 @@ 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}-retryable_codes>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-socket_timeout>> |<<number,number>>|No
-| <<plugins-{type}s-{plugin}-ssl_certificate_validation>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-truststore>> |a valid filesystem path|No
 | <<plugins-{type}s-{plugin}-truststore_password>> |<<password,password>>|No
 | <<plugins-{type}s-{plugin}-truststore_type>> |<<string,string>>|No
@@ -174,15 +172,6 @@ Otherwise, the event is sent as json.
 Custom headers to use
 format is `headers => ["X-My-Header", "%{host}"]`
 
-[id="plugins-{type}s-{plugin}-http_compression"]
-===== `http_compression`
-
-  * Value type is <<boolean,boolean>>
-  * Default value is `false`
-
-Enable request compression support. With this enabled the plugin will compress
-http requests using gzip.
-
 [id="plugins-{type}s-{plugin}-http_method"]
 ===== `http_method` 
 
@@ -328,15 +317,6 @@ If encountered as response codes this plugin will retry these requests
 
 Timeout (in seconds) to wait for data on the socket. Default is `10s`
 
-[id="plugins-{type}s-{plugin}-ssl_certificate_validation"]
-===== `ssl_certificate_validation` 
-
-  * Value type is <<boolean,boolean>>
-  * Default value is `true`
-
-Set this to false to disable SSL/TLS certificate validation
-Note: setting this to false is generally considered insecure!
-
 [id="plugins-{type}s-{plugin}-truststore"]
 ===== `truststore` 
 

data/lib/logstash/outputs/http.rb

@@ -4,7 +4,6 @@ require "logstash/namespace"
 require "logstash/json"
 require "uri"
 require "logstash/plugin_mixins/http_client"
-require "zlib"
 
 class LogStash::Outputs::Http < LogStash::Outputs::Base
   include LogStash::PluginMixins::HttpClient
@@ -81,9 +80,6 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
   # Otherwise, the event is sent as json.
   config :format, :validate => ["json", "form", "message"], :default => "json"
 
-  # Set this to true if you want to enable gzip compression for your http requests
-  config :http_compression, :validate => :boolean, :default => false
-  
   config :message, :validate => :string
 
   def register
@@ -200,12 +196,6 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
     url = event.sprintf(@url)
     headers = event_headers(event)
 
-    # Compress the body and add appropriate header
-    if @http_compression == true
-      headers["Content-Encoding"] = "gzip"
-      body = gzip(body)
-    end
-
     # Create an async request
     request = client.background.send(@http_method, url, :body => body, :headers => headers)
 
@@ -310,16 +300,6 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
     end
   end
 
-  # gzip data
-  def gzip(data)
-    gz = StringIO.new
-    gz.set_encoding("BINARY")
-    z = Zlib::GzipWriter.new(gz)
-    z.write(data)
-    z.close
-    gz.string
-  end
-
   def convert_mapping(mapping, event)
     if mapping.is_a?(Hash)
       mapping.reduce({}) do |acc, kv|

data/logstash-output-http.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-http'
-  s.version         = '4.4.0'
+  s.version         = '5.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output lets you `PUT` or `POST` events to a generic HTTP(S) endpoint"
   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-mixin-http_client", ">= 5.1.0", "< 6.0.0"
+  s.add_runtime_dependency "logstash-mixin-http_client", ">= 6.0.0", "< 7.0.0"
 
   s.add_development_dependency 'logstash-devutils'
   s.add_development_dependency 'sinatra'

data/spec/outputs/http_spec.rb

@@ -3,7 +3,6 @@ require "logstash/outputs/http"
 require "logstash/codecs/plain"
 require "thread"
 require "sinatra"
-require_relative "../supports/compressed_requests"
 
 PORT = rand(65535-1024) + 1025
 
@@ -17,10 +16,8 @@ end
 #
 # == Sinatra (v1.4.6) has taken the stage on 51572 for development with backup from WEBrick
 # == Sinatra has ended his set (crowd applauds)
-#
+
 class TestApp < Sinatra::Base
-  # on the fly uncompress gzip content
-  use CompressedRequests
 
   # disable WEBrick logging
   def self.server_settings
@@ -41,11 +38,11 @@ class TestApp < Sinatra::Base
   def self.last_request
     @last_request
   end
-
+  
   def self.retry_fail_count=(count)
     @retry_fail_count = count
   end
-
+  
   def self.retry_fail_count()
     @retry_fail_count
   end
@@ -59,10 +56,10 @@ class TestApp < Sinatra::Base
     self.class.last_request = request
     [400, "YUP"]
   end
-
+  
   multiroute(%w(get post put patch delete), "/retry") do
     self.class.last_request = request
-
+    
     if self.class.retry_fail_count > 0
       self.class.retry_fail_count -= 1
       [429, "Will succeed in #{self.class.retry_fail_count}"]
@@ -83,7 +80,7 @@ RSpec.configure do |config|
           app.run!(opts) do |server|
             queue.push("started")
           end
-        rescue => e
+        rescue => e 
           puts "Error in webserver thread #{e}"
           # ignore
         end
@@ -161,7 +158,7 @@ describe LogStash::Outputs::Http do
           expect(subject).to have_received(:log_failure).with(any_args)
         end
       end
-
+      
       context "with ignorable failing requests" do
         let(:url) { "http://localhost:#{port}/bad"}
         let(:verb_behavior_config) { super.merge("ignorable_codes" => [400]) }
@@ -174,7 +171,7 @@ describe LogStash::Outputs::Http do
           expect(subject).not_to have_received(:log_failure).with(any_args)
         end
       end
-
+      
       context "with retryable failing requests" do
         let(:url) { "http://localhost:#{port}/retry"}
 
@@ -187,12 +184,12 @@ describe LogStash::Outputs::Http do
         it "should log a failure 2 times" do
           expect(subject).to have_received(:log_failure).with(any_args).twice
         end
-
+        
         it "should make three total requests" do
           expect(subject).to have_received(:send_event).exactly(3).times
         end
-      end
-
+      end  
+      
     end
   end
 
@@ -228,8 +225,7 @@ describe LogStash::Outputs::Http do
     end
   end
 
-  shared_examples "integration tests" do
-    let(:base_config) { {} }
+  describe "integration tests" do
     let(:url) { "http://localhost:#{port}/good" }
     let(:event) {
       LogStash::Event.new("foo" => "bar", "baz" => "bot", "user" => "McBest")
@@ -243,7 +239,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending with the default (JSON) config" do
       let(:config) {
-        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1})
+        {"url" => url, "http_method" => "post", "pool_max" => 1}
       }
       let(:expected_body) { LogStash::Json.dump(event) }
       let(:expected_content_type) { "application/json" }
@@ -253,7 +249,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending the event as a form" do
       let(:config) {
-        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "form"})
+        {"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "form"}
       }
       let(:expected_body) { subject.send(:encode, event.to_hash) }
       let(:expected_content_type) { "application/x-www-form-urlencoded" }
@@ -263,7 +259,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending the event as a message" do
       let(:config) {
-        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "message", "message" => "%{foo} AND %{baz}"})
+        {"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "message", "message" => "%{foo} AND %{baz}"}
       }
       let(:expected_body) { "#{event.get("foo")} AND #{event.get("baz")}" }
       let(:expected_content_type) { "text/plain" }
@@ -273,7 +269,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending a mapped event" do
       let(:config) {
-        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1, "mapping" => {"blah" => "X %{foo}"} })
+        {"url" => url, "http_method" => "post", "pool_max" => 1, "mapping" => {"blah" => "X %{foo}"} }
       }
       let(:expected_body) { LogStash::Json.dump("blah" => "X #{event.get("foo")}") }
       let(:expected_content_type) { "application/json" }
@@ -283,7 +279,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending a mapped, nested event" do
       let(:config) {
-        base_config.merge({
+        {
           "url" => url,
           "http_method" => "post",
           "pool_max" => 1,
@@ -296,7 +292,7 @@ describe LogStash::Outputs::Http do
               "user" => "Z %{user}"
             }]
           }
-        })
+        }
       }
       let(:expected_body) {
         LogStash::Json.dump({
@@ -314,14 +310,4 @@ describe LogStash::Outputs::Http do
       include_examples("a received event")
     end
   end
-
-  describe "integration test without gzip compression" do
-    include_examples("integration tests")
-  end
-
-  describe "integration test with gzip compression" do
-    include_examples("integration tests") do
-      let(:base_config) { { "http_compression" => true } }
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-http
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -35,10 +35,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.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
@@ -46,10 +46,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.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:
@@ -108,7 +108,6 @@ files:
 - lib/logstash/outputs/http.rb
 - logstash-output-http.gemspec
 - spec/outputs/http_spec.rb
-- spec/supports/compressed_requests.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -137,4 +136,3 @@ specification_version: 4
 summary: This output lets you `PUT` or `POST` events to a generic HTTP(S) endpoint
 test_files:
 - spec/outputs/http_spec.rb
-- spec/supports/compressed_requests.rb

data/spec/supports/compressed_requests.rb

@@ -1,38 +0,0 @@
-# encoding: utf-8
-#
-# based on relistan's rack handler
-# out of the box rack only gives use the rack deflater handler to return compressed
-# response, this gist offer the inverse and should work on all rack based app like sinatra or rails.
-#
-# original source: https://gist.github.com/relistan/2109707
-require "zlib"
-
-class CompressedRequests
-  def initialize(app)
-    @app = app
-  end
-
-  def encoding_handled?(env)
-    ['gzip', 'deflate'].include? env['HTTP_CONTENT_ENCODING']
-  end
-
-  def call(env)
-    if encoding_handled?(env)
-      extracted = decode(env['rack.input'], env['HTTP_CONTENT_ENCODING'])
-
-      env.delete('HTTP_CONTENT_ENCODING')
-      env['CONTENT_LENGTH'] = extracted.bytesize
-      env['rack.input'] = StringIO.new(extracted)
-    end
-
-    status, headers, response = @app.call(env)
-    return [status, headers, response]
-  end
-
-  def decode(input, content_encoding)
-    case content_encoding
-      when 'gzip' then Zlib::GzipReader.new(input).read
-      when 'deflate' then Zlib::Inflate.inflate(input.read)
-    end
-  end
-end