loga 1.4.0 → 2.0.0

data/lib/loga/service_version_strategies.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext/object/blank'
+
+module Loga
+  class ServiceVersionStrategies
+    # Redirect stderror to /dev/null when git binary or git directory not available
+    SCM_GIT       = -> { `git rev-parse --short HEAD 2>/dev/null` }
+    REVISION_FILE = -> { begin; File.read('REVISION'); rescue Errno::ENOENT; nil; end }
+    DEFAULT       = -> { 'unknown.sha' }
+    STRATEGIES    = [SCM_GIT, REVISION_FILE, DEFAULT].freeze
+
+    def self.call
+      new.call
+    end
+
+    def call
+      STRATEGIES.map(&:call).find(&:presence).strip
+    end
+  end
+end

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '1.4.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/loga.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['engineering@fundingcircle.com']
   spec.summary       = 'Facilitate log aggregation via unified logging'
   spec.description   = 'Log aggregation through unified logging middleware, while respecting the original log format.'
+  spec.license       = 'BSD-3-Clause'
   spec.homepage      = 'https://github.com/FundingCircle/loga'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -25,7 +26,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec',    '~> 3.0.0'
+  spec.add_development_dependency 'rspec',    '~> 3.5.0'
   spec.add_development_dependency 'rubocop',  '~> 0.40.0'
   spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'guard',         '~> 2.13'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'guard-rspec',   '~> 4.7.3'
 end

data/spec/fixtures/rails32/config/application.rb

@@ -61,11 +61,11 @@ module Rails32
     # parameters by using an attr_accessible or attr_protected declaration.
     # config.active_record.whitelist_attributes = true
     config.log_tags = [ :uuid, 'TEST_TAG' ]
-    config.loga.configure do |loga|
-      loga.service_name = 'hello_world_app'
-      loga.service_version = '1.0'
-      loga.host = 'bird.example.com'
-      loga.device = STREAM
-    end
+    config.loga = {
+      device: STREAM,
+      host: 'bird.example.com',
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+    }
   end
 end

data/spec/fixtures/rails40/config/application.rb

@@ -27,11 +27,11 @@ module Rails40
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
     config.log_tags = [ :uuid, 'TEST_TAG' ]
-    config.loga.configure do |loga|
-      loga.service_name = 'hello_world_app'
-      loga.service_version = '1.0'
-      loga.host = 'bird.example.com'
-      loga.device = STREAM
-    end
+    config.loga = {
+      device: STREAM,
+      host: 'bird.example.com',
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+    }
   end
 end

data/spec/fixtures/rails50/config/application.rb

@@ -24,11 +24,11 @@ module Rails50
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
     config.log_tags = [ :request_id, 'TEST_TAG' ]
-    config.loga.configure do |loga|
-      loga.service_name = 'hello_world_app'
-      loga.service_version = '1.0'
-      loga.host = 'bird.example.com'
-      loga.device = STREAM
-    end
+    config.loga = {
+      device: STREAM,
+      host: 'bird.example.com',
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+    }
   end
 end

data/spec/integration/rails/railtie_spec.rb

@@ -3,85 +3,93 @@ require 'ostruct'
 RSpec.describe Loga::Railtie do
   let(:app)          { Rails.application }
   let(:middlewares)  { app.middleware.middlewares }
-  let(:initializers) { described_class.initializers }
 
-  describe 'loga_initialize_logger' do
-    let(:initializer) { initializers.find { |i| i.name == :loga_initialize_logger } }
-
-    let(:app)    { OpenStruct.new(config: config) }
-    let(:config) { OpenStruct.new(loga: loga, log_level: :info) }
-
-    before { initializer.run(app) }
-
-    context 'when loga is disabled' do
-      let(:loga) { Loga::Configuration.new.tap { |c| c.enabled = false } }
-
-      it 'is not initialized' do
-        expect(config.logger).to be_nil
+  context 'development', if: Rails.env.development? do
+    describe 'loga_initialize_logger' do
+      let(:formatter) do
+        if ActiveSupport::VERSION::MAJOR == 3
+          Logger::SimpleFormatter
+        else
+          ActiveSupport::Logger::SimpleFormatter
+        end
       end
-    end
 
-    context 'when loga is enabled' do
-      let(:loga) { Loga::Configuration.new }
+      it 'assign Loga logger to Rails logger' do
+        expect(Loga.logger).to equal(Rails.logger)
+      end
 
