loga 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58717f46fed6f5a99834472829baef870624e67d
-  data.tar.gz: efbaf0fcdb8c50a0d5193ecd1be1afcc03d4fa19
+  metadata.gz: 26c6ec05bee75b2cdaf5cc763dec166cfad96ce5
+  data.tar.gz: 845ef8d271804c24f62195cefb13dae6dd961be9
 SHA512:
-  metadata.gz: 62433f9172394016bc78a9b49a6c42f90827e925e1b5b5e9704367782705f821c69ff43afc5feb7a25f1eb87ff4a9e4084ad4d5b1e264d19a0c0a4e3feb1b9d7
-  data.tar.gz: fe2281a9a05f805402aab31da3add62067a718e58c0cc7c28bd6731e587301b7cd9dd5f4d86672303b5e93d332ec9a6acc1e11ff38db7ff288774dfd76b668b4
+  metadata.gz: 195a21b0f8ea0a2ac55c8b44f042116b32e2012bc18df2c781863041898ec1360ce0b45a14c3795d156830960ea3b7d076c919f4e75ea5de2f185d6c72966e14
+  data.tar.gz: 5f8c95fb86e68753e1da356fabf093c89bc3d7fb78b84ad29c569ca7352090546418e4ffdaf76f55508dc760621bb0b7239d15efa186c86ce72e18432b25f4f2

data/CHANGELOG.md

@@ -4,7 +4,13 @@ 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.1.0]
+## [2.1.0.pre.1]
+### Changed
+- Replace `ActiveSupport::Logger::SimpleFormatter` with `Loga::Formatters::SimpleFormatter`
+when using simple format. The formatter adds level, timestamp, pid and tags prepended to the message
+
+## [2.0.0] - 2016-10-27
 ## [2.0.0.pre.3]
 ## [2.0.0.pre.2]
 ## [2.0.0.pre1]
@@ -42,7 +48,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - Silence ActionDispatch::DebugExceptions' logger
 
-[2.0.0]: https://github.com/FundingCircle/loga/compare/v2.0.0.pre.3...v2.0.0
+[2.1.0]: https://github.com/FundingCircle/loga/compare/v2.0.0...v2.0.0
+[2.1.0.pre.1]: https://github.com/FundingCircle/loga/compare/v2.0.0...v2.1.0.pre.1
+[2.0.0]: https://github.com/FundingCircle/loga/compare/v1.4.0...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

data/Gemfile

@@ -4,5 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codeclimate-test-reporter', require: false
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0', require: false
 end

data/README.md

