loga 1.0.0

data/lib/loga/railtie.rb

@@ -0,0 +1,139 @@
+require 'loga'
+
+module Loga
+  class Railtie < Rails::Railtie
+    class InitializeLogger
+      def initialize(app)
+        @app = app
+      end
+
+      def call
+        loga.tap do |config|
+          config.sync  = sync
+          config.level = app.config.log_level
+        end
+        loga.initialize!
+        app.config.logger = loga.logger
+      end
+
+      private
+
+      attr_reader :app
+
+      def loga
+        app.config.loga
+      end
+
+      def sync
+        Rails::VERSION::MAJOR > 3 ? app.config.autoflush_log : true
+      end
+
+      def constantized_log_level
+        Logger.const_get(app.config.log_level.to_s.upcase)
+      end
+    end
+
+    config.loga = Loga::Configuration.new
+
+    initializer :loga_initialize_logger, before: :initialize_logger do |app|
+      InitializeLogger.new(app).call if app.config.loga.enabled
+    end
+
+    class InitializeMiddleware
+      module ExceptionsCatcher
+        # Sets up an alias chain to catch exceptions when Rails middleware does
+        def self.included(base) #:nodoc:
+          base.send(:alias_method, :render_exception_without_loga, :render_exception)
+          base.send(:alias_method, :render_exception, :render_exception_with_loga)
+        end
+
+        private
+
+        def render_exception_with_loga(env, exception)
+          env['loga.exception'] = exception
+          render_exception_without_loga(env, exception)
+        end
+      end
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call
+        insert_loga_rack_logger
+        disable_rails_rack_logger
+        insert_exceptions_catcher
+      end
+
+      private
+
+      attr_reader :app
+
+      def insert_exceptions_catcher
+        if defined?(ActionDispatch::DebugExceptions)
+          ActionDispatch::DebugExceptions.send(:include, ExceptionsCatcher)
+        elsif defined?(ActionDispatch::ShowExceptions)
+          ActionDispatch::ShowExceptions.send(:include, ExceptionsCatcher)
+        end
+      end
+
+      # Removes start of request log
+      # (e.g. Started GET "/users" for 127.0.0.1 at 2015-12-24 23:59:00 +0000)
+      def disable_rails_rack_logger
+        return unless app.config.loga.silence_rails_rack_logger
+
+        case Rails::VERSION::MAJOR
+        when 3 then require 'loga/ext/rails/rack/logger3.rb'
+        when 4 then require 'loga/ext/rails/rack/logger4.rb'
+        end
+      end
+
+      def insert_loga_rack_logger
+        app.middleware.insert_after Rails::Rack::Logger,
+                                    Loga::Rack::Logger,
+                                    app.config.logger,
+                                    app.config.log_tags
+      end
+    end
+
+    initializer :loga_initialize_middleware do |app|
+      InitializeMiddleware.new(app).call if app.config.loga.enabled
+      app.config.colorize_logging = false
+    end
+
+    class InitializeInstrumentation
+      def call
+        remove_existing_log_subscriptions
+      end
+
+      private
+
+      def remove_existing_log_subscriptions
+        ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+          case subscriber
+          when defined?(ActionView::LogSubscriber) && ActionView::LogSubscriber
+            unsubscribe(:action_view, subscriber)
+          end
+        end
+      end
+
+      def unsubscribe(component, subscriber)
+        events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+        events.each do |event|
+          ActiveSupport::Notifications
+            .notifier
+            .listeners_for("#{event}.#{component}")
+            .each do |listener|
+            if listener.instance_variable_get('@delegate') == subscriber
+              ActiveSupport::Notifications.unsubscribe listener
+            end
+          end
+        end
+      end
+    end
+
+    config.after_initialize do |app|
+      InitializeInstrumentation.new.call if app.config.loga.enabled
+    end
+  end
+end

data/lib/loga/tagged_logging.rb

@@ -0,0 +1,76 @@
+# Copy of ActiveSupport::TaggedLogging
+#
+# Copyright and license information: https://github.com/rails/rails/blob/master/activesupport/MIT-LICENSE
+# Original contributors: https://github.com/rails/rails/commits/master/activesupport/lib/active_support/tagged_logging.rb
+
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'logger'
+
+module Loga
+  # rubocop:disable Metrics/LineLength
+  # Wraps any standard Logger object to provide tagging capabilities.
+  #
+  #   logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
+  #   logger.tagged('BCX') { logger.info 'Stuff' }                            # Logs "[BCX] Stuff"
+  #   logger.tagged('BCX', "Jason") { logger.info 'Stuff' }                   # Logs "[BCX] [Jason] Stuff"
+  #   logger.tagged('BCX') { logger.tagged('Jason') { logger.info 'Stuff' } } # Logs "[BCX] [Jason] Stuff"
+  #
+  # This is used by the default Rails.logger as configured by Railties to make
+  # it easy to stamp log lines with subdomains, request ids, and anything else
+  # to aid debugging of multi-user production applications.
+  # rubocop:enable Metrics/LineLength
+  module TaggedLogging
+    module Formatter # :nodoc:
+      def tagged(*tags)
+        new_tags = push_tags(*tags)
+        yield self
+      ensure
+        pop_tags(new_tags.size)
+      end
+
+      def push_tags(*tags)
+        tags.flatten.reject(&:blank?).tap do |new_tags|
+          current_tags.concat new_tags
+        end
+      end
+
+      def pop_tags(size = 1)
+        current_tags.pop size
+      end
+
+      def clear_tags!
+        current_tags.clear
+      end
+
+      def current_tags
+        Thread.current[:loga_tagged_logging_tags] ||= []
+      end
+
+      private
+
+      def tags_text
+        tags = current_tags
+        tags.collect { |tag| "[#{tag}] " }.join if tags.any?
+      end
+    end
+
+    def self.new(logger)
+      # Ensure we set a default formatter so we aren't extending nil!
+      # logger.formatter ||= ::Logger::SimpleFormatter.new
+      logger.formatter.extend Formatter
+      logger.extend(self)
+    end
+
+    delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter
+
+    def tagged(*tags)
+      formatter.tagged(*tags) { yield self }
+    end
+
+    def flush
+      clear_tags!
+      super if defined?(super)
+    end
+  end
+end

data/lib/loga/utilities.rb

@@ -0,0 +1,7 @@
+module Loga
+  module Utilities
+    def duration_in_ms(started_at, ended_at)
+      ((ended_at - started_at) * 1000).round
+    end
+  end
+end

data/lib/loga/version.rb

@@ -0,0 +1,3 @@
+module Loga
+  VERSION = '1.0.0'
+end

data/loga.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'loga/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'loga'
+  spec.version       = Loga::VERSION
+  spec.authors       = ['Funding Circle']
+  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.homepage      = 'https://github.com/FundingCircle/loga'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 2.3.8'
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency 'appraisal', '~> 2.0.2'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  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 'rubocop',  '~> 0.30.0'
+  spec.add_development_dependency 'timecop'
+end

data/spec/fixtures/README.md

@@ -0,0 +1,8 @@
+# Generating fixture Apps
+
+## Rails 3.2
+`appraisal rails_3.2 rails new spec/fixtures/rails32 --skip-gemfile --skip-git --skip-active-record --skip-sprockets --skip-javascript --skip-test-unit`
+
+
+## Rails 4.0
+`appraisal rails_4.0 rails new spec/fixtures/rails40 --skip-gemfile --skip-git --skip-keeps --skip-active-record --skip-action-view --skip-sprockets --skip-spring --skip-javascript --skip-test-unit`

data/spec/fixtures/rails32/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails32::Application.load_tasks

data/spec/fixtures/rails32/app/controllers/application_controller.rb

@@ -0,0 +1,28 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def ok
+    render text: 'Hello Rails'
+  end
+
+  def error
+    nil.name
+  end
+
+  def show
+    render json: params
+  end
+
+  def create
+    render json: params
+  end
+
+  def new
+    redirect_to :ok
+  end
+
+  def update
+    @id = params[:id]
+    render '/user'
+  end
+end

data/spec/fixtures/rails32/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/fixtures/rails32/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails32</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/fixtures/rails32/app/views/user.html.erb

@@ -0,0 +1 @@
+<p>User <%= @id %></p>

data/spec/fixtures/rails32/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails32::Application

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

@@ -0,0 +1,71 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+if defined?(Bundler)
+  # If you precompile assets before deploying to production, use this line
+  Bundler.require(*Rails.groups(:assets => %w(development test)))
+  # If you want your assets lazily compiled in production, use this line
+  # Bundler.require(:default, :assets, Rails.env)
+end
+
+STREAM = StringIO.new unless defined?(STREAM)
+
+module Rails32
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    # config.active_record.whitelist_attributes = true
+    config.log_tags = [:uuid]
+    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
+  end
+end

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

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

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

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Rails32::Application.initialize!

data/spec/fixtures/rails32/config/environments/development.rb

@@ -0,0 +1,26 @@
+Rails32::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+
+end