log_toolbox 1.2.0 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7a0a82ef30745dbef3c5bc479a0be875fd881b015254b5650ce15c61611595c
-  data.tar.gz: 797f45b294bdabeaf068df140e3d278dfd20a5b2f23ff684f40d865703bec041
+  metadata.gz: 5ac8156b11e49224b6a2505694346bee18bb52f0672befb14e6e711cff84b45d
+  data.tar.gz: 5319f54b73100e5bc36ee754f8e62732fa6ded6560b73c97a93bdd72e4c1f3df
 SHA512:
-  metadata.gz: 897098929dea4f4105c1eba591d3a133c33c8faada961f09d1e4dc959fd2f6b86801f69d4f863030bce531a5e9ab99706a84944f4f366604b9a1d55d149e5707
-  data.tar.gz: 9a2a119b9dcd418e86684678f24c2b0f49a87799a41d52b4593b907ac143b2b652c9984d2106e0d181c9f83f75848bee29f87c6666e5e9ab292ceb1d1933f572
+  metadata.gz: 97d815d439efa23b6ac48b6aaaa7b977f5af22996460ab922fbf07cf3a99c65211e7ef530a59b3d378582d52f5ae9649a39ad374f31eda8d39b76550ef6ac319
+  data.tar.gz: f8d09ba573af4f0f7ed1cf1c65900c39a0d7c3fb67e15cb0071f5c1302e305a22827afc2149156f357f81454a0dc0b80d108ce883a4f239cc4c616de45d0aabf

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.4] - 2020-12-03
+### Addd
+- 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
+
 ## [1.2.0] - 2019-07-24
 ### Added
 - Add feature to change log level of your application at running time

data/Gemfile.lock

@@ -1,10 +1,13 @@
 PATH
   remote: .
   specs:
-    log_toolbox (1.2.0)
+    log_toolbox (1.3.3)
       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/
@@ -70,6 +73,8 @@ GEM
       railties (>= 4)
       request_store (~> 1.0)
     logstash-event (1.2.02)
+    logstash-logger (0.26.1)
+      logstash-event (~> 1.2)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -78,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)
@@ -123,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)
@@ -152,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)
@@ -165,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

@@ -1,32 +1,75 @@
 # frozen_string_literal: true
 
 require 'lograge'
+require 'logstash-logger'
 
 module LogToolbox
   class LogrageConfig
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    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']
+    LOGSTASH_BUFFER_MAX_INTERVAL = ENV['LOGSTASH_BUFFER_MAX_INTERVAL']
+
     def self.configure
       Rails.application.configure do
-        config.lograge.enabled = true
-        config.lograge.base_controller_class = 'ActionController::API'
-        config.lograge.formatter = Lograge::Formatters::Json.new
-
-        config.lograge.custom_options = lambda do |event|
-          {
-            activityID: event.payload[:activityID],
-            event_at: event.payload[:event_at],
-            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]
-          }
+        log_config = LogToolbox::LogrageConfig.new(config)
+        log_config.configure_log_format
+        if ENV['RAILS_ENV'] == 'development'
+          log_config.configure_log_output_stdout
+        else
+          log_config.configure_log_output_logstash
         end
       end
-      # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+    end
+
+    def initialize(config)
+      @config = config
+    end
+
+    def configure_log_output_logstash
+      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.formatter = config.log_formatter
+      config.logger    = ActiveSupport::TaggedLogging.new(logger)
+    end
+
+    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def configure_log_format
+      config.lograge.enabled = true
+      config.lograge.base_controller_class = 'ActionController::API'
+      config.lograge.formatter = Lograge::Formatters::Json.new
+
+      config.lograge.custom_options = lambda do |event|
+        {
+          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: 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.2.0'
+  VERSION = '1.3.4'
 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
@@ -23,7 +25,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'lograge', '>= 0.11.1'
   spec.add_dependency 'logstash-event', '>= 1.2.02'
-  spec.add_dependency('rails', ['>= 4.0'])
+  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'
@@ -33,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.2.0
+  version: 1.3.4
 platform: ruby
 authors:
 - Caio Almeida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-26 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.02
+- !ruby/object:Gem::Dependency
+  name: logstash-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -52,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
@@ -192,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:
   - - ">="