request_headers_logger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a3ef4bf0a8787742b143de9fd75e856c99284dd
-  data.tar.gz: 8159bb657b7de2a5036a113d0dc05b65d4a1ac34
+  metadata.gz: 426a124479eca311531e5bfea76dd501c1d18d91
+  data.tar.gz: 5f0588b3dd89067b276b144a826360511a8bab6d
 SHA512:
-  metadata.gz: b8bff686ae38f14bf3c5e4db57466c63385b307cd6a4633b61653b2b470f7fc89f27fbb843d50c28c507d2b0c319365af5ce988f08da479f57eea1d3d1a09ddb
-  data.tar.gz: f08ca98445f59ad39f3e0c88ad10b18f2cb4982049b177ce0fbf704ce4de2b3e6493f8314ce863dbaf881528d49a639ecce67e32590ab6e612f9e8ba849bfea7
+  metadata.gz: fc35c05ebc50865e5475852bdcdf8d987a90470cb4b3fda32582429b77d0de04e3d7f6c581662b9a64cf32a89856aef90e46fa308f0ae571cbdf670ad783420b
+  data.tar.gz: 9f683fc2afee57432db86b18fe506e174fb8966467c080c479f57c8dc827d1689357e11f8ecbb2f76c3d6fe894b8318b1346a5abdb90b806a5052a6b9ec85f4e

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    request_headers_logger (0.0.1)
-      activesupport (> 4.0)
+    request_headers_logger (0.0.2)
       request_headers_middleware (~> 0.0.4)
 
 GEM

data/lib/request_headers_logger/configuration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RequestHeadersLogger
+  class Configuration
+    class InvalidKey < StandardError
+      def initialize(key)
+        super("Configuration option '#{key.inspect}' is not a valid key")
+      end
+    end
+
+    CONFIG_KEYS = [
+      :log_format, # [logger_format] default or json
+      :loggers,    # [Loggers]  List of all loggers used.
+      :tag_format, # [tag_format]
+    ].freeze
+
+    LOG_FORMATS = %w[text json].freeze
+    TAG_FORMATS = %w[val key_val].freeze
+
+    def initialize
+      @configs = {
+        log_format: LOG_FORMATS.first,
+        loggers: [],
+        tag_format: TAG_FORMATS.first
+      }
+    end
+
+    def []=(key, value)
+      raise InvalidKey, key unless CONFIG_KEYS.include?(key)
+
+      @configs[key] = value
+    end
+
+    def [](key)
+      @configs[key]
+    end
+
+    def log_format
+      LOG_FORMATS.include?(@configs[:log_format]) ? @configs[:log_format] : LOG_FORMATS.first
+    end
+
+    def tag_format
+      TAG_FORMATS.include?(@configs[:tag_format]) ? @configs[:tag_format] : TAG_FORMATS.first
+    end
+  end
+end

data/lib/request_headers_logger/delayed_job/request_header_delayed_plugin.rb

@@ -13,21 +13,21 @@ module RequestHeadersLogger
 
       lifecycle.before(:perform) do |worker, job|
         RequestHeadersMiddleware.store = job.payload_object.instance_variable_get(:@store)
-
-        RequestHeadersLogger.tag_logger Delayed::Worker.logger
-        RequestHeadersLogger.tag_logger ::Rails.logger unless dj_use_rails_logger
+        set_dj_loggers
       end
 
       lifecycle.after(:perform) do |worker, job|
-        RequestHeadersLogger.untag_logger Delayed::Worker.logger
-        RequestHeadersLogger.untag_logger ::Rails.logger unless dj_use_rails_logger
-
         RequestHeadersMiddleware.store = {}
       end
     end
 
-    def self.dj_use_rails_logger
-      ::Rails.logger == Delayed::Worker.logger
+    def self.set_dj_loggers
+      RequestHeadersLogger.configure do |config|
+        loggers = [Delayed::Worker.logger]
+        loggers << ::Rails.logger
+
+        config[:loggers] = loggers
+      end
     end
   end
 end

data/lib/request_headers_logger/json_formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RequestHeadersLogger
+  class JsonFormatter
+    def call(severity, timestamp, progname, msg)
+      json = { level: severity, timestamp: timestamp.to_s, message: msg.strip }
+      json = json.merge(progname: progname.to_s) unless progname.nil?
+
+      json.merge(RequestHeadersLogger.tags || {}).to_json + "\n"
+    end
+  end
+end

data/lib/request_headers_logger/message_queue/message_queue.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'message_queue_plugin' if defined?(MessageQueue)

data/lib/request_headers_logger/message_queue/message_queue_plugin.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'message_queue'
+
+module RequestHeadersLogger
+  class MQRequestHeadersPlugin < MessageQueue::Plugin
+    class << self
+      def symbolize(obj = {})
+        if obj.is_a? Hash
+          return obj.reduce({}) do |memo, (k, v)|
+            memo.tap { |m| m[k.to_sym] = symbolize(v) }
+          end
+        end
+        obj
+      end
+    end
+
+    callbacks do |lifecycle|
+      lifecycle.before(:publish) do |_message, options|
+        options[:headers] ||= {}
+        options[:headers][:store] = RequestHeadersMiddleware.store
+      end
+
+      lifecycle.before(:consume) do |delivery_info, properties, payload|
+        store = symbolize(properties.headers).dig(:store) || {}
+        RequestHeadersMiddleware.store = store
+
+        set_dj_loggers
+      end
+
+      lifecycle.after(:consume) do |delivery_info, properties, payload|
+        RequestHeadersMiddleware.store = {}
+      end
+    end
+
+    def self.set_dj_loggers
+      RequestHeadersLogger.configure do |config|
+        config[:loggers] = [MessageQueue.logger]
+      end
+    end
+  end
+end
+
+MessageQueue.configure do |config|
+  config[:plugins] << RequestHeadersLogger::MQRequestHeadersPlugin
+end

data/lib/request_headers_logger/text_formatter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RequestHeadersLogger
+  class TextFormatter < ::Logger::Formatter
+    def call(severity, timestamp, progname, msg)
+      super(severity, timestamp, progname, "#{tags_text}#{msg}")
+    end
+
+    def tags_text
+      RequestHeadersLogger.tags.collect { |key, val| tag_value(key, val) }.join if RequestHeadersLogger.tags.any?
+    end
+
+    def tag_value(key, value)
+      tag = value.to_s
+      tag = "#{key}: #{tag}" if RequestHeadersLogger.tag_format.eql? 'key_val'
+
+      "[#{tag}] "
+    end
+  end
+end

data/lib/request_headers_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RequestHeadersLogger
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/request_headers_logger.rb

@@ -1,37 +1,55 @@
 # frozen_string_literal: true
 
-require 'active_support'
 require 'request_headers_middleware'
+require 'request_headers_logger/configuration'
+require 'request_headers_logger/json_formatter'
+require 'request_headers_logger/text_formatter'
 require 'request_headers_logger/delayed_job/delayed_job'
+require 'request_headers_logger/message_queue/message_queue'
 
 module RequestHeadersLogger # :nodoc:
   extend self
 
   attr_accessor :whitelist
-  @whitelist = ['x-request-id'.to_sym]
+  @whitelist     = ['x-request-id'.to_sym]
+  @configuration = Configuration.new
+
+  def configure
+    yield @configuration
+
+    prepare_loggers
+  end
 
   def tags
     filter(RequestHeadersMiddleware.store)
   end
 
-  def tag_logger(logger)
-    logger = tagged_logger(logger) unless logger.respond_to? :push_tags
-    tags.each do |_tag, value|
-      logger.push_tags(value) unless value.nil?
-    end
+  def log_format
+    @configuration.log_format
   end
 
-  def untag_logger(logger)
-    logger = tagged_logger(logger) unless logger.respond_to? :pop_tags
-    tags.each do |_tag, value|
-      logger.pop_tags unless value.nil?
-    end
+  def tag_format
+    @configuration.tag_format
+  end
+
+  def loggers
+    @configuration[:loggers]
   end
 
   private
 
-  def tagged_logger(logger)
-    ActiveSupport::TaggedLogging.new(logger)
+  def prepare_loggers
+    loggers.each do |logger|
+      logger_formatter logger
+    end
+  end
+
+  def logger_formatter(logger)
+    logger.tap { |obj| obj.formatter = formatter_class.new }
+  end
+
+  def formatter_class
+    RequestHeadersLogger.const_get("#{log_format.capitalize}Formatter")
   end
 
   def filter(store)

data/request_headers_logger.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['wshihadh@gmail.com']
   gem.description   = 'RequestHeaderLogger Allows you to tag logs with RequestHeader flags.'
   gem.summary       = 'RequestHeaderLogger Allows you to tag logs with RequestHeader flags.'
-  gem.homepage      = 'https://github.com/wshihadeh/request_headers_logger'
+  gem.homepage      = 'https://github.com/fidor/request_headers_logger'
   gem.licenses      = ['MIT']
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -19,7 +19,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'activesupport', '> 4.0'
   gem.add_dependency 'request_headers_middleware', '~> 0.0.4'
 
   gem.add_development_dependency 'delayed_job', '~> 4.1', '>= 4.1.4'

