include http status code in metadata

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.5.0
+  - Feat: add http response status code to metadata
+
 ## 1.4.1
   - Fix: don't process response body for HEAD requests [#40](https://github.com/logstash-plugins/logstash-filter-http/pull/40)
 

docs/index.asciidoc

@@ -45,6 +45,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-query>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-target_body>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-target_headers>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-target_status>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-url>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-verb>> |<<string,string>>|No
 |=======================================================================
@@ -155,6 +156,14 @@ Define the target field for placing the body of the HTTP response.
 
 Define the target field for placing the headers of the HTTP response.
 
+[id="plugins-{type}s-{plugin}-target_status"]
+===== `target_status`
+
+  * Value type is <<string,string>>
+  * Default value `"[@metadata][filter][http][response][status_code]"`
+
+Define the target field for placing the status code of the HTTP response.
+
 [id="plugins-{type}s-{plugin}-url"]
 ===== `url`
 

lib/logstash/filters/http.rb

@@ -33,6 +33,8 @@ class LogStash::Filters::Http < LogStash::Filters::Base
   config :target_body, :validate => :field_reference
   # default [headers] (legacy) or [@metadata][filter][http][response][headers] in ECS mode
   config :target_headers, :validate => :field_reference
+  # default [@metadata][filter][http][response][status_code] in all modes
+  config :target_status, :validate => :field_reference, default: '[@metadata][filter][http][response][status_code]'
 
   # Append values to the `tags` field when there has been no
   # successful match or json parsing error
@@ -85,16 +87,20 @@ def filter(event)
                     :url => url_for_event, :body => body_sprintfed,
                     :client_error => client_error.message)
       @tag_on_request_failure.each { |tag| event.tag(tag) }
-    elsif !code.between?(200, 299)
-      @logger.error('error during HTTP request',
-                    :url => url_for_event, :code => code,
-                    :response => response_body)
-      @tag_on_request_failure.each { |tag| event.tag(tag) }
     else
-      @logger.debug? && @logger.debug('success received',
-                                      :code => code, :body => response_body)
-      process_response(response_body, response_headers, event)
-      filter_matched(event)
+      event.set(@target_status, code)
+      if !code.between?(200, 299)
+        @logger.error('error during HTTP request',
+                      :url => url_for_event, :code => code,
+                      :response => response_body)
+
+        @tag_on_request_failure.each { |tag| event.tag(tag) }
+      else
+        @logger.debug? && @logger.debug('success received',
+                                        :code => code, :body => response_body)
+        process_response(response_body, response_headers, event)
+        filter_matched(event)
+      end
     end
   end # def filter
 

logstash-filter-http.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-http'
-  s.version = '1.4.1'
+  s.version = '1.5.0'
   s.licenses = ['Apache License (2.0)']
   s.summary = 'This filter requests data from a RESTful Web Service.'
   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 logstash-filter-http. This gem is not a stand-alone program'

spec/filters/http_spec.rb

@@ -109,6 +109,10 @@
       expect(event).to_not include('rest')
       expect(event.get('tags')).to include('_httprequestfailure')
     end
+
+    it 'stores the HTTP status in the associated target' do
+      expect(event.get('[@metadata][filter][http][response][status_code]')).to eq(404)
+    end
   end
 
   describe "headers", :ecs_compatibility_support do
@@ -141,6 +145,8 @@
           expect(event.get('[@metadata][filter][http][response][headers]')).to include "Server" => "Apache"
           expect(event.get('[@metadata][filter][http][response][headers]')).to include "X-Backend-Server" => "logstash.elastic.co"
         end
+
+        expect(event.get('[@metadata][filter][http][response][status_code]')).to eq(200)
       end
 
       context 'with a headers target' do
@@ -158,6 +164,18 @@
 
       end
 
+      context 'with a status target' do
+        let(:config) { super().merge("target_status" => '[res][status]') }
+
+        it 'sets the the targeted field on the event' do
+          expect(subject).to receive(:request_http).with(anything, config['url'], anything).and_return(response)
+
+          subject.filter(event)
+
+          expect(event.get('[res][status]')).to eq(200)
+        end
+      end
+
     end
 
     context "(extra) request headers" do