ichnite 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8356832e68c689347200de1532c4b5ee6c878905
-  data.tar.gz: 6eec0f10c9ad8f9f4cee5e337c45ff0f874b4ab4
+SHA256:
+  metadata.gz: 677aac051c83f841ad6c88bcc59e81eec236a16f2073bfcb9ecda926a5ab526e
+  data.tar.gz: eac35f4f44079509b5bd05c690e0810059d6be9e0a29f5c1a54f3dbc404845f4
 SHA512:
-  metadata.gz: 4835f9417bd793d5101e9aaebf84e65f8cd4bc4a6137ffa9b93534f445699a74a5523c1263dea2c9bf870891ad8cb32563f56ebbe7516dbb514ba645658081c5
-  data.tar.gz: 72040b57c125facae786106773580f5adb03ad9179b35b62954fd0ebf5005d48c2975bca74fd33c6eabf45fcecff0b760b2a5294e0abb720c7c7c7a2a916802e
+  metadata.gz: '03299eb5ed6de16539367a015471151d5e4cf094742062e8b6f11594b27824902531fba745032d78048d96bb78bdb177da80496a98721f0dcbfd0171ee781a45'
+  data.tar.gz: e93689adf0c210d474291d70fc50f1ebc855730843c4fd98dc7781c85b23249d220f05a64ca617cc7536fcdd4a31bfb75e054fc71cd878cd95e0f1580754b39c

data/lib/ichnite.rb

@@ -44,8 +44,8 @@ module Ichnite
 
   def self.default_logger
     @default_logger ||=
-      if defined?(Rails)
-        Ichnite::Logger.new(Rails.logger)
+      if defined?(::Rails) && ::Rails.respond_to?(:logger)
+        Ichnite::Logger.new(::Rails.logger)
       else
         inner = ::Logger.new($stdout)
         inner.formatter =  proc { |_level, _time, _prog, msg| "#{msg}\n" }

data/lib/ichnite/action_dispatch/structured_exceptions.rb

@@ -0,0 +1,28 @@
+module Ichnite
+  module ActionDispatch
+    module StructuredExceptions
+      def render_exception(_env, e)
+        begin
+          exception_name = e.class.name
+          status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_name)
+          if status == 500
+            ::Ichnite.log('request_error',
+              at: :error,
+              error: exception_name,
+              message: e.message[/\A.+$/].inspect
+            )
+          end
+        rescue Exception => e2
+          # never interfere with the regular exception handling
+          ::Rails.logger.error(e2.inspect)
+        end
+
+        super
+      end
+
+      def log_error(*)
+        # no-logging
+      end
+    end
+  end
+end

data/lib/ichnite/active_support/disable_tagged_logging_patch.rb

@@ -0,0 +1,11 @@
+module ActiveSupport
+  module TaggedLogging
+    module Formatter
+      def tagged(*_args)
+        yield
+      end
+
+      def push_tags(*_args); end
+    end
+  end
+end

data/lib/ichnite/rails.rb

@@ -0,0 +1 @@
+require "ichnite/rails/railtie"

data/lib/ichnite/rails/railtie.rb

@@ -0,0 +1,24 @@
+require 'ichnite/action_dispatch/structured_exceptions'
+
+module Ichnite
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'ichnite_rails.setup' do |app|
+        Ichnite.default_logger = Ichnite::Logger.new(::Rails.logger)
+
+        ActiveSupport.on_load :action_controller do
+          if defined?(::ActionDispatch::DebugExceptions)
+            ::ActionDispatch::DebugExceptions.prepend Ichnite::ActionDispatch::StructuredExceptions
+          elsif defined?(::ActionDispatch::ShowExceptions)
+            ::ActionDispatch::ShowExceptions.prepend Ichnite::ActionDispatch::StructuredExceptions
+          end
+        end
+
+        if !::Rails.env.test? && !::Rails.env.development?
+          require 'active_support/tagged_logging'
+          require 'ichnite/active_support/disable_tagged_logging_patch'
+        end
+      end
+    end
+  end
+end

data/lib/ichnite/sidekiq.rb

@@ -0,0 +1,26 @@
+require 'ichnite/sidekiq/middleware'
+
+Sidekiq.logger.level = Logger::WARN
+
+Sidekiq.configure_server do |config|
+  # Remove Sidekiqs default backtrace logging
+  if !defined?(::Rails) || ::Rails.env.production?
+    config.error_handlers.delete_if { |h| Sidekiq::ExceptionHandler::Logger === h }
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Ichnite::ClientMiddleware
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Ichnite::ClientMiddleware
+  end
+
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Ichnite::ServerMiddleware
+  end
+end

data/lib/ichnite/sidekiq/middleware.rb

@@ -0,0 +1,108 @@
+module Sidekiq
+  module Ichnite
+    def self.job_id(msg)
+      msg['jid']
+    end
+
+    def self.job_class(msg)
+      aj_job_class(msg) || msg['class']
+    end
+
+    def self.aj_job_class(msg)
+      msg['wrapped']
+    end
+
+    def self.job_args(msg)
+      args = msg['args']
+      aj_job_args(args) || args
+    end
+
+    def self.aj_job_args(args)
+      first_arg = args.first
+
+      # check if the first argument looks like a AJ metadata hash
+      if first_arg.is_a?(Hash) && first_arg.key?('arguments')
+        first_arg['arguments'].map do |arg|
+          if arg.is_a?(Hash) && arg.key?('_aj_globalid')
+            arg['_aj_globalid']
+          else
+            arg
+          end
+        end
+      end
+    end
+
+    class ClientMiddleware
+      def call(worker_class, msg, queue, _redis_pool)
+        context = {
+          queue: queue,
+          job_id: Sidekiq::Ichnite.job_id(msg),
+          job_class: Sidekiq::Ichnite.job_class(msg)
+        }
+        if at = msg['at']
+          context[:scheduled_at] = Time.at(at).utc
+          ::Ichnite.log('job_schedule', context)
+        else
+          context[:args] = Sidekiq::Ichnite.job_args(msg)
+          ::Ichnite.log('job_enqueue', context)
+        end
+        yield
+      end
+    end
+
+    class ServerMiddleware
+      def call(worker, msg, queue)
+        ::Ichnite.enter(
+          job_id: Sidekiq::Ichnite.job_id(msg),
+          job_class: Sidekiq::Ichnite.job_class(msg)) do
+          begin
+            context = { queue: queue }
+
+            ts = Time.now.to_f
+            # We are currently not logging start events.
+            # This would most likely blow our SumoLogic limit.
+            # start context, ts
+            yield
+            stop context, msg, ts
+          rescue => ex
+            error context, msg, ex, ts
+            raise ex
+          end
+        end
+      end
+
+      def start(context, _time)
+        ::Ichnite.log('job_start', context)
+      end
+
+      def error(context, msg, error, start)
+        data = context.merge(job_timing(msg, start))
+        data.merge!(
+          at: :error,
+          error: error.class.name,
+          message: error.message[/\A.+$/].inspect)
+        ::Ichnite.log('job_error', data)
+      end
+
+      def stop(context, msg, start)
+        data = context.merge(job_timing(msg, start))
+        ::Ichnite.log('job_stop', data)
+      end
+
+      def job_timing(msg, start)
+        # with clock drift this number can become negative.
+        # Let's take 0 in this case.
+        queued_duration = [0, duration_ms(msg['enqueued_at'], start)].max
+        {
+          queued_for: queued_duration / 1000,
+          duration: duration_ms(start)
+        }
+      end
+
+      def duration_ms(from, to = Time.now.to_f)
+        ((to - from) * 1000).round
+      end
+    end
+
+  end
+end

data/lib/ichnite/version.rb

@@ -1,3 +1,3 @@
 module Ichnite
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ichnite
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Yves Senn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2019-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,8 +69,14 @@ files:
 - bin/setup
 - ichnite.gemspec
 - lib/ichnite.rb
+- lib/ichnite/action_dispatch/structured_exceptions.rb
+- lib/ichnite/active_support/disable_tagged_logging_patch.rb
 - lib/ichnite/formatters.rb
 - lib/ichnite/logger.rb
+- lib/ichnite/rails.rb
+- lib/ichnite/rails/railtie.rb
+- lib/ichnite/sidekiq.rb
+- lib/ichnite/sidekiq/middleware.rb
 - lib/ichnite/testing.rb
 - lib/ichnite/version.rb
 homepage: https://github.com/senny/ichnite
@@ -93,9 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A structured logging library.
 test_files: []
-has_rdoc: