logstash-output-http 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddd34eaab5f5f023138eede5762b6911c6542be9
-  data.tar.gz: ab1aec99d160c6dcd84fe624d5d4274fa0840dfd
+  metadata.gz: ed1975dd9a23d8a355ca14ccd0d191d387620356
+  data.tar.gz: d4ce66fe7f7c0b4e5396f819a70aeb62292be625
 SHA512:
-  metadata.gz: 2e5d6443d21b3caf9172a53c6469a4ba9cd8351f3c62e10ecc2b905eabf2710427b63938d0b56e66245487e59486c6dac05e1d1a5a5825c2692914bd0a8b4892
-  data.tar.gz: 6ae047e197b2e1ff442ef460d49e22f40b5746c0cde155d2752778d23836fe9fae4a69712c38377d5a3780b94fbb52ce70aeea96b7ec66babb6b1bbec4f0da6b
+  metadata.gz: d393ce2604784a67dcdedd1196650054cc32e246e16fb13fc93638941fbf6f0dffad804a758b9b99bd87ebefa16ed194b3e5558c52bf92b403c54af1fc72cd70
+  data.tar.gz: 70237b74bcdbeaeb2a0bd482f07189faf3c3f9dedda59226ca29086f9967eb7cf93dab8caecfb10e47093b508ca9aa8d2fc5013fec3f3b84feadca79dec6cabb

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 5.1.0
+  - Adding a new option `http_compression` for sending compressed payload with the `Content-Encoding: gzip` header to the configured http endpoint #66
+
 ## 5.0.1
   - Fix some documentation issues
 

data/docs/index.asciidoc

@@ -48,6 +48,7 @@ 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
@@ -172,6 +173,15 @@ 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` 
 

data/lib/logstash/outputs/http.rb

@@ -4,6 +4,7 @@ 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
@@ -80,6 +81,9 @@ 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
@@ -196,6 +200,12 @@ 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)
 
@@ -300,6 +310,16 @@ 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         = '5.0.1'
+  s.version         = '5.1.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"

data/spec/outputs/http_spec.rb

@@ -3,6 +3,7 @@ require "logstash/outputs/http"
 require "logstash/codecs/plain"
 require "thread"
 require "sinatra"
+require_relative "../supports/compressed_requests"
 
 PORT = rand(65535-1024) + 1025
 
@@ -16,8 +17,10 @@ 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
@@ -38,11 +41,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
@@ -56,10 +59,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}"]
@@ -80,7 +83,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
@@ -158,7 +161,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]) }
@@ -171,7 +174,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"}
 
@@ -184,12 +187,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
 
@@ -225,7 +228,8 @@ describe LogStash::Outputs::Http do
     end
   end
 
-  describe "integration tests" do
+  shared_examples "integration tests" do
+    let(:base_config) { {} }
     let(:url) { "http://localhost:#{port}/good" }
     let(:event) {
       LogStash::Event.new("foo" => "bar", "baz" => "bot", "user" => "McBest")
@@ -239,7 +243,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending with the default (JSON) config" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1}
+        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1})
       }
       let(:expected_body) { LogStash::Json.dump(event) }
       let(:expected_content_type) { "application/json" }
@@ -249,7 +253,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending the event as a form" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "form"}
+        base_config.merge({"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" }
@@ -259,7 +263,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending the event as a message" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "message", "message" => "%{foo} AND %{baz}"}
+        base_config.merge({"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" }
@@ -269,7 +273,7 @@ describe LogStash::Outputs::Http do
 
     describe "sending a mapped event" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1, "mapping" => {"blah" => "X %{foo}"} }
+        base_config.merge({"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" }
@@ -279,7 +283,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,
@@ -292,7 +296,7 @@ describe LogStash::Outputs::Http do
               "user" => "Z %{user}"
             }]
           }
-        }
+        })
       }
       let(:expected_body) {
         LogStash::Json.dump({
@@ -310,4 +314,14 @@ 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

data/spec/supports/compressed_requests.rb

@@ -0,0 +1,38 @@
+# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-http
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,7 @@ 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)
@@ -136,3 +137,4 @@ 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