<h1 id="%E6%A6%82%E8%A6%81"><a class="header-anchor-link" href="#%E6%A6%82%E8%A6%81" aria-hidden="true" rel="nofollow"></a> 概要</h1>
Ruby on RailsのロガーをRuby標準の <code>Logger</code> クラスから、 <code>ActiveSupport::Logger</code> に変更すると形式が変わってしまったので、原因と対処方法を調査しました。

 <div class="code-block-container">
 <div class="code-block-filename-container">従来のログ</div>
 <pre class="language-text"><code class="language-text">I, [2021-09-23T21:56:45.043019 #1103] INFO -- : Started GET "/" for XXX.XXX.XXX.XXX at 2021-09-23 21:57:22 +0900
I, [2021-09-23T21:56:45.043019 #1103] INFO -- : Processing by ExampleController#show as HTML
I, [2021-09-23T21:56:45.043019 #1103] INFO -- : Parameters: {"id"=>"1234"}
I, [2021-09-23T21:56:45.043019 #1103] INFO -- : Completed 200 OK in 341ms (Views: 152.1ms | ActiveRecord: 123.6ms)
I, [2021-09-23T21:56:45.043019 #1103] INFO -- : Started GET "/" for XXX.XXX.XXX.XXX at 2021-09-23 21:57:22 +0900
</code></pre>

 </div>
 
 <div class="code-block-container">
 <div class="code-block-filename-container">形式が変わってしまったログ</div>
 <pre class="language-text"><code class="language-text">Started GET "/" for XXX.XXX.XXX.XXX at 2021-09-23 21:57:22 +0900
Processing by ExampleController#show as HTML
 Parameters: {"id"=>"1234"}
Completed 200 OK in 341ms (Views: 152.1ms | ActiveRecord: 123.6ms)
</code></pre>

 </div>
 先頭についていた <code>I, [2021-09-23T21:56:45.043019 #1103] INFO -- : </code> のような表記がなくなってしまっています。
<h1 id="%E7%92%B0%E5%A2%83"><a class="header-anchor-link" href="#%E7%92%B0%E5%A2%83" aria-hidden="true" rel="nofollow"></a> 環境</h1>
<ul>
<li>Ruby 2.2.3</li>
<li>Ruby on Rails 4.2.4</li>
</ul>
<h1 id="%E5%AF%BE%E5%BF%9C%E6%96%B9%E6%B3%95"><a class="header-anchor-link" href="#%E5%AF%BE%E5%BF%9C%E6%96%B9%E6%B3%95" aria-hidden="true" rel="nofollow"></a> 対応方法</h1>
<ul>
<li>
<code>config/application.rb</code> （もしくは <code>config/environments/{環境名}.rb</code> ）で以下のように設定する。

 <div class="code-block-container">
 <div class="code-block-filename-container">config/application.rb</div>
 <pre class="diff-highlight language-diff-ruby"><code class="diff-highlight language-diff-ruby">- config.logger = ActiveSupport::Logger.new('log/application.log')

+ logger = ActiveSupport::Logger.new('log/application.log')
+ logger.formatter = ::Logger::Formatter.new
+ config.logger = logger
</code></pre>

 </div>
 </li>
</ul>
<h1 id="%E5%8E%9F%E5%9B%A0"><a class="header-anchor-link" href="#%E5%8E%9F%E5%9B%A0" aria-hidden="true" rel="nofollow"></a> 原因</h1>
<h2 id="%E9%96%A2%E9%80%A3%E3%82%B3%E3%83%BC%E3%83%89"><a class="header-anchor-link" href="#%E9%96%A2%E9%80%A3%E3%82%B3%E3%83%BC%E3%83%89" aria-hidden="true" rel="nofollow"></a> 関連コード</h2>
<ul>
<li>
Rubyの <code>Logger</code> クラスでは、ログのフォーマットは <code>format_message</code> メソッドにて行われる。
<a href="https://github.com/ruby/ruby/blob/v2_2_3/lib/logger.rb#L490-L492" rel="nofollow">https://github.com/ruby/ruby/blob/v2_2_3/lib/logger.rb#L490-L492</a>

 <div class="code-block-container">
 <div class="code-block-filename-container">lib/logger.rb#L490-L492</div>
 <pre class="language-ruby"><code class="language-ruby">def format_message(severity, datetime, progname, msg)
 (@formatter || @default_formatter).call(severity, datetime, progname, msg)
end
</code></pre>

 </div>
 実際のログのフォーマットは <code>@formatter</code> にセットされているフォーマッタクラスによって行われる。
</li>
<li>
<code>Logger</code> クラスのインスタンスの <code>formatter</code> をセットしない場合、デフォルトでは同じファイルで定義されている <code>Formatter</code> クラスが利用される。
<a href="https://github.com/ruby/ruby/blob/v2_2_3/lib/logger.rb#L314" rel="nofollow">https://github.com/ruby/ruby/blob/v2_2_3/lib/logger.rb#L314</a>

 <div class="code-block-container">
 <div class="code-block-filename-container">lib/logger.rb#L314</div>
 <pre class="language-ruby"><code class="language-ruby">@default_formatter = Formatter.new
@formatter = nil
</code></pre>

 </div>
 </li>
<li>
Rubyの <code>Logger</code> クラスを継承した <code>ActiveSupport::Logger</code> クラスでは、 <code>formatter</code> の値を上書きして <code>SimpleFormatter</code> クラスにしている。
<a href="https://github.com/rails/rails/blob/v4.2.4/activesupport/lib/active_support/logger.rb#L46" rel="nofollow">https://github.com/rails/rails/blob/v4.2.4/activesupport/lib/active_support/logger.rb#L46</a>

 <div class="code-block-container">
 <div class="code-block-filename-container">activesupport/lib/active_support/logger.rb#L46</div>
 <pre class="language-ruby"><code class="language-ruby">def initialize(*args)
 super
 @formatter = SimpleFormatter.new
end
</code></pre>

 </div>
 </li>
<li>
<code>SimpleFormatter</code> クラスは以下のような実装となっている。
<a href="https://github.com/rails/rails/blob/v4.2.4/activesupport/lib/active_support/logger.rb#L50-L55" rel="nofollow">https://github.com/rails/rails/blob/v4.2.4/activesupport/lib/active_support/logger.rb#L50-L55</a>

 <div class="code-block-container">
 <div class="code-block-filename-container">activesupport/lib/active_support/logger.rb#L50-L55</div>
 <pre class="language-ruby"><code class="language-ruby">class SimpleFormatter &lt; ::Logger::Formatter
 # This method is invoked when a log event occurs
 def call(severity, timestamp, progname, msg)
 "#{String === msg ? msg : msg.inspect}\n"
 end
end
</code></pre>

 </div>
 </li>
</ul>
<h2 id="%E8%A7%A3%E8%AA%AC"><a class="header-anchor-link" href="#%E8%A7%A3%E8%AA%AC" aria-hidden="true" rel="nofollow"></a> 解説</h2>
<ul>
<li>Railsの <code>config/application.rb</code> で <code>config.logger</code> に <code>Logger</code> クラスを設定するとフォーマッタにはRubyの <code>Formatter</code> クラスが利用され、 <code>ActiveSupport::Logger</code> クラスを設定するとフォーマッタにはRailsの <code>SimpleFormatter</code> クラスが利用される。</li>
<li><code>logger.formatter</code> に任意のフォーマッタクラスをセットすることでログを好きなフォーマットに変更することができる。</li>
</ul>
<h1 id="%E5%82%99%E8%80%83"><a class="header-anchor-link" href="#%E5%82%99%E8%80%83" aria-hidden="true" rel="nofollow"></a> 備考</h1>
<h2 id="activesupport%3A%3Ataggedlogging%E3%82%92%E4%BD%BF%E3%81%84%E3%81%9F%E3%81%84%E5%A0%B4%E5%90%88%E3%81%AE%E8%A8%AD%E5%AE%9A%E6%96%B9%E6%B3%95"><a class="header-anchor-link" href="#activesupport%3A%3Ataggedlogging%E3%82%92%E4%BD%BF%E3%81%84%E3%81%9F%E3%81%84%E5%A0%B4%E5%90%88%E3%81%AE%E8%A8%AD%E5%AE%9A%E6%96%B9%E6%B3%95" aria-hidden="true" rel="nofollow"></a> ActiveSupport::TaggedLoggingを使いたい場合の設定方法</h2>

 <div class="code-block-container">
 <div class="code-block-filename-container">config/application.rb</div>
 <pre class="language-ruby"><code class="language-ruby">logger = ActiveSupport::Logger.new('log/application.log')
logger.formatter = ::Logger::Formatter.new
config.logger = ActiveSupport::TaggedLogging.new(logger)
</code></pre>

 </div>
 <h2 id="config.log_formatter%E3%81%AB%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%82%BF%E3%82%92%E8%A8%AD%E5%AE%9A%E3%81%97%E3%81%A6%E3%82%82%E6%84%8F%E5%9B%B3%E9%80%9A%E3%82%8A%E3%81%AE%E7%B5%90%E6%9E%9C%E3%81%AB%E3%81%AA%E3%82%89%E3%81%AA%E3%81%84%E7%90%86%E7%94%B1"><a class="header-anchor-link" href="#config.log_formatter%E3%81%AB%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%82%BF%E3%82%92%E8%A8%AD%E5%AE%9A%E3%81%97%E3%81%A6%E3%82%82%E6%84%8F%E5%9B%B3%E9%80%9A%E3%82%8A%E3%81%AE%E7%B5%90%E6%9E%9C%E3%81%AB%E3%81%AA%E3%82%89%E3%81%AA%E3%81%84%E7%90%86%E7%94%B1" aria-hidden="true" rel="nofollow"></a> config.log_formatterにフォーマッタを設定しても意図通りの結果にならない理由</h2>
<code>config.log_formatter</code> の値が <code>Logger</code> クラスの <code>formatter</code> にセットされるのは、 <code>config.logger</code> が未設定の場合のみ。
<div class="embed-zenn-link"><iframe src="https://card.zenn.dev/?url=https%3A%2F%2Fgithub.com%2Frails%2Frails%2Fblob%2Fv4.2.4%2Frailties%2Flib%2Frails%2Fapplication%2Fbootstrap.rb%23L33-L56" frameborder="0" scrolling="no" loading="lazy"></iframe></div><a href="https://github.com/rails/rails/blob/v4.2.4/railties/lib/rails/application/bootstrap.rb#L33-L56" style="display: none" rel="nofollow">https://github.com/rails/rails/blob/v4.2.4/railties/lib/rails/application/bootstrap.rb#L33-L56</a>

 <div class="code-block-container">
 <div class="code-block-filename-container">railties/lib/rails/application/bootstrap.rb#L43-L46</div>
 <pre class="language-ruby"><code class="language-ruby">logger = ActiveSupport::Logger.new f
logger.formatter = config.log_formatter
logger = ActiveSupport::TaggedLogging.new(logger)
logger
</code></pre>

 </div>
 よって、 <code>config.log_formatter = ::Logger::Formatter.new</code> としたとしても、 <code>config.logger = ActiveSupport::Logger.new('log/application.log')</code> としていると意味がなくなってしまう。
そのため、 <code>config.log_formatter</code> を使わずに以下のように設定する。

 <div class="code-block-container">
 <div class="code-block-filename-container">config/application.rb</div>
 <pre class="language-ruby"><code class="language-ruby">logger = ActiveSupport::Logger.new('log/application.log')
logger.formatter = ::Logger::Formatter.new
config.logger = logger
</code></pre>

 </div>
 <h1 id="%E8%83%8C%E6%99%AF"><a class="header-anchor-link" href="#%E8%83%8C%E6%99%AF" aria-hidden="true" rel="nofollow"></a> 背景</h1>
<a href="https://itotetsu.work/articles/ruby-on-rails-suppress-logs-from-elb" rel="nofollow">RailsアプリでELBからのヘルスチェックのアクセスをログに残さないようにする</a> は <code>ActiveSupport::Logger</code> を継承したクラスを利用していないと行えなかったのでロガークラスを変更したところ、ログの形式が変わってしまったために本対応を行いました。
<h1 id="%E6%84%9F%E6%83%B3"><a class="header-anchor-link" href="#%E6%84%9F%E6%83%B3" aria-hidden="true" rel="nofollow"></a> 感想</h1>
<code>config.log_formatter</code> を変更しても適用されずしばらくハマりました。今回RailsやRubyのソースコードをじっくり追いながら実装を把握することができて明確になりました。フルタイムで働いていた頃は何かと忙しくてついこういった細部は「動けばいいや」でやってしまっていたことも多かったですが、しっかり調べることで足元を掬われにくくなるのでやはり急がば回れできちんと調べることが重要だと思いました。
<h1 id="%E5%8F%82%E8%80%83%E3%81%AB%E3%81%95%E3%81%9B%E3%81%A6%E3%81%84%E3%81%9F%E3%81%A0%E3%81%84%E3%81%9F%E3%82%B5%E3%82%A4%E3%83%88"><a class="header-anchor-link" href="#%E5%8F%82%E8%80%83%E3%81%AB%E3%81%95%E3%81%9B%E3%81%A6%E3%81%84%E3%81%9F%E3%81%A0%E3%81%84%E3%81%9F%E3%82%B5%E3%82%A4%E3%83%88" aria-hidden="true" rel="nofollow"></a> 参考にさせていただいたサイト</h1>
<ul>
<li><a href="https://sites.google.com/site/mozuememo/home/rubyno-memo/ruby-no--activesupport-ga--logger-no-rogu-naiyou-wo-henkou-suru" rel="nofollow">Ruby の activesupport が logger のログ内容を変更する</a>
<ul>
<li>原因と解決策が端的に書かれていました。</li>
</ul>
</li>
<li><a href="https://railsguides.jp/configuring.html" rel="nofollow">Rails アプリケーションを設定する</a>
<ul>
<li><code>log_formatter</code> オプションの挙動が説明されていました。</li>
</ul>
</li>
</ul>

Ruby on RailsのロガーをActiveSupport::Loggerに変更したときに形式が変わる問題の原因と対処方法

<h1 id="%E6%A6%82%E8%A6%81"><a class="header-anchor-link" href="#%E6%A6%82%E8%A6%81" aria-hidden="true" rel="nofollow"></a> 概要</h1>
EC2上で稼働するRuby on Railsのログに、ELBからのヘルスチェックのリクエストが記録されないようにする手順です。
<h1 id="%E7%92%B0%E5%A2%83"><a class="header-anchor-link" href="#%E7%92%B0%E5%A2%83" aria-hidden="true" rel="nofollow"></a> 環境</h1>
<ul>
<li>Ruby 2.2.3</li>
<li>Ruby on Rails 4.2.4</li>
<li>Application Load Balancer</li>
</ul>
<h1 id="%E6%89%8B%E9%A0%86"><a class="header-anchor-link" href="#%E6%89%8B%E9%A0%86" aria-hidden="true" rel="nofollow"></a> 手順</h1>
<ul>
<li>
Railsのロガーに <code>ActiveSupport::Logger</code> を継承するクラスが設定されているか確認する

 <div class="code-block-container">
 <div class="code-block-filename-container">config/application.rb</div>
 <pre class="language-ruby"><code class="language-ruby"># NG
config.logger = Logger.new('log/application.log')

# OK
config.logger = ActiveSupport::Logger.new('log/application.log')

# OK
config.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new('log/application.log'))
</code></pre>

 </div>
 <div class="msg ">この作業が完了できていない場合に起きるエラーは後述。
</div>
</li>
<li>
条件に応じてログ出力を抑制する処理を記述する <code>CustomLogger</code> クラスを作成する

 <div class="code-block-container">
 <div class="code-block-filename-container">lib/custom_logger.rb</div>
 <pre class="language-ruby"><code class="language-ruby">class CustomLogger &lt; Rails::Rack::Logger
 def call(env)
 user_agent = env['HTTP_USER_AGENT']

 if user_agent.include?('ELB-HealthChecker')
 Rails.logger.silence do
 super
 end
 else
 super
 end
 end
end
</code></pre>

 </div>
 </li>
<li>
ミドルウェアスタック内の <code>Rails::Rack::Logger</code> を独自で定義した <code>CustomLogger</code> に置き換える

 <div class="code-block-container">
 <div class="code-block-filename-container">config/initializers/custom_logger.rb</div>
 <pre class="language-ruby"><code class="language-ruby">require 'custom_logger'
MyApp::Application.config.middleware.swap Rails::Rack::Logger, CustomLogger
</code></pre>

 </div>
 <div class="msg "><code>MyApp</code> の部分は各アプリケーションの名前に置き換える。具体的には <code>config/application.rb</code> で <code>module MyApp</code> のように定義している名前に合わせる。
</div>
</li>
</ul>
<h1 id="%E5%82%99%E8%80%83"><a class="header-anchor-link" href="#%E5%82%99%E8%80%83" aria-hidden="true" rel="nofollow"></a> 備考</h1>
<h2 id="curl%E3%81%A7%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E3%82%A8%E3%83%BC%E3%82%B8%E3%82%A7%E3%83%B3%E3%83%88%E3%82%92%E5%A4%89%E6%9B%B4%E3%81%97%E3%81%A6%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%82%92%E7%99%BA%E8%A1%8C%E3%81%99%E3%82%8B"><a class="header-anchor-link" href="#curl%E3%81%A7%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E3%82%A8%E3%83%BC%E3%82%B8%E3%82%A7%E3%83%B3%E3%83%88%E3%82%92%E5%A4%89%E6%9B%B4%E3%81%97%E3%81%A6%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%82%92%E7%99%BA%E8%A1%8C%E3%81%99%E3%82%8B" aria-hidden="true" rel="nofollow"></a> curlでユーザーエージェントを変更してリクエストを発行する</h2>
手元の開発環境で効率的に検証することができる。

 <div class="code-block-container">
 
 <pre class="language-bash"><code class="language-bash">curl -A "ELB-HealthChecker" http://localhost:3000/
</code></pre>

 </div>
 Basic認証をかけている環境では、さらに <code>-u</code> オプションでユーザー名とパスワードを指定することでテストできる。

 <div class="code-block-container">
 
 <pre class="language-bash"><code class="language-bash">curl \
 -u user:password \
 -A "ELB-HealthChecker" \
 http://localhost:3000/
</code></pre>

 </div>
 <h2 id="rails%E3%81%AE%E3%83%AD%E3%82%AC%E3%83%BC%E3%81%AB-activesupport%3A%3Alogger-%E3%82%92%E7%B6%99%E6%89%BF%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E3%82%AF%E3%83%A9%E3%82%B9%E3%81%8C%E8%A8%AD%E5%AE%9A%E3%81%95%E3%82%8C%E3%81%A6%E3%81%84%E3%81%AA%E3%81%84%E5%A0%B4%E5%90%88%E3%81%AB%E7%99%BA%E7%94%9F%E3%81%99%E3%82%8B%E3%82%A8%E3%83%A9%E3%83%BC"><a class="header-anchor-link" href="#rails%E3%81%AE%E3%83%AD%E3%82%AC%E3%83%BC%E3%81%AB-activesupport%3A%3Alogger-%E3%82%92%E7%B6%99%E6%89%BF%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E3%82%AF%E3%83%A9%E3%82%B9%E3%81%8C%E8%A8%AD%E5%AE%9A%E3%81%95%E3%82%8C%E3%81%A6%E3%81%84%E3%81%AA%E3%81%84%E5%A0%B4%E5%90%88%E3%81%AB%E7%99%BA%E7%94%9F%E3%81%99%E3%82%8B%E3%82%A8%E3%83%A9%E3%83%BC" aria-hidden="true" rel="nofollow"></a> Railsのロガーに ActiveSupport::Logger を継承しているクラスが設定されていない場合に発生するエラー</h2>
ELB以外からのアクセスの（＝ユーザーエージェントに <code>ELB-HealthChecker</code> が含まれない）場合は問題なくログが出力されるが、ELBからのアクセス時には以下のようなエラーが発生する。

 <div class="code-block-container">
 
 <pre class="language-text"><code class="language-text">2021-09-24 01:14:54 +0900: Rack app error handling request { GET / }
#&lt;ArgumentError: wrong number of arguments (0 for 1)>
/var/www/vendor/bundle/ruby/2.2.0/gems/activesupport-4.2.4/lib/active_support/core_ext/kernel/reporting.rb:89:in `capture'
/var/www/lib/custom_logger.rb:8:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/request_store-1.4.0/lib/request_store/middleware.rb:19:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/actionpack-4.2.4/lib/action_dispatch/middleware/request_id.rb:21:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/rack-1.6.8/lib/rack/methodoverride.rb:22:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/rack-1.6.8/lib/rack/runtime.rb:18:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/activesupport-4.2.4/lib/active_support/cache/strategy/local_cache_middleware.rb:28:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/rack-1.6.8/lib/rack/lock.rb:17:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/actionpack-4.2.4/lib/action_dispatch/middleware/static.rb:116:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/rack-1.6.8/lib/rack/sendfile.rb:113:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/railties-4.2.4/lib/rails/engine.rb:518:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/railties-4.2.4/lib/rails/application.rb:165:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/rack-1.6.8/lib/rack/content_length.rb:15:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/puma-3.8.2/lib/puma/configuration.rb:224:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/puma-3.8.2/lib/puma/server.rb:600:in `handle_request'
/var/www/vendor/bundle/ruby/2.2.0/gems/puma-3.8.2/lib/puma/server.rb:435:in `process_client'
/var/www/vendor/bundle/ruby/2.2.0/gems/puma-3.8.2/lib/puma/server.rb:299:in `block in run'
/var/www/vendor/bundle/ruby/2.2.0/gems/puma-3.8.2/lib/puma/thread_pool.rb:120:in `call'
/var/www/vendor/bundle/ruby/2.2.0/gems/puma-3.8.2/lib/puma/thread_pool.rb:120:in `block in spawn_thread'
</code></pre>

 </div>
 <h1 id="%E8%83%8C%E6%99%AF"><a class="header-anchor-link" href="#%E8%83%8C%E6%99%AF" aria-hidden="true" rel="nofollow"></a> 背景</h1>
EC2でRuby on Railsを稼働させており、前段にApplication Load Balancerを配置しています。ヘルスチェックで定期的にアプリケーションにリクエストが来るようになっていますが、そのログがアクセスログに残ってしまうと見づらかったりログファイルを圧迫して困っていました。
ログはAWSのCloudWatch Logsに送信しているので、ログの量が増えれば転送量やストレージ容量が増え、コスト増加につながるため、それを防ぎたい狙いもありました。
Nginxでは既にELBからのヘルスチェックのアクセスをログに残さないように設定していましたが、Railsの方はまだ設定できていませんでした。NginxだけでなくRailsアプリケーションが正しく動作していることをヘルスチェックの条件にしたいので、Railsが処理するパスを叩くことは継続したい状況でした。
<h1 id="%E6%84%9F%E6%83%B3"><a class="header-anchor-link" href="#%E6%84%9F%E6%83%B3" aria-hidden="true" rel="nofollow"></a> 感想</h1>
Rackの設定は普段触れることがないのでまだまだ知らないことだらけです。必要になったタイミングで多少時間を多めに取ってコツコツ理解できたらと思います。
<h1 id="%E5%8F%82%E8%80%83%E3%81%AB%E3%81%95%E3%81%9B%E3%81%A6%E3%81%84%E3%81%9F%E3%81%A0%E3%81%84%E3%81%9F%E3%82%B5%E3%82%A4%E3%83%88"><a class="header-anchor-link" href="#%E5%8F%82%E8%80%83%E3%81%AB%E3%81%95%E3%81%9B%E3%81%A6%E3%81%84%E3%81%9F%E3%81%A0%E3%81%84%E3%81%9F%E3%82%B5%E3%82%A4%E3%83%88" aria-hidden="true" rel="nofollow"></a> 参考にさせていただいたサイト</h1>
<ul>
<li><a href="https://blog.hello-world.jp.net/posts/ruby-2490" rel="nofollow">[rails]ELBのヘルスチェックをアプリケーションログに残さないようにする</a>
<ul>
<li>やりたいことをほぼそのままやられていたので、ほぼ全て参考にさせていただきました。</li>
</ul>
</li>
<li><a href="https://railsguides.jp/rails_on_rack.html#%E3%83%9F%E3%83%89%E3%83%AB%E3%82%A6%E3%82%A7%E3%82%A2%E3%82%92%E7%BD%AE%E3%81%8D%E6%8F%9B%E3%81%88%E3%82%8B" rel="nofollow">Rails と Rack（3.2.2 ミドルウェアを置き換える） - Railsガイド</a>
<ul>
<li><code>Application.config.middleware.swap</code> が何をしているのか理解できました。</li>
</ul>
</li>
</ul>

RailsアプリでELBからのヘルスチェックのアクセスをログに残さないようにする

<h1 id="%E6%A6%82%E8%A6%81"><a class="header-anchor-link" href="#%E6%A6%82%E8%A6%81" aria-hidden="true" rel="nofollow"></a> 概要</h1>
Linux上で稼働しているRuby on RailsアプリケーションのログローテーションにRubyの <code>Logger</code> クラスの機能を使うか、Linuxの <code>logrotate</code> を使うか検討してみました。
<h1 id="%E7%92%B0%E5%A2%83"><a class="header-anchor-link" href="#%E7%92%B0%E5%A2%83" aria-hidden="true" rel="nofollow"></a> 環境</h1>
<ul>
<li>Ruby 2.2.3</li>
<li>Ruby on Rails 4.2.4</li>
<li>Puma 3.8.2</li>
<li>Amazon Linux</li>
</ul>
<h1 id="%E7%B5%90%E8%AB%96"><a class="header-anchor-link" href="#%E7%B5%90%E8%AB%96" aria-hidden="true" rel="nofollow"></a> 結論</h1>
Railsではログローテーションは行わず、 <code>logrotate</code> で行う
理由：
<ul>
<li>Rails（Puma）以外にもログを出力するプロセスは複数存在しており、ログローテーションの管理を1系統にしたい</li>
<li>現在はEC2で稼働させているが、Docker + Amazon ECSの環境に移行することを考えた場合、ログはCloudWatch Logsに直接送信する構成にするので、その時はRailsアプリケーションにログローテーションの設定が入っている必要がない（あると移行したときにハマる可能性がある）</li>
</ul>
<h1 id="logger%E3%82%AF%E3%83%A9%E3%82%B9%E3%81%AE%E5%88%A9%E7%94%A8%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88"><a class="header-anchor-link" href="#logger%E3%82%AF%E3%83%A9%E3%82%B9%E3%81%AE%E5%88%A9%E7%94%A8%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88" aria-hidden="true" rel="nofollow"></a> Loggerクラスの利用する場合</h1>
Ruby on RailsではデフォルトでRubyの <code>Logger</code> クラスがログ出力に利用されており、その <code>Logger</code> クラスにはログローテーション機能が含まれています。
<div class="embed-zenn-link"><iframe src="https://card.zenn.dev/?url=https%3A%2F%2Fdocs.ruby-lang.org%2Fja%2F2.2.0%2Fclass%2FLogger.html" frameborder="0" scrolling="no" loading="lazy"></iframe></div><a href="https://docs.ruby-lang.org/ja/2.2.0/class/Logger.html" style="display: none" rel="nofollow">https://docs.ruby-lang.org/ja/2.2.0/class/Logger.html</a>
例えば以下のように設定することで、ファイルサイズが10MBを超えたらログをローテーションし、古いログファイルを最大30件保持するような動作が実現できます。

 <div class="code-block-container">
 <div class="code-block-filename-container">config/application.rb</div>
 <pre class="language-ruby"><code class="language-ruby">config.logger = Logger.new('log/application.log', 30, 10 * 1024 * 1024)
</code></pre>

 </div>
 <h1 id="logrotate%E3%82%92%E4%BD%BF%E3%81%86%E5%A0%B4%E5%90%88"><a class="header-anchor-link" href="#logrotate%E3%82%92%E4%BD%BF%E3%81%86%E5%A0%B4%E5%90%88" aria-hidden="true" rel="nofollow"></a> logrotateを使う場合</h1>
<code>/etc/logrotate.d/myapp</code> に以下のような設定を記述する

 <div class="code-block-container">
 <div class="code-block-filename-container">/etc/logrotate.d/myapp</div>
 <pre class="language-text"><code class="language-text">/var/www/log/*.log {
 size 5M
 rotate 5
 create 0644 rails rails
 copytruncate
 missingok
 notifempty
 nocompress
}
</code></pre>

 </div>
 <ul>
<li>Railsのログは <code>/var/www/log</code> に出力されるので、対象は <code>/var/www/log/*.log</code> にする</li>
<li>アプリケーションはユーザー <code>rails</code> 、グループ <code>rails</code> で稼働させているので、ローテーション後に作成するログも同様にする</li>
<li>ログファイルのパーミッションは <code>664</code> なので、ローテーション後に作成するログも同様にする</li>
<li>ログのローテーション後にRailsプロセスを再起動しなくていいように、 <code>copytruncate</code> をオンにする</li>
</ul>
<h1 id="%E6%84%9F%E6%83%B3"><a class="header-anchor-link" href="#%E6%84%9F%E6%83%B3" aria-hidden="true" rel="nofollow"></a> 感想</h1>
最近はAWSのマネージドサービスを組み合わせてシステムを構築することも多くなってきたので、こういったLinuxの設定周りはあまりやらなくなってきましたが、こういった運用周りの設定は嫌いじゃないです。

tag: Ruby on Rails