RTALogger 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 344cc6430343748963541c7f025549d8ee80007f8abc30fa6218b8924fe73755
-  data.tar.gz: 4c84b47e1f0a6d9007c1d0df5dc210955e3a0c525851a2edd46be8732b4e8d57
+  metadata.gz: 6e3e0080b58239ca52e5c80dceab5dfacd7202d25dbef441695c8f3fef56ad70
+  data.tar.gz: 40f0c55f14e92a4207b932e6090c14db5b6177fbc10e0f5c642ceb65c2c5e2b3
 SHA512:
-  metadata.gz: 0a8e5f960166d6dd6ffc5627d61eedcc4bd0a3e15dcbc9dc2bcc4d8d6da20810ddc05a302931001165e28eee7e6db1c4513cc352b8425091f8a1271ecd05cdd0
-  data.tar.gz: 4c3a4cb3e2458afbceceabd517083565992ae034ca8f5ad9baddb580ab37919d422e7f9e670ae94a62aecbad3eab9e9bee768cab03e747b1e2510900c623c06d
+  metadata.gz: 50e947dbcfbbda443696f07bc804b982a7310407580d429011f1932cdb304707eb303346445edb98c4cd0f140ca8ba46a4d84f5752f9017db4c64e9871b3886c
+  data.tar.gz: d9414ec73afcede5e67987fe83de43afc3ce5312db5b7089358bd4c1162004fbdaab2dbe48c02e8191d82a9a64bf2c69f5501ced9288aec49fee42bfc7f71b24

data/Gemfile.lock

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

data/README.md

@@ -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":
             [
@@ -216,7 +217,8 @@ the result will be:
             "formatter":
             {
               "type": "text",
-              "delimiter": "|"
+              "delimiter": "|",
+              "colorize": true
             },
             "filters":
             [
@@ -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,6 +352,7 @@ 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).

data/lib/RTALogger/version.rb

@@ -1,3 +1,3 @@
 module RTALogger
-  VERSION = '2.1.2'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/log_formatter_base.rb

@@ -1,16 +1,22 @@
 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)
       @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 +26,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 +36,39 @@ module RTALogger
     def reveal_config
       to_builder.target!
     end
+
+    def apply_run_time_config(config_json)
+      @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_colorj
+      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_repository.rb

@@ -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)
       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

@@ -20,14 +20,15 @@
             "formatter":
             {
               "type": "text",
-              "delimiter": "|"
+              "delimiter": "|",
+              "colorize": true
             },
             "filters":
             [
               {
                 "type": "topic",
                 "title": "topic_filter_1",
-                "enable": true,
+                "enable": false,
                 "default_regex" : "^test$"
               },
               {

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.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Babak Bahreini, RTA Backend Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger