RTALogger 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c27d68d46d9d0ff75577b50a1b29983ce9012bc1d3dc86778b197154596ab2c5
-  data.tar.gz: 53ebb2215c5a2e4733de28b9178c9d4db5713aa87483309407be0de1763b36f1
+  metadata.gz: b037c1dbb6f51228afd43cfc7e576e86a7e46e711b96cedaaeb9a5b3e5f3f1ec
+  data.tar.gz: d1e2fb9ee4cddf0b221b0ec9c471117953387c502337e3d438b82348ce4111ae
 SHA512:
-  metadata.gz: e731b3cd50b9c13b017679a34e9136b743055e50892017a73890d5f74031f6d88fc437b8a26dee5abe8207fcc9c1616c83ab998f77ee216701c2fd0d98220cc2
-  data.tar.gz: 871fd3047f195f7076e08eeec631bc3f0143ea4c4f8ae483bf054e244e5e6f75541f775f0b4f973e8127a592cace225922357fb7f9167f00623f3845bd0573b7
+  metadata.gz: 1fe26e02fcdb17eb44f56644469f7061a925f5dfdc25afcde968b1d910eb5f25a13a49e25afeec8898e78eb7398bbcabe53fca3b7ca98dc85afdeae304ba12a0
+  data.tar.gz: 11fdcff4f789f1eb739cd307c9f60c52b7f6a2816caa60699b0d1f607fba0a3cf7619e58dd17d6817b4711ba35f4998585e64a8d0f099142f8c3009210220759

data/Gemfile.lock

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

data/README.md

@@ -7,26 +7,24 @@ All log manager's main features are configable through a json config file.
 
 Main purposes of developing this gem are:
 - Creating standard logging API to seperate application from existing variety of loggers.
-- Wrapping around existing loggers so get advantage of different loggers at the same time.
-- Make it possible to easily replace a logger component with a new one. (for example Rails standard Logger with Fluentd)
-  without any changes in the consumer application. 
-- Creating easy to use logger interface.
-- Apply some rules and restrictions about log structure and data format, which prevents chaos in application log information.
-- No interrupt or wait time for log consumer modules.
+- Wrapping around existing loggers to get advantage of different loggers at the same time.
+- Make it possible to easily replace a logger component with new one without any changes in the consumer application.(for example Rails standard Logger with Fluentd)
+- Creating easy to use logger interface for developers.
+- Apply some rules and restrictions about log structure and data format, which prevents chaos in application's log information.
+- No interrupt, wait time or overhead for log consumer modules.
 - Utilize multiple log repositories at the same time in background (Console, File, UDP, FluentD, etc.) 
-- Make it possible to implement customized log repositories.
+- Make it possible to implement customize log repositories.
 
 Main Features:
 - Creating multiple log manager instances with different configuration is possible entire application.
 - Each log manager instance could be configured via a json file.
 - Each log manager instance could be config to use multiple log repositories such as Console, File, UDP, Fluentd.
 - Runtime configurations could be applied through log manager APIs.
-- By using multi threading techniques and also buffering techniques, 
-  all logging process will handled in seperated thread.
+- By using multi threading and buffering techniques, all logging process will handled in seperated thread.
   So the log consumer modules should not be wait for log manager to finish the logging task.
 - Multiple standard log severity levels are available through topic APIs (debug, info, warning, error, fatal, unknown)
 - Main features could be set and manipulate through json configuration file.
-- And at the end, it is easy to use for ruby backend developers. 
+- And at the end, it is easy to use for ruby developers. 
 
 ## Installation
 
