RubyGems - loga - Versions diffs - 1.0.0 - Mend

loga 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (102) hide show

checksums.yaml +7 -0
data/.gitignore +25 -0
data/.rspec +2 -0
data/.rubocop.yml +19 -0
data/.rubocop_todo.yml +33 -0
data/Appraisals +14 -0
data/Gemfile +8 -0
data/README.md +147 -0
data/Rakefile +9 -0
data/circle.yml +23 -0
data/gemfiles/rails32.gemfile +11 -0
data/gemfiles/rails40.gemfile +11 -0
data/gemfiles/sinatra14.gemfile +11 -0
data/gemfiles/unit.gemfile +9 -0
data/lib/loga.rb +33 -0
data/lib/loga/configuration.rb +96 -0
data/lib/loga/event.rb +21 -0
data/lib/loga/ext/rails/rack/logger3.rb +21 -0
data/lib/loga/ext/rails/rack/logger4.rb +13 -0
data/lib/loga/formatter.rb +104 -0
data/lib/loga/parameter_filter.rb +65 -0
data/lib/loga/rack/logger.rb +102 -0
data/lib/loga/rack/request.rb +77 -0
data/lib/loga/rack/request_id.rb +44 -0
data/lib/loga/railtie.rb +139 -0
data/lib/loga/tagged_logging.rb +76 -0
data/lib/loga/utilities.rb +7 -0
data/lib/loga/version.rb +3 -0
data/loga.gemspec +31 -0
data/spec/fixtures/README.md +8 -0
data/spec/fixtures/rails32/Rakefile +7 -0
data/spec/fixtures/rails32/app/controllers/application_controller.rb +28 -0
data/spec/fixtures/rails32/app/helpers/application_helper.rb +2 -0
data/spec/fixtures/rails32/app/views/layouts/application.html.erb +14 -0
data/spec/fixtures/rails32/app/views/user.html.erb +1 -0
data/spec/fixtures/rails32/config.ru +4 -0
data/spec/fixtures/rails32/config/application.rb +71 -0
data/spec/fixtures/rails32/config/boot.rb +6 -0
data/spec/fixtures/rails32/config/environment.rb +5 -0
data/spec/fixtures/rails32/config/environments/development.rb +26 -0
data/spec/fixtures/rails32/config/environments/production.rb +50 -0
data/spec/fixtures/rails32/config/environments/test.rb +35 -0
data/spec/fixtures/rails32/config/initializers/backtrace_silencers.rb +7 -0
data/spec/fixtures/rails32/config/initializers/inflections.rb +15 -0
data/spec/fixtures/rails32/config/initializers/mime_types.rb +5 -0
data/spec/fixtures/rails32/config/initializers/secret_token.rb +7 -0
data/spec/fixtures/rails32/config/initializers/session_store.rb +8 -0
data/spec/fixtures/rails32/config/initializers/wrap_parameters.rb +10 -0
data/spec/fixtures/rails32/config/locales/en.yml +5 -0
data/spec/fixtures/rails32/config/routes.rb +64 -0
data/spec/fixtures/rails32/public/404.html +26 -0
data/spec/fixtures/rails32/public/422.html +26 -0
data/spec/fixtures/rails32/public/500.html +25 -0
data/spec/fixtures/rails32/public/favicon.ico +0 -0
data/spec/fixtures/rails32/public/index.html +241 -0
data/spec/fixtures/rails32/public/robots.txt +5 -0
data/spec/fixtures/rails32/script/rails +6 -0
data/spec/fixtures/rails40/Rakefile +6 -0
data/spec/fixtures/rails40/app/controllers/application_controller.rb +30 -0
data/spec/fixtures/rails40/app/helpers/application_helper.rb +2 -0
data/spec/fixtures/rails40/app/views/layouts/application.html.erb +14 -0
data/spec/fixtures/rails40/app/views/user.html.erb +1 -0
data/spec/fixtures/rails40/bin/bundle +3 -0
data/spec/fixtures/rails40/bin/rails +4 -0
data/spec/fixtures/rails40/bin/rake +4 -0
data/spec/fixtures/rails40/config.ru +4 -0
data/spec/fixtures/rails40/config/application.rb +37 -0
data/spec/fixtures/rails40/config/boot.rb +4 -0
data/spec/fixtures/rails40/config/environment.rb +5 -0
data/spec/fixtures/rails40/config/environments/development.rb +24 -0
data/spec/fixtures/rails40/config/environments/production.rb +65 -0
data/spec/fixtures/rails40/config/environments/test.rb +39 -0
data/spec/fixtures/rails40/config/initializers/backtrace_silencers.rb +7 -0
data/spec/fixtures/rails40/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/fixtures/rails40/config/initializers/inflections.rb +16 -0
data/spec/fixtures/rails40/config/initializers/mime_types.rb +5 -0
data/spec/fixtures/rails40/config/initializers/secret_token.rb +12 -0
data/spec/fixtures/rails40/config/initializers/session_store.rb +3 -0
data/spec/fixtures/rails40/config/initializers/wrap_parameters.rb +9 -0
data/spec/fixtures/rails40/config/locales/en.yml +23 -0
data/spec/fixtures/rails40/config/routes.rb +62 -0
data/spec/fixtures/rails40/public/404.html +58 -0
data/spec/fixtures/rails40/public/422.html +58 -0
data/spec/fixtures/rails40/public/500.html +57 -0
data/spec/fixtures/rails40/public/favicon.ico +0 -0
data/spec/fixtures/rails40/public/robots.txt +5 -0
data/spec/integration/rails/railtie_spec.rb +64 -0
data/spec/integration/rails/request_spec.rb +42 -0
data/spec/integration/sinatra_spec.rb +54 -0
data/spec/spec_helper.rb +39 -0
data/spec/support/helpers.rb +16 -0
data/spec/support/request_spec.rb +183 -0
data/spec/support/timecop_shared.rb +7 -0
data/spec/unit/loga/configuration_spec.rb +123 -0
data/spec/unit/loga/event_spec.rb +20 -0
data/spec/unit/loga/formatter_spec.rb +186 -0
data/spec/unit/loga/parameter_filter_spec.rb +76 -0
data/spec/unit/loga/rack/logger_spec.rb +114 -0
data/spec/unit/loga/rack/request_spec.rb +70 -0
data/spec/unit/loga/utilities_spec.rb +16 -0
data/spec/unit/loga_spec.rb +41 -0
metadata +357 -0