@@ -17,7 +17,9 @@ Includes:
     - [Reduced logs](#reduced-logs)
     - [Request log tags](#request-log-tags)
   - [Sinatra](#sinatra)
-- [GELF Output example](#gelf-output-example)
+- [Output example](#output-example)
+   - [GELF Format](#gelf-format)
+   - [Simple Format](#simple-format)
 - [Road map](#road-map)
 - [Contributing](#contributing)
   - [Running tests](#running-tests)
@@ -45,7 +47,7 @@ end
 
 Loga hooks into the Rails logger initialization process and defines its own logger for all environments.
 
-The logger configuration adjusts based on the environment:
+The logger configuration is adjusted based on the environment:
 
 |        | Production | Test         | Development | Others |
 |--------|------------|--------------|-------------|--------|
@@ -119,13 +121,23 @@ You can now use `Loga.logger` or assign it to your existing logger.
 The above configuration also inserts two middleware:
 
 - `Loga::Rack::RequestId` makes the request id available to the request logger
-- `Loga::Rack::Logger`  logs requests
+- `Loga::Rack::Logger` logs requests
 
-## GELF Output Example
+You can easily switch between formats by using the `LOGA_FORMAT`
+environment variable. The `format` key in the options takes precedence over the
+environment variable therefore it must be removed.
+
+```
+LOGA_FORMAT=simple rackup
+```
+
+## Output Example
+
+### GELF Format
 
 Rails request logger: (includes controller/action name):
 
-`GET /ok`
+`curl localhost:3000/ok -X GET -H "X-Request-Id: 12345"`
 
 ```json
 {
@@ -133,7 +145,7 @@ Rails request logger: (includes controller/action name):
    "_request.method":     "GET",
    "_request.path":       "/ok",
    "_request.params":     {},
-   "_request.request_id": "2b99e3d3-3ee2-4781-972b-782682f57648",
+   "_request.request_id": "12345",
    "_request.request_ip": "127.0.0.1",
    "_request.user_agent": null,
    "_request.controller": "ApplicationController#ok",
@@ -141,7 +153,7 @@ Rails request logger: (includes controller/action name):
    "_type":               "request",
    "_service.name":       "my_app",
    "_service.version":    "1.0",
-   "_tags":               "2b99e3d3-3ee2-4781-972b-782682f57648",
+   "_tags":               "12345",
    "short_message":       "GET /ok 200 in 0ms",
    "timestamp":           1450150205.123,
    "host":                "example.com",
@@ -164,7 +176,7 @@ Loga.logger.info('I love Loga')
 {
   "_service.name":     "my_app",
   "_service.version":  "v1.0.0",
-  "_tags":             "",
+  "_tags":             "12345",
   "host":              "example.com",
   "level":             6,
   "short_message":     "I love Loga",
@@ -173,6 +185,38 @@ Loga.logger.info('I love Loga')
 }
 ```
 
+### Simple Format
+
+Request logger:
+
+`curl localhost:3000/ok -X GET -H "X-Request-Id: 12345"`
+
+Rails
+
+```
+I, [2016-11-15T16:05:03.614081+00:00 #1][12345] Started GET "/ok" for ::1 at 2016-11-15 16:05:03 +0000
+I, [2016-11-15T16:05:03.620176+00:00 #1][12345] Processing by ApplicationController#ok as HTML
+I, [2016-11-15T16:05:03.624807+00:00 #1][12345]   Rendering text template
+I, [2016-11-15T16:05:03.624952+00:00 #1][12345]   Rendered text template (0.0ms)
+I, [2016-11-15T16:05:03.625137+00:00 #1][12345] Completed 200 OK in 5ms (Views: 4.7ms)
+```
+
+Sinatra
+
+```
+I, [2016-11-15T16:10:08.645521+00:00 #1][12345] GET /ok 200 in 0ms type=request data={:request=>{"status"=>200, "method"=>"GET", "path"=>"/ok", "params"=>{}, "request_id"=>"12345", "request_ip"=>"127.0.0.1", "user_agent"=>nil, "duration"=>0}}
+```
+
+Logger output:
+
+```ruby
+Loga.logger.info('I love Loga')
+```
+
+```
+I, [2015-12-15T09:30:05.123000+06:00 #999] I love Loga
+```
+
 ## Road map
 
 Consult the [milestones](https://github.com/FundingCircle/loga/milestones).

data/circle.yml

@@ -10,7 +10,8 @@ test:
     - RACK_ENV=production  rvm-exec 2.2.5 bundle exec appraisal rspec
     - RACK_ENV=development rvm-exec 2.3.1 bundle exec appraisal rspec
     - RACK_ENV=production  rvm-exec 2.3.1 bundle exec appraisal rspec
-    - rvm-exec 2.2.5 bundle exec rubocop
+    - rvm-exec 2.3.1 bundle exec rubocop
+    - rvm-exec 2.3.1 bundle exec codeclimate-test-reporter
 deployment:
   gemfury:
     tag: /.*/

data/gemfiles/rails32.gemfile

@@ -5,7 +5,8 @@ source "https://rubygems.org"
 gem "rails", "~> 3.2.0"
 
 group :test do
-  gem "codeclimate-test-reporter", :require => false
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -5,7 +5,8 @@ source "https://rubygems.org"
 gem "rails", "~> 4.0.0"
 
 group :test do
-  gem "codeclimate-test-reporter", :require => false
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/rails50.gemfile

@@ -5,7 +5,8 @@ source "https://rubygems.org"
 gem "rails", "~> 5.0.0"
 
 group :test do
-  gem "codeclimate-test-reporter", :require => false
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/sinatra14.gemfile

@@ -5,7 +5,8 @@ source "https://rubygems.org"
 gem "sinatra", "~> 1.4.0"
 
 group :test do
-  gem "codeclimate-test-reporter", :require => false
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/unit.gemfile

@@ -3,7 +3,8 @@
 source "https://rubygems.org"
 
 group :test do
-  gem "codeclimate-test-reporter", :require => false
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0", :require => false
 end
 
 gemspec :path => "../"

data/lib/loga.rb

@@ -3,7 +3,6 @@ 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'

data/lib/loga/configuration.rb

@@ -1,48 +1,42 @@
 require 'active_support/core_ext/object/blank'
 require 'active_support/version'
+require 'loga/formatters/gelf_formatter'
+require 'loga/formatters/simple_formatter'
 require 'loga/service_version_strategies'
 require 'logger'
 require 'socket'
 
 module Loga
   class Configuration
-    DEFAULT_KEYS = %i(
-      device
-      filter_exceptions
-      filter_parameters
-      format
-      host
-      level
-      service_name
-      service_version
-      sync
-      tags
-    ).freeze
-
     FRAMEWORK_EXCEPTIONS = %w(
       ActionController::RoutingError
       ActiveRecord::RecordNotFound
       Sinatra::NotFound
     ).freeze
 
-    attr_accessor(*DEFAULT_KEYS)
-    attr_reader :logger, :service_version
-    private_constant :DEFAULT_KEYS
+    attr_accessor :device, :filter_exceptions, :filter_parameters, :format,
+                  :host, :level, :service_name, :service_version, :sync, :tags
+    attr_reader :logger
 
     def initialize(user_options = {}, framework_options = {})
       options = default_options.merge(framework_options)
                                .merge(environment_options)
                                .merge(user_options)
 
-      DEFAULT_KEYS.each do |attribute|
-        public_send("#{attribute}=", options[attribute])
-      end
+      self.device            = options[:device]
+      self.filter_exceptions = options[:filter_exceptions]
+      self.filter_parameters = options[:filter_parameters]
+      self.format            = options[:format]
+      self.host              = options[:host]
+      self.level             = options[:level]
+      self.service_name      = options[:service_name]
+      self.service_version   = options[:service_version] || ServiceVersionStrategies.call
+      self.sync              = options[:sync]
+      self.tags              = options[:tags]
 
-      raise ConfigurationError, 'Service name cannot be blank' if service_name.blank?
-      raise ConfigurationError, 'Device cannot be blank' if device.blank?
+      validate
 
-      @service_version = initialize_service_version
-      @logger          = initialize_logger
+      @logger = initialize_logger
     end
 
     def format=(name)
@@ -59,6 +53,11 @@ module Loga
 
     private
 
+    def validate
+      raise ConfigurationError, 'Service name cannot be blank' if service_name.blank?
+      raise ConfigurationError, 'Device cannot be blank' if device.blank?
+    end
+
     def default_options
       {
         device:            STDOUT,
@@ -76,10 +75,6 @@ module Loga
       { format: ENV['LOGA_FORMAT'].presence }.reject { |_, v| v.nil? }
     end
 
-    def initialize_service_version
-      service_version || ServiceVersionStrategies.call
-    end
-
     def initialize_logger
       device.sync      = sync
       logger           = Logger.new(device)
@@ -100,27 +95,13 @@ module Loga
 
     def assign_formatter
       if format == :gelf
-        Formatter.new(
+        Formatters::GELFFormatter.new(
           service_name:    service_name,
           service_version: service_version,
           host:            host,
         )
       else
-        active_support_simple_formatter
-      end
-    end
-
-    def active_support_simple_formatter
-      case ActiveSupport::VERSION::MAJOR
-      when 3
-        require 'active_support/core_ext/logger'
-        Logger::SimpleFormatter.new
-      when 4..5
-        require 'active_support/logger'
-        ActiveSupport::Logger::SimpleFormatter.new
-      else
-        raise Loga::ConfigurationError,
-              "ActiveSupport #{ActiveSupport::VERSION::MAJOR} is unsupported"
+        Formatters::SimpleFormatter.new
       end
     end
   end

data/lib/loga/event.rb

@@ -10,17 +10,6 @@ module Loga
       @type      = opts[:type]
     end
 
-    def to_s
-      output = ["#{timestamp.iso8601(3)} #{message}"]
-      if exception
-        output.push exception.to_s
-        output.push exception.backtrace.join("\n")
-      end
-      output.join("\n")
-    end
-
-    alias inspect to_s
-
     private
 
     # Guard against Encoding::UndefinedConversionError

data/lib/loga/formatters/gelf_formatter.rb

@@ -0,0 +1,106 @@
+require 'logger'
+require 'json'
+
+module Loga
+  module Formatters
+    class GELFFormatter < Logger::Formatter
+      include TaggedLogging::Formatter
+
+      GELF_VERSION = '1.1'.freeze
+      SYSLOG_LEVEL_MAPPING = {
+        'DEBUG'   => 7,
+        'INFO'    => 6,
+        'WARN'    => 4,
+        'ERROR'   => 3,
+        'FATAL'   => 2,
+        'UNKNOWN' => 1,
+      }.freeze
+      DEFAULT_TYPE = 'default'.freeze
+
+      def initialize(opts)
+        @service_name    = opts.fetch(:service_name)
+        @service_version = opts.fetch(:service_version)
+        @host            = opts.fetch(:host)
+      end
+
+      def call(severity, time, _progname, message)
+        event = build_event(time, message)
+        payload = format_additional_fields(event.data)
+
+        payload[:short_message] = event.message
+        payload[:timestamp]     = compute_timestamp(event.timestamp)
+        payload[:host]          = @host
+        payload[:level]         = compute_level(severity)
+        payload[:version]       = GELF_VERSION
+
+        "#{payload.to_json}\n"
+      end
+
+      private
+
+      def build_event(time, message)
+        event = case message
+                when Loga::Event
+                  message
+                else
+                  Loga::Event.new(message: message)
+                end
+
+        event.timestamp ||= time
+        event.data ||= {}
+        event.data.tap do |hash|
+          hash.merge! compute_exception(event.exception)
+          hash.merge! compute_type(event.type)
+          # Overwrite hash with Loga's additional fields
+          hash.merge! loga_additional_fields
+        end
+        event
+      end
+
+      def compute_timestamp(timestamp)
+        (timestamp.to_f * 1000).floor / 1000.0
+      end
+
+      def compute_level(severity)
+        SYSLOG_LEVEL_MAPPING[severity]
+      end
+
+      def format_additional_fields(fields)
+        fields.each_with_object({}) do |(main_key, values), hash|
+          if values.is_a?(Hash)
+            values.each do |sub_key, sub_values|
+              hash["_#{main_key}.#{sub_key}"] = sub_values
+            end
+          else
+            hash["_#{main_key}"] = values
+          end
+        end
+      end
+
+      def compute_exception(exception)
+        return {} unless exception
+        {
+          exception: {
+            klass:     exception.class.to_s,
+            message:   exception.message,
+            backtrace: exception.backtrace.first(10).join("\n"),
+          },
+        }
+      end
+
+      def compute_type(type)
+        type ? { type: type } : {}
+      end
+
+      def loga_additional_fields
+        {
+          service: {
+            name:    @service_name,
+            version: @service_version,
+          },
+          tags: current_tags.join(' '),
+        }
+      end
+    end
+  end
+end

data/lib/loga/formatters/simple_formatter.rb

@@ -0,0 +1,46 @@
+module Loga
+  module Formatters
+    class SimpleFormatter < Logger::Formatter
+      include TaggedLogging::Formatter
+
+      FORMAT = "%s, [%s #%d]%s %s\n".freeze
+
+      def call(severity, time, _progname, object)
+        FORMAT % [
+          severity[0..0],
+          time.iso8601(6),
+          Process.pid,
+          tags,
+          compute_message(object),
+        ]
+      end
+
+      private
+
+      def compute_message(object)
+        case object
+        when Loga::Event
+          compute_event_message(object)
+        else
+          msg2str(object)
+        end
+      end
+
+      def compute_event_message(event)
+        components = [event.message]
+
+        %i(type data exception).each do |attr|
+          if event.public_send(attr)
+            components.push "#{attr}=#{event.public_send(attr)}"
+          end
+        end
+
+        components.join(' ')
+      end
+
+      def tags
+        current_tags.empty? ? '' : "[#{current_tags.join(' ')}]"
+      end
+    end
+  end
+end

data/lib/loga/version.rb

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

data/spec/integration/rails/railtie_spec.rb

@@ -6,13 +6,7 @@ RSpec.describe Loga::Railtie do
 
   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
+      let(:formatter) { Loga::Formatters::SimpleFormatter }
 
       it 'assign Loga logger to Rails logger' do
         expect(Loga.logger).to equal(Rails.logger)
@@ -31,7 +25,8 @@ RSpec.describe Loga::Railtie do
       end
 
       it 'configures Loga with a structured formatter' do
-        expect(Loga.configuration.logger.formatter).to be_a(Loga::Formatter)
+        expect(Loga.configuration.logger.formatter)
+          .to be_a(Loga::Formatters::GELFFormatter)
       end
 
       it 'disables colorized logging' do

data/spec/integration/sinatra_spec.rb

@@ -62,37 +62,68 @@ RSpec.describe 'Structured logging with Sinatra', timecop: true do
     end
   end
 
-  context 'when RACK_ENV is production', if: ENV['RACK_ENV'].eql?('development') do
+  # rubocop:disable Metrics/LineLength
+  context 'when RACK_ENV is development', if: ENV['RACK_ENV'].eql?('development') do
     let(:format) { :simple }
     let(:last_log_entry) do
       io.rewind
       io.read
     end
+    let(:data) do
+      {
+        'status' => 200,
+        'method' => 'GET',
+        'path'   => '/ok',
+        'params' => { 'username'=>'yoshi' },
+        'request_id' => '700a6a01',
+        'request_ip' => '127.0.0.1',
+        'user_agent' => nil,
+        'duration'   => 0,
+      }
+    end
+    let(:data_as_text)  { "data=#{{ request: data }.inspect}" }
+    let(:time_pid_tags) { '[2015-12-15T09:30:05.123000+06:00 #999][700a6a01 TEST_TAG]' }
+
+    before do
+      allow(Process).to receive(:pid).and_return(999)
+    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")
+        get '/ok', { username: 'yoshi' }, 'HTTP_X_REQUEST_ID' => '700a6a01'
+
+        expect(last_log_entry).to eq("I, #{time_pid_tags} GET /ok?username=yoshi 200 in 0ms type=request #{data_as_text}\n")
       end
     end
 
     context 'request with redirect' do
+      let(:data) do
+        super().merge(
+          'status' => 302,
+          'path'   => '/new',
+          'params' => {},
+        )
+      end
       it 'specifies the original path' do
-        get '/new'
-        expect(last_log_entry).to eql("#{time_anchor.iso8601(3)} GET /new 302 in 0ms\n")
+        get '/new', {}, 'HTTP_X_REQUEST_ID' => '700a6a01'
+        expect(last_log_entry).to eql("I, #{time_pid_tags} GET /new 302 in 0ms type=request #{data_as_text}\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
+      let(:data) do
+        super().merge(
+          'status' => 500,
+          'path'   => '/error',
+          'params' => {},
+        )
       end
 
       it 'logs the request with the exception' do
-        get '/error'
-        expect(last_log_entry).to match(log_entry_match)
+        get '/error', {}, 'HTTP_X_REQUEST_ID' => '700a6a01'
+        expect(last_log_entry).to eql("E, #{time_pid_tags} GET /error 500 in 0ms type=request #{data_as_text} exception=undefined method `name' for nil:NilClass\n")
       end
     end
   end
+  # rubocop:enable Metrics/LineLength
 end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
-require 'codeclimate-test-reporter'
 require 'pry'
 require 'support/helpers'
 require 'support/timecop_shared'
 require 'support/request_spec'
 require 'rack/test'
+require 'simplecov'
 
-CodeClimate::TestReporter.start if ENV.fetch('CODECLIMATE_REPO_TOKEN', nil)
+SimpleCov.start
 
 class Socket
   def self.gethostname

data/spec/unit/loga/configuration_spec.rb

@@ -150,7 +150,7 @@ describe Loga::Configuration do
         let(:formatter) { subject.logger.formatter }
 
         it 'uses the GELF formatter' do
-          expect(subject.logger.formatter).to be_a(Loga::Formatter)
+          expect(subject.logger.formatter).to be_a(Loga::Formatters::GELFFormatter)
         end
 
         it 'strips the service name' do
@@ -162,15 +162,7 @@ describe Loga::Configuration do
         let(:options) { super().merge(format: :simple) }
 
         it 'uses the SimpleFormatter' do
-          expect(subject.logger.formatter).to be_a(ActiveSupport::Logger::SimpleFormatter)
-        end
-      end
-
-      context 'when the ActiveSupport::VERSION is unsupported' do
-        it 'raises an error' do
-          stub_const('ActiveSupport::VERSION::MAJOR', 1)
-          expect { described_class.new(options) }
-            .to raise_error(Loga::ConfigurationError, 'ActiveSupport 1 is unsupported')
+          expect(subject.logger.formatter).to be_a(Loga::Formatters::SimpleFormatter)
         end
       end
     end

data/spec/unit/loga/event_spec.rb

@@ -17,34 +17,4 @@ RSpec.describe Loga::Event, timecop: true do
       end
     end
   end
-
-  describe '#to_s' do
-    let(:opts) { { message: 'Hello World', timestamp: Time.now } }
-    subject { described_class.new(opts) }
-
-    context 'when exception' do
-      let(:exception) do
-        instance_double(StandardError, to_s: 'Some Message', backtrace: ['file'])
-      end
-      let(:opts) { super().merge(exception: exception) }
-      it 'outputs the message with exception' do
-        expect(subject.to_s)
-          .to eql("#{time_anchor.iso8601(3)} Hello World\nSome Message\nfile")
-      end
-    end
-
-    context 'when no exception' do
-      it 'outputs the message' do
-        expect(subject.to_s).to eql("#{time_anchor.iso8601(3)} Hello World")
-      end
-    end
-  end
-
-  describe '#inspect' do
-    subject { described_class.new message: 'Hey Siri', timestamp: Time.now }
-
-    it 'aliases to to_s' do
-      expect(subject.to_s).to eql(subject.inspect)
-    end
-  end
 end

data/spec/unit/loga/{formatter_spec.rb → formatters/gelf_formatter_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Loga::Formatter do
+describe Loga::Formatters::GELFFormatter do
   let(:service_name)    { 'loga' }
   let(:service_version) { '725e032a' }
   let(:host)            { 'www.example.com' }

data/spec/unit/loga/formatters/simple_formatter_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+require 'loga/formatters/simple_formatter'
+
+# rubocop:disable Metrics/LineLength
+describe Loga::Formatters::SimpleFormatter do
+  before { allow(Process).to receive(:pid).and_return(999) }
+
+  describe '#call(severity, time, _progname, message)' do
+    subject { super().call(severity, time_anchor, nil, message) }
+
+    let(:severity) { 'INFO' }
+    let(:message)  { 'Tree house magic' }
+    let(:time_pid) { '[2015-12-15T09:30:05.123000+06:00 #999]' }
+
+    context 'when the message parameter is a String' do
+      specify do
+        expect(subject).to eq("I, #{time_pid} Tree house magic\n")
+      end
+    end
+
+    context 'when the message parameter is a nil' do
+      let(:message) { nil }
+      specify do
+        expect(subject).to eq("I, #{time_pid} nil\n")
+      end
+    end
+
+    context 'when message parameter is a Hash' do
+      let(:message) { { record: 'Wooden house' } }
+
+      specify do
+        expect(subject).to eq("I, #{time_pid} {:record=>\"Wooden house\"}\n")
+      end
+    end
+
+    context 'when the message parameter is a Loga::Event' do
+      let(:options) { { message: 'Hello World' } }
+      let(:message) { Loga::Event.new(options) }
+
+      it 'the short_message is the Event message' do
+        expect(subject).to eq("I, #{time_pid} Hello World\n")
+      end
+
+      context 'when the event has a timestamp' do
+        it 'uses the event timestamp'
+      end
+
+      context 'when the Event has a type' do
+        let(:options) { { message: 'Hello World', type: 'request' } }
+
+        specify do
+          expect(subject).to eq("I, #{time_pid} Hello World type=request\n")
+        end
+      end
+
+      context 'when the Event has an exception' do
+        let(:backtrace) { %w(a b) }
+        let(:exception) do
+          StandardError.new('Foo Error').tap { |e| e.set_backtrace backtrace }
+        end
+        let(:options)   { { exception: exception } }
+
+        it 'outputs the exception'
+      end
+
+      context 'when the event has data' do
+        let(:options) do
+          {
+            data: {
+              admin: true,
+              user: {
+                email: 'hello@world.com',
+              },
+            },
+            message: 'Hello World',
+          }
+        end
+
+        specify do
+          expect(subject).to eq("I, #{time_pid} Hello World data={:admin=>true, :user=>{:email=>\"hello@world.com\"}}\n")
+        end
+      end
+
+      context 'when the event has data and a type' do
+        let(:options) do
+          {
+            data: { ssl: true },
+            message: 'Hello World',
+            type: 'request',
+          }
+        end
+
+        specify do
+          expect(subject).to eq("I, #{time_pid} Hello World type=request data={:ssl=>true}\n")
+        end
+      end
+    end
+
+    context 'when tags are available' do
+      let(:tags) { %w(USER_54321 EmailWorker) }
+
+      before do
+        allow_any_instance_of(described_class).to receive(:current_tags).and_return(tags)
+      end
+
+      specify do
+        expect(subject).to eq("I, #{time_pid}[USER_54321 EmailWorker] #{message}\n")
+      end
+    end
+
+    {
+      'DEBUG'   => 'D',
+      'INFO'    => 'I',
+      'WARN'    => 'W',
+      'ERROR'   => 'E',
+      'FATAL'   => 'F',
+      'UNKNOWN' => 'U',
+    }.each do |ruby_severity, formatted_severity|
+      context "with severity #{ruby_severity}" do
+        let(:severity) { ruby_severity }
+
+        specify { expect(subject).to match(/^#{formatted_severity},/) }
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/LineLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -222,7 +222,8 @@ files:
 - lib/loga/ext/rails/rack/debug_exceptions.rb
 - lib/loga/ext/rails/rack/logger.rb
 - lib/loga/ext/rails/rack/logger3.rb
-- lib/loga/formatter.rb
+- lib/loga/formatters/gelf_formatter.rb
+- lib/loga/formatters/simple_formatter.rb
 - lib/loga/parameter_filter.rb
 - lib/loga/rack/logger.rb
 - lib/loga/rack/request.rb
@@ -337,7 +338,8 @@ files:
 - spec/support/timecop_shared.rb
 - spec/unit/loga/configuration_spec.rb
 - spec/unit/loga/event_spec.rb
-- spec/unit/loga/formatter_spec.rb
+- spec/unit/loga/formatters/gelf_formatter_spec.rb
+- spec/unit/loga/formatters/simple_formatter_spec.rb
 - spec/unit/loga/parameter_filter_spec.rb
 - spec/unit/loga/rack/logger_spec.rb
 - spec/unit/loga/rack/request_spec.rb
@@ -473,7 +475,8 @@ test_files:
 - spec/support/timecop_shared.rb
 - spec/unit/loga/configuration_spec.rb
 - spec/unit/loga/event_spec.rb
-- spec/unit/loga/formatter_spec.rb
+- spec/unit/loga/formatters/gelf_formatter_spec.rb
+- spec/unit/loga/formatters/simple_formatter_spec.rb
 - spec/unit/loga/parameter_filter_spec.rb
 - spec/unit/loga/rack/logger_spec.rb
 - spec/unit/loga/rack/request_spec.rb

data/lib/loga/formatter.rb

@@ -1,104 +0,0 @@
-require 'logger'
-require 'json'
-
-module Loga
-  class Formatter < Logger::Formatter
-    include TaggedLogging::Formatter
-
-    GELF_VERSION = '1.1'.freeze
-    SYSLOG_LEVEL_MAPPING = {
-      'DEBUG'   => 7,
-      'INFO'    => 6,
-      'WARN'    => 4,
-      'ERROR'   => 3,
-      'FATAL'   => 2,
-      'UNKNOWN' => 1,
-    }.freeze
-    DEFAULT_TYPE = 'default'.freeze
-
-    def initialize(opts)
-      @service_name    = opts.fetch(:service_name)
-      @service_version = opts.fetch(:service_version)
-      @host            = opts.fetch(:host)
-    end
-
-    def call(severity, time, _progname, message)
-      event = build_event(time, message)
-      payload = format_additional_fields(event.data)
-
-      payload[:short_message] = event.message
-      payload[:timestamp]     = compute_timestamp(event.timestamp)
-      payload[:host]          = @host
-      payload[:level]         = compute_level(severity)
-      payload[:version]       = GELF_VERSION
-
-      "#{payload.to_json}\n"
-    end
-
-    private
-
-    def build_event(time, message)
-      event = case message
-              when Loga::Event
-                message
-              else
-                Loga::Event.new(message: message)
-              end
-
-      event.timestamp ||= time
-      event.data ||= {}
-      event.data.tap do |hash|
-        hash.merge! compute_exception(event.exception)
-        hash.merge! compute_type(event.type)
-        # Overwrite hash with Loga's additional fields
-        hash.merge! loga_additional_fields
-      end
-      event
-    end
-
-    def compute_timestamp(timestamp)
-      (timestamp.to_f * 1000).floor / 1000.0
-    end
-
-    def compute_level(severity)
-      SYSLOG_LEVEL_MAPPING[severity]
-    end
-
-    def format_additional_fields(fields)
-      fields.each_with_object({}) do |(main_key, values), hash|
-        if values.is_a?(Hash)
-          values.each do |sub_key, sub_values|
-            hash["_#{main_key}.#{sub_key}"] = sub_values
-          end
-        else
-          hash["_#{main_key}"] = values
-        end
-      end
-    end
-
-    def compute_exception(exception)
-      return {} unless exception
-      {
-        exception: {
-          klass:     exception.class.to_s,
-          message:   exception.message,
-          backtrace: exception.backtrace.first(10).join("\n"),
-        },
-      }
-    end
-
-    def compute_type(type)
-      type ? { type: type } : {}
-    end
-
-    def loga_additional_fields
-      {
-        service: {
-          name:    @service_name,
-          version: @service_version,
-        },
-        tags: current_tags.join(' '),
-      }
-    end
-  end
-end