xlog 0.1.5 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d164bebc098c5c7b0dbe424397856e92011a53648273d4e8609b5f112d2db9ff
-  data.tar.gz: c8f0cc3eabb68d96bc60dfa12d5a598fe071d7a72de5c53141284254d99dfe56
+  metadata.gz: 460bcad515dfdef4370712e91ac0110afe3fd1884386abcb0f464bd2cc9606d2
+  data.tar.gz: b0d8baf9e37cae99ed51cfa5afbe99152d6112bdc3ae6be2e11431419d6f20f6
 SHA512:
-  metadata.gz: e14895a0d31c8db2a23a3b9745d1b43e8230d26f70ac955c64f0da3adcfd188501233ecfd57c9019f9e864203e07edc053803b2ef79b9e4e4a5538d8fa8b28dc
-  data.tar.gz: 69765e968d5a89352cc9ce5fe5f4fd4dfd9a8c610063224b5f738305a39a11b0f9bbc8d01eadfd8821cded84a474afc3ac63d79871c059b127fc31c9105dba29
+  metadata.gz: 6b3003bd928eb552f2038704753e0f5490aab2d6efa271ad2b1a2db56f2946a443d9cd1a722cfae45dc21f21a469ff9797e3758432a337ef7cd9f5ce16da0715
+  data.tar.gz: 6688c324b9a71b430df3942018bf28fa06c2b667d0103edc7ca8e69c39bff0c4d1cd5d2562a687ac9001665635c783a05873e3f2aaeb82fcea7ad44aa66806f9

data/README.md

@@ -1,19 +1,35 @@
-# Xlog v0.1.5
+# Xlog v0.1.8 - [changelog](https://github.com/coaxsoft/xlog/blob/master/CHANGELOG.md)
 
 Xlog - awesome logger for your Rails app. Logs everything you need in well-formatted view with timestamp, caller path and tags.
 
+### Tested on second ruby versions:
+- 2.7.3
+- 3.0.0
+- 3.1.1
+
 ## Usage
-##### Standard
+
+### `.info`
+
 Log any info with `.info` method
+
 ```ruby
 Xlog.info('Some info text') # [2019-04-30 12:29:13 UTC] [ArtilesController.show] [info] Message: Some info text
 ```
+
+
+### `.warn`
+
 Log important info with `.warn` method
+
 ```ruby
 Xlog.warn('Validation failed') # [2019-04-30 12:29:13 UTC] [ArticlesController.update] [warn] Message: Validation failed
 ```
 
+### `.error` and `.and_raise_error`
+
 Xlog has awesome `.error` and `.and_raise_error` methods
+
 ```ruby
 def index
   10 / 0  
@@ -22,7 +38,9 @@ def index
     Xlog.and_raise_error(e, data: { params: params }, message: 'Some message text here')
 end
 ```
+
 ...and the output
+
 ```
 [2019-04-30 11:48:33 UTC] [Admin::OrdersController.index] [error] ZeroDivisionError: divided by 0. 
   | Message: Some message text here
@@ -31,23 +49,56 @@ end
   | /home/me/test_app/app/controllers/admin/orders_controller.rb:7:in `/'
   | /home/me/test_app/app/controllers/admin/orders_controller.rb:7:in `index'
 ```
+
 The only difference between `Xlog.error` and `Xlog.and_raise_error` is that second one raises error after logging.
 
+Log any info with `.info` method
+
 Xlog automatically defines Rails application name and environment.
 It writes logs into `log/xlog_[environement].log`
 
