lograge 0.1.2 → 0.2.0

data/README.md

@@ -52,7 +52,7 @@ gem "lograge"
 
 Enable it for the relevant environments, e.g. production:
 
-```
+```ruby
 # config/environments/production.rb
 MyApp::Application.configure do
   config.lograge.enabled = true
@@ -61,7 +61,7 @@ end
 
 You can also add a hook for own custom data
 
-```
+```ruby
 # config/environments/staging.rb
 MyApp::Application.configure do
   config.lograge.enabled = true
@@ -79,7 +79,7 @@ Lograge supports multiple output formats. The most common is the default
 lograge format described above. Alternatively, you can also generate JSON
 logs in the json_event format used by [Logstash](http://logstash.net/).
 
-```
+```ruby
 # config/environments/production.rb
 MyApp::Application.configure do
   config.lograge.log_format = :logstash
@@ -161,6 +161,7 @@ that fits in with the general spirit of the log output generated by Lograge.
 
 **Changes**
 
+* Add support for Graylog2 events (Lennart Koopmann, http://github.com/lennartkoopmann)
 * Add support for Logstash events (Holger Just, http://github.com/meineerde)
 * Fix for Rails 3.2.9
 * Use keys everywhere (Curt Michols, http://github.com/asenchi)

data/lib/lograge/log_subscriber.rb

@@ -43,6 +43,20 @@ module Lograge
       event.to_json
     end
 
+    def process_action_graylog2(data)
+      # Cloning because we don't want to mess with the original when mutating keys.
+      my = data.clone
+
+      base = {
+        :short_message => "[#{my[:status]}] #{my[:method]} #{my[:path]} (#{my[:controller]}##{my[:action]})"
+      }
+
+      # Add underscore to every key to follow GELF additional field syntax.
+      my.keys.each { |k| my["_#{k}".to_sym] = my[k]; my.delete(k) }
+
+      my.merge(base)
+    end
+
     def redirect_to(event)
       Thread.current[:lograge_location] = event.payload[:location]
     end

data/lib/lograge/version.rb

@@ -1,3 +1,3 @@
 module Lograge
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/lograge_logsubscriber_spec.rb

@@ -196,6 +196,107 @@ describe Lograge::RequestLogSubscriber do
     end
   end
 
+  describe "when processing an action with graylog2 output" do
+    before do
+      Lograge::log_format = :graylog2
+    end
+
+    it "should include the URL in the log output" do
+      subscriber.process_action(event)
+      log_output.string.should include(':_path=>"/home"')
+    end
+
+    it "should start include the HTTP method" do
+      subscriber.process_action(event)
+      log_output.string.should include(':_method=>"GET"')
+    end
+
+    it "should include the status code" do
+      subscriber.process_action(event)
+      log_output.string.should include(':_status=>200')    end
+
+    it "should include the controller and action" do
+      subscriber.process_action(event)
+      log_output.string.should include(':_controller=>"home"')
+      log_output.string.should include(':_action=>"index"')
+    end
+
+    it "should include the duration" do
+      subscriber.process_action(event)
+      log_output.string.should =~ /:_duration=>\d+\.\d{0,2}/
+    end
+
+    it "should include the view rendering time" do
+      subscriber.process_action(event)
+      log_output.string.should include(':_view=>0.01')
+    end
+
+    it "should include the database rendering time" do
+      subscriber.process_action(event)
+      log_output.string.should include(':_db=>0.02')
+    end
+
+    it "should add a 500 status when an exception occurred" do
+      event.payload[:status] = nil
+      event.payload[:exception] = ['AbstractController::ActionNotFound', 'Route not found']
+      subscriber.process_action(event)
+      log_output.string.should include(':_status=>500')
+      log_output.string.should include(':_error=>"AbstractController::ActionNotFound:Route not found"')
+    end
+
+    it "should return an unknown status when no status or exception is found" do
+      event.payload[:status] = nil
+      event.payload[:exception] = nil
+      subscriber.process_action(event)
+      log_output.string.should include(':_status=>0')
+    end
+
+    describe "with a redirect" do
+      before do
+        Thread.current[:lograge_location] = "http://www.example.com"
+      end
+
+      it "should add the location to the log line" do
+        subscriber.process_action(event)
+        log_output.string.should include(':_location=>"http://www.example.com"')
+      end
+
+      it "should remove the thread local variable" do
+        subscriber.process_action(event)
+        Thread.current[:lograge_location].should == nil
+      end
+    end
+
+    it "should not include a location by default" do
+      subscriber.process_action(event)
+      log_output.string.should_not =~ /"location":/
+    end
+  end
+
+  describe "with custom_options configured for graylog2 output" do
+    before do
+      Lograge::log_format = :graylog2
+    end
+
+    it "should combine the hash properly for the output" do
+      Lograge.custom_options = {:data => "value"}
+      subscriber.process_action(event)
+      log_output.string.should include(':_data=>"value"')
+    end
+
+    it "should combine the output of a lambda properly" do
+      Lograge.custom_options = lambda {|event| {:data => "value"}}
+      subscriber.process_action(event)
+      log_output.string.should include(':_data=>"value"')
+    end
+
+    it "should work if the method returns nil" do
+      Lograge.custom_options = lambda {|event| nil}
+      subscriber.process_action(event)
+      log_output.string.should be_present
+    end
+  end
+
   describe "with custom_options configured for lograge output" do
     before do
       Lograge::log_format = :lograge

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec