loga 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: feb7e0fc4418e6763bb4cbe7cd0a381e8f0edf09
+  data.tar.gz: 7ee939ed4ba16283823ca2ca8f77bd9148e145b3
+SHA512:
+  metadata.gz: 71a379ec8c9659592d58dc1c0fae6096d00c6ed457368d26013970108ee4957141a5323620d931824768c2304ff04d95a1b707d90e893f3a2c0c3751054cb725
+  data.tar.gz: 3d71749a93556d196ea112fefa59cf26544a5b883dbda8044238ee759dde6dee71956ff74c4cbf1caaa06a088fd514de7f584ffdef6cc4699e7ae7984e661578

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log
+spec/fixtures/**/*.log
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'spec/fixtures/**/*'
+    - '*.gemspec'
+
+Style/TrailingComma:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-18 23:19:09 +0100 using RuboCop version 0.30.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/HandleExceptions:
+  Enabled: false
+
+# Offense count: 2
+Lint/RescueException:
+  Enabled: false
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 16
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 93
+
+# Offense count: 8
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 22
+
+# Offense count: 14
+Style/Documentation:
+  Enabled: false
+

data/Appraisals

@@ -0,0 +1,14 @@
+appraise 'rails32' do
+  gem 'rails', '~> 3.2.0'
+end
+
+appraise 'rails40' do
+  gem 'rails', '~> 4.0.0'
+end
+
+appraise 'sinatra14' do
+ gem 'sinatra',  '~> 1.4.0'
+end
+
+appraise 'unit' do
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loga.gemspec
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+end

data/README.md

@@ -0,0 +1,147 @@
+# Loga [![Build Status](https://circleci.com/gh/FundingCircle/loga/tree/master.svg?style=shield&circle-token=9b81c3cf8468a8c3dc760f4c0398cf8914cb27d4)](https://circleci.com/gh/FundingCircle/loga/tree/master) [![Code Quality](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/gpa.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/feed) [![Test Coverage](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/coverage.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/coverage)
+
+## Description
+
+Loga defines a single log format, logger and middleware logger
+to faciliate log aggregation.
+
+It provides:
+- Rack logger middleware to log HTTP requests
+- Ruby logger
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'loga', git: 'git@github.com:FundingCircle/loga.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Loga integrates well with Rails and Sinatra frameworks. It also works in projects
+using plain Ruby.
+
+### Rails applications
+
+In Rails applications initialization and middleware insertion is catered by
+the Railtie.
+
+```ruby
+# config/environments/production.rb
+...
+config.loga.configure do |loga|
+  # See configuration section
+end
+...
+```
+
+### Ruby and Sinatra/Rack applications
+
+In Ruby applications Loga must be required and configured.
+
+```ruby
+# .../initializers/loga.rb
+require 'loga'
+
+Loga.configure do |loga|
+  # See configuration section
+end
+Loga.initialize!
+```
+Log requests in Rack applications with Loga middleware.
+
+`RequestId` and `Logger` must be inserted early in the middleware chain.
+
+```ruby
+# config.ru
+use Loga::Rack::RequestId
+use Loga::Rack::Logger, Loga.logger
+
+user Marketplace
+run Sinatra::Application
+```
+
+### Configuration
+
+| Option          | Type          | Default | Description                                                                                        |
+|-----------------|---------------|---------|----------------------------------------------------------------------------------------------------|
+| host            | String        | nil     | Service hostname. When nil the hostname is computed with `Socket.gethostname`                      |
+| service_version | String/Symbol | :git    | Service version is embedded in every message. When Symbol the version is computed with a strategy. |
+| service_name    | String        | nil     | Service name is embedded in every message                                                          |
+| device          | IO            | nil     | The device the logger writes to                                                                    |
+| sync            | Boolean       | true    | Sync IO                                                                                            |
+| level           | Symbol        | :info   | The level to logger logs at                                                                        |
+| enabled         | Boolean       | true    | Enable/Disable Loga in Rails                                                                       |
+
+## Sample output
+
+```ruby
+# Anywhere in your application
+Loga.logger.info('Hello World')
+```
+```json
+//GELF Output
+{
+  "version":           "1.1",
+  "host":              "example.com",
+  "short_message":     "Hello World",
+  "timestamp":         1450150205.123,
+  "level":             6,
+  "_service.name":     "marketplace",
+  "_service.version":  "v1.0.0",
+  "_tags":             []
+}
+```
+
+## Event types
+
+Middleware augment payload with the `type` key to label events.
+
+| event type        | description                       | middleware              |
+|-------------------|-----------------------------------|-------------------------|
+| request           | HTTP request and response         | Rack                    |
+
+## Caveat
+
+- Loga formats timestamps in seconds since UNIX epoch with 3 decimal places
+  for milliseconds. Which is in accordance with GELF 1.1 specification.
+
+
+## Road Map
+
+Consult the [milestones](https://github.com/FundingCircle/loga/milestones).
+
+## Contributing
+
+### Overview
+
+1. Fork it ( https://github.com/FundingCircle/loga/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+### Running tests
+
+This project uses [`appraisal`](https://github.com/thoughtbot/appraisal/tree/v2.0.2) to run tests against different versions of dependencies (e.g. Rails, Sinatra).
+
+Once you have run bundle, you can install the test dependencies with `bundle exec appraisal install`.
+
+Run all tests with `bundle exec appraisal rspec`.
+
+You can run tests for one appraisal with `bundle exec appraisal appraisal-name rspec`.
+
+With Rack applications prepend RACK\_ENV to switch between environments `RACK_ENV=production bundle exec appraisal rspec`
+
+Refer to the [Appraisals](https://github.com/FundingCircle/loga/blob/master/Appraisals) file for a complete lists of appraisals.
+
+## Credits
+
+- [LogStashLogger](https://github.com/dwbutler/logstash-logger)
+- [Rails](https://github.com/rails/rails)
+- [RackLogstasher](https://github.com/alphagov/rack-logstasher)
+
+Copyright (c) 2015 Funding Circle. All rights reserved.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/circle.yml

@@ -0,0 +1,23 @@
+dependencies:
+  override:
+    - rvm-exec 1.9.3-p392 bundle install -j 4
+    - rvm-exec 1.9.3-p392 bundle exec appraisal install -j 4
+    - rvm-exec 2.0.0-p353 bundle install -j 4
+    - rvm-exec 2.0.0-p353 bundle exec appraisal install -j 4
+    - rvm-exec 2.2.2 bundle install -j 4
+    - rvm-exec 2.2.2 bundle exec appraisal install -j 4
+test:
+  override:
+    - RACK_ENV=development rvm-exec 1.9.3-p392 bundle exec appraisal rspec
+    - RACK_ENV=production  rvm-exec 1.9.3-p392 bundle exec appraisal rspec
+    - RACK_ENV=development rvm-exec 2.0.0-p353 bundle exec appraisal rspec
+    - RACK_ENV=production  rvm-exec 2.0.0-p353 bundle exec appraisal rspec
+    - RACK_ENV=development rvm-exec 2.2.2      bundle exec appraisal rspec
+    - RACK_ENV=production  rvm-exec 2.2.2      bundle exec appraisal rspec
+    - rvm-exec 2.2.2 bundle exec rubocop
+deployment:
+  gemfury:
+    tag: /.*/
+    commands:
+      - "gem build loga.gemspec"
+      - "curl -F package=@$(ls -t1 loga-*.gem | head -1) ${GEMFURY_PUSH_URI}"

data/gemfiles/rails32.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.0"
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/sinatra14.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra", "~> 1.4.0"
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/unit.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gemspec :path => "../"

data/lib/loga.rb

@@ -0,0 +1,33 @@
+require 'loga/version'
+require 'loga/tagged_logging'
+require 'loga/configuration'
+require 'loga/utilities'
+require 'loga/event'
+require 'loga/formatter'
+require 'loga/parameter_filter'
+require 'loga/rack/logger'
+require 'loga/rack/request'
+require 'loga/rack/request_id'
+require 'loga/railtie' if defined?(Rails)
+
+module Loga
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.initialize!
+    configuration.initialize!
+  end
+
+  def self.logger
+    configuration.logger
+  end
+
+  def self.reset
+    @configuration = nil
+  end
+end

data/lib/loga/configuration.rb

@@ -0,0 +1,96 @@
+require 'logger'
+require 'socket'
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+
+module Loga
+  class Configuration
+    attr_accessor :service_name,
+                  :service_version,
+                  :device,
+                  :sync,
+                  :filter_parameters,
+                  :level,
+                  :host,
+                  :enabled,
+                  :silence_rails_rack_logger
+
+    attr_reader :logger
+
+    def initialize
+      @host              = gethostname
+      @device            = nil
+      @sync              = true
+      @level             = :info
+      @filter_parameters = []
+      @service_version   = :git
+
+      # Rails specific configuration
+      @enabled           = true
+      @silence_rails_rack_logger = true
+    end
+
+    def initialize!
+      @service_name.to_s.strip!
+      @service_version = compute_service_version
+
+      initialize_logger
+    end
+
+    def configure
+      yield self
+    end
+
+    private
+
+    class GitRevisionStrategy
+      DEFAULT_REVISION = 'unknown.sha'.freeze
+
+      def self.call
+        revision = fetch_revision   if binary_available?
+        revision = DEFAULT_REVISION if revision.blank?
+        revision
+      end
+
+      def self.binary_available?
+        system 'which git'
+      end
+
+      def self.fetch_revision
+        `git rev-parse HEAD`.strip
+      end
+    end
+
+    def compute_service_version
+      service_version == :git ? GitRevisionStrategy.call : service_version.strip
+    end
+
+    def initialize_logger
+      device.sync = sync
+
+      logger           = Logger.new(device)
+      logger.formatter = Formatter.new(
+        service_name:    service_name,
+        service_version: service_version,
+        host:            host,
+      )
+      logger.level     = constantized_log_level
+    rescue
+      logger           = Logger.new(STDERR)
+      logger.level     = Logger::ERROR
+      logger.error 'Loga could not be initialized'
+    ensure
+      @logger          = TaggedLogging.new(logger)
+    end
+
+    def constantized_log_level
+      Logger.const_get(level.to_s.upcase)
+    end
+
+    def gethostname
+      Socket.gethostname
+    rescue Exception
+      'unknown.host'
+    end
+  end
+end