-Xlog also supports custom tags
+### Data
+
+Any log method (`.info`, `.warn`, `.error`, `.and_raise_error`) supports `data: ` - named argument. Put any object as `data: my_object`
+and it will be logged as "inspected" object.
+
+
+```ruby
+Xlog.info('test info', data: { my: 'hash' })
+# [2020-10-01 15:41:45 +0300] [(irb):4:in `irbBinding'.irb_binding] [info] Message: test info
+#   | Data: {:my=>"hash"}
+
+```
+
+### Tags
+
+As far as `.tag_logger` is deprecated as it's not thread-safe, the new tags mechanism is presented.
+Any log method (`.info`, `.warn`, `.error`, `.and_raise_error`) supports `tag: ` - named argument
+
+```ruby
+Xlog.info('Some info text', tags: 'my_custom_tag') # [2019-04-30 12:29:13 UTC] [ArtilesController.show] [info] [my_custom_tag] Message: Some info text
+Xlog.warn('Validation failed', tags: %w[validation input_error]) # [2019-04-30 12:29:13 UTC] [ArticlesController.update] [warn] [validation] [input_error] Message: Validation failed
+Xlog.warn(error, tags: %w[fatal]) # [2019-04-30 12:29:13 UTC] [ArticlesController.update] [error] [fatal] Message: Zero division error
+```
+
+
+### `.tag_logger` [DEPRECATED]
+
 ```ruby
 Xlog.tag_logger('custom_tag')
 Xlog.info('Some text') # [2019-04-30 12:29:13 UTC] [ArtilesController.show] [info] [custom_tag] Message: Some info text
 ```
 
-Clear tags with: 
+Clear tags with: [DEPRECATED]
+
 ```ruby
 Xlog.clear_tags
 ```
-##### Middleware
+
+## Middleware
+
 From version 0.1.4 Xlog could be used as Rails middleware. It catches `StandardError` using `Xlog.and_raise_error`.
+
 ```ruby
 # /config/application.rb
  module MyApp
@@ -60,6 +111,7 @@ From version 0.1.4 Xlog could be used as Rails middleware. It catches `StandardE
 ```
 
 ## Configuration
+
 Xlog is ready to use right out of the box, but it's possible to reconfigure default logger. Default logger is simple `Logger.new`. Add this code to `config/initializers/xlog.rb` and set any custom logger you want.
 
 ```ruby
@@ -67,7 +119,9 @@ Xlog.configure do |config|
   config.custom_logger = Logger.new(STDOUT) # or Logger.new('foo.log', 10, 1024000) or any other
 end
 ```
+
 It's possible to set third-party logger like Logentries(r7rapid)
