contextual_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 792d027e06730423ee08c1321a92d05b75d9c9a2
+  data.tar.gz: 4feda11871b919feeda59f2a94a7bd48e18412f5
+SHA512:
+  metadata.gz: 9dc835d30281ef8f52135a5040dc7fa708a1b22d4e20a5d0d4e1e5d5560afd2cc51decd0cd3e238a8ef3160dd4c50f670a6d4b70bd7cf14b127da62574b5b9cc
+  data.tar.gz: 8b59b651971148697c2f2e8cdc633278a25667bb00e7c54186cfe8d8f8f0a12556a6eb143e117a25944dcda1b5d91c15fafedd915dd753ae7a74f92437cc9f3b

data/lib/contextual_logger.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ContextualLogger
+  def self.new(logger)
+    logger.extend(self)
+  end
+
+  def global_context=(context)
+    Thread.current[THREAD_CONTEXT_NAMESPACE] = context
+  end
+
+  def with_context(context)
+    previous_context = Thread.current[THREAD_CONTEXT_NAMESPACE] || {}
+    Thread.current[THREAD_CONTEXT_NAMESPACE] = previous_context.merge(context)
+    yield if block_given?
+  ensure
+    Thread.current[THREAD_CONTEXT_NAMESPACE] = previous_context
+  end
+
+  def current_context_for_thread
+    Thread.current[THREAD_CONTEXT_NAMESPACE] || {}
+  end
+
+  def format_message(severity, timestamp, progname, message, context)
+    message_with_context = message_with_context(context, message, severity, timestamp, progname)
+
+    if @formatter
+      @formatter.call(severity, timestamp, progname, message_with_context)
+    else
+      "#{message_with_context.to_json}\n"
+    end
+  end
+
+  def debug(progname = nil, **extra_context, &block)
+    add(Logger::Severity::DEBUG, nil, progname, extra_context, &block)
+  end
+
+  def info(progname = nil, **extra_context, &block)
+    add(Logger::Severity::INFO, nil, progname, extra_context, &block)
+  end
+
+  def warn(progname = nil, **extra_context, &block)
+    add(Logger::Severity::WARN, nil, progname, extra_context, &block)
+  end
+
+  def error(progname = nil, **extra_context, &block)
+    add(Logger::Severity::ERROR, nil, progname, extra_context, &block)
+  end
+
+  def fatal(progname = nil, **extra_context, &block)
+    add(Logger::Severity::FATAL, nil, progname, extra_context, &block)
+  end
+
+  def unknown(progname = nil, **extra_context, &block)
+    add(Logger::Severity::UNKNOWN, nil, progname, extra_context, &block)
+  end
+
+  def add(severity, message = nil, progname = nil, extra_context = nil)
+    severity ||= UNKNOWN
+    if @logdev.nil? || (severity < @level)
+      return true
+    end
+    progname ||= @progname
+    if message.nil?
+      if block_given?
+        message = yield
+      else
+        message = progname
+        progname = @progname
+      end
+    end
+    write_entry_to_log(severity, Time.now, progname, message, current_context_for_thread.merge(extra_context))
+    true
+  end
+
+  def write_entry_to_log(severity, timestamp, progname, message, context)
+    @logdev.write(format_message(format_severity(severity), timestamp, progname, message, context))
+  end
+
+  private
+
+  THREAD_CONTEXT_NAMESPACE = 'ContextualLoggerCurrentLoggingContext'
+
+  def message_with_context(context, message, severity, timestamp, progname)
+    context.merge(
+      message: message,
+      severity: severity,
+      timestamp: timestamp,
+      progname: progname
+    )
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: contextual_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Ebentier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+description: A way to add context to the logs you have
+email: jebentier@invoca.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/contextual_logger.rb
+homepage: https://rubygems.org/gems/contextual_logger
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Invoca/contextual_logger
+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: Add context to your logger
+test_files: []