Ruby on Rails production log rotation

Ruby on-RailsLoggingProduction Environment

Ruby on-Rails Problem Overview


What is the best way to enable log rotation on a Ruby on Rails production app?

Is it by using logrotate on the hosting server or is there a set of options to use when initialising logger from the app?

Ruby on-Rails Solutions


Solution 1 - Ruby on-Rails

Option 1: syslog + logrotate

You can configure rails, to use the systems log tools.

An example in config/environments/production.rb.

# Use a different logger for distributed setups
config.logger = SyslogLogger.new

That way, you log to syslog, and can use default logrotate tools to rotate the logs.

Option 2: normal Rails logs + logrotate

Another option is to simply configure logrotate to pick up the logs left by rails. On Ubuntu and Debian that would be, for example, in a file called /etc/logrotate.d/rails_example_com.

/path/to/rails.example.com/tmp/log/*.log {
    weekly
    missingok
    rotate 52
    compress
    delaycompress
    notifempty
    copytruncate
}

As per suggestions below, in Rails it is advised to use copytruncate, to avoid having to restart the Rails app.

Edit: removed "sharedscripts/endscript" since they are not used here and cause problems according to comment. And removed create 640 root adm as per comment suggested.

Solution 2 - Ruby on-Rails

If you are using logrotate then you can choose either of the options shown below by placing a conf file in the /etc/logrotate.d/ directory.

# Rotate Rails application logs based on file size
# Rotate log if file greater than 20 MB
/path/to/your/rails/applicaton/log/*.log {
	size=20M
	missingok
	rotate 52
	compress
	delaycompress
	notifempty
	copytruncate
}

Or

# Rotate Rails application logs weekly
/path/to/your/rails/applicaton/log/*.log {
  weekly
  missingok
  rotate 52
  compress
  delaycompress
  notifempty
  copytruncate
}

Please note that copytruncate makes a backup copy of the current log and then clears the log file for continued writing. The alternative is to use create which will perform the rotation by renaming the current file and then creating a new log file with the same name as the old file. I strongly recommend that you use copytruncate unless you know that you need create. The reason why is that Rails may still keep pointing to the old log file even though its name has changed and they may require restarting to locate the new log file. copytruncate avoids this by keeping the same file as the active file.

Solution 3 - Ruby on-Rails

For Rails 5, this is what I had to do to limit log size and don't change server output in the console:

According to the documentation, if you want to limit the size of the log folder, put this in your environment-file ('development.rb'/'production.rb').

config.logger = ActiveSupport::Logger.new(config.paths['log'].first, 1, 50 * 1024 * 1024)

With this, your log files will never grow bigger than 50Mb. You can change the size to your own preference. The ‘1’ in the second parameter means that 1 historic log file will be kept, so you’ll have up to 100Mb of logs – the current log and the previous chunk of 50Mb.

Source to this solution.

Solution 4 - Ruby on-Rails

For Rails 5, if you want daily log rotation, you only need this:

  config.logger = ActiveSupport::Logger.new(config.paths['log'].first, shift_age = 'daily')

According the documentation, you can use daily, weekly or monthly.

Solution 5 - Ruby on-Rails

For every log: Rails log, Rpush log, ... You can use like this in your config file of service:

 config.log_file = 'log/rpush.log'
 config.logger = ActiveSupport::Logger.new(config.log_file, 1, 20.megabytes)

It means: only save 1 previous log file after split. Main log size never over 20 MB.

Solution 6 - Ruby on-Rails

Enable to send logs to the loggly using rails logglier as following in my environments/production.rb file. rails version is 4.1.0

RailsApplication::Application.configure do
require 'logglier'
config.logger = Logglier.new(<https://logs-01.loggly.com/inputs/inputkey>)
log.info("hello from logglier")
end

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestioncnikolaouView Question on Stackoverflow
Solution 1 - Ruby on-RailsberkesView Answer on Stackoverflow
Solution 2 - Ruby on-Railsamit_saxenaView Answer on Stackoverflow
Solution 3 - Ruby on-RailsFellow StrangerView Answer on Stackoverflow
Solution 4 - Ruby on-RailsRael Gugelmin CunhaView Answer on Stackoverflow
Solution 5 - Ruby on-RailsThienSuBSView Answer on Stackoverflow
Solution 6 - Ruby on-Railsriya khanaView Answer on Stackoverflow