RTALogger 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4c558e31bfbc739d0ad9ebb218c96c61fdcc354b6ae9a9c0daa3ea4743786c3
-  data.tar.gz: b00ec909d9a8791671e29e949fb19cfb31e59d7fbf353532a70bfb216e6b4e45
+  metadata.gz: c27d68d46d9d0ff75577b50a1b29983ce9012bc1d3dc86778b197154596ab2c5
+  data.tar.gz: 53ebb2215c5a2e4733de28b9178c9d4db5713aa87483309407be0de1763b36f1
 SHA512:
-  metadata.gz: c6296831235e737111217cf51f4e3d477620d588319fb0540760b948028b26f87361e03cc7c453dd00ab3c4553a26ad045791e2d9e64d1153017246e664348bd
-  data.tar.gz: 39885f5f4f039199748d9201f632ac4e745bd41cced49971ddc70b9599281c556a2d85e3fb13332a76cb0b01d78f1efb88d510331071332ccfdcbd26528543a7
+  metadata.gz: e731b3cd50b9c13b017679a34e9136b743055e50892017a73890d5f74031f6d88fc437b8a26dee5abe8207fcc9c1616c83ab998f77ee216701c2fd0d98220cc2
+  data.tar.gz: 871fd3047f195f7076e08eeec631bc3f0143ea4c4f8ae483bf054e244e5e6f75541f775f0b4f973e8127a592cace225922357fb7f9167f00623f3845bd0573b7

data/Gemfile.lock

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

data/lib/RTALogger/version.rb

@@ -1,3 +1,3 @@
 module RTALogger
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/log_factory_log_formatter.rb

@@ -1,3 +1,5 @@
+require_relative 'log_formatter_base'
+
 module RTALogger
   # Log factory to get new instance of log formatter
   module LogFactory
@@ -8,7 +10,6 @@ module RTALogger
     def self.create_formatter(type, config_json = '')
       lib_file = @log_formatters[type.to_sym]
       raise "unregistered formatter class: #{type.to_s}" if lib_file.nil? || lib_file.empty?
-
       begin
         load lib_file
       rescue
@@ -30,6 +31,6 @@ module RTALogger
     end
 
     @log_formatters = {:text => 'log_formatter_text.rb',
-                          :json =>  'log_formatter_json.rb'}
+                       :json =>  'log_formatter_json.rb'}
   end
 end

data/lib/log_factory_repository.rb

@@ -32,6 +32,6 @@ module RTALogger
     @log_repositories = {:console => 'log_repository_console.rb',
                           :file =>  'log_repository_file.rb',
                           :udp =>  'log_repository_upd.rb',
-                          :fluentd => 'log_repository_fluetnd.rb'}
+                          :fluentd => 'log_repository_fluentd.rb'}
   end
 end

data/lib/log_formatter_base.rb

@@ -0,0 +1,33 @@
+require 'jbuilder'
+require_relative 'string'
+
+module RTALogger
+  class LogFormatterBase
+    def initialize
+      @delimiter = '|'
+    end
+
+    attr_accessor :delimiter
+
+    def load_config(config_json)
+      @delimiter = config_json['delimiter'].nil? ? true : config_json['delimiter']
+    end
+
+    def format(log_record)
+      log_record.to_s
+    end
+
+    def to_builder
+      jb = Jbuilder.new do |json|
+        json.type self.class.to_s.split('::').last.underscore.sub('log_formatter_', '')
+        json.delimiter delimiter
+      end
+
+      jb
+    end
+
+    def reveal_config
+      to_builder.target!
+    end
+  end
+end

data/lib/log_formatter_json.rb

@@ -1,10 +1,10 @@
 require 'jbuilder'
-require_relative 'log_formatter'
+require_relative 'log_formatter_base'
 
 module RTALogger
   # json formatter which receive log_record and
   # returns it's data as json string
-  class LogFormatterJson < LogFormatter
+  class LogFormatterJson < LogFormatterBase
     def format(log_record)
       return '' unless log_record
 

data/lib/log_formatter_text.rb

@@ -1,9 +1,9 @@
-require_relative 'log_formatter'
+require_relative 'log_formatter_base'
 
 module RTALogger
   # text formatter which receive log_record and
   # returns it's data as delimited text string
-  class LogFormatterText < LogFormatter
+  class LogFormatterText < LogFormatterBase
     def format(log_record)
       return '' unless log_record
 

data/lib/log_manager.rb

@@ -58,7 +58,6 @@ module RTALogger
       @config_file_name = file_name if config_json
       apply_config(config_json)
     rescue StandardError => e
-      puts e.message
       @propagator.drop_all_repositories
       @propagator.add_log_repository(LogFactory.create_repository(:console))
     end
@@ -67,7 +66,6 @@ module RTALogger
       config_json = load_config_from_json_string(config_string, manager_name)
       apply_config(config_json)
     rescue StandardError => e
-      puts e.message
       @propagator.drop_all_repositories
       @propagator.add_log_repository(LogFactory.create_repository(:console))
     end
@@ -113,6 +111,9 @@ module RTALogger
           json.buffer_size buffer_size
           json.flush_size flush_size
           json.flush_wait_time flush_wait_time
+          json.repositories do
+            json.array! @propagator.repositories.collect { |repository| repository.to_builder.attributes! }
+          end
           json.topics do
             json.array! topics.keys.collect { |topic_key| @topics[topic_key].to_builder.attributes! }
           end
@@ -169,7 +170,7 @@ module RTALogger
     end
 
     def apply_config_repos(config_json)
-      config_json['repos']&.each { |item| @propagator.load_log_repository(item) }
+      config_json['repositories']&.each { |item| @propagator.load_log_repository(item) }
     end
 
     def apply_config_topics(config_json)

data/lib/log_propagator.rb

@@ -5,17 +5,19 @@ module RTALogger
   class LogPropagator
     def initialize
       @semaphore = Mutex.new
-      @log_records = []
-      @log_repositories = []
+      @records = []
+      @repositories = []
     end
 
-    def add_log(log_record)
-      @semaphore.synchronize { @log_records.push(log_record.dup) }
+    attr_reader :repositories
+
+    def add_log(record)
+      @semaphore.synchronize { @records.push(record.dup) }
     end
 
-    def add_log_repository(log_repository)
-      return unless log_repository.is_a? RTALogger::LogRepository
-      @log_repositories.push(log_repository) unless @log_repositories.include?(log_repository)
+    def add_log_repository(repository)
+      return unless repository.is_a? RTALogger::LogRepository
+      @repositories.push(repository) unless @repositories.include?(repository)
     end
 
     def load_log_repository(config_json)
@@ -24,20 +26,20 @@ module RTALogger
       enable = config_json['enable'].nil? ? true : config_json['enable']
       return unless enable
 
-      log_repository = ::RTALogger::LogFactory.create_repository(type, config_json)
-      add_log_repository(log_repository)
+      repository = ::RTALogger::LogFactory.create_repository(type, config_json)
+      add_log_repository(repository)
     end
 
     def drop_all_repositories
-      @semaphore.synchronize { @log_repositories.clear }
+      @semaphore.synchronize { @repositories.clear }
     end
 
     def propagate
       @semaphore.synchronize do
-        @log_repositories.each do |log_repository|
-          log_repository.add_log_records(@log_records)
+        @repositories.each do |repository|
+          repository.add_log_records(@records)
         end
-        @log_records.clear
+        @records.clear
       end
     end
   end

data/lib/log_repository.rb

@@ -1,3 +1,5 @@
+require_relative 'string'
+
 module RTALogger
   # base log repository class
   class LogRepository
@@ -5,6 +7,7 @@ module RTALogger
       @semaphore = Mutex.new
       @log_records = []
       @enable = true
+      @formatter = RTALogger::LogFactory.log_formatter_default
     end
 
     # @@sub_classes = {}
@@ -23,6 +26,7 @@ module RTALogger
     # end
 
     attr_accessor :enable
+    attr_accessor :formatter
 
     def add_log_records(items)
       return 0 unless @enable
@@ -41,6 +45,20 @@ module RTALogger
       end
     end
 
+    def to_builder
+      jb = Jbuilder.new do |json|
+        json.type self.class.to_s.split('::').last.underscore.sub('log_repository_', '')
+        json.enable enable
+        json.formatter @formatter.to_builder.attributes!
+      end
+
+      jb
+    end
+
+    def reveal_config
+      to_builder.target!
+    end
+
     protected
 
     def flush_and_clear

