<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上で動くアプリケーションのログを <code>awslogs</code> を使ってCloudWatch Logsに送信する手順です。
<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>Amazon Linux AMI release 2018.03</li>
<li>awslogs 1.1.4-1.12</li>
<li>EC2インスタンスにはインスタンスプロファイルがアタッチ済み</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>
EC2インスタンスに割り当てられているインスタンスプロファイルに、CloudWatch Logsへの書き込み権限を与える
インラインポリシーで許可する例

 <div class="code-block-container">
 
 <pre class="language-json"><code class="language-json">{
 "Version": "2012-10-17",
 "Statement": [
 {
 "Effect": "Allow",
 "Action": [
 "logs:CreateLogGroup",
 "logs:CreateLogStream",
 "logs:PutLogEvents",
 "logs:DescribeLogStreams"
 ],
 "Resource": [
 "*"
 ]
 }
 ]
}
</code></pre>

 </div>
 </li>
<li>
EC2インスタンスに <code>awslogs</code> をインストールする

 <div class="code-block-container">
 
 <pre class="language-bash"><code class="language-bash">yum install -y awslogs
</code></pre>

 </div>
 </li>
<li>
<code>awslogs</code> の設定を行う
<ul>
<li>
設定ファイルは <code>/etc/awslogs/awslogs.conf</code> にある
</li>
<li>
どのファイルを、どの頻度で、どのロググループに送るのか等を設定できる
設定の記述方法は <a href="https://docs.aws.amazon.com/ja_jp/AmazonCloudWatch/latest/logs/AgentReference.html" rel="nofollow">CloudWatch Logs エージェントのリファレンス</a> を参照
</li>
<li>
設定の例

 <div class="code-block-container">
 <div class="code-block-filename-container">/etc/awslogs/awslogs.conf</div>
 <pre class="language-text"><code class="language-text">[general]
state_file = /var/lib/awslogs/agent-state
use_gzip_http_content_encoding = true

[/var/www/log/application.log]
file = /var/www/log/application.log*
log_group_name = application-log
log_stream_name = {instance_id}
datetime_format = '%Y-%m-%dT%H:%M:%S%z'
time_zone = LOCAL
initial_position = start_of_file
encoding = utf_8
</code></pre>

 </div>
 </li>
</ul>
</li>
<li>
システム起動時に <code>awslogs</code> サービスが起動するようにする

 <div class="code-block-container">
 
 <pre class="language-bash"><code class="language-bash">chkconfig awslogs on
</code></pre>

 </div>
 </li>
<li>
<code>awslogs</code> サービスを起動する

 <div class="code-block-container">
 
 <pre class="language-bash"><code class="language-bash">service awslogs start
</code></pre>

 </div>
 </li>
</ul>
<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でWebアプリケーションを構築していて、ログをインスタンスにアタッチしているEBSに書き込むと以下のような不都合が発生します。
<ul>
<li>メンテナンス作業で、以前作成したAMIからインスタンスを作成して稼働中のインスタンスと差し替えるといった操作をする場合、AMI作成時点から作業時までのログが失われる</li>
<li>EC2インスタンスのストレージを徐々に圧迫する</li>
<li>EBSはハードウェア障害時の内容は保証されず、ログが失われる可能性がある</li>
<li>複数台のインスタンスを起動して冗長構成を取っている場合、ログを確認するのが手間（EFSを利用すれば解消できるかも）</li>
</ul>
EC2インスタンスに可能な限り状態を持たせないようにするため、CloudWatch Logsにエクスポートするようにしたいと考えました。
<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>awslogs</code> を使うことで簡単にログをCloudWatch Logsに送信できました。CloudWatch Logsにフィルタを設定してログを監視することもできそうです。
EC2インスタンスからログの保存という役割は追い出せたものの、CloudWatch Logsも保存容量に応じた費用がかかるので、定期的にS3にアーカイブする設定も作った方が良さそうです。
インスタンスプロファイル経由で認証情報を得られるかと思いきや、作業環境では前任者がIAMユーザーを作成して認証情報を <code>~/.aws/credentials</code> に書き込んでいたためハマりました。
<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://docs.aws.amazon.com/ja_jp/AmazonCloudWatch/latest/logs/QuickStartEC2Instance.html" rel="nofollow">クイックスタート: 実行中の EC2 Linux インスタンスに CloudWatch Logs エージェントをインストールして設定する</a>
<ul>
<li>Amazon Linuxへのインストール方法が把握できました。</li>
</ul>
</li>
<li><a href="https://docs.aws.amazon.com/ja_jp/AmazonCloudWatch/latest/logs/AgentReference.html" rel="nofollow">CloudWatch Logs エージェントのリファレンス</a>
<ul>
<li>設定ファイルの記述方法を把握できました。</li>
</ul>
</li>
</ul>

