RTALogger 0.1.4 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb273e7ee1ae08716218cd1338f233c0b5af1d652934cae575b319f7a4f5c66
-  data.tar.gz: 010d8cc58971fa3252875c245d6b4deea9e5183ef122f17b6e403621e223f17c
+  metadata.gz: af9ac8a5e34e79ce013e0447fe227f1bc0d86b6a4c7d3822c9d09775709722aa
+  data.tar.gz: d395ec41a747196bbac4d9ce1a8efe68237d294bce287e66b80dde78bea8455d
 SHA512:
-  metadata.gz: c91009d62b8810a5f2930c43e16a132673fa31487bd81c8843a4072244ea893f52d542364587fc94c9c3cf6de49e90351b72d9074491e740a395466400e4a722
-  data.tar.gz: 0bd9f95d1a89cd1d0341f18f90e42e8fb0f1cffe11637d2f558e29a14a371e0380f18111ce2be208b7e8854ce9df1e2fb1d3e6da0b34ea5476090a9fdd97833a
+  metadata.gz: 7332a7ac1b188d309646d117b9e529eeefbac12ced002596e040c10e3f83e92e0ace272851a0b75cc673798dfd9d9d0fc5a7ebd5c56ca6df39bfc791f3e261f6
+  data.tar.gz: 959c6efbc7bb3be254954798b544b7a6505d57550f8b5b3c55b516a5455d1cfc2acb5c012fb4de737cb9dc5d1cca6a3d6b5d21721888d5574f0361f9c901e95f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    RTALogger (0.1.4)
+    RTALogger (2.0.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,21 +49,22 @@ 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
-- DEBUG = 0 : Low-level information, mostly for developers.
-- INFO = 1 : Generic (useful) information about system operation.
-- WARN = 2 : A warning, which it does NOT cause crashing the process.
-- ERROR = 3 : A handleable error condition.
-- FATAL = 4 : An un-handleable error that results in a program crash.
-- UNKNOWN = 5 : An unknown message that should always be logged.
+- TRACE = 0 : all information that helps us to trace the processing of an incoming request through our application.
+- DEBUG = 1  : Low-level information, mostly for developers.
+- INFO = 2 : Generic (useful) information about system operation.
+- WARN = 3 : A warning, which it does NOT cause crashing the process.
+- ERROR = 4 : A handleable error condition.
+- FATAL = 5 : An un-handleable error that results in a program crash.
+- UNKNOWN = 6 : An unknown message that should always be logged.
     
 ### Time for coding
 - create log manager instance:
@@ -81,6 +80,71 @@ To use log manager APIs, first step is to have a quick review on Log Data Struct
     # the parameter is the json config file
     log_manager.config_use_json_file('rta_logger_config.json')
 ```
+- Sample configuration json file
+```
+{
+  "rta_logger":
+  {
+    "default_manager": "develop",
+    "log_managers":
+    [
+      {
+        "title": "develop",
+        "enable": true,
+        "app_name": "TestApp",
+        "severity_level": "trace",
+        "buffer_size": 100,
+        "flush_wait_seconds": 10,
+        "repositories":
+        [
+          {
+            "type": "console",
+            "title": "console_repo_1",
+            "enable": true,
+            "formatter":
+            {
+              "type": "text",
+              "delimiter": "|"
+            }
+          },
+          {
+            "type": "file",
+            "title": "file_repo_1",
+            "enable": true,
+            "file_path": "log.txt",
+            "roll_period": "daily",
+            "roll_size": "1048576",
+            "formatter":
+            {
+              "type": "json",
+              "delimiter": "|"
+            }
+          },
+          {
+            "enable": true,
+            "title": "console_repo_1",
+            "type": "fluentd",
+            "host": "localhost",
+            "port": "8888",
+            "formatter":
+            {
+              "type": "json"
+            }
+          }
+        ],
+        "topics":
+        [
+          {
+            "title": "test",
+            "enable": true,
+            "severity_level": "WARN"
+          }
+        ]
+      }
+    ]
+  }
+}
+``` 
 - Add new topic to log manager and get the topic instance
 ```ruby
     # the parameter is the topic name
@@ -93,69 +157,84 @@ To use log manager APIs, first step is to have a quick review on Log Data Struct
     # Assume user 'Tom' is trying to authenticate we will use user_name as log Context_id
     user_name = 'Tom'
     topic = log_manager.add_topic('Authentication')
+    topic.trace(user_name, 'Authentication process began for:', user_name)
     topic.debug(user_name, 'use_id is nil for user:', user_name)
     topic.info(user_name, 'User ', user_name , ' is trying to login.')
     topic.warning(user_name, 'Authentication failed for user ', user_name)
     topic.error(user_name, 'Error connecting to data base for user ', user_name)
     topic.fatal(user_name, 'Authentication service has been stopped working')
     topic.unknown(user_name, 'An unknown error occured during authentication. user name:', user_name)
+    topic.trace(user_name, 'Authentication process end for:', user_name)
 ```
 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":"TRACE","message"Authentication process began for: 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"}
+    {"occurred_at":"2020-11-04 15:56:58:785","app_name":"TestApp","topic_title":"Authentication","context_id":"Tom","severity":"TRACE","message"Authentication process end for: Tom"}
 ```
 - json config file sample
 ```json
 {
-  "RTALogger":
+  "rta_logger":
   {
-    "Default_Manager": "Develop",
-    "Log_Managers":
+    "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":
+        "title": "develop",
+        "enable": true,
+        "app_name": "TestApp",
+        "severity_level": "trace",
+        "buffer_size": 100,
+        "flush_wait_seconds": 10,
+        "repositories":
         [
           {
-            "Enable": true,
-            "Type": "Console"
-          },
-          {
-            "Enable": true,
-            "Type": "UDP",
-            "Host": "localhost",
-            "Port": 8888
+            "type": "console",
+            "title": "console_repo_1",
+            "enable": true,
+            "formatter":
+            {
+              "type": "text",
+              "delimiter": "|"
+            }
           },
           {
-            "Enable": false,
-            "Type": "File",
-            "File_Path": "../../log/log.txt",
-            "Roll_Period": "daily",
-            "Roll_Size": "1048576"
+            "type": "file",
+            "title": "file_repo_1",
+            "enable": true,
+            "file_path": "log.txt",
+            "roll_period": "daily",
+            "roll_size": "1048576",
+            "formatter":
+            {
+              "type": "json",
+              "delimiter": "|"
+            }
           },
           {
-            "Enable": true,
-            "Type": "Fluentd",
-            "Host": "localhost",
-            "Port": "24442",
-            "TLS_Options": 
+            "enable": true,
+            "title": "console_repo_1",
+            "type": "fluentd",
+            "host": "localhost",
+            "port": "8888",
+            "formatter":
             {
-              "ca":",/path/to/cacert.pem",
-              "cert":"/path/to/client-cert.pem",
-              "key":"/path/to/client-key.pem",
-              "key_passphrase":"test"
-             }
+              "type": "json"
+            }
+          }
+        ],
+        "topics":
+        [
+          {
+            "title": "test",
+            "enable": true,
+            "severity_level": "WARN"
           }
         ]
       }
@@ -163,69 +242,134 @@ the result will be:
   }
 }
 ```
-- json config file structure 
+### json config file structure 
 ```comment
   As we described you cap apply RTA log manager using a json config file.
   
   log_manager.config_use_json_file('rta_logger_config.json')
      
   The file structure:
-  - RTALogger : the root element of RTALogger json configuration.
-    - Default_Manager: the name of default log manager config, when there is 
+  - rta_logger : the root element of rta_logger json configuration.
+    - default_manager: the name of default log manager config, when there is 
       multiple log manager configuration in Log_Managers array.
-    - Log_Managers : the array of LogManagers with different configuration.
+    - log_managers : the array of LogManagers with different configuration.
       It is possible to define multiple log manager configurations for differen usages.
-      - Name: the name of log manager. It will be used to define the default log manager.
-      - Enable: (true/false) The value of this property activate or deactivate entire log manager.
-      - App_Name: Application name as the owner of log data.
-      - Log_Severity: Defines which level of log data will be stored in log repositories.
-      - BufferSize: The memory buffer size (number of buffered log objects) to 
+      - title: the name of log manager. It will be used to define the default log manager.
+      - 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: 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.
-      - Formatter: (JSON/TEXT) declare log format when it's required to converrt log object to text.
-      - 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 
+        and register it to RTALogger.
         - Log repository types and config:
-          1- Console: Show log data in text format on standard out put
-             - "Type":"Console"
-             - "Enable": [true/false] this will activate or deactivate log repository.
-          2- File: Store log data in a file.
-             - "Type":"Console"
-             - "Enable": [true/false] this will activate or deactivate log repository.
-             - "File_Path": [file path and file name] the path and the name to store log data.
-             - "Roll_Period": ["daily"/"weekly"/"monthly"] the period to generate new log file.
-             - "Roll_Size": [bytes]  the maximum size of log file to 
+          1- console: Show log data in text format on standard out put
+             - "type": "console"
+             - "enable": [true/false] this will activate or deactivate log repository.
+             - "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 "|")]
+                if formatter not defined then the json formatter will be used
+          2- file: Store log data in a file.
+             - "type": "console"
+             - "enable": [true/false] this will activate or deactivate log repository.
+             - "file_path": [file path and file name] the path and the name to store log data.
+             - "roll_period": ["daily"/"weekly"/"monthly"] the period to generate new log file.
+             - "roll_size": [bytes]  the maximum size of log file to 
                 roll file and create the new log file
-          3- UDP: Send log data over UDP on network. 
-             - "Type":"Console"
-             - "Enable": [true/false] this will activate or deactivate log repository.
-             - "Host": IP of the server to send log data.
-             - "Port": Port of server to send log data.
-          4- Fluentd: send log data to Fluentd Log collector over network using TCP/IP protocol.
-             - "Type":"Console"
-             - "Enable": [true/false] this will activate or deactivate log repository.
-             - "Host": IP of the server to send log data.
-             - "Port": Port of server to send log data.
-             - "TLS_Options": TLS configuration to stablish a secure TCP connection to Fluentd Server.
- 
+             - "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 "|")]
+                if formatter not defined then the json formatter will be used
+          3- udp: Send log data over UDP on network. 
+             - "type": "udp"
+             - "enable": [true/false] this will activate or deactivate log repository.
+             - "host": IP of the server to send log data.
+             - "port": Port of server to send log data.
+          4- fluentd: send log data to Fluentd Log collector over network using TCP/IP protocol.
+             - "type": "fluentd"
+             - "enable": [true/false] this will activate or deactivate log repository.
+             - "host": IP of the server to send log data.
+             - "port": Port of server to send log data.
+             - "tls_options": TLS configuration to stablish a secure TCP connection to Fluentd Server.
+             - "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 "|")]
+                if formatter not defined then the json formatter will be used
+        - 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'
 
     # update specific topic log level if necessary
-    log_manager.update_topic_level(controller_name, RTALogger::LogSeverity::INFO)
+    log_manager.update_topic_severity_level(topic_title, RTALogger::SeverityLevel::INFO)
+
+    # update all topics severity level if necessary
+    log_manager.update_all_topics_severity_level(RTALogger::SeverityLevel::INFO)
+
+    # enable or disable specific topic if necessary
+    log_manager.update_topic_enable(topic_title, [true/false])
+
+    # enable or disable all topic if necessary
+    log_manager.update_all_topics_enable([true/false])
 
-    # update all topics log level if necessary
-    log_manager.update_all_topics_log_level(RTALogger::LogSeverity::INFO)
+    # to get log manager configuration as json object use to_builder method
+    log_manager.to_builder
+    
+    # to get log manager configuration as json string use reveal_config method
+    log_manager.reveal_config
+    
+    # to apply some limited changes on log manager functionality at run time
+    # config_json parameter should carry a json object which contains the configuration
+    # structure described before in 'json configuration file structure' section.
+    # Attention: these changes will apply to manager but will not save. 
+    # So during next load these changes will be lost. Save changes will be available in
+    # next version.
+    # Attention: only following attributes could be change at run time:
+    # log_manager.enable
+    # log_manager.default_severity_level    
+    # log_manager.buffer_size (minimum is 100)
+    # log_manager.flush_wait_time (minimum 15 second)
+    # repository.enable
+    # topic.enable
+    # topic.severity_level
+    # Other attributes could only change via config file via manager config_use_json_file 
+    log_manager.apply_run_time_config(config_json) 
 ```
-- Implement and Expand
-  It is possible to implement new log repositories.
-  All repository classes should inherit from 'RTALogger::LogRepository'
+### Implement and Expand
+#### Implement new log repository
+  It is possible to implement new log repositories. There will be fue rules to implement and
+  integrate new customized log repository with RTALogger LogManager.
+  
+  1- Define you class inside RTALogger module.
+  
+  2- The class should be inherited from 'RTALogger::LogRepository'.
+  
+  3- Also appropriate naming convention is necessary. 
+     As an example if you are implementing a Console Repo, your class name should be LogRepositoryConsole and 
+     your source code should be placed in a ruby file and name it log_repository_console.rb
+  
+  4- After implementing your own log repository, you should register the class at run-time using the following syntax:
+  ```ruby
+  RTALogger::LogFactory.register_log_repository :console, 'log_repository_console.rb'
+  ```
+  Another example: LogRepositoryMyCustomizedUdp
+
+  ```ruby
+  RTALogger::LogFactory.register_log_repository :my_customized_udp, 'log_repository_my_customized_udp.rb'
+  ```
   Here is 'LogRepositoryConsole' implementation:
 ```ruby
 require_relative 'log_repository'
@@ -252,17 +396,10 @@ module RTALogger
 end
 ```
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/BBahrainy/RTALogger.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).