RTALogger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8102f5e6bfb81e09e529d98b34039304aa7376d553e0df71e974a2eeaf6818d
-  data.tar.gz: 7a6558fa4df04b8bbaede48620644b7b85de448d96b7e93340d30f018a872461
+  metadata.gz: 5cd821ed8beebbda5bfd6aff1088372642f5f20012c7f5d6ca8b2d59cc8dee42
+  data.tar.gz: 8dbf6b01f03b98525acade15eaebece1e500dfbc610f2d9cbda5e760df0e048b
 SHA512:
-  metadata.gz: 590a74703f4605c4a0df2e3a5a1997bf1c0209182b961ef74769f4c037f7fefb8770240d317e6017d3cf9ae30f1fc1cbd4e489c6e5c7f083b36f04b6d6f64bc6
-  data.tar.gz: 1dd9d109f63173420be1bbb6306d76eda10140c4474aa8b4de27f46ef7dbadceec58d5ba8816b03fa53de2cb6ee6b793ae3726ade97728aa3de55ec592e30255
+  metadata.gz: 7a1e77c33e3fb301780bb6d4a0b254701ab918403ee8705e19bda759b2c0ce56b1e1cf76c18012c195b5c3b28267dea524bbe3db303f7a9fb9dca58662fe9a2f
+  data.tar.gz: fd81ab07bb1a3c79e00e425298068e4cfa357208e4173f157a156e5cdefcb044f456604cfc0c3b9d0f37342e672d47636ffd75ceb4b5ef866a47f8f7db9bc7aa

data/.idea/.gitignore

@@ -0,0 +1,2 @@
+# Default ignored files
+/workspace.xml

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build RTALogger-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install RTALogger-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install RTALogger-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push RTALogger-0.1.0.gem to https://www.rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /></RakeGroup></Settings>