@@ -36,11 +34,11 @@ Add this line to your application's Gemfile:
 gem 'RTALogger'
 ```
 
-And then execute:
+Then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it yourself via following command:
 
     $ gem install RTALogger
 
@@ -51,12 +49,12 @@ To add gem to your rails application:
 ## Usage
 #### RTA Log Data Structure
 To use log manager APIs, first step is to have a quick review on Log Data Structure
-- Application: The root of each log data record is Application, which specify the log data owner application.
+- Application: The root of each log data record is the Application name, which specify the log data owner application.
 - Topic: By adding multiple topics to log manager you can categorize log data in logical topics.
 - Context: Under each topic, one or multiple contexts (in one level) could be defined. 
-- As an instance the Application could by 'MyEShopApp', one of Topics could be 'Authentication' and 
-  Contexts could be 'uer_name' which attend in application authorization process.
-- The next step is log severity level, which determines that the log record severity (debug, information, warning, error, fatal, unknown)
+- As an instance for Application 'MyEShopApp', one of Topics could be 'Authentication' and 
+  Context could be 'uer_name' which attend in application authorization process.
+- The next step is log severity level, which determines the log record severity (debug, information, warning, error, fatal, unknown)
 - At last the final element is log message, which contains log message data.
 
 ### Which Log Severity Levels to use
@@ -96,7 +94,7 @@ To use log manager APIs, first step is to have a quick review on Log Data Struct
           "severity_level": "debug",
           "buffer_size": 100,
           "flush_wait_seconds": 15,
-          "repos":
+          "repositories":
                   [
                     {
                       "enable": true,
@@ -147,12 +145,12 @@ To use log manager APIs, first step is to have a quick review on Log Data Struct
 ```
 the result will be:
 ```
-    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":0,"message":"user_id is nil for user: Tom"}
-    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":1,"message":"User Tom is trying to login"}
-    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":2,"message":"Authentication failed for user Tom"}
-    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":3,"message":"Error connecting to data base for user Tom"}
-    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":4,"message":"Authentication service has been stopped working"}
-    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":5,"message":"An unknown error occured during authentication. user name: Tom"}
+    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":"DEBUG","message":"user_id is nil for user: Tom"}
+    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":"INFO","message":"User Tom is trying to login"}
+    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":"WARN","message":"Authentication failed for user Tom"}
+    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":"ERROR","message":"Error connecting to data base for user Tom"}
+    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":"FATAL","message":"Authentication service has been stopped working"}
+    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":"UNKNOWN","message":"An unknown error occured during authentication. user name: Tom"}
 ```
 - json config file sample
 ```json
@@ -169,7 +167,7 @@ the result will be:
         "severity_level": "debug",
         "buffer_size": 100,
         "flush_wait_seconds": 15,
-        "repos":
+        "repositories":
         [
           {
             "enable": true,
@@ -232,12 +230,12 @@ the result will be:
       - enable: (true/false) The value of this property activate or deactivate entire log manager.
       - app_name: Application name as the owner of log data.
       - severity_level: Defines which level of log data will be stored in log repositories.
-      - buffer_size: The memory buffer size (number of buffered log objects) to 
+      - 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: Time in soconds which log managers wait to flush buffered log objects
+      - 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
         to log repository.
-      - repos: Array of log repositories. It is possible to define multiple log repositories to
+      - 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
         add new ones. Each item in Repos array will configure a log repository.
         Pre-defined types are described below, also it's possible to implement your custome repo type 

data/lib/RTALogger/version.rb

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

data/lib/log_formatter_json.rb

@@ -1,10 +1,13 @@
 require 'jbuilder'
 require_relative 'log_formatter_base'
+require_relative 'severity_level'
 
 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
 
@@ -13,7 +16,7 @@ module RTALogger
         json.app_name log_record.app_name
         json.topic_title log_record.topic_title
         json.context_id log_record.context_id
-        json.severity log_record.severity
+        json.severity parse_severity_level_to_s(log_record.severity)
         json.message log_record.message.flatten.join(' ')
       end
 

data/lib/log_formatter_text.rb

@@ -1,17 +1,20 @@
 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
 
       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.context_id.to_s
+      result << @delimiter << parse_severity_level_to_s(log_record.severity)
       result << @delimiter << log_record.message.join(' ').gsub(delimiter, '$<$')
 
       result

data/lib/log_manager.rb

@@ -26,9 +26,9 @@ module RTALogger
       @config_file_name = ''
       @topic_semaphore = Mutex.new
       @log_semaphore = Mutex.new
-      @buffer_size = ENV.fetch('RTA_LOGGER_BUFFER_SIZE', 100)
+      self.buffer_size = ENV.fetch('RTA_LOGGER_BUFFER_SIZE', 100)
       @flush_size = @buffer_size * 20 / 100
-      @flush_wait_time = ENV.fetch('RTA_LOGGER_FLUSH_WAIT_SECONDS', 15)
+      self.flush_wait_time = ENV.fetch('RTA_LOGGER_FLUSH_WAIT_SECONDS', 15)
       @topics = {}
       @log_records = []
       @propagator = LogFactory.new_log_propagator
@@ -47,12 +47,26 @@ module RTALogger
     attr_accessor :app_name
     attr_reader :propagator
     attr_accessor :default_severity_level
-    attr_accessor :buffer_size
     attr_reader :flush_size
-    attr_accessor :flush_wait_time
     attr_reader :topics
     attr_reader :config_file_name
 
+    def buffer_size
+      @buffer_size
+    end
+
+    def buffer_size=(size)
+      @buffer_size = size < 100 ? 100 : size
+    end
+
+    def flush_wait_time
+      @flush_wait_time
+    end
+
+    def flush_wait_time=(time_in_seconds)
+      @flush_wait_time = time_in_seconds < 10 ? 10 : time_in_seconds
+    end
+
     def config_use_json_file(file_name, manager_name = '')
       config_json = load_config_from_json_file(file_name, manager_name)
       @config_file_name = file_name if config_json
@@ -162,8 +176,8 @@ module RTALogger
       @enable = config_json['enable'].nil? ? true : config_json['enable']
       @app_name = config_json['app_name'] unless config_json['app_name'].empty?
       @default_severity_level = parse_severity_level_to_i(config_json['severity_level']) if config_json['severity_level']
-      @buffer_size = config_json['buffer_size'] if config_json['buffer_size']
-      @flush_wait_time = config_json['flush_wait_seconds'] if config_json['flush_wait_seconds']
+      self.buffer_size = config_json['buffer_size'] if config_json['buffer_size']
+      self.flush_wait_time = config_json['flush_wait_seconds'] if config_json['flush_wait_seconds']
       @propagator.drop_all_repositories
       apply_config_repos(config_json)
       apply_config_topics(config_json)
@@ -187,7 +201,7 @@ module RTALogger
       @flush_scheduler = Thread.new do
         loop do
           elapsed_seconds = ((DateTime.now - @last_flush_time) * 24 * 60 * 60).to_i
-          flush if elapsed_seconds > @flush_wait_time
+          flush if elapsed_seconds > flush_wait_time
           sleep(1)
           break if @exit_flush_scheduler
         end

data/lib/rta_logger_config.json

@@ -10,7 +10,7 @@
         "app_name": "TestApp",
         "severity_level": "debug",
         "buffer_size": 100,
-        "flush_wait_seconds": 15,
+        "flush_wait_seconds": 10,
         "repositories":
         [
           {
@@ -30,7 +30,7 @@
             "roll_size": "1048576",
             "formatter":
             {
-              "type": "text",
+              "type": "json",
               "delimiter": "|"
             }
           },

metadata

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