Skip to content

README.md

Latest commit

 

History

History
88 lines (60 loc) · 1.84 KB

README.md

File metadata and controls

88 lines (60 loc) · 1.84 KB

BitqueryLogger

Installation

Add this line to your application's Gemfile:

# Logger
gem 'bitquery_logger', git: 'https://github.com/bitquery/bitquery_logger.git', branch: 'main'#, path: '../bitquery_logger'

And then execute:

$ bundle install

Execute

$ rails g bitquery_logger:install

to add initializer

And add to environments/[env].rb

BITQUERY_LOGGER_CONFIG = {
  output: :file,
  log_level: 0
}

Possible settings

BITQUERY_LOGGER_CONFIG = {
  # Uncomment to 'disable' logger
  # output: :stdout,
  # format_stdout: false,
  
  output: :tcp,
  host: "127.0.0.1",
  port: 5170,
  buffer_max_items: 300,
  log_level: 2,
  # output: :stdout # :stdout_json, :file
  # stdout_log_level: 0,
  # 0 - debug, 1 - info, 2 - warn, 3 - error
  # format_stdout: true
}

Usage

Automatic exception dispatch already works

To send message with some level use

BitqueryLogger.debug msg
BitqueryLogger.info msg
BitqueryLogger.warn msg
BitqueryLogger.error msg

msg can be String or Hash

To add to context use:

BitqueryLogger.extra_context hash

To flush buffer use:

BitqueryLogger.flush

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bitquery_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the BitqueryLogger project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.