EC2上のアプリのログをawslogsを使ってCloudWatch Logsに送信する

<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>
AWSのElastic Load Balancer（ELB）では、ELBの設定だけでメンテナンス画面を表示することができます。Tailwind CSSを組み合わせることで、シンプルにそれなりの見た目を持つメンテナンス画面をサクッと作ることができます。
<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>
HTMLを用意する

 <div class="code-block-container">
 
 <pre class="language-html"><code class="language-html">&lt;!DOCTYPE html>
&lt;html lang="ja">
&lt;head>
 &lt;meta charset="utf-8">
 &lt;title>メンテナンス中です | {サービス名}&lt;/title>
 &lt;link href="https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css" rel="stylesheet">
&lt;/head>
&lt;body>
 &lt;div class="p-5">
 &lt;div class="rounded p-5 bg-yellow-100 text-yellow-800 border border-solid border-yellow-200 mx-auto" style="max-width: 800px;">
 ただいまメンテナンス中です。ご迷惑をおかけしております。
 &lt;/div>
 &lt;/div>
&lt;/body>
&lt;/html>
</code></pre>

 </div>
 このコードの場合、メンテナンス画面の見た目は以下のようになる。
<img src="maintenance.png" alt="">
</li>
<li>
AWSのマネジメントコンソールでロードバランサーの管理画面を開く
</li>
<li>
メンテナンス画面を表示させたいアプリケーションの前段に配置しているロードバランサーを選択し、「ルールの表示/編集」をクリックする
<img src="01.png" alt="">
</li>
<li>
「＋」ボタンをクリックし、「ルールの挿入」をクリックする 
<img src="02.png" alt="">
</li>
<li>
条件とレスポンスを設定する
<ul>
<li>「条件の追加」で「パス」を選び、条件に「*」を入力する</li>
<li>「アクションの追加」で「固定レスポンスを返す」を選び、レスポンスコードに <code>503</code> を、Content-Typeに <code>text/html</code> を、レスポンス本文に事前に作成したHTMLコードを入力する</li>
</ul>
<img src="03.png" alt="">
</li>
<li>
ルールを保存する
</li>
</ul>
<div class="msg ">更新したルールが反映されるまで15秒〜10秒程度かかる。
</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>
ELBの管理画面から表示させたいHTMLの設定することになるので、CSSファイルを分けて用意するとなると、別途ホスティングするサーバーが必要になります。メンテナンス画面を表示させたい機会はそれほど多くないので、できるだけ管理はシンプルに保ちたいです。
Tailwind CSSをCDNから読み込んで利用することで、HTMLファイルだけで表現力のあるメンテナンス画面を構築することができると考えて挑戦しました。
<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>
Tailwind CSSはHTMLをコピペするだけでスタイルごとコピペできるので非常に便利だと感じています。CSSを書く必要がないので、CSSのコーディング規約や記述場所に悩む必要がなくなりました。CDNで利用する場合、使っていないクラスに関するCSSを削除できないので転送するデータ量は大きくなりますが、今回のような用途であれば全く問題ないかと思います。

tag: AWS