data/spec/fixtures/rails40/public/422.html ADDED

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/fixtures/rails40/public/500.html ADDED

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/fixtures/rails40/public/favicon.ico ADDED

File without changes

data/spec/fixtures/rails40/public/robots.txt ADDED

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-agent: *
+# Disallow: /

data/spec/integration/rails/railtie_spec.rb ADDED

@@ -0,0 +1,64 @@
+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
+      end
+    end
+    context 'when loga is enabled' do
+      let(:loga) { Loga::Configuration.new }
+      it 'initializes the logger' do
+        expect(config.logger).to be_a(Logger)
+      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
+  it 'disables colorized logging' do
+    expect(app.config.colorize_logging).to eq(false)
+  end
+  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
+    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
+end

data/spec/integration/rails/request_spec.rb ADDED

@@ -0,0 +1,42 @@
+require 'spec_helper'
+describe 'Integration with Rails', timecop: true 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
+    end
+  end
+  let(:json) { json_entries.last }
+  let(:json_response) { JSON.parse(last_response.body) }
+  include_examples 'request logger'
+  it 'preserves rails parameters' do
+    get '/show'
+    expect(json_response).to eq('action' => 'show', 'controller' => 'application')
+  end
+  context 'when a template is rendered' do
+    let(:action_view_notifications) do
+      json_entries.select { |e| e.to_json =~ /Rendered/ }
+    end
+    before { put '/users/5' }
+    specify { expect(last_response.status).to eq(200) }
+    it 'silences ActionView::LogSubscriber' do
+      expect(action_view_notifications).to be_empty
+    end
+  end
+end

data/spec/integration/sinatra_spec.rb ADDED

