loga 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c78d0451e64bdc2c8d119392f4843a92b492173
-  data.tar.gz: c48cbbab79d4fd61ad15de32328905feecec51f6
+  metadata.gz: 58717f46fed6f5a99834472829baef870624e67d
+  data.tar.gz: efbaf0fcdb8c50a0d5193ecd1be1afcc03d4fa19
 SHA512:
-  metadata.gz: 0b26955630b96e19d9e10db0503c24f1ddd5a6bcaee3dd86973ddbf4c294cb2a7cd27fb22b8b75f2c27a3bf915d41f023341920932f0ca524c80116c76a6eeb2
-  data.tar.gz: da5cc880a6a53cb8671016e27a5881cece5c4275e6951aa0053e598b78771c2df12921feb1a6488d5193ef112424e109bfc41cc045b742fec597b81277aaca5c
+  metadata.gz: 62433f9172394016bc78a9b49a6c42f90827e925e1b5b5e9704367782705f821c69ff43afc5feb7a25f1eb87ff4a9e4084ad4d5b1e264d19a0c0a4e3feb1b9d7
+  data.tar.gz: fe2281a9a05f805402aab31da3add62067a718e58c0cc7c28bd6731e587301b7cd9dd5f4d86672303b5e93d332ec9a6acc1e11ff38db7ff288774dfd76b668b4

data/.rubocop.yml

@@ -1,17 +1,24 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   Exclude:
     - 'spec/fixtures/**/*'
     - '*.gemspec'
 
-Style/TrailingCommaInLiteral:
+Documentation:
+    Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
   Enabled: true
-  EnforcedStyleForMultiline: comma
+  Max: 90
 
-Style/TrailingCommaInArguments:
+Metrics/MethodLength:
   Enabled: true
-  EnforcedStyleForMultiline: comma
+  Max: 15
+
+Style/ExtraSpacing:
+  Enabled: false
 
 Style/BlockDelimiters:
   Enabled: false
@@ -22,8 +29,13 @@ Style/FormatString:
 Style/PerlBackrefs:
   Enabled: false
 
-Style/ExtraSpacing:
-  Enabled: false
-
 Style/SpaceAroundOperators:
   Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.0.0]
+## [2.0.0.pre.3]
+## [2.0.0.pre.2]
+## [2.0.0.pre1]
+### Added
+- Human readable formatter `SimpleFormatter`
+- `LOGA_FORMAT` environment variable to switch between (gelf|simple) formatters
+- Added `format` and `filter_exceptions` configuration options
+
+### Changed
+#### Configuration interface
+- Configure via Hash instead of Block
+- String only `service_version` configuration option
+
+#### Rails
+- Use Loga everywhere with environment based configuration
+- Added `ActiveRecord::RecordNotFound` to default `filter_exceptions`
+- Removed `enabled` and `silence_rails_rack_logger` configure options
+- Enforce Rails configuration options over Loga where possible
+
+#### Sinatra
+- Removed logger and tags parameters in `Loga::Rack::Logger`
+
+### Fixed
+- Uninitialized `Loga.logger` in Rails
+
+## [1.4.0] - 2016-09-13
+### Added
+- Rails 5 support
+- Silence ActionController::LogSubscriber
+
+### Changed
+- Update GELF payload to include `_request.controller` when available (Rails Controller/Action)
+
+## [1.3.0] - 2016-09-07
+### Changed
+- Silence ActionDispatch::DebugExceptions' logger
+
+[2.0.0]: https://github.com/FundingCircle/loga/compare/v2.0.0.pre.3...v2.0.0
+[2.0.0.pre.3]: https://github.com/FundingCircle/loga/compare/v2.0.0.pre.2...v2.0.0.pre.3
+[2.0.0.pre.2]: https://github.com/FundingCircle/loga/compare/v2.0.0.pre1...v2.0.0.pre.2
+[2.0.0.pre1]: https://github.com/FundingCircle/loga/compare/v1.4.0...v2.0.0.pre1
+[1.4.0]: https://github.com/FundingCircle/loga/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/FundingCircle/loga/compare/v1.2.1...v1.3.0

data/Guardfile