data/spec/configuration_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RequestHeadersLogger::Configuration do
+  let(:config) { RequestHeadersLogger::Configuration.new }
+
+  describe '.log_format' do
+    it 'return text as default' do
+      expect(config.log_format).to eq('text')
+    end
+
+    it 'return text when log_format is not supported' do
+      config[:log_format] = 'syslog'
+      expect(config.log_format).to eq('text')
+    end
+
+    it 'return log_format value when it is supported' do
+      config[:log_format] = 'json'
+      expect(config.log_format).to eq('json')
+    end
+  end
+
+  describe '.tag_format' do
+    it 'return val as default' do
+      expect(config.tag_format).to eq('val')
+    end
+
+    it 'return val when log_format is not supported' do
+      config[:tag_format] = 'unknwn'
+      expect(config.tag_format).to eq('val')
+    end
+
+    it 'return tag_format value when it is supported' do
+      config[:tag_format] = 'key_val'
+      expect(config.tag_format).to eq('key_val')
+    end
+  end
+
+  describe '[]' do
+    it 'return text as default for log_format' do
+      expect(config[:log_format]).to eq('text')
+    end
+
+    it 'return empty array as default for loggers' do
+      expect(config[:loggers]).to eq([])
+    end
+  end
+
+  describe '[]=' do
+    it 'assign valid config keys' do
+      logger = Logger.new(STDOUT)
+
+      config[:log_format] = 'json'
+      config[:loggers] << logger
+
+      expect(config[:log_format]).to eq('json')
+      expect(config[:loggers].first).to eq(logger)
+    end
+
+    it 'raise an error for invalid configs ' do
+      expect { config[:undefined] = 'undefined' }.to raise_error(RequestHeadersLogger::Configuration::InvalidKey)
+    end
+  end
+end

data/spec/json_formatter_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'json'
+
+RSpec.describe RequestHeadersLogger::JsonFormatter do
+  let(:buffer) { StringIO.new }
+  let(:logger) do
+    logger = Logger.new(buffer)
+    logger.progname = 'dummy'
+    logger.formatter = RequestHeadersLogger::JsonFormatter.new
+    logger
+  end
+
+  it 'output logs in a json format' do
+    logger.info('json log message')
+    json = JSON.parse(buffer.string)
+
+    expect(json.class).to eq Hash
+    expect(json.size).to eq 4
+    expect(json.keys).to eq %w[level timestamp message progname]
+    expect(json['level']).to eq 'INFO'
+    expect(json['message']).to eq 'json log message'
+    expect(json['progname']).to eq 'dummy'
+  end
+
+  it 'include tags in the json' do
+    RequestHeadersMiddleware.store = { 'X-Request-Id': 'ef382618', 'tag': 'SSS' }
+
+    logger.info('json log message')
+    json = JSON.parse(buffer.string)
+
+    expect(json.class).to eq Hash
+    expect(json.size).to eq 5
+    expect(json.keys).to eq %w[level timestamp message progname X-Request-Id]
+    expect(json['level']).to eq 'INFO'
+    expect(json['message']).to eq 'json log message'
+    expect(json['progname']).to eq 'dummy'
+    expect(json['X-Request-Id']).to eq 'ef382618'
+
+    RequestHeadersMiddleware.store = {}
+  end
+end

data/spec/request_headers_logger_spec.rb

@@ -1,27 +1,28 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require 'active_support'
 
 RSpec.describe RequestHeadersLogger do
-  let(:logger) { ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)) }
+  let(:logger) { Logger.new(STDOUT) }
 
   describe '.tags' do
-    before(:each) do
+    before do
       @store = {  'X-Request-Id': 'ef382618-e46d-42f5-aca6-ae9e1db8fee0',
                   'X-Request-Id2': 'e46def38-2618-42f5-ae9e-1db8fee0aca6',
                   'X-Request-Id3': '618e46de-f382-42f5-aca6-8fee0ae9e1db' }
+      RequestHeadersMiddleware.store = @store
     end
 
-    it 'return only x-request-id by default' do
-      RequestHeadersMiddleware.store = @store
+    after do
+      RequestHeadersMiddleware.store = {}
+    end
 
+    it 'return only x-request-id by default' do
       expect(RequestHeadersLogger.tags.count).to eq(1)
       expect(RequestHeadersLogger.tags).to eq('X-Request-Id': 'ef382618-e46d-42f5-aca6-ae9e1db8fee0')
     end
 
     it 'return empty hash when whitelist is empty' do
