tag_logger 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca7876f8a33dfbe7a209c3981c80c92013bb064151e0e5bd8c922551d0bc61b4
-  data.tar.gz: f6d858cc3d50e54971ae194985264313886a6ea71b0fd8e0a5627a08b7849db9
+  metadata.gz: 06b6ffe603dda9c2a7833e47df69ffb15940a00d6bcb7721951316d7be5ad74d
+  data.tar.gz: e51ecdcf5d7ff594a3658862864a4da8f058693f107c30ab596838d44d27e876
 SHA512:
-  metadata.gz: 200a2c7c1f70bc92d8ab308c988365901bd7e410f7cc60db28353570cbea56c0ceb31abf60e647e81c4d286a713e4cd79da08b8f4320d9637daaa955aef0ea2a
-  data.tar.gz: f60823c056fb2aac28fd3bb8cb8bb9266de5c293059ee70e9e980b7e3934679ddd1b7dd7607baf015b83b4f5eb6becd5ff6cd737076092cb59cb3e6f24dae5da
+  metadata.gz: ee664cba8fce8430fea45838e72e28bc3d72afaebcd78ee144a977d092feb1f8cdf61af8c349b2d9f48c79e02339316170861104f519d26769a5c27fb938a470
+  data.tar.gz: 5f5750e470787a3d334e05103ad43893122640431aa202162011f3c308037343a2402858bd23b28a7d20072310353e962509a4cdf836672915e753b4e7fa2c3e

data/README.md

@@ -11,7 +11,7 @@ gem 'tag_logger'
 
 Or install it yourself as:
 ```bash
-$ gem install sample_filter
+$ gem install tag_logger
 ```
 
 ## Usage
@@ -19,6 +19,8 @@ First need to add configuration:
 ```ruby
 TagLogger.configure do |config|
   config.output_path = 'log/tag_logger.log'
+  config.filter_parameters = [:password]
+  config.use_stdout = true # STDOUT log isn't shown by default
 end
 ```
 
@@ -29,10 +31,15 @@ class MyClass
 
   def my_method
     # start logging with tags
-    tag_logger 'tag_name'
+    tag_logger 'tag_name', 'another_name'
 
     # then log with levels: [:warn, :info, :debug, :fatal, :error]
     log :info, 'Log information'
+
+    # if data has sensitive information, it must be sanitized
+    # INFO -- : [tag_name] Log information {:email=>"test@email.com", :password=>"[FILTERED]"}
+    data = {email: 'test@email.com', password: '123456'}
+    log :info, "Log information #{sanitize_log(data)}"
   end
 end
 ```

data/lib/tag_logger.rb

@@ -2,15 +2,27 @@ require 'tag_logger/helper_logger'
 require 'tag_logger/configuration'
 
 module TagLogger
+  FILTERED_TEXT = '[FILTERED]'.freeze
+
   def tag_logger(*tags)
     @tag_logger ||= HelperLogger.new(tags)
   end
 
   def log(type, text)
-    if @tag_logger.nil?
-      raise 'Initialize `tag_logger` method with tags name'
-    else
-      @tag_logger.write_log(type, text)
+    tag_logger if @tag_logger.nil?
+
+    @tag_logger.write_log(type, text)
+  end
+
+  def sanitize_log(data)
+    data = data.to_hash.transform_keys(&:to_sym)
+
+    filter_parameters = TagLogger.configuration.filter_parameters
+    filter_parameters.each do |key|
+      next if data[key.to_sym].nil?
+      data[key.to_sym] = FILTERED_TEXT
     end
+
+    data
   end
 end

data/lib/tag_logger/configuration.rb

@@ -9,6 +9,10 @@ module TagLogger
   end
 
   class Configuration
-    attr_accessor :output_path
+    attr_accessor :output_path, :use_stdout, :filter_parameters
+
+    def initialize
+      @filter_parameters = Array.new
+    end
   end
 end

data/lib/tag_logger/helper_logger.rb

@@ -1,20 +1,27 @@
 module TagLogger
   class HelperLogger
-    attr_reader :tags, :logger
+    attr_reader :tag_id, :tags, :path_logger, :stdout_logger
 
-    def initialize(tags)
-      if tags.empty?
-        raise 'Tags for `tag_logger` are empty!'
-      else
-        @tags = tags
+    def initialize(tags = [])
+      raise 'TagLogger configuration is nil!' if TagLogger.configuration.nil?
+
+      @tag_id = rand(36**8).to_s(36)
+      @tags = tags
+
+      output_path = TagLogger.configuration.output_path
+      use_stdout = TagLogger.configuration.use_stdout
+
+      unless output_path.nil? || output_path.empty?
+        @path_logger ||= Logger.new(output_path)
+        path_logger.formatter = log_format
       end
 
-      output_path = TagLogger.configuration&.output_path
-      if output_path.nil? || output_path.empty?
-        raise 'TagLogger configuration `output_path` is blank!'
-      else
-        @logger ||= Logger.new(output_path)
+      if TagLogger.configuration.use_stdout == true
+        @stdout_logger ||= Logger.new(STDOUT)
+        stdout_logger.formatter = log_format
       end
+
+      raise 'TagLogger output is blank!' if path_logger.nil? && stdout_logger.nil?
     end
 
     def write_log(type, text)
@@ -28,12 +35,16 @@ module TagLogger
 
       log_text = prepared_text(text)
       logger_class = types.fetch(type)
-      logger_class.log(logger, log_text)
+
+      logger_class.log(path_logger, log_text) if path_logger
+      logger_class.log(stdout_logger, log_text) if stdout_logger
     end
 
     private
 
     def prepared_text(text)
+      return text if tags.empty?
+
       ''.tap do |s|
         tags.each do |t|
           s << ("[#{t}]" + ' ')
@@ -42,6 +53,12 @@ module TagLogger
       end
     end
 
+    def log_format
+      proc do |severity, time, _program_name, message|
+        "#{time.utc.iso8601(3)} ##{Process.pid} TID-#{Thread.current.object_id.to_s(36)} TAG-#{tag_id} #{severity}: #{message}\n"
+      end
+    end
+
     class ErrorLogger
       def self.log(logger, text)
         logger.error(text)

data/lib/tag_logger/version.rb

@@ -1,3 +1,3 @@
 module TagLogger
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tag_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - iliakg
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Simple gem for tag logging