log_toolbox 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfb310b68412730aaa0bfa5d92a15c8e244486bd58b3123f02ce7e01d4736d66
-  data.tar.gz: fc39e75e6e06dd7b81447d8b1d41fe95a1ce82b8fd0d9b61d5cb02be32f1a605
+  metadata.gz: 242002b9bd8b12b831126fdd8a500608149a3f2f32046813308ed58739d042d4
+  data.tar.gz: 2f26403b6bcb6aa638634d195da70fdfb3abb30620075bbdce5a79cec6f1042c
 SHA512:
-  metadata.gz: 2da7b481ea7dd2c5e496f5e68c8562d89a21e80f97c32fa52439b41f18490bf1c12da1f747720d9e1108425ea6e65d2204304ca02421b114f19e521d434b41dd
-  data.tar.gz: c56341160141cc458888d78d33497c84dc8c875e8a5f407580fe1a81fe7931dfee9da38a56be2192ad5a138b54c2aa9a09920fda40688e5474014b1101973e44
+  metadata.gz: 4cc0b12e1dc369f6f503b6a499fb6005f5a679fc182bc04b36e0d2acb5498ae9bfcf172787416acdf896c0f39231576a67bf48271c853fdb31ff94035e85e274
+  data.tar.gz: 9fde6d9099e3bcf904eafe985a991386be622c6ef81a194d0e4118aada76cf76f3c28e860493ca32b6cc7f247b0d9fbcc8a9354879881019cd9f17aaaf29786f

data/CHANGELOG.md

@@ -6,6 +6,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Released] - 2019-05-21
 
+## [1.3.5] - 2020-12-04
+### FIXED
+- Convert buffer_max_items and buffer_max_interval values to integer
+
+## [1.3.4] - 2020-12-03
+### Added
+- Add settings to buffer_max_items and buffer_max_interval
+
+## [1.3.3] - 2020-11-25
+### Added
+- Parametrize logstash protocol
+- Refactor request logs
+
+## [1.3.2] - 2020-02-19
+### Fixed
+- Fixed log simple sending to logstash
+
+## [1.3.1] - 2019-07-30
+### Fixed
+- Missed log format on posting to logstash
+
 ## [1.3.0] - 2019-07-30
 ### Added
 - Add feature to send log to logstash at stanging and production environment

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    log_toolbox (1.3.0)
+    log_toolbox (1.3.5)
       lograge (>= 0.11.1)
       logstash-event (>= 1.2.02)
       logstash-logger (>= 0.26.1)
       rails (>= 4.0)
+      rspec (>= 3.0.0)
+      rspec-rails
 
 GEM
   remote: https://rubygems.org/
@@ -81,11 +83,11 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.2)
-    mimemagic (0.3.3)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nio4r (2.4.0)
+    nio4r (2.5.4)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
@@ -126,8 +128,12 @@ GEM
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (12.3.2)
-    request_store (1.4.1)
+    request_store (1.5.0)
       rack (>= 1.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
     rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
     rspec-expectations (3.8.4)
@@ -155,10 +161,10 @@ GEM
     ruby-progressbar (1.10.1)
     shoulda-matchers (3.1.3)
       activesupport (>= 4.0.0)
-    sprockets (3.7.2)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -168,9 +174,9 @@ GEM
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -22,7 +22,7 @@ $ gem install log_toolbox
 
 ## Usage
 
-Create a rails initializer 'config/initializers/lograge.rb' with content
+Add this line at the end of your 'config/application.rb'
 
 ```ruby
 LogToolbox::LogrageConfig.configure
@@ -36,6 +36,14 @@ class ApplicationController < ActionController::API
 end
 ```
 
+Add these keys at your '.env' file
+
+```ruby
+# Logstash
+LOGSTASH_URL=utils-hml.aws.guideinvestimentos.com.br
+LOGSTASH_PORT=5001
+```
+
 Now your application log was converted to json pattern.
 
 ### Log at controller

data/bitbucket-pipelines.yml

@@ -8,7 +8,7 @@ pipelines:
           - gem update bundler
           - bundle install
           - gem install rubocop
-          - rspec -fdoc
+          - bundle exec rspec -fdoc
           - rubocop .
 
   branches:

data/lib/log_toolbox/log_helper.rb

@@ -7,7 +7,7 @@ module LogToolbox
         'fatal',
         additional.merge(
           message: error.try(:message),
-          exception_stack: error.try(:backtrace),
+          backtrace: error.try(:backtrace),
           status: 500
         )
       )
@@ -31,7 +31,7 @@ module LogToolbox
 
     private
 
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength
     def default_log(level)
       level = 'CRITICAL' if level == 'FATAL'
       {
@@ -45,7 +45,7 @@ module LogToolbox
         username: request.headers['Authorization']
       }
     end
-    # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength
 
     def log_pattern(level, log_hash)
       log = default_log(level.upcase).merge(log_hash)

data/lib/log_toolbox/log_payload.rb

@@ -12,7 +12,7 @@ module LogToolbox
     def append_info_to_payload(payload)
       super
       payload[:activityID] = request.headers['activityID']
