RTALogger 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c31a37c1f8f9ce88c8fae11d7df9fe88d397e9e21da9c8b13ddce48fe5e216c5
-  data.tar.gz: 920e2000e9cf216dea8251dd6e6b5b2e3e2c114533e7459cd698eb2131c69c65
+  metadata.gz: 7e81de465e520fd877b0a8be28723ca3df6edc4770a06811cd1321a47a9fe009
+  data.tar.gz: ee63b302ec830dcc25cab746f2b5adb6071b2677c1ed4d07884b933946b3e7ca
 SHA512:
-  metadata.gz: 626deeb001694ef40e87743bb61742f1db0cbeeb46125f1f7b3185a52d33494d811439c3bc9d669c15e60563c9dc71d305159d3c801c06cdfcce82c4450970d0
-  data.tar.gz: 2a3a39efce340c0e0e204ebf6390d17283f6804b3846b3b086e849c25d92e9aec9994beb2a06ab6c81cf10a9abc8af0ded19d37317adbbe5abe16c1744a43aff
+  metadata.gz: 527aead929bac69790be99d22b5d5e0232c96908f8c7935fb9877a2561b2b4cea82bb3ac4cd5b0f869b677e202d52e6b0bddd3bb845a2154b45436729fd3a9ad
+  data.tar.gz: be339710ef0c3cf2dd045e165062a058ba3b8a509777522f519505888255f051e5994cb8c2929d17797c06d7b8475d7f08b5e37d2c9d6d5ce48155b067c54ba7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    RTALogger (2.1.0)
+    RTALogger (2.3.0)
       fluent-logger (~> 0.9)
       jbuilder (~> 2.10)
 

data/README.md

@@ -94,7 +94,7 @@ To use log manager APIs, first step is to have a quick review on Log Data Struct
         "app_name": "TestApp",
         "severity_level": "trace",
         "buffer_size": 100,
-        "flush_wait_seconds": 10,
+        "flush_wait_seconds": 5,
         "repositories":
         [
           {
@@ -104,7 +104,8 @@ To use log manager APIs, first step is to have a quick review on Log Data Struct
             "formatter":
             {
               "type": "text",
-              "delimiter": "|"
+              "delimiter": "|",
+              "colorize": true
             },
             "filters":
             [
@@ -206,7 +207,7 @@ the result will be:
         "app_name": "TestApp",
         "severity_level": "trace",
         "buffer_size": 100,
-        "flush_wait_seconds": 10,
+        "flush_wait_seconds": 5,
         "repositories":
         [
           {
@@ -216,7 +217,8 @@ the result will be:
             "formatter":
             {
               "type": "text",
-              "delimiter": "|"
+              "delimiter": "|",
+              "colorize": true
             },
             "filters":
             [
@@ -291,7 +293,7 @@ the result will be:
       - buffer_size: Minimune possible value for this attribute is 100 and defines memory buffer size (number of buffered log objects) to 
         decread api consumers wait time. when the buffer is full the flush operation will
         save buffered logs to log repositoies.
-      - flush_wait_seconds: Minimum possible value for this attribure is 10 seconds and defines time in soconds which log managers wait to flush buffered log records
+      - flush_wait_seconds: Minimum possible value for this attribure is 5 seconds and defines time in soconds which log managers wait to flush buffered log records
         to log repository.
       - repositories: Array of log repositories. It is possible to define multiple log repositories to
         store log data. there are variaty of log repositories and it is possible to
@@ -305,6 +307,8 @@ the result will be:
              - "foramtter" is the text, json or any custome defined types as LogRecord formatter
                 - "type": ["text"/"json"] type of formatter
                 - "delimiter": [any text delimiter you need.(as an instance pipe line "|")]
+                - "colorize": [true/false] default value of this attribute is false. 
+                   if you need to colorize your out put format on standard output set this attribute to true.
                 if formatter not defined then the json formatter will be used
           2- file: Store log data in a file.
              - "type": "console"
@@ -348,13 +352,14 @@ the result will be:
                "enable": [true/false] this will enable or disable filtering opration of current filter.
                "default_regex": "valid regual expression" to compare with corresponding attribute.
              * It's possible to implement customize filter classes and integerate with RTALogger filter factory. 
+             * In RTALogger version 2.2.0 colorize out put format is availabel.
         - topics: This is an optional item. When you need to customize a specific topic severity level or
                   enable value, you can define the settings here.
           - title: The topic title to customize. (mandatoy).
           - severity_level: Defines which level of log data will be stored in log repositories.
           - enable: [true/false] to enable or disable logging process of the topic.
 ```
-###Some useful features
+##Some useful features
 ```ruby
     # change log manager app name at run time
     log_manager.app_name = 'myTestApp'
@@ -387,7 +392,7 @@ the result will be:
     # log_manager.enable
     # log_manager.default_severity_level    
     # log_manager.buffer_size (minimum is 100)
-    # log_manager.flush_wait_time (minimum 15 second)
+    # log_manager.flush_wait_time (minimum 5 second)
     # repository.enable
     # topic.enable
     # topic.severity_level

data/lib/RTALogger/version.rb

@@ -1,3 +1,3 @@
 module RTALogger
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/lib/log_factory_filter.rb

@@ -9,7 +9,7 @@ module RTALogger
       begin
         load lib_file
       rescue
-        raise "unable to load formatter class file: #{lib_file}"
+        raise "unable to load filter class file: #{lib_file}"
       end
 
       filter_class_name = 'RTALogger::' + ('log_filter_' + type.to_s).split('_').map(&:capitalize).join

data/lib/log_factory_log_formatter.rb

@@ -21,7 +21,7 @@ module RTALogger
       return nil unless formatter_class
       result = formatter_class.new
 
-      return result if config_json.empty?
+      return result if config_json.nil? || config_json.empty?
       result.load_config(config_json) if result.present?
       return result
     end

data/lib/log_filter_base.rb

@@ -3,11 +3,14 @@ module RTALogger
     def initialize
       @title = self.class.to_s.split('::').last.underscore
       @enable = true
+      @action = :accept
     end
 
     attr_accessor :title
     attr_accessor :enable
     attr_accessor :default_regex
+    # possible values: accept, ignore
+    attr_accessor :action
 
     def match_conditions(log_record)
       return true if !@enable
@@ -18,11 +21,13 @@ module RTALogger
       @title = config_json['title'] if config_json['title'].present?
       @enable = config_json['enable'].nil? ? true : config_json['enable'].present?
       @default_regex = config_json['default_regex'] if config_json['default_regex'].present?
+      @action = valid_action(config_json['action']) if config_json['action'].present?
     end
 
     def apply_run_time_config(config_json)
       @enable = config_json['enable'].nil? ? true : config_json['enable'].present?
       @default_regex = config_json['default_regex'] if config_json['default_regex'].present?
+      @action = valid_action(config_json['action']) if config_json['action'].present?
     end
 
     def to_builder
@@ -35,5 +40,18 @@ module RTALogger
 
       jb
     end
+
+    private
+
+    def valid_action(action_value)
+      case action_value.to_s.downcase
+      when 'accept'
+        :accept
+      when 'ignore'
+        :ignore
+      else
+        :accept
+      end
+    end
   end
 end

data/lib/log_filter_context.rb

@@ -7,7 +7,9 @@ module RTALogger
       result = super
       return result unless result
 
-      return default_regex.present? ? (Regexp.new(@default_regex).match(log_record.context_id.to_s)) : result
+      result = default_regex.present? ? (Regexp.new(@default_regex).match(log_record.context_id.to_s)) : result
+      result = !result if @action == :ignore
+      return result
     end
   end
 end

data/lib/log_filter_message.rb

@@ -7,7 +7,9 @@ module RTALogger
       result = super
       return result unless result
 
-      return default_regex.present? ? (Regexp.new(@default_regex).match(log_record.full_message)) : result
+      result = default_regex.present? ? (Regexp.new(@default_regex).match(log_record.full_message)) : result
+      result = !result if @action == :ignore
+      return result
     end
   end
 end

data/lib/log_filter_topic.rb

@@ -7,7 +7,9 @@ module RTALogger
       result = super
       return result unless result
 
-      return default_regex.present? ? (Regexp.new(@default_regex).match(log_record.topic_title)) : result
+      result = default_regex.present? ? (Regexp.new(@default_regex).match(log_record.topic_title)) : result
+      result = !result if @action == :ignore
+      return result
     end
   end
 end

data/lib/log_formatter_base.rb

@@ -1,16 +1,24 @@
 require 'jbuilder'
 require_relative 'string'
+require_relative 'severity_level'
 
 module RTALogger
   class LogFormatterBase
+    include SeverityLevel
+
     def initialize
       @delimiter = '|'
+      @colorize = false
     end
 
     attr_accessor :delimiter
+    attr_accessor :colorize
 
     def load_config(config_json)
+      return unless config_json.present?
+
       @delimiter = config_json['delimiter'].nil? ? true : config_json['delimiter']
+      @colorize = config_json['colorize'].nil? ? false : config_json['colorize']
     end
 
     def format(log_record)
@@ -20,7 +28,8 @@ module RTALogger
     def to_builder
       jb = Jbuilder.new do |json|
         json.type self.class.to_s.split('::').last.underscore.sub('log_formatter_', '')
-        json.delimiter delimiter
+        json.delimiter @delimiter
+        json.colorize @colorize
       end
 
       jb
@@ -29,5 +38,41 @@ module RTALogger
     def reveal_config
       to_builder.target!
     end
+
+    def apply_run_time_config(config_json)
+      return unless config_json.present?
+
+      @delimiter = config_json['delimiter'] unless config_json['delimiter'].nil?
+      @colorize = config_json['colorize'] unless config_json['colorize'].nil?
+    end
+
+    protected
+
+    def severity_text(severity)
+      text = parse_severity_level_to_s(severity)
+      text = severity_colorized_text(severity, text) if @colorize
+      return text
+    end
+
+    def severity_colorized_text(severity, text)
+      case severity
+      when 0
+        text.trace_color
+      when 1
+        text.debug_color
+      when 2
+        text
+      when 3
+        text.warning_color
+      when 4
+        text.error_color
+      when 5
+        text.fatal_color
+      when 6
+        text.unknown_color
+      else
+        text
+      end
+    end
   end
 end

data/lib/log_formatter_json.rb

@@ -1,12 +1,11 @@
 require 'jbuilder'
 require_relative 'log_formatter_base'
-require_relative 'severity_level'
+require_relative 'string'
 
 module RTALogger
   # json formatter which receive log_record and
   # returns it's data as json string
   class LogFormatterJson < LogFormatterBase
-    include SeverityLevel
 
     def format(log_record)
       return '' unless log_record
@@ -20,7 +19,21 @@ module RTALogger
         json.message log_record.message.flatten.join(' ')
       end
 
-      jb.target!
+      result = jb.target!
+      result = colorize_json(result) if @colorize
+
+      return result
+    end
+
+    protected
+
+    def colorize_json(json_text)
+      json_text.gsub(/"severity":"TRACE"/i, '"severity":"TRACE"'.trace_color)
+               .gsub(/"severity":"DEBUG"/i, '"severity":"DEBUG"'.debug_color)
+               .gsub(/"severity":"WARN"/i, '"severity":"WARN"'.warning_color)
+               .gsub(/"severity":"ERROR"/i, '"severity":"ERROR"'.error_color)
+               .gsub(/"severity":"FATAL"/i, '"severity":"FATAL"'.fatal_color)
+               .gsub(/"severity":"UNKNOWN"/i, '"severity":"UNKNOWN"'.unknown_color)
     end
   end
 end

data/lib/log_formatter_text.rb

@@ -1,12 +1,9 @@
 require_relative 'log_formatter_base'
-require_relative 'severity_level'
 
 module RTALogger
   # text formatter which receive log_record and
   # returns it's data as delimited text string
   class LogFormatterText < LogFormatterBase
-    include SeverityLevel
-
     def format(log_record)
       return '' unless log_record
 
@@ -14,7 +11,7 @@ module RTALogger
       result << @delimiter << log_record.app_name
       result << @delimiter << log_record.topic_title
       result << @delimiter << log_record.context_id.to_s
-      result << @delimiter << parse_severity_level_to_s(log_record.severity)
+      result << @delimiter << severity_text(log_record.severity)
       result << @delimiter << log_record.message.join(' ').gsub(delimiter, '$<$')
 
       result

data/lib/log_manager.rb

@@ -27,7 +27,7 @@ module RTALogger
       @topic_semaphore = Mutex.new
       @log_semaphore = Mutex.new
       self.buffer_size = ENV.fetch('RTA_LOGGER_BUFFER_SIZE', 100)
-      self.flush_wait_time = ENV.fetch('RTA_LOGGER_FLUSH_WAIT_SECONDS', 15)
+      self.flush_wait_time = ENV.fetch('RTA_LOGGER_FLUSH_WAIT_SECONDS', 5)
       @topics = {}
       @log_records = []
       @propagator = LogFactory.new_log_propagator
@@ -64,13 +64,14 @@ module RTALogger
     end
 
     def flush_wait_time=(time_in_seconds)
-      @flush_wait_time = time_in_seconds < 10 ? 10 : time_in_seconds
+      @flush_wait_time = time_in_seconds < 5 ? 5 : time_in_seconds
     end
 
     def config_use_json_file(file_name, title = '')
       config_json = load_config_from_json_file(file_name, title)
       @config_file_name = file_name if config_json
       apply_config(config_json)
+      self
     rescue StandardError => e
       @propagator.drop_all_repositories
       @propagator.add_log_repository(LogFactory.create_repository(:console))
@@ -79,6 +80,7 @@ module RTALogger
     def config_use_json_string(config_string, title = '')
       config_json = load_config_from_json_string(config_string, title)
       apply_config(config_json)
+      self
     rescue StandardError => e
       @propagator.drop_all_repositories
       @propagator.add_log_repository(LogFactory.create_repository(:console))

data/lib/log_propagator.rb

@@ -92,7 +92,7 @@ module RTALogger
         if repository.present?
           repository.apply_run_time_config(repository_config)
         else
-          repository = ::RTALogger::LogFactory.create_repository(repository_config['type'], config_json)
+          repository = ::RTALogger::LogFactory.create_repository(repository_config['type'], repository_config)
           add_log_repository(repository)
         end
       end

data/lib/log_repository.rb

@@ -47,9 +47,8 @@ module RTALogger
       @enable = config_json['enable'].nil? ? true : config_json['enable']
       @title = config_json['title'].nil? ? self.class.to_s.split('::').last.underscore : config_json['title']
       formatter_config = config_json['formatter']
-      if formatter_config && formatter_config['type']
-        @formatter = LogFactory.create_formatter(formatter_config['type'], formatter_config)
-      end
+
+      @formatter = LogFactory.create_formatter(formatter_config['type'], formatter_config) if formatter_config && formatter_config['type']
 
       apply_config_filters(config_json)
     end
@@ -57,6 +56,7 @@ module RTALogger
     def to_builder
       jb = Jbuilder.new do |json|
         json.type self.class.to_s.split('::').last.underscore.sub('log_repository_', '')
+        json.title @title
         json.enable enable
         json.formatter @formatter.to_builder.attributes!
         json.filters do
@@ -86,6 +86,7 @@ module RTALogger
     def apply_run_time_config(config_json)
       return unless config_json
       @enable = config_json['enable'] unless config_json['enable'].nil?
+      @formatter.apply_run_time_config(config_json['formatter'])
       apply_run_time_config_filters(config_json)
     end
 

data/lib/log_repository_file.rb

@@ -36,6 +36,8 @@ module RTALogger
 
     def apply_run_time_config(config_json)
       super config_json
+
+      @formatter.colorize = false
     end
 
     protected

data/lib/log_repository_fluentd.rb

@@ -62,6 +62,8 @@ module RTALogger
       @port = config_json['port'] unless config_json['port'].nil?
       @tls_options = config_json['tls_options'] unless config_json['tls_options'].nil?
       @semaphore.synchronize { @fluent_logger = nil }
+
+      @formatter.colorize = false
     end
 
     protected

data/lib/rta_logger_config.json

@@ -10,7 +10,7 @@
         "app_name": "TestApp",
         "severity_level": "trace",
         "buffer_size": 100,
-        "flush_wait_seconds": 10,
+        "flush_wait_seconds": 5,
         "repositories":
         [
           {
@@ -20,18 +20,21 @@
             "formatter":
             {
               "type": "text",
-              "delimiter": "|"
+              "delimiter": "|",
+              "colorize": true
             },
             "filters":
             [
               {
                 "type": "topic",
+                "action" : "ignore",
                 "title": "topic_filter_1",
-                "enable": true,
-                "default_regex" : "^test$"
+                "enable": false,
+                "default_regex" : "^test$",
               },
               {
                 "type": "message",
+                "action" : "accept",
                 "title": "message_filter_1",
                 "enable": false,
                 "default_regex" : "error"
@@ -52,9 +55,9 @@
             }
           },
           {
-            "enable": false,
             "title": "fluentd_repo_1",
             "type": "fluentd",
+            "enable": false,
             "host": "localhost",
             "port": "8888",
             "formatter":

data/lib/sample.rb

@@ -1,5 +1,14 @@
 require_relative 'log_factory_manager'
 require_relative 'log_factory_repository'
+# require_relative 'string'
+
+# puts 'trace'.gray
+# puts 'debug'.green
+# puts 'info'
+# puts 'warning'.brown
+# puts 'error'.red
+# puts 'fatal'.bg_red
+# puts 'unknown'.bg_cyan
 
 controller_name = 'test_controller'
 userID = 5

data/lib/string.rb

@@ -1,9 +1,40 @@
 class String
   def underscore
     self.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+        gsub(/([a-z\d])([A-Z])/, '\1_\2').
         tr("-", "_").
         downcase
   end
+
+  def black;          "\e[30m#{self}\e[0m" end
+  def red;            "\e[31m#{self}\e[0m" end
+  def green;          "\e[32m#{self}\e[0m" end
+  def brown;          "\e[33m#{self}\e[0m" end
+  def blue;           "\e[34m#{self}\e[0m" end
+  def magenta;        "\e[35m#{self}\e[0m" end
+  def cyan;           "\e[36m#{self}\e[0m" end
+  def gray;           "\e[37m#{self}\e[0m" end
+
+  def bg_black;       "\e[40m#{self}\e[0m" end
+  def bg_red;         "\e[41m#{self}\e[0m" end
+  def bg_green;       "\e[42m#{self}\e[0m" end
+  def bg_brown;       "\e[43m#{self}\e[0m" end
+  def bg_blue;        "\e[44m#{self}\e[0m" end
+  def bg_magenta;     "\e[45m#{self}\e[0m" end
+  def bg_cyan;        "\e[46m#{self}\e[0m" end
+  def bg_gray;        "\e[47m#{self}\e[0m" end
+
+  def bold;           "\e[1m#{self}\e[22m" end
+  def italic;         "\e[3m#{self}\e[23m" end
+  def underline;      "\e[4m#{self}\e[24m" end
+  def blink;          "\e[5m#{self}\e[25m" end
+  def reverse_color;  "\e[7m#{self}\e[27m" end
+
+  def trace_color; self.gray end
+  def debug_color; self.green end
+  def warning_color; self.brown end
+  def error_color; self.red end
+  def fatal_color; self.bg_red end
+  def unknown_color; self.bg_cyan end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RTALogger
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Babak Bahreini, RTA Backend Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger