xlog 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e093d33c6d4650e69e6319057c9f3c6d0657821c94fa339ec1fea3c0ba40dac
-  data.tar.gz: 82bb2b2910223c9af42cf19a159673b7e46daa94c448f5c3c43457f8489a7e49
+  metadata.gz: 8863710eaab6d3927f227924b036248dd2bb416839a3df5b955f12c7a51cd4b5
+  data.tar.gz: 7259415eb72a926f64d91d4eb9f888476a39927a13335873aeb7e179a92fc7db
 SHA512:
-  metadata.gz: cd086b221db39453401dd0bb5d1064cea47a6f747a3aa508f2a2060c497ffa3aefbb09b058491a2009f02bc1e86b0ff3998801c38306ce8be699009da9f272c6
-  data.tar.gz: 3af328da784bc4f1f7c7278d4e4e07bc13e2c6094134476569f38cbe30e5ed497dbaa45f34fa2ea0fbc80d6b074823d198b9dbaad3c106dac3d537c466307d10
+  metadata.gz: f9da1a515bb2cf27829dc81a947a224aaba7eea61eb15d5f48a2221bbf0f06d3e077ab8d75f8cde273a9be827d6d99b1b3c9a55bbb9eacb8b65bc69abc78a0ab
+  data.tar.gz: e360df5da61c0d47353d95f4850bd4e7a524c29c54fcf4e0e8f0dc9a3055f78e84b32b1caf6b668bbe3cced6c4f6f36b91373bc499df4a1954a513892bb54544

data/README.md

@@ -1,8 +1,131 @@
-# Xlog
+# Xlog v0.1.6
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xlog`. To experiment with that code, run `bin/console` for an interactive prompt.
+Xlog - awesome logger for your Rails app. Logs everything you need in well-formatted view with timestamp, caller path and tags.
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+### `.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  
+  @orders = Order.all  
+  rescue StandardError => e
+    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
+  | Data: {:params=><ActionController::Parameters {"controller"=>"admin/orders", "action"=>"index"} permitted: false>} 
+  | Error backtrace: 
+  | /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`
+
+### 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: [DEPRECATED]
+
+```ruby
+Xlog.clear_tags
+```
+
+## 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
+   class Application < Rails::Application
+     # some configs...
+
+     config.middleware.use Xlog::Middleware
+   end
+ end
+```
+
+## 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
+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'
+
+Xlog.configure do |config|
+  config.custom_logger = Le.new(logentries_key, 'eu', tag: true)
+end
+```
+
+Look [here](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html) to know more about `Logger` configuration.
 
 ## Installation
 
@@ -20,10 +143,6 @@ Or install it yourself as:
 
     $ gem install xlog
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## 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.
@@ -32,7 +151,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/coaxsoft/xlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +159,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Xlog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/xlog/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Xlog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coaxsoft/xlog/blob/master/CODE_OF_CONDUCT.md).
+
+## Idea
+Initially designed and created by [Orest Falchuk (OrestF)](https://github.com/OrestF)

data/lib/xlog.rb

@@ -3,29 +3,36 @@
 require 'rails'
 require_relative 'xlog/xlogger'
 require_relative 'xlog/version'
+require_relative 'xlog/middleware'
 
 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 info(message, data: nil)
-      config.xlogger.info(message, data)
+    def clear_tags
+      puts "\e[33mWARING: 'clear_tags' is no longer supported as it's not thread safe\e[0m"
     end
 
-    def warn(message, data: nil)
-      config.xlogger.warn(message, data)
+    def info(message, data: nil, tags: [])
+      config.xlogger.info(message, data, tags)
     end
 
-    def error(e, message: nil, data: nil)
-      config.xlogger.error(e, message, data)
+    def warn(message, data: nil, tags: [])
+      config.xlogger.warn(message, data, tags)
     end
 
-    def and_raise_error(e, message: nil, data: nil)
-      config.xlogger.and_raise_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, tags: [])
+      config.xlogger.and_raise_error(e, message, data, tags)
     end
   end
 

data/lib/xlog/middleware.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Xlog
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    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 })
+    end
+  end
+end

data/lib/xlog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xlog
-  VERSION = '0.1.1'
+  VERSION = '0.1.6'
 end

data/lib/xlog/xlogger.rb

@@ -13,31 +13,27 @@ module Xlog
       @folder_names_to_remove = Dir.glob('app/*').map { |f| f.gsub('app/', '') }
     end
 
-    def tag_logger(*tags)
-      @tags = tags
-    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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlog
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - OrestF
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Xlog is just awesome logger
+- !ruby/object:Gem::Dependency
+  name: rails
+  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:
 - falchuko@gmail.com
 executables: []
@@ -75,9 +90,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/xlog.rb
+- lib/xlog/middleware.rb
 - lib/xlog/version.rb
 - lib/xlog/xlogger.rb
-homepage: https://github.com/OrestF/xlog
+homepage: https://github.com/coaxsoft/xlog
 licenses:
 - MIT
 metadata: {}
@@ -96,8 +112,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Xlog is just awesome logger
+summary: Xlog - awesome logger for your Rails app. Logs everything you need in well-formatted
+  view with timestamp, caller path and tags.
 test_files: []