lumberyak 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2542d62276a1c1c56ee45a5108a106063cabec72
+  data.tar.gz: 82a9624e5dfbc30b194c0f3629a4d3cec8f1a833
+SHA512:
+  metadata.gz: 5eb223c4d0ef4317ef1277d50b8ef3efeb500d0c803c6421e1b689eb1551508e6371811c6fdf1a7adb40801e83439e23895a57aa350ed87231c9f36c9cb03b61
+  data.tar.gz: f66379861291b2ca798ba869442dbe8dde0bf469f77f258243533a503e778a6be1d3bf2dbdc3146ec14e8ec6ebe9e62ad6ad424b86cec2a89018a690a4021a66

data/lib/activesupport/taggedlogging/formatter.rb

@@ -0,0 +1,64 @@
+
+module ActiveSupport
+  module TaggedLogging
+    module Formatter # :nodoc:
+      # This method is invoked when a log event occurs.
+      def call(severity, timestamp, progname, message)
+        # This scheme of serializing text log messages into a json format is
+        # loosely based on the logstasher.log() method found here:
+        # https://github.com/shadabahmed/logstasher/blob/master/lib/logstasher.rb#L160
+        # The major difference is we use the TaggedLogging formater's tagging ability.
+        # As implemented, TaggedLogging expects the proc's it executes return a scalar
+        # value which it converts to a string wrapped with brackets. The resulting
+        # behavior is logs that take the form of:
+        # '[23432342] [234245] error parsing post request'
+        # We could have left that intact by say having a tags field in our json doc that
+        # points to our list of tags, but this lacks context. So what we've done is change
+        # the convention in our application.rb to have our callback procs return hashes
+        # instead of scalars. This way, we get the context by letting the proc provide keys
+        # that describe each value.
+        data = { 'level' => severity }
+        if message.is_a? StandardError
+          e = message
+          data['type'] = e.class.to_s
+          data['message'] = e.message
+          data['backtrace'] = clean_backtrace(e).join("\n    ")
+        elsif message.respond_to?(:to_hash)
+          data.merge!(message.to_hash)
+        else
+          data['message'] = message
+        end
+        data['timestamp'] = timestamp.iso8601
+
+        data.merge!(user_defined_attributes)
+
+        super(severity, timestamp, progname, data.to_json)
+      end
+
+      def user_defined_attributes
+        attrs = {
+          "tags" => []
+        }
+        current_tags.each do |t|
+          if t.respond_to?(:to_hash)
+            attrs.merge!(t.to_hash)
+          else
+            attrs["tags"].push(t)
+          end
+        end
+        attrs
+      end
+
+      # Taken from http://stackoverflow.com/a/237846
+      def clean_backtrace(exception)
+        if backtrace = exception.backtrace
+          if defined?(RAILS_ROOT)
+            backtrace.map { |line| line.sub RAILS_ROOT, '' }
+          else
+            backtrace
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lograge/formatter/noformat.rb

@@ -0,0 +1,14 @@
+
+
+# We don't want Log Rage to do any message formatting as our JSON
+# encoding owns this step.  Otherwise we end up with a json encoded
+# message within a json blob.
+module Lograge
+  module Formatters
+    class NoFormat
+      def call(data)
+        data
+      end
+    end
+  end
+end

data/lib/lumberyak.rb

@@ -0,0 +1,62 @@
+
+require 'active_support'
+require 'rails/railtie'
+require 'lograge'
+require 'lograge/railtie'
+require 'lograge/formatter/noformat'
+
+module LumberYak
+  module_function
+
+  mattr_accessor :application
+
+  def setup(app)
+    self.application = app
+    setup_logger
+    setup_lograge
+    setup_logtags
+    enable_json_logging
+  end
+
+  class LumberYakRailtie < ::Rails::Railtie
+    config.lumberyak = ActiveSupport::OrderedOptions.new
+    config.lumberyak.enabled = false
+    config.lumberyak.configure_lograge = true
+    config.lumberyak.log_tags = nil
+
+    config.after_initialize do |app|
+      LumberYak.setup(app) if app.config.lumberyak.enabled
+    end
+  end
+
+  def setup_logger
+    if application.config.logger
+      new_logger = ActiveSupport::TaggedLogging.new(application.config.logger)
+      application.config.logger = new_logger
+      Rails.logger = new_logger
+    end
+  end
+
+  def setup_lograge
+    if config.configure_lograge
+      application.configure do
+        config.lograge.enabled = true
+        config.lograge.formatter = Lograge::Formatters::NoFormat.new
+      end
+      Lograge.setup(application)
+    end
+  end
+
+  def setup_logtags
+    application.config.log_tags = config.log_tags if config.log_tags
+  end
+
+  def enable_json_logging
+    # Explicitly require our monkey patch to ensure it takes effect.
+    require 'activesupport/taggedlogging/formatter.rb'
+  end
+
+  def config
+    application.config.lumberyak
+  end
+end

data/lib/lumberyak/version.rb

@@ -0,0 +1,4 @@
+
+module LumberYak
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: lumberyak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Roddy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: LumberYak enables structured logging via JSON for any Rails application
+email:
+- mroddy@primary.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/activesupport/taggedlogging/formatter.rb
+- lib/lograge/formatter/noformat.rb
+- lib/lumberyak.rb
+- lib/lumberyak/version.rb
+homepage: https://github.com/PrimaryKids/lumberyak
+licenses:
+- Apache
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Structured Logging for Rails Applications
+test_files: []