@@ -0,0 +1,54 @@
+require 'spec_helper'
+describe 'Rack request logger with Sinatra', timecop: true do
+  let(:io) { StringIO.new }
+  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!
+  end
+  let(:json) do
+    io.rewind
+    JSON.parse(io.read)
+  end
+  let(:app) do
+    Class.new(Sinatra::Base) do
+      # Disable show_exceptions and rely on user defined exception handlers
+      # (e.i. the error blocks)
+      set :show_exceptions, false
+      use Loga::Rack::RequestId
+      use Loga::Rack::Logger, Loga.logger, [:uuid]
+      error do
+        status 500
+        body 'Ooops'
+      end
+      get '/ok' do
+        'Hello Sinatra'
+      end
+      get '/error' do
+        nil.name
+      end
+      post '/users' do
+        content_type :json
+        params.to_json
+      end
+      get '/new' do
+        redirect '/ok'
+      end
+    end
+  end
+  include_examples 'request logger'
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,39 @@
+require 'codeclimate-test-reporter'
+require 'pry'
+require 'support/helpers'
+require 'support/timecop_shared'
+require 'support/request_spec'
+require 'rack/test'
+CodeClimate::TestReporter.start if ENV.fetch('CODECLIMATE_REPO_TOKEN', nil)
+class Socket
+  def self.gethostname
+    'bird.example.com'
+  end
+end
+case ENV['BUNDLE_GEMFILE']
+when /rails/
+  rspec_pattern = 'integration/rails/**/*_spec.rb'
+  /(?<appraisal>rails\d{2})\.gemfile/ =~ ENV['BUNDLE_GEMFILE']
+  require 'rails'
+  require File.expand_path("../fixtures/#{appraisal}/config/environment.rb",  __FILE__)
+when /sinatra/
+  rspec_pattern = 'integration/sinatra_spec.rb'
+  require 'json'
+  require 'sinatra'
+  require 'loga'
+when /unit/
+  rspec_pattern = 'unit/**/*_spec.rb'
+  require 'loga'
+else
+  fail 'BUNDLE_GEMFILE is unknown. Ensure the appraisal is present in Appraisals'
+end
+RSpec.configure do |config|
+  config.include Helpers
+  config.include Rack::Test::Methods
+  config.pattern = rspec_pattern
+end

data/spec/support/helpers.rb ADDED

@@ -0,0 +1,16 @@
+require 'bigdecimal'
+module Helpers
+  # Time used when testing timestamp
+  def time_anchor
+    Time.new(2015, 12, 15, 9, 30, 5.123, '+06:00')
+  end
+  def time_anchor_unix
+    BigDecimal.new('1450150205.123')
+  end
+  def hostname_anchor
+    'bird.example.com'
+  end
+end

data/spec/support/request_spec.rb ADDED

