CloudLoggingUtil

Test codecov Gem Version license

CloudLoggingUtil is a small library to output structured logs in Cloud Logging.

Installation

Add this line to your application's Gemfile:

gem 'cloud-logging-util'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install cloud-logging-util

Usage

Insert CloudLoggingUtil::AccessLogging on the head of rack middlewares.

Rails

# config/application.rb
class Application < Rails::Application
  # setting for Access Logging ($stdout)
  config.middleware.insert_before(0, CloudLoggingUtil::AccessLogging)

  # setting for Application Logger ($stderr)
  config.logger = ActiveSupport::Logger.new($stderr)
  config.logger.formatter = CloudLoggingUtil::Formatter.new
  config.colorize_logging = false
end

Middleware check.

bundle exec rake middleware

setup.

class YourController < ActionController::Base
  prepend_before_action do
    # set trace_id to request_id
    CloudLoggingUtil.setup_trace_id(request.request_id)
  end
end

More in-depth method documentation can be found at RubyDoc.info.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/koshilife/cloud-logging-util. 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 Cloud::Logging::Logger project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.