<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>

tag: AWS ELB