klarna-app-loggers 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6affdfa7906777baf322efc677477f4ff3d49aad
+  data.tar.gz: f40ebc08390ecf369e6eb890a7a2e2ab33112b8c
+SHA512:
+  metadata.gz: 28bb60116338f429e6a41d26dd9875ddd98c8d07b197c937ed9fe6943d8959994dce7444a6b9d18258aba8ce4d02424521c4bf1aa5b13770ec68f5a7e0e46ebb
+  data.tar.gz: d4ef861c388ff242a1c9fe5352a3f6e63ebe52ed2c151db9588e501237963eb1a610a0568ad384356feef2352ca4e75d2a506a9af56f6e16286e371c0d6b11b8

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.4

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG for Klarna App Loggers
+You should follow the [keepachangelog](http://keepachangelog.com/) format
+
+## 1.2.0 (2017-10-18)
+* [Mathias Klippinge & Tommy Gustafsson] Make it possible to set layout format to json for stdout
+
+## 1.1.0 (2017-02-20)
+* [Mathias Klippinge] Fix the NoMethodError by not mutating the root log level, see https://github.com/TwP/logging/issues/61
+
+## 1.0.1 (2017-02-18)
+* [Mathias Klippinge] Update readme and unlock gems
+
+## 1.0.0 (2017-02-17)
+* [Mathias Klippinge] Extracted AppLogger into a gem

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://nexus.int.klarna.net/content/groups/publicgems'
+
+# Specify your gem's dependencies in klarna-app-loggers.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# Klarna App Loggers
+
+Logger plugins for Faraday middleware and rack
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'klarna-app-loggers'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+Require the libs:
+
+```
+require 'app_logger'
+require 'app_logger/faraday_middleware'
+require 'app_logger/rack_middleware'
+```
+
+To use with Faraday:
+
+```
+  Faraday::Request.register_middleware faraday_app_logger: AppLogger::FaradayMiddleware
+```
+
+To use with Sinatra/Rack:
+
+```
+  class App < Sinatra::Base
+    configure do
+      use AppLogger::RackMiddleware
+    end
+  end
+```
+
+## Output format
+
+The output format is json to file and human readable stdout by default. To change layout format for stdout to json, use `AppLogger.output_format = :json`
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome, https://stash.int.klarna.net/projects/GEMS/repos/klarna-app-loggers/

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/klarna-app-loggers.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'app_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'klarna-app-loggers'
+  spec.version       = AppLogger::VERSION
+  spec.authors       = ['Team Panda']
+  spec.email         = ['panda.e@klarna.com']
+
+  spec.summary       = %q{Helpful app loggers for Rack and Faraday}
+  spec.description   = %q{Helpful app loggers for Rack and Faraday}
+  spec.homepage      = 'https://stash.int.klarna.net/projects/GEMS/repos/klarna-app-loggers/'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'logging'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rspec-benchmark', '~> 0.2'
+end

data/lib/app_logger.rb

@@ -0,0 +1,31 @@
+require 'logging'
+
+module AppLogger
+  DATE_PATTERN = '%Y-%m-%dT%H:%M:%S:%L%zZ'
+  LOG_PATH = "log/#{ENV['RACK_ENV']}.log"
+
+  class << self
+    attr_accessor :silence_stdout
+    attr_accessor :output_format
+  end
+
+  def create_logger(level: :info)
+    FileUtils.mkdir_p(File.dirname(LOG_PATH))
+    Logging.backtrace(true)
+
+    json_layout = Logging.layouts.json(date_pattern: DATE_PATTERN)
+    stdout_layout = if AppLogger.output_format == :json
+      json_layout
+    else
+      Logging.layouts.pattern(date_pattern: DATE_PATTERN)
+    end
+
+    Logging.logger['App'].tap do |logger|
+      logger.appenders = if AppLogger.silence_stdout
+        [Logging.appenders.file(LOG_PATH, layout: json_layout)]
+      else
+        [Logging.appenders.file(LOG_PATH, layout: json_layout), Logging.appenders.stdout(layout: stdout_layout)]
+      end
+    end
+  end
+end

data/lib/app_logger/faraday_middleware.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+
+module AppLogger
+  class FaradayMiddleware < ::Faraday::Response::Middleware
+    include AppLogger
+
+    def initialize(app)
+      super(app)
+      @logger = create_logger
+    end
+
+    def call(env)
+      began_at = Time.now
+      response = @app.call(env)
+      status = env[:status]
+      log_method = success?(status) ? :info : :error
+
+      payload = {
+        request_method: env[:method].to_s.upcase,
+        url: env[:url].to_s,
+        status: status,
+        request_time: "#{Time.now - began_at}s",
+        x_request_id: env[:response_headers]['x-request-id']
+      }
+
+      if Object.const_defined?(:KlarnaCorrelationId)
+        payload.merge!({
+          klarna_correlation_id: KlarnaCorrelationId.current
+        })
+      end
+
+      @logger.public_send(log_method, payload)
+
+      response
+    end
+
+    private
+
+    def success?(status)
+      status >= 200 && status < 400
+    end
+  end
+end
+
+Faraday::Request.register_middleware faraday_app_logger: AppLogger::FaradayMiddleware

data/lib/app_logger/rack_middleware.rb

@@ -0,0 +1,79 @@
+require 'rack'
+
+module AppLogger
+  class RackMiddleware
+    include AppLogger
+
+    MASK                  = '***'.freeze
+    RACK_LOGGER           = 'rack.logger'.freeze
+    SINATRA_ERROR         = 'sinatra.error'.freeze
+    KLARNA_CORRELATION_ID = 'Klarna-Correlation-Id'.freeze
+
+    def initialize(app, options = {})
+      @app = app
+      @path_filter = options[:path_filter]
+      @masked_params = options[:masked_params]
+      @logger = create_logger
+    end
+
+    def call(env)
+      began_at = Time.now
+      env[RACK_LOGGER] = @logger
+      status, headers, body = @app.call(env)
+      body = Rack::BodyProxy.new(body) do
+        log(env, status, headers, began_at)
+      end
+      [status, headers, body]
+    end
+
+    private
+
+    def log(env, status, headers, began_at)
+      request = Rack::Request.new(env)
+      return if skip_path?(request)
+      headers_hash = Rack::Utils::HeaderHash.new(headers)
+      error = env[SINATRA_ERROR]
+
+      payload = {
+        remote_address: request.ip,
+        remote_user: env['REMOTE_USER'],
+        request_method: request.request_method,
+        path: request.fullpath,
+        status: status.to_s[0..3],
+        request_time: "#{Time.now - began_at}s",
+        params: mask_params(request)
+      }
+
+      if Object.const_defined?(:KlarnaCorrelationId)
+        payload.merge!({
+          klarna_correlation_id: headers_hash[KLARNA_CORRELATION_ID]
+        })
+      end
+
+      if error
+        @logger.error(payload.merge(
+          exception_class: error.class.to_s,
+          exception_message: error.message,
+          backtrace: error.backtrace
+        ))
+      else
+        @logger.info(payload)
+      end
+    end
+
+    def mask_params(request)
+      params = request.params
+      return params unless @masked_params
+
+      masked_params = params.map do |k, v|
+        @masked_params.include?(k) ? [k, MASK] : [k, v]
+      end
+
+      Hash[masked_params]
+    end
+
+    def skip_path?(request)
+      @path_filter && request.fullpath =~ @path_filter
+    end
+  end
+end

data/lib/app_logger/version.rb

@@ -0,0 +1,3 @@
+module AppLogger
+  VERSION = '1.2.0'
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: klarna-app-loggers
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Team Panda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Helpful app loggers for Rack and Faraday
+email:
+- panda.e@klarna.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- klarna-app-loggers.gemspec
+- lib/app_logger.rb
+- lib/app_logger/faraday_middleware.rb
+- lib/app_logger/rack_middleware.rb
+- lib/app_logger/version.rb
+homepage: https://stash.int.klarna.net/projects/GEMS/repos/klarna-app-loggers/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Helpful app loggers for Rack and Faraday
+test_files: []