@@ -0,0 +1,183 @@
+RSpec.shared_examples 'request logger' do
+  context 'get request' do
+    it 'logs the request' do
+      get '/ok',
+          { username: 'yoshi' },
+          'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
+      expect(json).to match(
+        'version'             => '1.1',
+        'host'                => 'bird.example.com',
+        'short_message'       => 'GET /ok?username=yoshi 200 in 0ms',
+        'timestamp'           => 1_450_150_205.123,
+        'level'               => 6,
+        '_type'               => 'request',
+        '_service.name'       => 'hello_world_app',
+        '_service.version'    => '1.0',
+        '_request.method'     => 'GET',
+        '_request.path'       => '/ok',
+        '_request.params'     => { 'username' => 'yoshi' },
+        '_request.request_ip' => '127.0.0.1',
+        '_request.user_agent' => 'Chrome',
+        '_request.status'     => 200,
+        '_request.request_id' => '471a34dc',
+        '_request.duration'   => 0,
+        '_tags'               => ['471a34dc'],
+      )
+    end
+  end
+  context 'post request' do
+    let(:json_response) { JSON.parse(last_response.body) }
+    it 'logs the request' do
+      post '/users?username=yoshi',
+           { email: 'hello@world.com' },
+           'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
+      expect(json).to match(
+        'version'             => '1.1',
+        'host'                => 'bird.example.com',
+        'short_message'       => 'POST /users?username=yoshi 200 in 0ms',
+        'timestamp'           => 1_450_150_205.123,
+        'level'               => 6,
+        '_type'               => 'request',
+        '_service.name'       => 'hello_world_app',
+        '_service.version'    => '1.0',
+        '_request.method'     => 'POST',
+        '_request.path'       => '/users',
+        '_request.params'     => { 'username' => 'yoshi', 'email' => 'hello@world.com' },
+        '_request.request_ip' => '127.0.0.1',
+        '_request.user_agent' => 'Chrome',
+        '_request.status'     => 200,
+        '_request.request_id' => '471a34dc',
+        '_request.duration'   => 0,
+        '_tags'               => ['471a34dc'],
+      )
+    end
+    it 'preseves request parameters' do
+      post '/users?username=yoshi', email: 'hello@world.com'
+      expect(json_response).to include('email' => 'hello@world.com', 'username' => 'yoshi')
+    end
+  end
+  context 'request with redirect' do
+    it 'specifies the original path' do
+      get '/new', {}, 'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
+      expect(json).to match(
+        'version'             => '1.1',
+        'host'                => 'bird.example.com',
+        'short_message'       => 'GET /new 302 in 0ms',
+        'timestamp'           => 1_450_150_205.123,
+        'level'               => 6,
+        '_type'               => 'request',
+        '_service.name'       => 'hello_world_app',
+        '_service.version'    => '1.0',
+        '_request.method'     => 'GET',
+        '_request.path'       => '/new',
+        '_request.params'     => {},
+        '_request.request_ip' => '127.0.0.1',
+        '_request.user_agent' => 'Chrome',
+        '_request.status'     => 302,
+        '_request.request_id' => '471a34dc',
+        '_request.duration'   => 0,
+        '_tags'               => ['471a34dc'],
+      )
+    end
+  end
+  context 'when the request raises an exception' do
+    it 'logs the request with the exception' do
+      get '/error',
+          { username: 'yoshi' },
+          'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
+      expect(json).to match(
+        'version'              => '1.1',
+        'host'                 => 'bird.example.com',
+        'short_message'        => 'GET /error?username=yoshi 500 in 0ms',
+        'timestamp'            => 1_450_150_205.123,
+        'level'                => 3,
+        '_type'                => 'request',
+        '_service.name'        => 'hello_world_app',
+        '_service.version'     => '1.0',
+        '_request.method'      => 'GET',
+        '_request.path'        => '/error',
+        '_request.params'      => { 'username' => 'yoshi' },
+        '_request.request_ip'  => '127.0.0.1',
+        '_request.user_agent'  => 'Chrome',
+        '_request.status'      => 500,
+        '_request.request_id'  => '471a34dc',
+        '_request.duration'    => 0,
+        '_exception.klass'     => 'NoMethodError',
+        '_exception.message'   => "undefined method `name' for nil:NilClass",
+        '_exception.backtrace' => be_a(String),
+        '_tags'               => ['471a34dc'],
+      )
+    end
+  end
+  describe 'when request causes 404' do
+    it 'does not log the framework exception' do
+      get '/not_found', {}, 'HTTP_X_REQUEST_ID' => '471a34dc'
+      expect(json).to match(
+        'version'              => '1.1',
+        'host'                 => 'bird.example.com',
+        'short_message'        => 'GET /not_found 404 in 0ms',
+        'timestamp'            => 1_450_150_205.123,
+        'level'                => 6,
+        '_type'                => 'request',
+        '_service.name'        => 'hello_world_app',
+        '_service.version'     => '1.0',
+        '_request.method'      => 'GET',
+        '_request.path'        => '/not_found',
+        '_request.params'      => {},
+        '_request.request_ip'  => '127.0.0.1',
+        '_request.user_agent'  => nil,
+        '_request.status'      => 404,
+        '_request.request_id'  => '471a34dc',
+        '_request.duration'    => 0,
+        '_tags'               => ['471a34dc'],
+      )
+    end
+  end
+  describe 'when the request includes a filtered parameter' do
+    before { get '/ok', params }
+    context 'when params is shallow' do
+      let(:params) { { password: 'password123' } }
+      it 'filters the parameter from the params hash' do
+        expect(json).to include(
+          '_request.params' => { 'password' => '[FILTERED]' },
+        )
+      end
+      it 'filters the parameter from the message' do
+        expect(json).to include(
+          'short_message' => 'GET /ok?password=[FILTERED] 200 in 0ms',
+        )
+      end
+    end
+    context 'when params is nested' do
+      let(:params) { { users: [password: 'password123'] } }
+      it 'filters the parameter from the params hash' do
+        expect(json).to include(
+          '_request.params' => { 'users' => ['password' => '[FILTERED]'] },
+        )
+      end
+      it 'filters the parameter from the message' do
+        expect(json).to include(
+          'short_message' => 'GET /ok?users[][password]=[FILTERED] 200 in 0ms',
+        )
+      end
+    end
+  end
+end