@@ -0,0 +1,45 @@
+guard :rubocop do
+  watch(%r{^lib/.+\.rb$})
+  watch(%r{^spec/.+\.rb$})
+end
+
+group :sinatra do
+  %w(production development).each do |env|
+    guard :rspec,
+          all_on_start: true,
+          cmd: "RACK_ENV=#{env} bundle exec appraisal sinatra14 rspec" do
+      watch(%r{^spec/integration/sinatra_spec.rb$})
+    end
+  end
+end
+
+group :rails do
+  %w(production development).each do |env|
+    %w(rails32 rails40 rails50).each do |appraisal|
+      guard :rspec,
+            all_on_start: true,
+            cmd: "RACK_ENV=#{env} bundle exec appraisal #{appraisal} rspec" do
+        watch('lib/loga/railtie.rb') do
+          [
+            'spec/integration/rails/request_spec.rb',
+            'spec/integration/rails/railtie_spec.rb',
+          ]
+        end
+        watch(%r{^spec/fixtures/rails\d{2}/.+\.rb$}) do
+          [
+            'spec/integration/rails/request_spec.rb',
+            'spec/integration/rails/railtie_spec.rb',
+          ]
+        end
+        watch(%r{^spec/integration/rails/.+_spec\.rb$})
+      end
+    end
+  end
+end
+
+group :unit do
+  guard :rspec, cmd: 'bundle exec appraisal unit rspec' do
+    watch(%r{^spec/unit/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,29 @@
+Copyright (c) 2015, Funding Circle Ltd.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -2,146 +2,214 @@
 
 ## 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
+Loga provides consistent logging across frameworks and environments.
+
+Includes:
+- One logger for all environments
+- Human readable logs for development
+- Structured logs for production ([GELF](http://docs.graylog.org/en/2.1/pages/gelf.html))
+- One Rack logger for all Rack based applications
+
+## TOC
+
+- [Installation](#installation)
+  - [Rails](#rails)
+    - [Reduced logs](#reduced-logs)
+    - [Request log tags](#request-log-tags)
+  - [Sinatra](#sinatra)
+- [GELF Output example](#gelf-output-example)
+- [Road map](#road-map)
+- [Contributing](#contributing)
+  - [Running tests](#running-tests)
+- [Credits](#credits)
+- [License](#license)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'loga', git: 'git@github.com:FundingCircle/loga.git'
+```
+gem 'loga', git: 'git@github.com:FundingCircle/loga.git'
+```
+
+### Rails
 
-And then execute:
+Let Loga know what your application name is and Loga will do the rest.
 
-    $ bundle
+```ruby
+# config/application.rb
+class MyApp::Application < Rails::Application
+  config.loga = { service_name: 'MyApp' }
+end
+```
 
-## Usage
+Loga hooks into the Rails logger initialization process and defines its own logger for all environments.
 
-Loga integrates well with Rails and Sinatra frameworks. It also works in projects
-using plain Ruby.
+The logger configuration adjusts based on the environment:
 
-### Rails applications
+|        | Production | Test         | Development | Others |
+|--------|------------|--------------|-------------|--------|
+| Output | STDOUT     | log/test.log | STDOUT      | STDOUT |
+| Format | gelf       | simple       | simple      | simple |
 
-In Rails applications initialization and middleware insertion is catered by
-the Railtie.
+You can customize the configuration to your liking:
 
 ```ruby
-# config/environments/production.rb
-...
-config.loga.configure do |loga|
-  # See configuration section
+# config/application.rb
+class MyApp::Application < Rails::Application
+  config.loga = {
+    device:       File.open("log/application.log", 'a'),
+    format:       :gelf,
+    service_name: 'MyApp',
+  }
 end
-...
 ```
 
-### Ruby and Sinatra/Rack applications
+Loga leverages existing Rails configuration options:
 
-In Ruby applications Loga must be required and configured.
+- `config.filter_parameters`
+- `config.log_level`
+- `config.log_tags`
 
-```ruby
-# .../initializers/loga.rb
-require 'loga'
+Use these options to customize Loga instead of the Loga options hash.
 
-Loga.configure do |loga|
-  # See configuration section
-end
-Loga.initialize!
-```
-Log requests in Rack applications with Loga middleware.
+Inside your application use `Rails.logger` instead of `Loga.logger`, even though
+they are equivalent, to prevent lock-in.
+
+#### Reduced logs
 
-`RequestId` and `Logger` must be inserted early in the middleware chain.
+When the format set to `gelf` requests logs are reduced to a single log entry, which
+could include an exception.
+
+This is made possible by silencing these loggers:
+
+- `Rack::Request::Logger`
+- `ActionDispatch::DebugExceptions`
+- `ActionController::LogSubscriber`
+- `ActionView::LogSubscriber`
+
+#### Request log tags
+
+To provide consistency between Rails and other Rack frameworks, tags (e.i `config.log_tags`)
+are computed with a [Loga::Rack::Request](lib/loga/rack/request.rb) as
+opposed to a `ActionDispatch::Request`.
+
+### Sinatra
+
+With Sinatra Loga needs to be configured manually:
 
 ```ruby
-# config.ru
+require 'loga'
+
+Loga.configure(
+  filter_parameters: [:password],
+  format: :gelf,
+  service_name: 'my_app',
+  tags: [:uuid],
+)
+
 use Loga::Rack::RequestId
-use Loga::Rack::Logger, Loga.logger
+use Loga::Rack::Logger
 
-user Marketplace
+use MyApp
 run Sinatra::Application
 ```
 
-### Configuration
+You can now use `Loga.logger` or assign it to your existing logger.
+The above configuration also inserts two middleware:
 
-| 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                                                                       |
+- `Loga::Rack::RequestId` makes the request id available to the request logger
+- `Loga::Rack::Logger`  logs requests
 
-## Sample output
+## GELF Output Example
+
+Rails request logger: (includes controller/action name):
+
+`GET /ok`
 
-```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":             ""
+   "_request.status":     200,
+   "_request.method":     "GET",
+   "_request.path":       "/ok",
+   "_request.params":     {},
+   "_request.request_id": "2b99e3d3-3ee2-4781-972b-782682f57648",
+   "_request.request_ip": "127.0.0.1",
+   "_request.user_agent": null,
+   "_request.controller": "ApplicationController#ok",
+   "_request.duration":   0,
+   "_type":               "request",
+   "_service.name":       "my_app",
+   "_service.version":    "1.0",
+   "_tags":               "2b99e3d3-3ee2-4781-972b-782682f57648",
+   "short_message":       "GET /ok 200 in 0ms",
+   "timestamp":           1450150205.123,
+   "host":                "example.com",
+   "level":               6,
+   "version":             "1.1"
 }
 ```
 
-## Event types
+Sinatra request output is identical to Rails but without the `_request.controller` key.
 
-Middleware augment payload with the `type` key to label events.
+Logger output:
 
-| 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.
+```ruby
+Rails.logger.info('I love Loga')
+# or
+Loga.logger.info('I love Loga')
+```
 
+```json
+{
+  "_service.name":     "my_app",
+  "_service.version":  "v1.0.0",
+  "_tags":             "",
+  "host":              "example.com",
+  "level":             6,
+  "short_message":     "I love Loga",
+  "timestamp":         1450150205.123,
+  "version":           "1.1"
+}
+```
 
-## Road Map
+## 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
+Loga is in active development, feedback and contributions are welcomed.
 
 ### 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).
+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`.
+Install Loga dependencies with `bundle install` and then appraisals
+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`.
+Refer to the [Appraisals](Appraisals) file for a complete lists of appraisals.
+
+Prefix test command with RACK\_ENV to switch between environments for Rack based tests
+`RACK_ENV=production bundle exec appraisal rspec`.
 
-With Rack applications prepend RACK\_ENV to switch between environments `RACK_ENV=production bundle exec appraisal rspec`
+Experiment Guard support introduced to ease running tests locally `bundle exec guard`.
 
-Refer to the [Appraisals](https://github.com/FundingCircle/loga/blob/master/Appraisals) file for a complete lists of appraisals.
+[CI](https://circleci.com/gh/FundingCircle/loga) results are the source of truth.
 
 ## Credits
 
+- [Lograge](https://github.com/roidrage/lograge)
 - [LogStashLogger](https://github.com/dwbutler/logstash-logger)
 - [Rails](https://github.com/rails/rails)
 - [RackLogstasher](https://github.com/alphagov/rack-logstasher)
 
+## License
+
 Copyright (c) 2015 Funding Circle. All rights reserved.
+
+Distributed under the BSD 3-Clause License.