+
 ```ruby
 require 'le'
 

data/lib/xlog/middleware.rb

@@ -9,7 +9,7 @@ module Xlog
     def call(env)
       @status, @headers, @response = @app.call(env)
     rescue StandardError => e
-      Xlog.and_raise_error(e, data: { request_params: Rack::Request.new(env).params, status: @status, headers: @headers, response: @response })
+      Xlog.and_raise_error(e, data: { request_params: Rack::Request.new(env).params, status: @status, headers: @headers })
     end
   end
 end

data/lib/xlog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xlog
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.8'
 end

data/lib/xlog/xlogger.rb

@@ -5,43 +5,36 @@ module Xlog
     include Singleton
 
     attr_accessor :app_name, :app_root, :base_logger
+
     def initialize
-      @base_logger = ActiveSupport::TaggedLogging.new(Logger.new("log/xlog_#{Rails.env}.log"))
+      @base_logger = ActiveSupport::TaggedLogging.new(Logger.new("log/xlog_#{Rails.env}.log", 'weekly'))
 
       @app_name = Rails.application.class.to_s.split('::')[0].underscore
       @app_root = Rails.root.to_s
       @folder_names_to_remove = Dir.glob('app/*').map { |f| f.gsub('app/', '') }
     end
 
-    def tag_logger(*tags)
-      @tags = tags
-    end
-
-    def clear_tags
-      @tags = nil
-    end
-
-    def log(type, text)
-      tags = [time_stamp, called_from(type), type] + Array.wrap(@tags)
+    def log(type, text, tags)
+      tags = [time_stamp, called_from(type), type] + Array.wrap(tags)
       @base_logger.tagged(tags.compact) { @base_logger.send(type, text) }
     end
 
-    def info(message, data)
-      log(:info, compose_log(message, data))
+    def info(message, data, tags)
+      log(:info, compose_log(message, data), tags)
     end
 
-    def warn(message, data)
-      log(:warn, compose_log(message, data))
+    def warn(message, data, tags)
+      log(:warn, compose_log(message, data), tags)
     end
 
     # do NOT refactor error and and_raise_error
-    def error(e, message, data)
+    def error(e, message, data, tags)
       # they MUST BE NOT DRY in order to log correct backtrace
-      log(:error, "#{e.class}: #{e.try(:message)}. \n #{compose_log(message, data)} \n Error backtrace: \n#{backtrace(e)}")
+      log(:error, "#{e.class}: #{e.try(:message)}. \n #{compose_log(message, data)} \n Error backtrace: \n#{backtrace(e)}", tags)
     end
 
-    def and_raise_error(e, message, data)
-      log(:error, "#{e.class}: #{e.try(:message)}. #{newline} #{compose_log(message, data)} #{newline} Error backtrace: #{newline} #{backtrace(e)}")
+    def and_raise_error(e, message, data, tags)
+      log(:error, "#{e.class}: #{e.try(:message)}. #{newline} #{compose_log(message, data)} #{newline} Error backtrace: #{newline} #{backtrace(e)}", tags)
       message.present? ? raise(e, message) : raise(e)
     end
 
@@ -56,7 +49,7 @@ module Xlog
     end
 
     def time_stamp
-      Time.zone&.now || Time.current
+      Time.current
     end
 
     def compose_log(message, data)

data/lib/xlog.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'rails'
+require 'active_support/core_ext/time/zones'
+require 'active_support/core_ext/time/calculations'
 require_relative 'xlog/xlogger'
 require_relative 'xlog/version'
 require_relative 'xlog/middleware'
@@ -9,28 +11,30 @@ module Xlog
   class << self
     attr_accessor :config, :app_name, :app_root, :base_logger, :xlogger
 
-    def tag_logger(*tags)
-      config.xlogger.tag_logger(tags)
+    # rubocop:disable Layout/LineLength
+    def tag_logger(*_tags)
+      puts "\e[33mWARING: 'tag_logger' is no longer supported as it's not thread safe. Use 'tags: ' named argument instead for 'info', 'warn', 'error', 'and_raise_error'.\e[0m"
     end
+    # rubocop:enable Layout/LineLength
 
     def clear_tags
-      config.xlogger.clear_tags
+      puts "\e[33mWARING: 'clear_tags' is no longer supported as it's not thread safe\e[0m"
     end
 
-    def info(message, data: nil)
-      config.xlogger.info(message, data)
+    def info(message, data: nil, tags: [])
+      config.xlogger.info(message, data, tags)
     end
 
-    def warn(message, data: nil)
-      config.xlogger.warn(message, data)
+    def warn(message, data: nil, tags: [])
+      config.xlogger.warn(message, data, tags)
     end
 
-    def error(e, message: nil, data: nil)
-      config.xlogger.error(e, message, data)
+    def error(e, message: nil, data: nil, tags: [])
+      config.xlogger.error(e, message, data, tags)
     end
 
-    def and_raise_error(e, message: nil, data: nil)
-      config.xlogger.and_raise_error(e, message, data)
+    def and_raise_error(e, message: nil, data: nil, tags: [])
+      config.xlogger.and_raise_error(e, message, data, tags)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlog
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.8
 platform: ruby
 authors:
 - OrestF
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Xlog - awesome logger for your Rails app. Logs everything you need in
   well-formatted view with timestamp, caller path and tags.
 email:
@@ -97,7 +117,7 @@ homepage: https://github.com/coaxsoft/xlog
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Xlog - awesome logger for your Rails app. Logs everything you need in well-formatted
   view with timestamp, caller path and tags.