logstash-input-http_poller 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be8d40ddad581f2259c10aca4689effe57c77031
-  data.tar.gz: be1d671303288aeaf7f35e1407c9471725c696d2
+  metadata.gz: 376d01f7f7f2543cf29dc25d017d09e5d7c46472
+  data.tar.gz: e1fe840d963dc87fb97afd647f43047eaf9f1a44
 SHA512:
-  metadata.gz: c319eb5ab0d614a25f7054a3defb670805fd22abb9724e69813d673cbf44e1d006a073921b1d59ada3c855874c33a3ae4485c0dcd2ef55566ca237ad75f96ae4
-  data.tar.gz: 31122f1e4723a548b717105f8a1848923921e741cc8f86880caa78c8d30460c431a5d36fcbef0af0eb4f2ddd42e6951fc5373533e76cf4f09a4472a99179b0a6
+  metadata.gz: 9b7aa09232b6540dab84356da874b160396071edcc76ae1e1021e98121909918319cf87624f2fc069bf26980051360ad60455bfb0b83050d37e732d4a28fa7b6
+  data.tar.gz: b151a285605f59e062f62faddf8c4b09378fc43ee0fe2ef51525e6e102c36e3b5c3094eeb65ad66480703ef2274371adbe2b15f9b900d9ee27e7cb0519b0780b

data/CHANGELOG.md

@@ -1,8 +1,9 @@
+* 1.1.0
+  - Error metadata no longer '_' prefixed for kibana compat
+  - HTTP metadata now normalized to prevent conflicts with ES schemas
 * 1.0.2
   - Bug fix: Decorating the event before pushing it to the queue
-
 * 1.0.1
   - Add 'target' option
-  
 * 1.0.0
   - Initial release

data/lib/logstash/inputs/http_poller.rb

@@ -31,7 +31,7 @@ require "manticore"
 #     interval => 60
 #     codec => "json"
 #     # A hash of request metadata info (timing, response headers, etc.) will be sent here
-#     metadata_target => "_http_poller_metadata"
+#     metadata_target => "http_poller_metadata"
 #   }
 # }
 #
@@ -184,8 +184,8 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
 
     # This is also in the metadata, but we send it anyone because we want this
     # persisted by default, whereas metadata isn't. People don't like mysterious errors
-    event["_http_request_failure"] = {
-      "url" => @urls[name], # We want the exact parameter they passed in
+    event["http_request_failure"] = {
+      "request" => structure_request(request),
       "name" => name,
       "error" => exception.to_s,
       "backtrace" => exception.backtrace,
@@ -214,7 +214,7 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
     m = {
         "name" => name,
         "host" => @host,
-        "url" => @urls[name]
+        "request" => structure_request(request),
       }
 
     m["runtime_seconds"] = execution_time
@@ -228,4 +228,15 @@ class LogStash::Inputs::HTTP_Poller < LogStash::Inputs::Base
 
     m
   end
+
+  private
+  # Turn [method, url, spec] requests into a hash for friendlier logging / ES indexing
+  def structure_request(request)
+    method, url, spec = request
+    # Flatten everything into the 'spec' hash, also stringify any keys to normalize
+    Hash[(spec||{}).merge({
+      "method" => method.to_s,
+      "url" => url,
+    }).map {|k,v| [k.to_s,v] }]
+  end
 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.0.2'
+  s.version         = '1.1.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/plugin install gemname. This gem is not a stand-alone program."

data/spec/inputs/http_poller_spec.rb

@@ -130,6 +130,25 @@ describe LogStash::Inputs::HTTP_Poller do
         end
       end
     end
+
+    describe "#structure_request" do
+      it "Should turn a simple request into the expected structured request" do
+        expected = {"url" => "http://example.net", "method" => "get"}
+        expect(subject.send(:structure_request, ["get", "http://example.net"])).to eql(expected)
+      end
+
+      it "should turn a complex request into the expected structured one" do
+        headers = {
+          "X-Fry" => " Like a balloon, and... something bad happens! "
+        }
+        expected = {
+          "url" => "http://example.net",
+          "method" => "get",
+          "headers" => headers
+        }
+        expect(subject.send(:structure_request, ["get", "http://example.net", {"headers" => headers}])).to eql(expected)
+      end
+    end
   end
 
   describe "events" do
@@ -140,8 +159,12 @@ describe LogStash::Inputs::HTTP_Poller do
         expect(metadata["name"]).to eql(name)
       end
 
-      it "should have the correct url" do
-        expect(metadata["url"]).to eql(url)
+      it "should have the correct request url" do
+        if url.is_a?(Hash) # If the url was specified as a complex test the whole thing
+          expect(metadata["request"]).to eql(url)
+        else # Otherwise we have to make some assumptions
+          expect(metadata["request"]["url"]).to eql(url)
+        end
       end
 
       it "should have the correct code" do
@@ -167,8 +190,8 @@ describe LogStash::Inputs::HTTP_Poller do
         expect(event).to be_a(LogStash::Event)
       end
 
-      it "should enqueue a message with '_http_request_failure' set" do
-        expect(event["_http_request_failure"]).to be_a(Hash)
+      it "should enqueue a message with 'http_request_failure' set" do
+        expect(event["http_request_failure"]).to be_a(Hash)
       end
 
       it "should tag the event with '_http_request_failure'" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-http_poller
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - andrewvc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core