-      RequestHeadersMiddleware.store = @store
       RequestHeadersLogger.whitelist = []
 
       expect(RequestHeadersLogger.tags.count).to eq(0)
@@ -29,7 +30,6 @@ RSpec.describe RequestHeadersLogger do
     end
 
     it 'return only the white listed flags' do
-      RequestHeadersMiddleware.store = @store
       RequestHeadersLogger.whitelist = ['x-request-id'.to_sym, 'x-request-id2'.to_sym]
 
       expect(RequestHeadersLogger.tags.count).to eq(2)
@@ -37,29 +37,4 @@ RSpec.describe RequestHeadersLogger do
       expect(RequestHeadersLogger.tags[:'X-Request-Id2']).to eq('e46def38-2618-42f5-ae9e-1db8fee0aca6')
     end
   end
-
-  describe '.tag_logger' do
-    it 'tag the logger' do
-      store = { 'X-Request-Id': 'ef382618-e46d-42f5-aca6-ae9e1db8fee0' }
-      RequestHeadersMiddleware.store = store
-      RequestHeadersLogger.tag_logger logger
-      tags = logger.formatter.current_tags
-
-      expect(tags.count).to eq(1)
-      expect(tags.first).to eq(store[:'X-Request-Id'])
-    end
-  end
-
-  describe '.untag_logger' do
-    it 'untag the logger' do
-      store = { 'X-Request-Id': 'ef382618-e46d-42f5-aca6-ae9e1db8fee0' }
-      RequestHeadersMiddleware.store = store
-      RequestHeadersLogger.tag_logger logger
-      RequestHeadersLogger.untag_logger logger
-      tags = logger.formatter.current_tags
-
-      expect(tags.count).to eq(0)
-      expect(tags).to eq([])
-    end
-  end
 end

data/spec/text_formatter_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RequestHeadersLogger::TextFormatter do
+  let(:buffer) { StringIO.new }
+  let(:logger) do
+    logger = Logger.new(buffer)
+    logger.progname = 'dummy'
+    logger.formatter = RequestHeadersLogger::TextFormatter.new
+    logger
+  end
+
+  it 'output logs in a text format' do
+    logger.info('text log message')
+
+    expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: text log message$/)
+  end
+
+  context 'store has some tags' do
+    before do
+      RequestHeadersMiddleware.store = { 'X-Request-Id': 'ef382618', 'tag': 'SSS' }
+    end
+
+    after do
+      RequestHeadersMiddleware.store = {}
+      RequestHeadersLogger.configure { |c| c[:tag_format] = 'val' }
+    end
+
+    it 'output tags with key_val formmat' do
+      RequestHeadersLogger.configure { |c| c[:tag_format] = 'key_val' }
+      logger.info('text log message')
+      output = buffer.string
+
+      expect(output).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[X-Request-Id: ef382618\] text log message$/)
+    end
+
+    it 'include tags in the log line' do
+      logger.info('text log message')
+
+      expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[ef382618\] text log message$/)
+    end
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: request_headers_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Al-waleed Shihadeh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: request_headers_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -165,16 +151,24 @@ files:
 - Rakefile
 - bin/travis
 - lib/request_headers_logger.rb
+- lib/request_headers_logger/configuration.rb
 - lib/request_headers_logger/delayed_job/delayed_job.rb
 - lib/request_headers_logger/delayed_job/performable_method.rb
 - lib/request_headers_logger/delayed_job/request_header_delayed_plugin.rb
+- lib/request_headers_logger/json_formatter.rb
+- lib/request_headers_logger/message_queue/message_queue.rb
+- lib/request_headers_logger/message_queue/message_queue_plugin.rb
+- lib/request_headers_logger/text_formatter.rb
 - lib/request_headers_logger/version.rb
 - request_headers_logger.gemspec
+- spec/configuration_spec.rb
 - spec/delayed_job/performable_method_spec.rb
+- spec/json_formatter_spec.rb
 - spec/request_headers_logger_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_dj_user.rb
-homepage: https://github.com/wshihadeh/request_headers_logger
+- spec/text_formatter_spec.rb
+homepage: https://github.com/fidor/request_headers_logger
 licenses:
 - MIT
 metadata: {}
@@ -199,7 +193,10 @@ signing_key:
 specification_version: 4
 summary: RequestHeaderLogger Allows you to tag logs with RequestHeader flags.
 test_files:
+- spec/configuration_spec.rb
 - spec/delayed_job/performable_method_spec.rb
+- spec/json_formatter_spec.rb
 - spec/request_headers_logger_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_dj_user.rb
+- spec/text_formatter_spec.rb