-      payload[:event_at] = I18n.l(Time.now, format: :timestamp)
+      payload[:event_at] = I18n.l(Time.current, format: :timestamp)
       payload[:service_name] = LogUtil.system_service_name
       payload[:version] = LogUtil.system_version
       payload[:origin_ipv4] = request.env['REMOTE_ADDR']

data/lib/log_toolbox/log_simple.rb

@@ -15,11 +15,15 @@ module LogToolbox
         log_pattern('info', additional.merge(message: message))
       end
 
+      def log_debug(message, additional = {})
+        log_pattern('debug', additional.merge(message: message))
+      end
+
       private
 
       def log_pattern(level, log_hash)
         log = default_log(level.upcase).merge(log_hash)
-        puts(normalize_hash(log))
+        Rails.logger.send(level, normalize_hash(log))
       end
 
       def default_log(level)

data/lib/log_toolbox/lograge_config.rb

@@ -7,9 +7,16 @@ module LogToolbox
   class LogrageConfig
     attr_accessor :config
 
+    LOGSTASH_URL = ENV['LOGSTASH_URL']
+    LOGSTASH_PORT = ENV['LOGSTASH_PORT']
+    LOGSTASH_PROTOCOL = ENV.fetch('LOGSTASH_PROTOCOL', 'udp')
+    LOGSTASH_BUFFER_MAX_ITEMS =  ENV['LOGSTASH_BUFFER_MAX_ITEMS'].to_i
+    LOGSTASH_BUFFER_MAX_INTERVAL = ENV['LOGSTASH_BUFFER_MAX_INTERVAL'].to_i
+
     def self.configure
       Rails.application.configure do
         log_config = LogToolbox::LogrageConfig.new(config)
+        log_config.configure_log_format
         if ENV['RAILS_ENV'] == 'development'
           log_config.configure_log_output_stdout
         else
@@ -23,15 +30,17 @@ module LogToolbox
     end
 
     def configure_log_output_logstash
-      config.logger = LogStashLogger.new(type: :udp,
-                                         host: ENV['LOGSTASH_URL'],
-                                         port: ENV['LOGSTASH_PORT'])
+      config.logger = LogStashLogger.new(type: LOGSTASH_PROTOCOL,
+                                         host: LOGSTASH_URL,
+                                         port: LOGSTASH_PORT,
+                                         buffer_max_items: LOGSTASH_BUFFER_MAX_ITEMS || 50,
+                                         buffer_max_interval: LOGSTASH_BUFFER_MAX_INTERVAL || 5)
     end
 
     def configure_log_output_stdout
       return unless ENV['RAILS_LOG_TO_STDOUT'].present?
 
-      logger           = ActiveSupport::Logger.new(STDOUT)
+      logger           = ActiveSupport::Logger.new($stdout)
       logger.formatter = config.log_formatter
       config.logger    = ActiveSupport::TaggedLogging.new(logger)
     end
@@ -44,19 +53,23 @@ module LogToolbox
 
       config.lograge.custom_options = lambda do |event|
         {
-          activityID: event.payload[:activityID],
           event_at: event.payload[:event_at],
+          parameters: event.payload[:params].to_json,
           level: 'INFO',
           service_name: event.payload[:service_name],
           version: event.payload[:version],
           origin_ipv4: event.payload[:origin_ipv4],
           destination_ipv4: event.payload[:destination_ipv4],
-          username: event.payload[:username],
-          exception_stack: event.payload[:exception_stack],
-          response: event.payload[:response]
+          username: wso2_user_name(event.payload[:headers][:HTTP_USER_IDENTIFIER])
         }
       end
     end
     # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+
+    def wso2_user_name(http_user_identifier)
+      return nil unless http_user_identifier.is_a? String
+
+      http_user_identifier ? JSON.parse(Base64.decode64(http_user_identifier))['user_name'] : nil
+    end
   end
 end

data/lib/log_toolbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogToolbox
-  VERSION = '1.3.0'
+  VERSION = '1.3.5'
 end

data/log_toolbox.gemspec

@@ -4,17 +4,19 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'log_toolbox/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
-  spec.name          = 'log_toolbox'
-  spec.version       = LogToolbox::VERSION
-  spec.authors       = ['Caio Almeida']
-  spec.email         = ['cbalmeida@guide.com.br']
+  spec.name                   = 'log_toolbox'
+  spec.version                = LogToolbox::VERSION
+  spec.authors                = ['Caio Almeida']
+  spec.email                  = ['cbalmeida@guide.com.br']
 
-  spec.summary       = 'Guide default gem for ruby application logging'
-  spec.homepage      = 'http://bitbucket.org/guideinvestimentos/log_toolbox'
-  spec.license       = 'Guide'
+  spec.required_ruby_version  = '>= 2.4.0'
+  spec.summary                = 'Guide default gem for ruby application logging'
+  spec.homepage               = 'http://bitbucket.org/guideinvestimentos/log_toolbox'
+  spec.license                = 'Guide'
 
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files                  = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/})
     end
@@ -25,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'logstash-event', '>= 1.2.02'
   spec.add_dependency 'logstash-logger', '>= 0.26.1'
   spec.add_dependency 'rails', ['>= 4.0']
+  spec.add_dependency 'rspec', '>= 3.0.0'
+  spec.add_dependency 'rspec-rails'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
@@ -34,3 +38,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
 end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_toolbox
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - Caio Almeida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="