loggun 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8815d61a25fc71e36d6648e2e65fd7d6d73ebffd56e0b4631c95e589a5b9ced4
-  data.tar.gz: a6d4aea0a8971708fc3eb78eb42c50d99afb6fcbfec1e4dad5753c6552865566
+  metadata.gz: 3a8a4d4015105e9d55b653cab3305ab2b1ddeeda0e1429bd5e2449c5841771fe
+  data.tar.gz: e6a84389338458849f87dfb2ffcdea13403537553fa547b170c4debb5901f433
 SHA512:
-  metadata.gz: aa4ee9f1f9d4a2fe3dae09083a9554c30d28d3821a5de8230db81efeef204e36e075c79335d4e7b587ead7a20da17cdf81b695acd6f00d27c751109ea2753902
-  data.tar.gz: 52768e02e7021307b455d5c5b7e2a55cda78152e61d387a2eff6cb1878060ea9b885d09b09c6b5f3c586eb9d33a0e8b6724e2827769f98d8c241f69920d16034
+  metadata.gz: f10eb810cb421dde460b1c97c777496447d22197dfdbf35bf6eae341a1b9b2a6270044135887a062882c0f8bf4ccc21efbfe3231598ee7f060ca5be220385a6f
+  data.tar.gz: 3362704777d4d6814ba58e1a72aee945d5f1f8105d03ff20930e3ecd02d559d5878f90681a77aefd14231aef67dbb79b41cd1883a5cbc6e54a8fa3817c1a49c9

data/README.md

@@ -92,6 +92,16 @@ end
 `error_info` - лямбда, позволяющая добавить в лог информацию об ошибке, содержащейся в неуспешном ответе экшена. 
 Например `-> { JSON.parse(response.body)['error_code'] }`
 
+Для Rails 6 и выше данный модификатор может работать некорректно. 
+В этом случае можно указать в требуемом базовом контроллере строку:
+```ruby
+include Loggun::HttpHelpers
+```
+Это делает настройки `enable` и `controllers` модификатора безсполезными, 
+однако позволяет гарантированно логировать входящие http запросы.
+
+Настройки `success_condition` и `error_info` продолжают использоваться и могу быть установлены требуемым образом.
+
 Помимо указанных модификаторов существует возможность добавить собственный. 
 Необходимо уснаследовать его от `Loggun::Modifiers::Base` и указать в методе `apply` все необходимые действия.
 ```ruby

data/lib/loggun.rb

@@ -5,6 +5,8 @@ require 'loggun/config'
 require 'loggun/modifiers'
 require 'loggun/modifiers/base'
 require 'loggun/helpers'
+require 'loggun/http_helpers'
+require 'logger'
 
 module Loggun
   class Error < StandardError; end
@@ -12,10 +14,22 @@ module Loggun
   class << self
     include Loggun::Helpers
 
-    attr_accessor :application
+    attr_writer :logger
 
     %i[unknown fatal error warn info debug].each do |method|
       alias_method method, "log_#{method}"
     end
+
+    def logger
+      @logger ||= default_logger
+    end
+
+    private
+
+    def default_logger
+      logger = Logger.new(STDOUT)
+      logger.formatter = Config.instance.formatter
+      logger
+    end
   end
 end

data/lib/loggun/config.rb

@@ -56,8 +56,8 @@ module Loggun
       end
 
       def setup_formatter(app)
-        Loggun.application = app
-        Loggun.application.logger.formatter = instance.formatter
+        Loggun.logger = app.logger
+        Loggun.logger.formatter = instance.formatter
       end
     end
 

data/lib/loggun/formatter.rb

@@ -1,4 +1,5 @@
-require 'date'
+require 'time'
+require 'json'
 
 module Loggun
   class Formatter
@@ -17,13 +18,14 @@ module Loggun
       end
 
       data[:message] = message.to_s.tr("\r\n", ' ').strip
-      data[:severity] = severity&.present? ? severity.to_s : 'INFO'
+      data[:severity] = severity&.to_s || 'INFO'
       data[:tags_text] = tags_text
       data[:type] = Loggun.type || DEFAULT_VALUE.dup
       data[:transaction_id] = Loggun.transaction_id
       data[:parent_transaction] = parent_transaction if parent_transaction
 
-      if data[:transaction_id]&.to_i != Process.pid && data[:type] != DEFAULT_VALUE
+      if data[:transaction_id] && data[:type] != DEFAULT_VALUE &&
+         data[:transaction_id].to_i != Process.pid
         data[:type] = "#{data[:type]}##{data[:transaction_id]}"
       end
 

data/lib/loggun/helpers.rb

@@ -60,8 +60,8 @@ module Loggun
     %i[unknown fatal error warn info debug].each do |method|
       define_method("log_#{method}") do |*args, **attrs, &block|
         type = args.shift
-        next application.logger.send(method, type, &block) if args.empty? &&
-                                                              attrs.empty?
+        next logger.send(method, type, &block) if args.empty? &&
+                                                  attrs.empty?
 
         method_name = caller_locations.first.label.split(' ').last
         type = log_type(type, method_name)
@@ -78,10 +78,10 @@ module Loggun
             attrs[:hidden] = { error: { backtrace: error.backtrace } }
           end
         end
-        attrs[:value] = args if args.present?
+        attrs[:value] = args unless args.empty?
 
         with_type(type) do
-          application.logger.send(method, **attrs, &block)
+          logger.send(method, **attrs, &block)
         end
       end
     end
@@ -171,8 +171,8 @@ module Loggun
       "#{SecureRandom.uuid[0..7]}_#{DateTime.now.strftime('%Q')}"
     end
 
-    def application
-      Loggun.application
+    def logger
+      Loggun.logger
     end
   end
 end

data/lib/loggun/http_helpers.rb

@@ -0,0 +1,48 @@
+module Loggun
+  module HttpHelpers
+    def self.included(klass)
+      klass.class_eval do
+        around_action :log_http_actions
+      end
+    end
+
+    private
+
+    def log_http_actions
+      log_action :start
+      yield
+      log_action :response
+    rescue StandardError => e
+      log_action :response, fail: e
+      raise e
+    end
+
+    def log_action(action = :start, fail: nil)
+      api = request.path[/\w+/]
+      api_version = request.path[/v./]
+      type = "http_request.#{api}.#{action}"
+      data = { path: clean_pathname }
+      data[:api_version] = api_version if api_version
+
+      return Loggun.info type, data if action == :start
+
+      success = fail.nil? && instance_exec(&modifier_config.success_condition)
+      data[:success] = success
+      unless success
+        error = instance_exec(&modifier_config.error_info)
+        data[:error] = error if error
+      end
+      Loggun.info type, data
+    end
+
+    def clean_pathname
+      filtered_params = params.to_unsafe_h
+      filtered_params.delete('action')
+      request.path.gsub(/(#{filtered_params.values.join('|')})/, '').gsub(/\/api\/v./, '')
+    end
+
+    def modifier_config
+      Loggun::Config.instance.modifiers.incoming_http
+    end
+  end
+end

data/lib/loggun/modifiers/incoming_http.rb

@@ -1,5 +1,3 @@
-require_relative 'incoming_http/log_http_actions'
-
 module Loggun
   module Modifiers
     class IncomingHttp < Loggun::Modifiers::Base
@@ -9,8 +7,7 @@ module Loggun
         controllers = Loggun::Config.instance.modifiers.incoming_http.controllers
         controllers.each do |controller|
           controller.constantize.class_eval do
-            include LogHttpActions
-            around_action :log_http_actions
+            include Loggun::HttpHelpers
           end
         end
       end

data/lib/loggun/version.rb

@@ -1,3 +1,3 @@
 module Loggun
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/loggun.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'clockwork', '~> 2.0'
   spec.add_development_dependency 'http', '~> 4.0'
   spec.add_development_dependency 'rails', '~> 6.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-rails', '~> 3.0'
   spec.add_development_dependency 'sidekiq', '~> 6.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggun
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aleksandr Noskov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -144,13 +144,13 @@ files:
 - lib/loggun/config.rb
 - lib/loggun/formatter.rb
 - lib/loggun/helpers.rb
+- lib/loggun/http_helpers.rb
 - lib/loggun/modifiers.rb
 - lib/loggun/modifiers/base.rb
 - lib/loggun/modifiers/clockwork.rb
 - lib/loggun/modifiers/clockwork/manager.rb
 - lib/loggun/modifiers/clockwork/methods.rb
 - lib/loggun/modifiers/incoming_http.rb
-- lib/loggun/modifiers/incoming_http/log_http_actions.rb
 - lib/loggun/modifiers/outgoing_http.rb
 - lib/loggun/modifiers/outgoing_http/block_logger.rb
 - lib/loggun/modifiers/rails.rb

data/lib/loggun/modifiers/incoming_http/log_http_actions.rb

@@ -1,36 +0,0 @@
-module LogHttpActions
-
-  private
-
-  def log_http_actions
-    log_action :start
-    yield
-    log_action :response
-  end
-
-  def log_action(action = :start)
-    api = request.path[/\w+/]
-    api_version = request.path[/v./]
-    type = "http_request.#{api}.#{action}"
-    data = { path: clean_pathname, api_version: api_version }
-    return Loggun.info type, data if action == :start
-
-    success = instance_exec(&modifier_config.success_condition)
-    data[:success] = success
-    unless success
-      error = instance_exec(&modifier_config.error_info)
-      data[:error] = error if error
-    end
-    Loggun.info type, data
-  end
-
-  def clean_pathname
-    filtered_params = params.to_unsafe_h
-    filtered_params.delete('action')
-    request.path.gsub(/(#{filtered_params.values.join('|')})/, '').gsub(/\/api\/v./, '')
-  end
-
-  def modifier_config
-    Loggun::Config.instance.modifiers.incoming_http
-  end
-end