xlog 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e093d33c6d4650e69e6319057c9f3c6d0657821c94fa339ec1fea3c0ba40dac
-  data.tar.gz: 82bb2b2910223c9af42cf19a159673b7e46daa94c448f5c3c43457f8489a7e49
+  metadata.gz: 7ccd2436fed84277e65b847759e35046266a1863b4056fadfc01b85e751d3c2c
+  data.tar.gz: d386c7834e49faaffbcf23e0e1d32fdb7312583b6268cac18fd5028bbf286591
 SHA512:
-  metadata.gz: cd086b221db39453401dd0bb5d1064cea47a6f747a3aa508f2a2060c497ffa3aefbb09b058491a2009f02bc1e86b0ff3998801c38306ce8be699009da9f272c6
-  data.tar.gz: 3af328da784bc4f1f7c7278d4e4e07bc13e2c6094134476569f38cbe30e5ed497dbaa45f34fa2ea0fbc80d6b074823d198b9dbaad3c106dac3d537c466307d10
+  metadata.gz: fe55daec4b7ff8b3f33b05a59568d2c23bf2ccb52f142d2d2376965fe5821c3a6ea629a55f6e3f0cb5e15f0abf9220b4b7b9f954a3e387e74e00b97587b4b7c9
+  data.tar.gz: e80b2ff448b6da4446d8252236059b2bd36aed7fd5547086466a9f1d534e627b57253c455b9ab0282ada4ef8df95d6579d322c11be144de15b114fc0882ce8a5

data/README.md

@@ -1,8 +1,69 @@
-# Xlog
+# Xlog v0.0.1
 
-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
+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
+```
+Log important info with `.warn` method
+```ruby
+Xlog.warn('Validation failed') # [2019-04-30 12:29:13 UTC] [ArticlesController.update] [warn] Message: Validation failed
+```
+
+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.
+
+Xlog automatically defines Rails application name and environment.
+It writes logs into `log/xlog_[environement].log`
+
+Xlog also supports custom tags
+```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: 
+```ruby
+Xlog.clear_tags
+```
+
+## 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 +81,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 +89,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 +97,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/version.rb

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

data/lib/xlog/xlogger.rb

@@ -17,6 +17,10 @@ module Xlog
       @tags = tags
     end
 
+    def clear_tags
+      @tags = nil
+    end
+
     def log(type, text)
       tags = [time_stamp, called_from(type), type] + Array.wrap(@tags)
       @base_logger.tagged(tags.compact) { @base_logger.send(type, text) }

data/lib/xlog.rb

@@ -12,6 +12,10 @@ module Xlog
       config.xlogger.tag_logger(tags)
     end
 
+    def clear_tags
+      config.xlogger.clear_tags
+    end
+
     def info(message, data: nil)
       config.xlogger.info(message, data)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlog
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - OrestF
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Xlog is just awesome logger
+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: []
@@ -77,7 +78,7 @@ files:
 - lib/xlog.rb
 - lib/xlog/version.rb
 - lib/xlog/xlogger.rb
-homepage: https://github.com/OrestF/xlog
+homepage: https://github.com/coaxsoft/xlog
 licenses:
 - MIT
 metadata: {}
@@ -99,5 +100,6 @@ requirements: []
 rubygems_version: 3.0.1
 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: []