Collect Rails 5 production.log with td-agent

Tweet

• English
• 日本語

Abstract

Hello everybody It’s me candle.
In this article I will show you how to collect rails 5 production.log with td-agent.
Rails 5 was changed log format and it cause some problem.
I will solve it and explain.

relational article

If you are using rails 4 please refer to the following article.

td-agentでRails 4のproduction.logを取得する

Precondition

You can work ruby on rails in production mode
Before read this article you setup the rails production environment such as webrick, apache, puma and nginx.

You already installed td-agent or fluentd.
You need td-agent or fluentd. It is installed on the ruby on rails server.

Change the rails log format

This is a default rails 5 production format.

There are two places where Rails 5 log format is different from Rails 4.
Rails 5 log format added request id like this.

For rails logs, multiple lines of logs are output, such as status, which pages, what parameters are, even for one access.
The request ID is very useful and the same request ID is displayed during the 1 access so that you can see where the same access.

Another thing is not good news for td-agent user. The FATAL error message is output separate each line.

In fact, in spite of one error, every new line in the error message will be written in the log as a another error.

For example, if you make td-agent and slack cooperate to notify when FATAL error is occured, you get notified for each new line despite one error.

In this article, override the function that displays the error log and change it to output of log like Rails 4.
Of course, if it is ok to save FATAL error messages as separate logs, you can skip the next chapter.

Chnage the Fatal error log format

Fortunately it is not difficult to change the part of Fatal message.
Change the log_error function as Rails 4 format.

In addition, if we also delete the newline character, it will be easier for fluentd’s processing.

Open the config/environment.rb in rails project and write it

module ActionDispatch
  class DebugExceptions
    def log_error(request, wrapper)
      logger = logger(request)
      return unless logger

      exception = wrapper.exception

      trace = wrapper.application_trace
      trace = wrapper.framework_trace if trace.empty?

      ActiveSupport::Deprecation.silence do
        message = "#{exception.class} (#{exception.message}):"
        message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
        message << "  " << trace.join("\n  ")
        logger.fatal("#{message}")
      end
    end
  end
end

Let’s restart the server and see how the FATAL error log has changed.

The FATAL error message is included in to one line like this sample.

Error log setting is over.

Do not display View logs

The following is a code without any change from the default log format.

class Logger::Formatter
  def call(severity, time, progname, msg)
    format = "%s, [%s #%d] %5s -- %s: %s\n"
    format % [severity[0], "#{time.strftime('%Y-%m-%dT%H:%M:%S')}.#{'%06d' % time.usec.to_s}", $$, severity, progname, msg2str(msg)]
  end
end

In rails production log it outputs view information too.
Since this information is wasteful, it should not be left in the log.
This is the part of log.

It is ok if you don’t change that or not.

Open the config/environment.rb

Change the format like this.
If you are using erb please change “.haml” part to “.erb”.

class Logger::Formatter
  def call(severity, time, progname, msg)
    if !msg.include?('.haml')
      format = "%s, [%s #%d] %5s -- %s: %s\n"
      format % [severity[0], "#{time.strftime('%Y-%m-%dT%H:%M:%S')}.#{'%06d' % time.usec.to_s}", $$, severity, progname, msg2str(msg)]
    end
  end
end

Setting of rails is over.

Preparing to get rails log with td-agent

Alright, let’s prepare for td-agent side.

My rails and td-agent environment is like this.
Td-agent is running with CentOS 6.5.
Rails application is running on the unicorn + nginx.
Please prepare those servers environment.

Set up td-agent

In rails 4 production log is that Fatal errors are displayed over multiple lines. However, since the error_log function was overridden, the FATAL error message is gathered in one line. So you can write td-agent setting as a simple

<source>
  @type tail
  path /usr/share/nginx/alice5/log/production.log
  tag rails.production
  pos_file /var/log/td-agent/rails.production.pos
  format /^(?<log_initial>.*), [(?<date>d{1,4}-d{1,2}-d{1,2}Td{1,2}:d{1,2}:d{1,2}.d{1,6}) (?<process_id>[^ ]*)] *(?<log_level>[^ ]*) -- : [(?<request_id>[^ ]*)] (?<message>[^']*[^]]*)/
</source>

<match rails.production>
  @type stdout
</match>

With the “path” reference the production.log in the log folder of the rails project.
Please rewrite the reference path to your environment.

“tag rails.production” tagged a collected log.

With the “pos_file /var/log/td-agent/rails.production.pos” specifies the location of temporary files.

In the “format” matches the format of rails 5 production.log.

“” directive catch the log and display it.

This is the setting for td-agent to get rails log.

Getting log and check it

Restart the td-agent server.

sudo serice td-agent restart

Lauch the rails application in production.
Let’s access.

The td-agent log is output to the following location.

/var/log/td-agent/td-agent.log

Check with the tail command.

sudo tail -f /var/log/td-agent/td-agent.log

This is the log.

The most important thing is the part of “FATAL”.

The messages are gathered to one.

Conclusion

How about you, did you get it well?
I think that it is best not to edit the log format of rail as much as possible.
However, I had to change it in the form of FATAL error message.
If I get more good ways than this in the future I would like to change it.