LiveLog provides an user interface to show logs in realtime for production.

Add this line to your application's Gemfile:

gem 'live_log'

And then execute:

$ bundle

Or install it yourself as:

$ gem install live_log

To use live_log views you need to add this mount into your routes.rb

mount LiveLog::Web, at: 'rrtools/live-log', defaults: { group: 'RRTools' }

It will be accessible on the browser at /rrtools/live-log with or without middlewares.

Pay attention that is good pratice to protect this route on production because it could have confidential metadata. We also support basic auth that you can use to protect it.

All middlewares are optional

Enabling basic auth requires adding the middleware with recommended environment variables

LiveLog::Web.use Rack::Auth::Basic do |username, password|
    ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV['LIVELOG_USERNAME'])) &
        ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV['LIVELOG_PASSWORD']))
end if Rails.env.production?
mount LiveLog::Web, at: 'rrtools/live-log', defaults: { group: 'RRTools' }

To use all_exceptions feature we need to add the following code on your application_controller.rb.

rescue_from Exception, with: ->(e) { LiveLog::Logger.handle_exception(e) }

It will catch all the exception from your controllers and log them on /rrtools/live-log

This feature requires all_exceptions enable on the initializer.

LiveLog can catch all the logs from your rails application and filter it by files. To make it work just add the following on the development.rb or production.rb file:

require "live_log/tracer"

config.logger = LiveLog::Tracer.new(ActiveSupport::Logger.new($stdout))

You can define configurations by creating a file live_log.rb on config/initializers and use it like the following:

LiveLog.configuration.channel = 'my_channel_name'
LiveLog.configuration.persist = true
LiveLog.configuration.persist_limit = 10
LiveLog.configuration.persist_time = 5
LiveLog.configuration.all_exceptions = true

or

LiveLog.configure do |config|
    config.channel = 'my_channel_name'
    config.persist = true
    config.persist_limit = 10
    config.persist_time = 5
    config.all_exceptions = true
end

To use this gem you just need to call the logger, for instance:

LiveLog::Logger.info "Some message"

This will send the message to the view on /rrtools/live-log.

You have these type of messages for visual purposes on the view, they are essentially the same.

LiveLog::Logger.info
LiveLog::Logger.warn
LiveLog::Logger.error

Bug reports and pull requests are welcome on GitHub at https://github.com/runtimerevolution/live_log.

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