data/.idea/RTALogger.iml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.0.3.4, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.7, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="cool.io (v1.7.0, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.4.4, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fluentd (v1.11.4, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="http_parser.rb (v0.6.0, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.8.5, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="jbuilder (v2.10.1, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.14.2, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="msgpack (v1.3.3, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.10.0, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.10.0, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.10.0, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.10.0, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.10.0, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="serverengine (v2.2.2, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sigdump (v0.2.4, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="strptime (v0.2.5, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thread_safe (v0.3.6, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo (v1.2.7, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo-data (v1.2020.4, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="yajl-ruby (v1.4.1, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.4.1, ruby-2.6.3-p62) [gem]" level="application" />
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.6.3-p62" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/RTALogger.iml" filepath="$PROJECT_DIR$/.idea/RTALogger.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem "jbuilder"

data/Gemfile.lock

@@ -1,12 +1,19 @@
 PATH
   remote: .
   specs:
-    RTALogger (0.1.0)
+    RTALogger (0.1.1)
       fluentd (~> 1.11, >= 1.11.4)
+      jbuilder (~> 2.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     concurrent-ruby (1.1.7)
     cool.io (1.7.0)
     diff-lcs (1.4.4)
@@ -21,6 +28,11 @@ GEM
       tzinfo-data (~> 1.0)
       yajl-ruby (~> 1.0)
     http_parser.rb (0.6.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jbuilder (2.10.1)
+      activesupport (>= 5.0.0)
+    minitest (5.14.2)
     msgpack (1.3.3)
     rake (12.3.3)
     rspec (3.10.0)
@@ -40,17 +52,20 @@ GEM
       sigdump (~> 0.2.2)
     sigdump (0.2.4)
     strptime (0.2.5)
-    tzinfo (2.0.2)
-      concurrent-ruby (~> 1.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
     tzinfo-data (1.2020.4)
       tzinfo (>= 1.0.0)
     yajl-ruby (1.4.1)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   RTALogger!
+  jbuilder
   rake (~> 12.0)
   rspec (~> 3.0)
 

data/README.md

@@ -22,7 +22,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+require_relative 'log_factory_manager'
+require_relative 'log_factory_repository'
+
+controller_name = 'test_controller'
+userID = 5
+
+# create log manager instance
+# this could be a global variable declared in application level
+log_manager = RTALogger::LogFactory.log_manager_instance
+
+# set log manage application name (hard code)
+log_manager.app_name = 'myTestApp'
+
+# load log manager configuration from a json config file
+log_manager.config_use_json_file('rta_logger_config.json')
+
+# add log repository to log manager
+#log_manager.propagator.add_log_repository(RTALogger::LogFactory.new_log_repository_console)
+
+# add new topic to log manager
+# use this api to get a new log topic instance
+# this api could be called in entry point of each service or class initialize method
+topic = log_manager.add_topic(controller_name)
+
+# add log information to log topic
+topic.debug(userID, 'Controller Name=', controller_name, 'debug')
+topic.info(userID, 'Controller Name=', controller_name, 'information')
+topic.warning(userID, 'Controller Name=', controller_name, 'warning')
+topic.error(userID, 'Controller Name=', controller_name, 'error')
+topic.fatal(userID, 'Controller Name=', controller_name, 'fatal')
+topic.unknown(userID, 'Controller Name=', controller_name, 'unknown')
+
+# update specific topic log level if necessary
+# log_manager.update_topic_level(controller_name, RTALogger::LogSeverity::INFO)
+
+# update all topics log level if necessary
+# log_manager.update_all_topics_log_level(RTALogger::LogSeverity::INFO)
 
 ## Development
 

data/RTALogger.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_dependency "fluentd", "~> 1.11", ">= 1.11.4"
+  spec.add_dependency "jbuilder", "~> 2.10"
 end

data/lib/RTALogger.rb

@@ -1,6 +1,4 @@
-require "RTALogger/version"
-
+require 'RTALogger/version'
+# main namespace of the log manager
 module RTALogger
-  class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/RTALogger/version.rb

@@ -1,3 +1,3 @@
 module RTALogger
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'.freeze
 end

data/lib/{factory/origin/log_factory_file_logger.rb → log_factory_file_logger.rb}

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 require 'logger'
 
 module RTALogger
   # this module generates object instance
   module LogFactory
-    def self.new_file_logger(file_path = 'log.txt', period = 'daily', shift_size = 1048576)
+    def self.new_file_logger(file_path = 'log.txt', period = 'daily', shift_size = 1_048_576)
       @ruby_logger = Logger.new(file_path, period, shift_size)
       @ruby_logger.level = Logger::Severity::DEBUG
-      @ruby_logger.formatter = proc do |severity, datetime, progname, msg|
+      @ruby_logger.formatter = proc do |_severity, _datetime, _progname, msg|
         "#{msg}\n"
       end
       @ruby_logger

data/lib/log_factory_log_formatter.rb

@@ -0,0 +1,12 @@
+require_relative 'log_formatter_text'
+require_relative 'log_formatter_json'
+
+module RTALogger
+  # Log factory to get new instance of log formatter
+  module LogFactory
+    def self.log_formatter_default
+      RTALogger::LogFormatterJSON.new
+      # RTALogger::LogFormatterText.new
+    end
+  end
+end

data/lib/{factory/origin/log_factory_manager.rb → log_factory_manager.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../log_manager'
+require_relative 'log_manager'
 
 module RTALogger
   # this module generates object instance
@@ -8,7 +8,5 @@ module RTALogger
     def self.log_manager_instance
       RTALogger::LogManager.instance
     end
-
-
   end
 end

data/lib/{factory/origin/log_factory_propagator.rb → log_factory_propagator.rb}

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../log_propagator'
-#require_relative './log_repository_console'
+require_relative 'log_propagator'
 
 module RTALogger
   # this module generates object instance

data/lib/{factory/origin/log_factory_record.rb → log_factory_record.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../log_record'
+require_relative 'log_record'
 
 module RTALogger
   # this module generates object instance

data/lib/{factory/origin/log_factory_repository.rb → log_factory_repository.rb}

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../../log_repository_console'
-require_relative '../../log_repository_file'
-require_relative '../../log_repository_udp'
-#require_relative '../../log_repository_db'
+require_relative 'log_repository_console'
+require_relative 'log_repository_file'
+require_relative 'log_repository_udp'
 
 module RTALogger
   # this module generates object instance
@@ -12,14 +11,14 @@ module RTALogger
       LogRepositoryConsole.new
     end
 
-    def self.new_log_repository_file(file_path = 'log.txt', period = 'daily', shift_size = 1048576)
+    def self.new_log_repository_file(file_path = 'log.txt', period = 'daily', shift_size = 1_048_576)
       LogRepositoryFile.new(file_path, period, shift_size)
     end
 
     def self.load_log_repository_file(config_json)
       file_path = config_json['File_Path'].to_s
       period = config_json['Roll_Period'].to_s
-      shift_size = config_json['Roll_Size'].nil? ? 1048576 : config_json['Roll_Size'].to_i
+      shift_size = config_json['Roll_Size'].nil? ? 1_048_576 : config_json['Roll_Size'].to_i
       ::RTALogger::LogFactory.new_log_repository_file(file_path, period, shift_size)
     end
 
@@ -35,9 +34,9 @@ module RTALogger
 
     def self.create_repository(type, config_json)
       result = nil
-      result = new_log_repository_console if type.to_s.upcase.eql?('Console'.upcase)
-      result = load_log_repository_file(config_json) if type.to_s.upcase.eql?('File'.upcase)
-      result = load_log_repository_udp(config_json) if type.to_s.upcase.eql?('UDP'.upcase)
+      result = new_log_repository_console if type.to_s.casecmp('Console').zero?
+      result = load_log_repository_file(config_json) if type.to_s.casecmp('File').zero?
+      result = load_log_repository_udp(config_json) if type.to_s.casecmp('UDP').zero?
       result
     end
   end

data/lib/{factory/origin/log_factory_topic.rb → log_factory_topic.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../log_topic'
+require_relative 'log_topic'
 
 module RTALogger
   # this module generates object instance

data/lib/log_formatter.rb

@@ -1,8 +1,8 @@
 module RTALogger
+  # Log Formatter base class
   class LogFormatter
     def format(log_record)
       log_record.to_s
     end
   end
 end
-

data/lib/log_formatter_json.rb

@@ -2,12 +2,14 @@ require 'jbuilder'
 require_relative 'log_formatter'
 
 module RTALogger
+  # json formatter which receive log_record and
+  # returns it's data as json string
   class LogFormatterJSON
     def format(log_record)
       return '' unless log_record
 
       jb = Jbuilder.new do |json|
-        json.occurred_at log_record.occurred_at.strftime("%F %H:%M:%S:%3N")
+        json.occurred_at log_record.occurred_at.strftime('%F %H:%M:%S:%3N')
         json.app_name log_record.app_name
         json.topic_title log_record.topic_title
         json.context_id log_record.context_id

data/lib/log_formatter_text.rb

@@ -1,16 +1,18 @@
 require_relative 'log_formatter'
 
 module RTALogger
+  # text formatter which receive log_record and
+  # returns it's data as delimited text string
   class LogFormatterText < LogFormatter
-    def format(log_record)
+    def format(log_record, delimiter = '|')
       return '' unless log_record
 
-      result = log_record.occurred_at.strftime("%F %H:%M:%S:%3N")
-      result << '|' << log_record.app_name
-      result << '|' << log_record.topic_title
-      result << '|' << log_record.context_id
-      result << '|' << log_record.severity
-      result << '|' << log_record.message.join(' ').gsub('|' , '$<$')
+      result = log_record.occurred_at.strftime('%F %H:%M:%S:%3N')
+      result << delimiter << log_record.app_name
+      result << delimiter << log_record.topic_title
+      result << delimiter << log_record.context_id
+      result << delimiter << log_record.severity
+      result << delimiter << log_record.message.join(' ').gsub(delimiter, '$<$')
 
       result
     end

data/lib/log_manager.rb

@@ -1,10 +1,10 @@
 require 'date'
 require 'thread'
 require 'singleton'
-require_relative 'factory/origin/log_factory_propagator'
-require_relative 'factory/origin/log_factory_repository'
-require_relative 'factory/origin/log_factory_topic'
-require_relative './log_severity'
+require_relative 'log_factory_propagator'
+require_relative 'log_factory_repository'
+require_relative 'log_factory_topic'
+require_relative 'log_severity'
 
 # the module will contain all logger requirements
 module RTALogger
@@ -36,16 +36,18 @@ module RTALogger
       @flush_scheduler.run
     end
 
-    def config(config_file_name)
-      config_json = load_config_from_file(config_file_name)
-      raise 'json config not available' unless config_json
-      @enable = config_json['Enable'].nil? ? true : config_json['Enable']
-      @app_name = config_json['App_Name'] if config_json['App_Name'].present?
-      @default_log_level = config_json['Log_Severity'] if config_json['Log_Severity'].present?
-      @buffer_siz = config_json['Buffer_Size'] if config_json['Buffer_Size'].present?
-      @flush_wait_time = config_json['Flush_Wait_Seconds'] if config_json['Flush_Wait_Seconds'].present?
+    def config_use_json_file(config_file_name)
+      config_json = load_config_from_json_file(config_file_name)
+      apply_config(config_json)
+    rescue StandardError => e
+      puts e.message
       @propagator.drop_all_repositories
-      config_json['Repos']&.each { |item| @propagator.load_log_repository(item) }
+      @propagator.add_log_repository(LogFactory.new_log_repository_console)
+    end
+
+    def config_use_json_string(config_string)
+      config_json = load_config_from_json_string(config_file_name)
+      apply_config(config_json)
     rescue StandardError => e
       puts e.message
       @propagator.drop_all_repositories
@@ -55,6 +57,7 @@ module RTALogger
     attr_accessor :enable
     attr_accessor :app_name
     attr_reader :propagator
+    attr_reader :default_log_level
 
     def add_topic(topic_title, log_level = @default_log_level)
       @topic_semaphore.synchronize {
@@ -81,10 +84,21 @@ module RTALogger
 
     private
 
-    def load_config_from_file(config_file_name)
+    def load_config_from_json_file(config_file_name)
       config_file = File.open config_file_name
       config_json = JSON.load config_file
-      config_json = config_json['RTALogger']
+      config_json = extract_config(config_json)
+      config_json
+    end
+
+    def load_config_from_json_string(config_string)
+      config_json = JSON.parse(config_string)
+      config_json = extract_config(config_json)
+      config_json
+    end
+
+    def extract_config(json_data)
+      config_json = json_data['RTALogger']
       raise 'RTALogger configuration not found!' unless config_json
       raise 'Log_Managers section does not exists json configuration' unless config_json['Log_Managers']
       raise 'No config manager defined in json configuration' unless config_json['Log_Managers'].count.positive?
@@ -97,6 +111,17 @@ module RTALogger
       config_json
     end
 
+    def apply_config(config_json)
+      raise 'json config not available' unless config_json
+      @enable = config_json['Enable'].nil? ? true : config_json['Enable']
+      @app_name = config_json['App_Name'] if config_json['App_Name'].present?
+      @default_log_level = config_json['Log_Severity'] if config_json['Log_Severity'].present?
+      @buffer_siz = config_json['Buffer_Size'] if config_json['Buffer_Size'].present?
+      @flush_wait_time = config_json['Flush_Wait_Seconds'] if config_json['Flush_Wait_Seconds'].present?
+      @propagator.drop_all_repositories
+      config_json['Repos']&.each { |item| @propagator.load_log_repository(item) }
+    end
+
     def initialize_flush_scheduler
       @flush_scheduler = Thread.new do
         loop do

data/lib/log_propagator.rb

@@ -1,45 +1,44 @@
-require 'thread'
-require_relative './log_repository'
-
-module RTALogger
-  # propagate log records to multiple log repositories
-  class LogPropagator
-    def initialize
-      @semaphore = Mutex.new
-      @log_records = []
-      @log_repositories = []
-    end
-
-    def add_log(log_record)
-      @semaphore.synchronize { @log_records.push(log_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)
-    end
-
-    def load_log_repository(config_json)
-      type = config_json['Type']
-      return if type.to_s.strip.empty?
-      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)
-    end
-
-    def drop_all_repositories
-      @semaphore.synchronize { @log_repositories.clear }
-    end
-
-    def propagate
-      @semaphore.synchronize do
-        @log_repositories.each do |log_repository|
-          log_repository.add_log_records(@log_records)
-        end
-        @log_records.clear
-      end
-    end
-  end
-end
+require_relative 'log_repository'
+
+module RTALogger
+  # propagate log records to multiple log repositories
+  class LogPropagator
+    def initialize
+      @semaphore = Mutex.new
+      @log_records = []
+      @log_repositories = []
+    end
+
+    def add_log(log_record)
+      @semaphore.synchronize { @log_records.push(log_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)
+    end
+
+    def load_log_repository(config_json)
+      type = config_json['Type']
+      return if type.to_s.strip.empty?
+      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)
+    end
+
+    def drop_all_repositories
+      @semaphore.synchronize { @log_repositories.clear }
+    end
+
+    def propagate
+      @semaphore.synchronize do
+        @log_repositories.each do |log_repository|
+          log_repository.add_log_records(@log_records)
+        end
+        @log_records.clear
+      end
+    end
+  end
+end

data/lib/log_record.rb

@@ -1,28 +1,27 @@
-require 'date'
-
-module RTALogger
-  # log data structure
-  class LogRecord
-    def initialize(log_topic, context_id, severity, *message)
-      @log_topic = log_topic
-      @context_id = context_id
-      @severity = severity
-      @message = message
-      @occurred_at = DateTime.now
-    end
-
-    attr_reader :context_id
-    attr_reader :severity
-    attr_reader :message
-    attr_reader :occurred_at
-
-    def app_name
-      @log_topic.log_manager.app_name
-    end
-
-    def topic_title
-      @log_topic.topic_title
-    end
-  end
-end
-
+require 'date'
+
+module RTALogger
+  # log data structure
+  class LogRecord
+    def initialize(log_topic, context_id, severity, *message)
+      @log_topic = log_topic
+      @context_id = context_id
+      @severity = severity
+      @message = message
+      @occurred_at = DateTime.now
+    end
+
+    attr_reader :context_id
+    attr_reader :severity
+    attr_reader :message
+    attr_reader :occurred_at
+
+    def app_name
+      @log_topic.log_manager.app_name
+    end
+
+    def topic_title
+      @log_topic.topic_title
+    end
+  end
+end

data/lib/log_repository.rb

@@ -1,5 +1,3 @@
-require 'thread'
-
 module RTALogger
   # base log repository class
   class LogRepository
@@ -28,4 +26,4 @@ module RTALogger
     attr_reader :log_records
     attr_reader :semaphore
   end
-end
+end

data/lib/log_repository_console.rb

@@ -1,5 +1,5 @@
 require_relative 'log_repository'
-require_relative 'factory/origin/log_factory_log_formatter'
+require_relative 'log_factory_log_formatter'
 
 module RTALogger
   # show log items on console out put
@@ -7,7 +7,7 @@ module RTALogger
     def initialize
       super
 
-      @formatter = RTALogger::LogFactory::log_formatter_default
+      @formatter = RTALogger::LogFactory.log_formatter_default
     end
 
     protected
@@ -18,6 +18,5 @@ module RTALogger
       end
       super
     end
-
   end
 end

data/lib/log_repository_file.rb

@@ -1,15 +1,15 @@
 require 'logger'
 require_relative 'log_repository'
-require_relative 'factory/origin/log_factory_file_logger'
-require_relative 'factory/origin/log_factory_log_formatter'
+require_relative 'log_factory_file_logger'
+require_relative 'log_factory_log_formatter'
 
 module RTALogger
   # show log items on console out put
   class LogRepositoryFile < LogRepository
-    def initialize(file_path = 'log.txt', period = 'daily', shift_size = 1048576)
+    def initialize(file_path = 'log.txt', period = 'daily', shift_size = 1_048_576)
       super()
       @file_logger = RTALogger::LogFactory.new_file_logger(file_path, period, shift_size)
-      @formatter = RTALogger::LogFactory::log_formatter_default
+      @formatter = RTALogger::LogFactory.log_formatter_default
     end
 
     protected
@@ -20,6 +20,5 @@ module RTALogger
       end
       super
     end
-
   end
 end

data/lib/log_repository_udp.rb

@@ -15,11 +15,10 @@ module RTALogger
       semaphore.synchronize do
         u1 = UDPSocket.new
         u1.bind(@host, @port)
-        @log_records.each { |log_record| u1.send log_record.to_s, 0, @host, @port}
+        @log_records.each { |log_record| u1.send log_record.to_s, 0, @host, @port }
         u1.close
       end
       super
     end
-
   end
 end

data/lib/log_severity.rb

@@ -9,7 +9,7 @@ module RTALogger
     WARN = 2
     # A handleable error condition.
     ERROR = 3
-    # An unhandleable error that results in a program crash.
+    # An un-handleable error that results in a program crash.
     FATAL = 4
     # An unknown message that should always be logged.
     UNKNOWN = 5

data/lib/log_topic.rb

@@ -1,10 +1,8 @@
-# topic
-
-require_relative './log_severity'
-require_relative 'factory/origin/log_factory_record'
+require_relative 'log_severity'
+require_relative 'log_factory_record'
 
 module RTALogger
-  # the main class to logging data
+  # the main class to logging data as topic
   class LogTopic
     include LogSeverity
     include RTALogger::LogFactory

data/lib/rta_logger_config.json

@@ -0,0 +1,32 @@
+{
+  "RTALogger":
+  {
+    "Default_Manager": "Develop",
+    "Log_Managers":
+    [
+      {
+        "Manager_Name": "Develop",
+        "Enable": true,
+        "App_Name": "TestApp",
+        "Log_Severity": 2,
+        "Buffer_Size": 100,
+        "Flush_Wait_Seconds": 15,
+        "Formatter" : "JSON",
+        "Repos":
+        [
+          {
+            "Enable": true,
+            "Type": "Console"
+          },
+          {
+            "Enable": false,
+            "Type": "File",
+            "File_Path": "../../log/log.txt",
+            "Roll_Period": "daily",
+            "Roll_Size": "1048576"
+          }
+        ]
+      }
+    ]
+  }
+}

data/lib/sample.rb

@@ -0,0 +1,37 @@
+require_relative 'log_factory_manager'
+require_relative 'log_factory_repository'
+
+controller_name = 'test_controller'
+userID = 5
+
+# create log manager instance
+# this could be a global variable declared in application level
+log_manager = RTALogger::LogFactory.log_manager_instance
+
+# set log manage application name (hard code)
+log_manager.app_name = 'myTestApp'
+
+# load log manager configuration from a json config file
+log_manager.config_use_json_file('rta_logger_config.json')
+
+# add log repository to log manager
+#log_manager.propagator.add_log_repository(RTALogger::LogFactory.new_log_repository_console)
+
+# add new topic to log manager
+# use this api to get a new log topic instance
+# this api could be called in entry point of each service or class initialize method
+topic = log_manager.add_topic(controller_name)
+
+# add log information to log topic
+topic.debug(userID, 'Controller Name=', controller_name, 'debug')
+topic.info(userID, 'Controller Name=', controller_name, 'information')
+topic.warning(userID, 'Controller Name=', controller_name, 'warning')
+topic.error(userID, 'Controller Name=', controller_name, 'error')
+topic.fatal(userID, 'Controller Name=', controller_name, 'fatal')
+topic.unknown(userID, 'Controller Name=', controller_name, 'unknown')
+
+# update specific topic log level if necessary
+# log_manager.update_topic_level(controller_name, RTALogger::LogSeverity::INFO)
+
+# update all topics log level if necessary
+# log_manager.update_all_topics_log_level(RTALogger::LogSeverity::INFO)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: RTALogger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Babak Bahreini, RTA Backend Team
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.11.4
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
 description: RTA Log Manager has been designed and implemented to provide standard
   logging API for developers.This prevents chaos in log data format. Also provide
   multiple extendable log repositories including wrapping existing loggers, like 'Fluentd'
@@ -42,6 +56,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".idea/.gitignore"
+- ".idea/.rakeTasks"
+- ".idea/RTALogger.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -54,13 +74,13 @@ files:
 - bin/setup
 - lib/RTALogger.rb
 - lib/RTALogger/version.rb
-- lib/factory/origin/log_factory_file_logger.rb
-- lib/factory/origin/log_factory_log_formatter.rb
-- lib/factory/origin/log_factory_manager.rb
-- lib/factory/origin/log_factory_propagator.rb
-- lib/factory/origin/log_factory_record.rb
-- lib/factory/origin/log_factory_repository.rb
-- lib/factory/origin/log_factory_topic.rb
+- lib/log_factory_file_logger.rb
+- lib/log_factory_log_formatter.rb
+- lib/log_factory_manager.rb
+- lib/log_factory_propagator.rb
+- lib/log_factory_record.rb
+- lib/log_factory_repository.rb
+- lib/log_factory_topic.rb
 - lib/log_formatter.rb
 - lib/log_formatter_json.rb
 - lib/log_formatter_text.rb
@@ -72,9 +92,9 @@ files:
 - lib/log_repository_file.rb
 - lib/log_repository_udp.rb
 - lib/log_severity.rb
-- lib/log_test.rb
-- lib/log_test_db.rb
 - lib/log_topic.rb
+- lib/rta_logger_config.json
+- lib/sample.rb
 homepage: https://github.com/BBahrainy/RTALogger.git
 licenses:
 - MIT

data/lib/factory/origin/log_factory_log_formatter.rb

@@ -1,11 +0,0 @@
-require_relative '../../log_formatter_text'
-require_relative '../../log_formatter_json'
-
-module RTALogger
-  module LogFactory
-    def self.log_formatter_default
-      # RTALogger::LogFormatterJSON.new
-      RTALogger::LogFormatterText.new
-    end
-  end
-end

data/lib/log_test.rb

@@ -1,41 +0,0 @@
-#require 'logger'
-#require 'date'
-require_relative 'factory/origin/log_factory_manager'
-require_relative 'factory/origin/log_factory_repository'
-require 'socket'
-
-controller_name = 'test_controller'
-userID = 5
-
-log_manager = RTALogger::LogFactory.log_manager_instance
-log_manager.app_name = 'myTestApp'
-log_manager.config('../../../config/rta_logger_config.json')
-#log_manager.propagator.add_log_repository(RTALogger::LogFactory.new_log_repository_console)
-#log_manager.propagator.add_log_repository(RTALogger::LogFactory.new_log_repository_file('../../../log/log.txt'))
-#log_manager.propagator.add_log_repository(RTALogger::LogFactory.new_log_repository_udp('127.0.0.1', 4913))
-# log_manager.propagator.add_log_repository(RTALogger::LogFactory.new_log_repository_db)
-
-topic = log_manager.add_topic(controller_name)
-
-topic.info(userID, 'Controller Name=', controller_name, 'Called by client 1')
-
-#logger.level = RTALogger::LogSeverity::INFO
-#manager.update_topic_level(controller_name, RTALogger::LogSeverity::INFO)
-
-log_manager.update_all_topics_log_level(RTALogger::LogSeverity::INFO)
-
-topic.info(userID, 'Controller Name|', controller_name, 'Called by client |2|')
-topic.error(userID, 'Controller Name=', controller_name, 'Called by client 3')
-
-#sleep(10)
-
-topic.info(userID, 'Controller Name=', controller_name, 'Called by client |4|')
-topic.fatal(userID, 'Controller Name=', controller_name, 'Called by client 5')
-topic.info(userID, 'Controller Name=', controller_name, 'Called by client 6')
-
-#ruby_logger = Logger.new(STDOUT)
-#ruby_logger.formatter = proc do |severity, datetime, progname, msg|
-#  "NICE: #{msg}\n"
-#end
-#ruby_logger.info('logged by ruby default logger')
-

data/lib/log_test_db.rb

@@ -1,59 +0,0 @@
-#require 'active_record'
-#require 'pg'
-# require 'active_record'  # uncomment for not Rails environment
-
-#ActiveRecord::Base.establish_connection(:adapter => "postgresql",
-#                                        :username => "postgre",
-#                                        :database => "rails_test_development")
-
-require 'log_record'
-
-module RTALogger
-  class LogFormatter
-    def initialize(log_record,
-                   delimiter = '|',
-                   time_format = '%Y-%m-%d %H:%M:%S.%3N')
-      @log_record = log_record
-      @delimiter = delimiter
-      @time_format = time_format
-      @format_chance = format_chance
-    end
-
-    attr_accessor :log_record
-    attr_accessor :delimiter
-    attr_accessor :time_format
-
-    def self.default_formatter(log_record)
-      LogFormatter.new(log_record)
-    end
-
-    def to_s
-      result = "#{occurred_at}#{@delimiter}#{@log_record.app_name}#{@delimiter}"
-      result << "#{@log_record.topic_title}#{@delimiter}#{@log_record.context_id}"
-      result << "#{@delimiter}#{@log_record.severity}#{@delimiter}#{log_message}"
-
-      if @format_chance
-        result unless @format_chance.call(occurred_at,
-                                          @log_record.app_name,
-                                          @log_record.topic_title,
-                                          @log_record.context_id,
-                                          @log_record.severity,
-                                          log_message)
-      end
-      else
-        result
-      end
-    end
-
-    protected
-
-    def log_message
-      @log_record.message.join.gsub(delimiter, '&dlm&')
-    end
-
-    def occurred_at
-      @log_record.occurred_at.strftime(time_format)
-    end
-  end
-end
-