-      it 'initializes the logger' do
-        expect(config.logger).to be_a(Logger)
+      it 'configures Loga with a simple formatter' do
+        expect(Loga.configuration.logger.formatter).to be_a(formatter)
       end
     end
   end
 
-  it 'inserts Loga::Rack::Logger middleware after Rails::Rack::Logger' do
-    expect(middlewares.index(Loga::Rack::Logger))
-      .to eq(middlewares.index(Rails::Rack::Logger) + 1)
-  end
+  context 'production', if: Rails.env.production? do
+    describe 'loga_initialize_logger' do
+      it 'assign Loga logger to Rails logger' do
+        expect(Loga.logger).to equal(Rails.logger)
+      end
 
-  it 'disables colorized logging' do
-    expect(app.config.colorize_logging).to eq(false)
-  end
+      it 'configures Loga with a structured formatter' do
+        expect(Loga.configuration.logger.formatter).to be_a(Loga::Formatter)
+      end
 
-  describe 'instrumentation' do
-    let(:listeners)   do
-      ActiveSupport::Notifications.notifier.listeners_for(notification)
+      it 'disables colorized logging' do
+        expect(app.config.colorize_logging).to eq(false)
+      end
     end
-    let(:subscribers) do
-      listeners.map { |l| l.instance_variable_get(:@delegate).class }
+
+    describe 'loga_initialize_middleware' do
+      it 'inserts Loga::Rack::Logger middleware after Rails::Rack::Logger' do
+        expect(middlewares.index(Loga::Rack::Logger))
+          .to eq(middlewares.index(Rails::Rack::Logger) + 1)
+      end
     end
 
-    context 'ActionView' do
-      [
-        'render_collection.action_view',
-        'render_partial.action_view',
-        'render_template.action_view',
-      ].each do |notification|
-        let(:notification) { notification }
+    describe 'instrumentation' do
+      let(:listeners)   do
+        ActiveSupport::Notifications.notifier.listeners_for(notification)
+      end
+      let(:subscribers) do
+        listeners.map { |l| l.instance_variable_get(:@delegate).class }
+      end
 
-        it 'removes ActionView::LogSubscriber' do
-          expect(subscribers).to_not include(ActionView::LogSubscriber)
+      context 'ActionView' do
+        [
+          'render_collection.action_view',
+          'render_partial.action_view',
+          'render_template.action_view',
+        ].each do |notification|
+          let(:notification) { notification }
+
+          it 'removes ActionView::LogSubscriber' do
+            expect(subscribers).to_not include(ActionView::LogSubscriber)
+          end
         end
       end
-    end
 
-    context 'ActionController' do
-      [
-        'exist_fragment?.action_controller',
-        'expire_fragment.action_controller',
-        'expire_page.action_controller',
-        'halted_callback.action_controller',
-        'logger.action_controller',
-        'process_action.action_controller',
-        'read_fragment.action_controller',
-        'redirect_to.action_controller',
-        'send_data.action_controller',
-        'send_file.action_controller',
-        'start_processing.action_controller',
-        'unpermitted_parameters.action_controller',
-        'write_fragment.action_controller',
-        'write_page.action_controller',
-      ].each do |notification|
-        let(:notification) { notification }
+      context 'ActionController' do
+        [
+          'exist_fragment?.action_controller',
+          'expire_fragment.action_controller',
+          'expire_page.action_controller',
+          'halted_callback.action_controller',
+          'logger.action_controller',
+          'process_action.action_controller',
+          'read_fragment.action_controller',
+          'redirect_to.action_controller',
+          'send_data.action_controller',
+          'send_file.action_controller',
+          'start_processing.action_controller',
+          'unpermitted_parameters.action_controller',
+          'write_fragment.action_controller',
+          'write_page.action_controller',
+        ].each do |notification|
+          let(:notification) { notification }
 
-        it 'removes ActionController::LogSubscriber' do
-          expect(subscribers).to_not include(ActionController::LogSubscriber)
+          it 'removes ActionController::LogSubscriber' do
+            expect(subscribers).to_not include(ActionController::LogSubscriber)
+          end
         end
       end
     end

data/spec/integration/rails/request_spec.rb

@@ -1,23 +1,22 @@
 require 'spec_helper'
 
-describe 'Integration with Rails', timecop: true do
+RSpec.describe 'Structured logging with Rails', timecop: true,
+                                                if: Rails.env.production? do
   let(:app) { Rails.application }
 
-  let(:json_entries) do
-    [].tap do |entries|
-      STREAM.tap do |s|
-        s.rewind
-        s.read.split("\n").each do |line|
-          entries << JSON.parse(line)
-        end
-        s.close
-        s.reopen
-      end
+  let(:log_entries) do
+    entries = []
+    STREAM.tap do |s|
+      s.rewind
+      entries = s.read.split("\n").map { |line| JSON.parse(line) }
+      s.close
+      s.reopen
     end
+    entries
   end
 
-  let(:json) { json_entries.last }
-  let(:json_response) { JSON.parse(last_response.body) }
+  let(:last_log_entry) { log_entries.last }
+  let(:json_response)  { JSON.parse(last_response.body) }
 
   include_examples 'request logger'
 
@@ -28,13 +27,13 @@ describe 'Integration with Rails', timecop: true do
 
   it 'includes the controller name and action' do
     get '/ok'
-    expect(json).to include('_request.controller' => 'ApplicationController#ok')
+    expect(last_log_entry).to include('_request.controller' => 'ApplicationController#ok')
   end
 
   describe 'LogSubscriber' do
     context 'ActionController' do
       let(:action_controller_notifications) do
-        json_entries.select { |e| e.to_json =~ /Processing by|Completed/ }
+        log_entries.select { |e| e.to_json =~ /Processing by|Completed/ }
       end
 
       it 'silences ActionController::LogSubscriber' do
@@ -45,7 +44,7 @@ describe 'Integration with Rails', timecop: true do
 
     context 'ActionView' do
       let(:action_view_notifications) do
-        json_entries.select { |e| e.to_json =~ /Rendered/ }
+        log_entries.select { |e| e.to_json =~ /Rendered/ }
       end
 
       it 'silences ActionView::LogSubscriber' do
@@ -58,8 +57,8 @@ describe 'Integration with Rails', timecop: true do
   describe 'when request causes ActionDispatch 404' do
     it 'does not log ActionDispatch::DebugExceptions' do
       get '/not_found', {}, 'HTTP_X_REQUEST_ID' => '471a34dc'
-      expect(json_entries.count).to eq(1)
-      expect(json['short_message']).to eq('GET /not_found 404 in 0ms')
+      expect(log_entries.count).to eq(1)
+      expect(last_log_entry['short_message']).to eq('GET /not_found 404 in 0ms')
     end
   end
 end

data/spec/integration/sinatra_spec.rb

@@ -1,18 +1,20 @@
 require 'spec_helper'
 
-describe 'Rack request logger with Sinatra', timecop: true do
+RSpec.describe 'Structured logging with Sinatra', timecop: true do
   let(:io) { StringIO.new }
+  let(:format) {}
   before do
     Loga.reset
-    Loga.configure do |config|
-      config.service_name      = 'hello_world_app'
-      config.service_version   = '1.0'
-      config.filter_parameters = [:password]
-      config.device            = io
-    end
-    Loga.initialize!
+    Loga.configure(
+      device: io,
+      filter_parameters: [:password],
+      format: format,
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      tags: [:uuid, 'TEST_TAG'],
+    )
   end
-  let(:json) do
+  let(:last_log_entry) do
     io.rewind
     JSON.parse(io.read)
   end
@@ -24,7 +26,7 @@ describe 'Rack request logger with Sinatra', timecop: true do
       set :show_exceptions, false
 
       use Loga::Rack::RequestId
-      use Loga::Rack::Logger, Loga.logger, [:uuid, 'TEST_TAG']
+      use Loga::Rack::Logger
 
       error do
         status 500
@@ -50,10 +52,47 @@ describe 'Rack request logger with Sinatra', timecop: true do
     end
   end
 
-  include_examples 'request logger'
+  context 'when RACK_ENV is production', if: ENV['RACK_ENV'].eql?('production') do
+    let(:format) { :gelf }
+    include_examples 'request logger'
+
+    it 'does not include the controller name and action' do
+      get '/ok'
+      expect(last_log_entry).to_not include('_request.controller')
+    end
+  end
+
+  context 'when RACK_ENV is production', if: ENV['RACK_ENV'].eql?('development') do
+    let(:format) { :simple }
+    let(:last_log_entry) do
+      io.rewind
+      io.read
+    end
+
+    context 'get request' do
+      it 'logs the request' do
+        get '/ok', username: 'yoshi'
+        expect(last_log_entry)
+          .to eq("#{time_anchor.iso8601(3)} GET /ok?username=yoshi 200 in 0ms\n")
+      end
+    end
+
+    context 'request with redirect' do
+      it 'specifies the original path' do
+        get '/new'
+        expect(last_log_entry).to eql("#{time_anchor.iso8601(3)} GET /new 302 in 0ms\n")
+      end
+    end
+
+    context 'when the request raises an exception' do
+      let(:log_entry_match) do
+        %r{GET /error 500 in 0ms.undefined method `name' for nil:NilClass..+sinatra_spec}m
+      end
 
-  it 'does not include the controller name and action' do
-    get '/ok'
-    expect(json).to_not include('_request.controller')
+      it 'logs the request with the exception' do
+        get '/error'
+        expect(last_log_entry).to match(log_entry_match)
+      end
+    end
   end
 end

data/spec/support/request_spec.rb

@@ -5,7 +5,7 @@ RSpec.shared_examples 'request logger' do
           { username: 'yoshi' },
           'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
-      expect(json).to include(
+      expect(last_log_entry).to include(
         'version'             => '1.1',
         'host'                => 'bird.example.com',
         'short_message'       => 'GET /ok?username=yoshi 200 in 0ms',
@@ -35,7 +35,7 @@ RSpec.shared_examples 'request logger' do
            { email: 'hello@world.com' },
            'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
-      expect(json).to include(
+      expect(last_log_entry).to include(
         'version'             => '1.1',
         'host'                => 'bird.example.com',
         'short_message'       => 'POST /users?username=yoshi 200 in 0ms',
@@ -58,7 +58,8 @@ RSpec.shared_examples 'request logger' do
 
     it 'preseves request parameters' do
       post '/users?username=yoshi', email: 'hello@world.com'
-      expect(json_response).to include('email' => 'hello@world.com', 'username' => 'yoshi')
+      expect(json_response)
+        .to include('email' => 'hello@world.com', 'username' => 'yoshi')
     end
   end
 
@@ -66,7 +67,7 @@ RSpec.shared_examples 'request logger' do
     it 'specifies the original path' do
       get '/new', {}, 'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
-      expect(json).to include(
+      expect(last_log_entry).to include(
         'version'             => '1.1',
         'host'                => 'bird.example.com',
         'short_message'       => 'GET /new 302 in 0ms',
@@ -94,7 +95,7 @@ RSpec.shared_examples 'request logger' do
           { username: 'yoshi' },
           'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
-      expect(json).to include(
+      expect(last_log_entry).to include(
         'version'              => '1.1',
         'host'                 => 'bird.example.com',
         'short_message'        => 'GET /error?username=yoshi 500 in 0ms',
@@ -123,7 +124,7 @@ RSpec.shared_examples 'request logger' do
     it 'does not log the framework exception' do
       get '/not_found', {}, 'HTTP_X_REQUEST_ID' => '471a34dc'
 
-      expect(json).to include(
+      expect(last_log_entry).to include(
         'version'              => '1.1',
         'host'                 => 'bird.example.com',
         'short_message'        => 'GET /not_found 404 in 0ms',
@@ -152,13 +153,13 @@ RSpec.shared_examples 'request logger' do
       let(:params) { { password: 'password123' } }
 
       it 'filters the parameter from the params hash' do
-        expect(json).to include(
+        expect(last_log_entry).to include(
           '_request.params' => { 'password' => '[FILTERED]' },
         )
       end
 
       it 'filters the parameter from the message' do
-        expect(json).to include(
+        expect(last_log_entry).to include(
           'short_message' => 'GET /ok?password=[FILTERED] 200 in 0ms',
         )
       end
@@ -168,13 +169,13 @@ RSpec.shared_examples 'request logger' do
       let(:params) { { users: [password: 'password123'] } }
 
       it 'filters the parameter from the params hash' do
-        expect(json).to include(
+        expect(last_log_entry).to include(
           '_request.params' => { 'users' => ['password' => '[FILTERED]'] },
         )
       end
 
       it 'filters the parameter from the message' do
-        expect(json).to include(
+        expect(last_log_entry).to include(
           'short_message' => 'GET /ok?users[][password]=[FILTERED] 200 in 0ms',
         )
       end