data/lib/log_repository_console.rb

@@ -6,8 +6,6 @@ module RTALogger
   class LogRepositoryConsole < LogRepository
     def initialize
       super
-
-      @formatter = RTALogger::LogFactory.log_formatter_default
     end
 
     def load_config(config_json)

data/lib/log_repository_file.rb

@@ -7,8 +7,10 @@ module RTALogger
   class LogRepositoryFile < LogRepository
     def initialize(file_path = 'log.txt', period = 'daily', shift_size = 1_048_576)
       super()
-      @file_logger = create_ruby_logger(file_path, period, shift_size)
-      @formatter = RTALogger::LogFactory.log_formatter_default
+      @file_path = file_path
+      @period = period
+      @shift_size = shift_size
+      @file_logger = create_ruby_logger(@file_path, @period, @shift_size)
     end
 
     def load_config(config_json)
@@ -20,6 +22,15 @@ module RTALogger
       @file_logger = create_ruby_logger(file_path, period, shift_size)
     end
 
+    def to_builder
+      json = super
+      json.enable enable
+      json.file_path @file_path
+      json.period @period
+      json.shift_size @shift_size
+
+      json
+    end
     # register :file
 
     protected

data/lib/{log_repository_fluent.rb → log_repository_fluentd.rb}

@@ -2,10 +2,11 @@ require 'fluent-logger'
 require_relative 'log_repository'
 
 module RTALogger
-  class LogRepositoryFluent < LogRepository
+  class LogRepositoryFluentd < LogRepository
     def initialize(host = 'localhost', port = 24224, tls_options = nil)
       super()
-      @formatter = RTALogger::LogFactory.log_formatter_json
+      @host = host
+      @port = port
       @fluent_logger = create_fluentd_logger(host, port, tls_options)
     end
 
@@ -19,6 +20,14 @@ module RTALogger
       @fluent_logger = create_fluentd_logger(host, port, tls_options)
     end
 
+    def to_builder
+      json = super
+      json.enable enable
+      json.host @host
+      json.port @port
+
+      json
+    end
     # register :fluentd
 
     protected

data/lib/rta_logger_config.json

@@ -11,7 +11,7 @@
         "severity_level": "debug",
         "buffer_size": 100,
         "flush_wait_seconds": 15,
-        "repos":
+        "repositories":
         [
           {
             "enable": true,

data/lib/sample.rb

@@ -4,7 +4,6 @@ require_relative 'log_factory_repository'
 controller_name = 'test_controller'
 userID = 5
 
-
 # RTALogger::LogFactory.register_log_repository :console, 'log_repository_console.rb'
 
 # create log manager instance

data/lib/string.rb

@@ -0,0 +1,9 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RTALogger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Babak Bahreini, RTA Backend Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger
@@ -74,7 +74,7 @@ files:
 - lib/log_factory_record.rb
 - lib/log_factory_repository.rb
 - lib/log_factory_topic.rb
-- lib/log_formatter.rb
+- lib/log_formatter_base.rb
 - lib/log_formatter_json.rb
 - lib/log_formatter_text.rb
 - lib/log_manager.rb
@@ -83,12 +83,13 @@ files:
 - lib/log_repository.rb
 - lib/log_repository_console.rb
 - lib/log_repository_file.rb
-- lib/log_repository_fluent.rb
+- lib/log_repository_fluentd.rb
 - lib/log_repository_udp.rb
 - lib/log_topic.rb
 - lib/rta_logger_config.json
 - lib/sample.rb
 - lib/severity_level.rb
+- lib/string.rb
 homepage: https://github.com/BBahrainy/RTALogger.git
 licenses:
 - MIT

data/lib/log_formatter.rb

@@ -1,18 +0,0 @@
-# Log Formatter base class
-module RTALogger
-  class LogFormatter
-    def initialize
-      @delimiter = '|'
-    end
-
-    attr_accessor :delimiter
-
-    def load_config(config_json)
-      @delimiter = config_json['delimiter'].nil? ? true : config_json['delimiter']
-    end
-
-    def format(log_record)
-      log_record.to_s
-    end
-  end
-end