<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>
<p>EC2のAmazon Linux 2上でDockerとDocker Composeを利用できるようにする手順です。</p>
<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 2</li>
<li>Docker version 20.10.7</li>
<li>Docker Compose version v2.0.1</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>
<p>EC2インスタンスにSSH接続する</p>
</li>
<li>
<p>dockerとdocker composeをインストールする</p>
<div class="msg "><p>以下の手順は root に切り替えた上で実施する。</p>
</div>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">bash</span></div>
        <pre class="language-bash"><code class="language-bash">yum update -y

<span class="token comment"># dockerをインストールする</span>
yum <span class="token function">install</span> -y docker

<span class="token comment"># dockerサービスを起動する</span>
systemctl start docker

<span class="token comment"># dockerサービスを自動起動する設定をする</span>
systemctl <span class="token builtin class-name">enable</span> docker

<span class="token comment"># ec2-userがdockerコマンドを実行できるようにする</span>
<span class="token function">usermod</span> -a -G docker ec2-user

<span class="token comment"># dockerコマンドにcomposeコマンドを追加する</span>
<span class="token function">mkdir</span> -p ~/.docker/cli-plugins/
<span class="token function">curl</span> <span class="token punctuation">\</span>
  -SL https://github.com/docker/compose/releases/download/v2.0.1/docker-compose-linux-x86_64 <span class="token punctuation">\</span>
  -o ~/.docker/cli-plugins/docker-compose
<span class="token function">chmod</span> +x ~/.docker/cli-plugins/docker-compose
</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>
<p>M1 Proを購入したタイミングで運営していたサービスのDocker化を行いました。その際にM1 Pro上でDockerの環境構築を行うのは、ARM64に対応していないイメージがあったため効率が悪いと考えて、一旦EC2上のx86_64版Amazon Linux 2上で検証することにしました。</p>
<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.docker.com/compose/cli-command/" rel="nofollow">Compose V2 | Docker Documentation</a>
<ul>
<li>dockerコマンドにcomposeコマンドを追加する方法が書かれています。</li>
</ul>
</li>
</ul>


Amazon Linux 2にDockerとDocker Composeをインストールする

<h1 id="%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89"><a class="header-anchor-link" href="#%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89" aria-hidden="true" rel="nofollow"></a> コマンド</h1>
<h2 id="%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB%E5%8F%AF%E8%83%BD%E3%81%AAnode.js%E3%81%AE%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E3%82%92%E6%9B%B4%E6%96%B0%E3%81%99%E3%82%8B"><a class="header-anchor-link" href="#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB%E5%8F%AF%E8%83%BD%E3%81%AAnode.js%E3%81%AE%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E3%82%92%E6%9B%B4%E6%96%B0%E3%81%99%E3%82%8B" aria-hidden="true" rel="nofollow"></a> インストール可能なNode.jsのバージョンを更新する</h2>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash"><span class="token function">git</span> -C <span class="token environment constant">$HOME</span>/.anyenv/envs/nodenv/plugins/node-build pull
</code></pre>

      </div>
      <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://dev.classmethod.jp/articles/nodenv-install-newer-node-version/" rel="nofollow">nodenvでインストールしたいNodeのバージョンがない時の対処法</a></li>
</ul>


nodenvのTips

<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>macOS Big Sur 11.5.2</li>
<li>Google Cloud SDK 358.0.0</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>
<p>作成対象のプロジェクトをアクティブにする</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">gcloud config <span class="token builtin class-name">set</span> project <span class="token operator">&lt;</span>PROJECT_ID<span class="token operator">></span>
</code></pre>

      </div>
      </li>
<li>
<p>以下のコマンドを実行する</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">bq query <span class="token punctuation">\</span>
  --nouse_legacy_sql <span class="token string">'
  CREATE TABLE dataset_name.table_name (
    int_field     INT64   NOT NULL,
    string_field  STRING  NOT NULL,
    date_field    DATE    NOT NULL,
    timestamp     INT64
  )
'</span>
</code></pre>

      </div>
      </li>
</ul>
<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://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language?hl=ja" rel="nofollow">標準 SQL のデータ定義言語（DDL）ステートメント</a></li>
</ul>


bqコマンドでBigQueryのテーブルを作成する

<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>macOS Big Sur 11.5.2</li>
<li>Google Cloud SDK 358.0.0</li>
</ul>
<h1 id="%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E6%93%8D%E4%BD%9C"><a class="header-anchor-link" href="#%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E6%93%8D%E4%BD%9C" aria-hidden="true" rel="nofollow"></a> プロジェクトの操作</h1>
<ul>
<li>
<p>アクティブなプロジェクトを切り替える</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">gcloud config <span class="token builtin class-name">set</span> project <span class="token operator">&lt;</span>PROJECT_ID<span class="token operator">></span>
</code></pre>

      </div>
      </li>
<li>
<p>全てのプロジェクトを表示</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">gcloud projects list
</code></pre>

      </div>
      </li>
</ul>
<h1 id="%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%81%AE%E6%93%8D%E4%BD%9C"><a class="header-anchor-link" href="#%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%81%AE%E6%93%8D%E4%BD%9C" aria-hidden="true" rel="nofollow"></a> アカウントの操作</h1>
<ul>
<li>
<p>アクティブなアカウントを確認</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">gcloud auth list
</code></pre>

      </div>
      </li>
<li>
<p>アクティブなアカウントを切り替え</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">gcloud config <span class="token builtin class-name">set</span> account <span class="token operator">&lt;</span>EMAIL_ADDRESS<span class="token operator">></span>
</code></pre>

      </div>
      </li>
</ul>
<h1 id="configuration%E3%81%AE%E6%93%8D%E4%BD%9C"><a class="header-anchor-link" href="#configuration%E3%81%AE%E6%93%8D%E4%BD%9C" aria-hidden="true" rel="nofollow"></a> Configurationの操作</h1>
<ul>
<li>
<p>全ての設定を表示</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">gcloud config configurations list
</code></pre>

      </div>
      </li>
<li>
<p>設定を新たに作成</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">gcloud config configurations create <span class="token operator">&lt;</span>NAME<span class="token operator">></span>
</code></pre>

      </div>
      </li>
</ul>
<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://cloud.google.com/sdk/gcloud/reference/config/set" rel="nofollow">gcloud config set | Cloud SDK Documentation</a></li>
</ul>


gcloudでよく使うコマンド

<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>
<p><code>yum</code> でインストールしたパッケージのバージョンを確認する方法です。</p>
<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>CentOS Linux release 7.9.2009 (Core)</li>
<li>Amazon Linux AMI release 2018.03</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>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum list <span class="token operator">|</span> <span class="token function">grep</span> パッケージ名
</code></pre>

      </div>
      <h1 id="%E4%BE%8B"><a class="header-anchor-link" href="#%E4%BE%8B" aria-hidden="true" rel="nofollow"></a> 例</h1>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">例（Amazon Linux）</span></div>
        <pre class="language-bash"><code class="language-bash">$ yum list <span class="token operator">|</span> <span class="token function">grep</span> mysql-server
mysql-server.noarch             <span class="token number">5.5</span>-1.6.amzn1  amzn-main
</code></pre>

      </div>
      
      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">例（CentOS 7）</span></div>
        <pre class="language-bash"><code class="language-bash">$ yum list <span class="token operator">|</span> <span class="token function">grep</span> mysql-community-server
mysql-community-server.x86_64   <span class="token number">5.7</span>.35-1.el7   @mysql57-community
</code></pre>

      </div>
      <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>
<p>パッケージがインストールされているか確認したり、インストール済みの場合にバージョンを確認したりする作業はそんなに頻度が多くないので忘れがちですね。。</p>


yumパッケージの存在とバージョンを確認する

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

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

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

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

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

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">/etc/awslogs/awslogs.conf</span></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>
<p>システム起動時に <code>awslogs</code> サービスが起動するようにする</p>

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

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

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash"><span class="token function">service</span> 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>
<p>EC2でWebアプリケーションを構築していて、ログをインスタンスにアタッチしているEBSに書き込むと以下のような不都合が発生します。</p>
<ul>
<li>メンテナンス作業で、以前作成したAMIからインスタンスを作成して稼働中のインスタンスと差し替えるといった操作をする場合、AMI作成時点から作業時までのログが失われる</li>
<li>EC2インスタンスのストレージを徐々に圧迫する</li>
<li>EBSはハードウェア障害時の内容は保証されず、ログが失われる可能性がある</li>
<li>複数台のインスタンスを起動して冗長構成を取っている場合、ログを確認するのが手間（EFSを利用すれば解消できるかも）</li>
</ul>
<p>EC2インスタンスに可能な限り状態を持たせないようにするため、CloudWatch Logsにエクスポートするようにしたいと考えました。</p>
<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>
<p><code>awslogs</code> を使うことで簡単にログをCloudWatch Logsに送信できました。CloudWatch Logsにフィルタを設定してログを監視することもできそうです。</p>
<p>EC2インスタンスからログの保存という役割は追い出せたものの、CloudWatch Logsも保存容量に応じた費用がかかるので、定期的にS3にアーカイブする設定も作った方が良さそうです。</p>
<p>インスタンスプロファイル経由で認証情報を得られるかと思いきや、作業環境では前任者がIAMユーザーを作成して認証情報を <code>~/.aws/credentials</code> に書き込んでいたためハマりました。</p>
<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>
<p>Google Analytics 4（GA4）では、アプリケーションから送信された情報をBigQueryにエクスポートすることができます。</p>
<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>
<p>GA4の設定から「BigQueryのリンク設定」→「リンク」と進む</p>
<p><img src="01.png" alt=""></p>
</li>
<li>
<p>エクスポート先に設定したいBigQueryのプロジェクトを選択し、「確認」をクリックする</p>
<p><img src="02.png" alt=""></p>
<div class="msg "><p>エクスポートされたデータを後で別のプロジェクトに移動するのは大変なので慎重に選ぶ。</p>
</div>
</li>
<li>
<p>任意のデータロケーションを選び、「次へ」をクリックする</p>
<p><img src="03.png" alt=""></p>
</li>
<li>
<p>頻度は「毎日」と「ストリーミング」の両方にチェックを入れ、「次へ」をクリックする</p>
<p><img src="04.png" alt=""></p>
<div class="msg "><p>「毎日」を選択すると1日に1回、 <code>analytics_YYYYMMDD</code> というテーブル名でデータがBigQueryにエクスポートされる。</p>
</div>
<div class="msg "><p>「ストリーミング」を選択するとGA4にイベントが届いてから数秒以内に <code>analytics_intraday_YYYYMMDD</code> というテーブルにデータがエクスポートされる。</p>
</div>
</li>
<li>
<p>最終確認をして「送信」をクリックする</p>
<p><img src="05.png" alt=""></p>
</li>
<li>
<p>作成が完了する</p>
<p><img src="06.png" alt=""></p>
</li>
</ul>
<div class="msg "><p>本設定を行ってから実際にBigQueryにテーブルが作成されてデータがエクスポートされるまで時間がかかるので、設定後24時間は待ってみるのがよい。</p>
</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>
<p>DataPortalでBigQueryをデータソースにしてカスタムクエリを書くことで、GA4で提供されているレポート以外の好みのレポートを作成することができます。GA4プロパティを作成しただけではBigQueryへのエクスポートは有効化されないため、手動で設定を行う必要があります。</p>
<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>
<p>Firebaseの管理画面からも、今回のようにGA4の設定画面からも同様の設定ができるので若干わかりにくいです。</p>


GA4の情報をBigQueryにエクスポートする設定を行う

<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>
<p>Next.jsで作ったウェブサイトにGoogle Tag Manager（GTM）を導入する手順です。</p>
<h1 id="%E5%89%8D%E6%8F%90"><a class="header-anchor-link" href="#%E5%89%8D%E6%8F%90" aria-hidden="true" rel="nofollow"></a> 前提</h1>
<ul>
<li>GTMのコンテナの作成等のセットアップは済んでいる</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>
<p><code>pages/_document.tsx</code> を以下の内容で作成する。</p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">pages/_document.tsx</span></div>
        <pre class="language-tsx"><code class="language-tsx"><span class="token keyword">import</span> Document<span class="token punctuation">,</span> <span class="token punctuation">{</span> Html<span class="token punctuation">,</span> Head<span class="token punctuation">,</span> Main<span class="token punctuation">,</span> NextScript <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'next/document'</span><span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">MyDocument</span> <span class="token keyword">extends</span> <span class="token class-name">Document</span> <span class="token punctuation">{</span>
  <span class="token function">render</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
    <span class="token comment">// GTMのインストール用のタグを代入する</span>
    <span class="token keyword">const</span> gtmHeadScript <span class="token operator">=</span> <span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],j=d.createElement(s),dl=l!='dataLayer'?'&amp;l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-MXXXXXX');</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">;</span>

    <span class="token keyword">return</span> <span class="token punctuation">(</span>
      <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token class-name">Html</span></span><span class="token punctuation">></span></span><span class="token plain-text">
        </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token class-name">Head</span></span><span class="token punctuation">></span></span><span class="token plain-text">
          </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">dangerouslySetInnerHTML</span><span class="token script language-javascript"><span class="token script-punctuation punctuation">=</span><span class="token punctuation">{</span><span class="token punctuation">{</span> __html<span class="token operator">:</span> gtmHeadScript <span class="token punctuation">}</span><span class="token punctuation">}</span></span> <span class="token punctuation">/></span></span><span class="token plain-text">
        </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span><span class="token class-name">Head</span></span><span class="token punctuation">></span></span><span class="token plain-text">
        </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>body</span><span class="token punctuation">></span></span><span class="token plain-text">
          </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token class-name">Main</span></span> <span class="token punctuation">/></span></span><span class="token plain-text">
          </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token class-name">NextScript</span></span> <span class="token punctuation">/></span></span><span class="token plain-text">
        </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>body</span><span class="token punctuation">></span></span><span class="token plain-text">
      </span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span><span class="token class-name">Html</span></span><span class="token punctuation">></span></span>
    <span class="token punctuation">)</span><span class="token punctuation">;</span>
  <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

<span class="token keyword">export</span> <span class="token keyword">default</span> MyDocument<span class="token punctuation">;</span>
</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>
<p>本ブログはNext.jsで作っています。アクセス数等を解析するためにGoogle Analyticsの導入を考えていましたが、設定を便利にするためにGTM経由で導入したいと考えていました。</p>
<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>
<p>思ったより簡単に導入できて驚きました。以前Gatsby.jsでブログを作っていた頃はプラグイン等の設定で結構困った記憶があるので、Next.jsにしてよかったと思っています。</p>
<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://www.learnbestcoding.com/post/9/easiest-way-to-integrate-google-analytics-with-react-js-and-next-js" rel="nofollow">Next js google tag manager: Using Google analytics in Nextjs</a>
<ul>
<li>本記事で取り上げた方法と、 <code>react-gtm-module</code> パッケージを使う方法が紹介されていて参考になりました。</li>
</ul>
</li>
</ul>


Next.jsにGoogle Tag Managerを導入する手順

<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>
<p>Ruby on RailsのロガーをRuby標準の <code>Logger</code> クラスから、 <code>ActiveSupport::Logger</code> に変更すると形式が変わってしまったので、原因と対処方法を調査しました。</p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">従来のログ</span></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"><span class="code-block-filename">形式が変わってしまったログ</span></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>
      <p>先頭についていた <code>I, [2021-09-23T21:56:45.043019 #1103]  INFO -- : </code> のような表記がなくなってしまっています。</p>
<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>
<p><code>config/application.rb</code> （もしくは <code>config/environments/{環境名}.rb</code> ）で以下のように設定する。</p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">config/application.rb</span></div>
        <pre class="diff-highlight language-diff-ruby"><code class="diff-highlight language-diff-ruby"><span class="token deleted-sign deleted language-ruby"><span class="token prefix deleted">-</span> config<span class="token punctuation">.</span>logger    <span class="token operator">=</span> <span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">)</span>
</span>
<span class="token inserted-sign inserted language-ruby"><span class="token prefix inserted">+</span> logger           <span class="token operator">=</span> <span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">)</span>
<span class="token prefix inserted">+</span> logger<span class="token punctuation">.</span>formatter <span class="token operator">=</span> <span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Formatter</span><span class="token punctuation">.</span><span class="token keyword">new</span>
<span class="token prefix inserted">+</span> config<span class="token punctuation">.</span>logger    <span class="token operator">=</span> logger
</span></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>
<p>Rubyの <code>Logger</code> クラスでは、ログのフォーマットは <code>format_message</code> メソッドにて行われる。</p>
<p><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></p>

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

      </div>
      <p>実際のログのフォーマットは <code>@formatter</code> にセットされているフォーマッタクラスによって行われる。</p>
</li>
<li>
<p><code>Logger</code> クラスのインスタンスの <code>formatter</code> をセットしない場合、デフォルトでは同じファイルで定義されている <code>Formatter</code> クラスが利用される。</p>
<p><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></p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">lib/logger.rb#L314</span></div>
        <pre class="language-ruby"><code class="language-ruby"><span class="token variable">@default_formatter</span> <span class="token operator">=</span> <span class="token constant">Formatter</span><span class="token punctuation">.</span><span class="token keyword">new</span>
<span class="token variable">@formatter</span> <span class="token operator">=</span> <span class="token keyword">nil</span>
</code></pre>

      </div>
      </li>
<li>
<p>Rubyの <code>Logger</code> クラスを継承した <code>ActiveSupport::Logger</code> クラスでは、 <code>formatter</code> の値を上書きして <code>SimpleFormatter</code> クラスにしている。</p>
<p><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></p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">activesupport/lib/active_support/logger.rb#L46</span></div>
        <pre class="language-ruby"><code class="language-ruby"><span class="token keyword">def</span> <span class="token method-definition"><span class="token function">initialize</span></span><span class="token punctuation">(</span><span class="token operator">*</span>args<span class="token punctuation">)</span>
  <span class="token keyword">super</span>
  <span class="token variable">@formatter</span> <span class="token operator">=</span> <span class="token constant">SimpleFormatter</span><span class="token punctuation">.</span><span class="token keyword">new</span>
<span class="token keyword">end</span>
</code></pre>

      </div>
      </li>
<li>
<p><code>SimpleFormatter</code> クラスは以下のような実装となっている。</p>
<p><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></p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">activesupport/lib/active_support/logger.rb#L50-L55</span></div>
        <pre class="language-ruby"><code class="language-ruby"><span class="token keyword">class</span> <span class="token class-name">SimpleFormatter</span> <span class="token operator">&lt;</span> <span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Formatter</span>
  <span class="token comment"># This method is invoked when a log event occurs</span>
  <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">call</span></span><span class="token punctuation">(</span>severity<span class="token punctuation">,</span> timestamp<span class="token punctuation">,</span> progname<span class="token punctuation">,</span> msg<span class="token punctuation">)</span>
    <span class="token string">"<span class="token interpolation"><span class="token delimiter tag">#{</span><span class="token builtin">String</span> <span class="token operator">===</span> msg <span class="token operator">?</span> msg <span class="token punctuation">:</span> msg<span class="token punctuation">.</span>inspect<span class="token delimiter tag">}</span></span>\n"</span>
  <span class="token keyword">end</span>
<span class="token keyword">end</span>
</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"><span class="code-block-filename">config/application.rb</span></div>
        <pre class="language-ruby"><code class="language-ruby">logger           <span class="token operator">=</span> <span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">)</span>
logger<span class="token punctuation">.</span>formatter <span class="token operator">=</span> <span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Formatter</span><span class="token punctuation">.</span><span class="token keyword">new</span>
config<span class="token punctuation">.</span>logger    <span class="token operator">=</span> <span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">TaggedLogging</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span>logger<span class="token punctuation">)</span>
</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>
<p><code>config.log_formatter</code> の値が <code>Logger</code> クラスの <code>formatter</code> にセットされるのは、 <code>config.logger</code> が未設定の場合のみ。</p>
<p><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></p>

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

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

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">config/application.rb</span></div>
        <pre class="language-ruby"><code class="language-ruby">logger           <span class="token operator">=</span> <span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">)</span>
logger<span class="token punctuation">.</span>formatter <span class="token operator">=</span> <span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Formatter</span><span class="token punctuation">.</span><span class="token keyword">new</span>
config<span class="token punctuation">.</span>logger    <span class="token operator">=</span> 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>
<p><a href="https://itotetsu.work/articles/ruby-on-rails-suppress-logs-from-elb" rel="nofollow">RailsアプリでELBからのヘルスチェックのアクセスをログに残さないようにする</a> は <code>ActiveSupport::Logger</code> を継承したクラスを利用していないと行えなかったのでロガークラスを変更したところ、ログの形式が変わってしまったために本対応を行いました。</p>
<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>
<p><code>config.log_formatter</code> を変更しても適用されずしばらくハマりました。今回RailsやRubyのソースコードをじっくり追いながら実装を把握することができて明確になりました。フルタイムで働いていた頃は何かと忙しくてついこういった細部は「動けばいいや」でやってしまっていたことも多かったですが、しっかり調べることで足元を掬われにくくなるのでやはり急がば回れできちんと調べることが重要だと思いました。</p>
<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>
<p>EC2上で稼働するRuby on Railsのログに、ELBからのヘルスチェックのリクエストが記録されないようにする手順です。</p>
<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>
<p>Railsのロガーに <code>ActiveSupport::Logger</code> を継承するクラスが設定されているか確認する</p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">config/application.rb</span></div>
        <pre class="language-ruby"><code class="language-ruby"><span class="token comment"># NG</span>
config<span class="token punctuation">.</span>logger <span class="token operator">=</span> <span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">)</span>

<span class="token comment"># OK</span>
config<span class="token punctuation">.</span>logger <span class="token operator">=</span> <span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">)</span>

<span class="token comment"># OK</span>
config<span class="token punctuation">.</span>logger <span class="token operator">=</span> <span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">TaggedLogging</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token constant">ActiveSupport</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
</code></pre>

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

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">lib/custom_logger.rb</span></div>
        <pre class="language-ruby"><code class="language-ruby"><span class="token keyword">class</span> <span class="token class-name">CustomLogger</span> <span class="token operator">&lt;</span> <span class="token constant">Rails</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Rack</span><span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token constant">Logger</span>
  <span class="token keyword">def</span> <span class="token method-definition"><span class="token function">call</span></span><span class="token punctuation">(</span>env<span class="token punctuation">)</span>
    user_agent <span class="token operator">=</span> env<span class="token punctuation">[</span><span class="token string">'HTTP_USER_AGENT'</span><span class="token punctuation">]</span>

    <span class="token keyword">if</span> user_agent<span class="token punctuation">.</span><span class="token keyword">include</span><span class="token operator">?</span><span class="token punctuation">(</span><span class="token string">'ELB-HealthChecker'</span><span class="token punctuation">)</span>
      <span class="token constant">Rails</span><span class="token punctuation">.</span>logger<span class="token punctuation">.</span>silence <span class="token keyword">do</span>
        <span class="token keyword">super</span>
      <span class="token keyword">end</span>
    <span class="token keyword">else</span>
      <span class="token keyword">super</span>
    <span class="token keyword">end</span>
  <span class="token keyword">end</span>
<span class="token keyword">end</span>
</code></pre>

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

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

      </div>
      <div class="msg "><p><code>MyApp</code> の部分は各アプリケーションの名前に置き換える。具体的には <code>config/application.rb</code> で <code>module MyApp</code> のように定義している名前に合わせる。</p>
</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>
<p>手元の開発環境で効率的に検証することができる。</p>

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

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

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> <span class="token punctuation">\</span>
  -u user:password <span class="token punctuation">\</span>
  -A <span class="token string">"ELB-HealthChecker"</span> <span class="token punctuation">\</span>
  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>
<p>ELB以外からのアクセスの（＝ユーザーエージェントに <code>ELB-HealthChecker</code> が含まれない）場合は問題なくログが出力されるが、ELBからのアクセス時には以下のようなエラーが発生する。</p>

      <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>
<p>EC2でRuby on Railsを稼働させており、前段にApplication Load Balancerを配置しています。ヘルスチェックで定期的にアプリケーションにリクエストが来るようになっていますが、そのログがアクセスログに残ってしまうと見づらかったりログファイルを圧迫して困っていました。</p>
<p>ログはAWSのCloudWatch Logsに送信しているので、ログの量が増えれば転送量やストレージ容量が増え、コスト増加につながるため、それを防ぎたい狙いもありました。</p>
<p>Nginxでは既にELBからのヘルスチェックのアクセスをログに残さないように設定していましたが、Railsの方はまだ設定できていませんでした。NginxだけでなくRailsアプリケーションが正しく動作していることをヘルスチェックの条件にしたいので、Railsが処理するパスを叩くことは継続したい状況でした。</p>
<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>
<p>Rackの設定は普段触れることがないのでまだまだ知らないことだらけです。必要になったタイミングで多少時間を多めに取ってコツコツ理解できたらと思います。</p>
<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>
<p>Linux上で稼働しているRuby on RailsアプリケーションのログローテーションにRubyの <code>Logger</code> クラスの機能を使うか、Linuxの <code>logrotate</code> を使うか検討してみました。</p>
<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>
<p><strong>Railsではログローテーションは行わず、 <code>logrotate</code> で行う</strong></p>
<p>理由：</p>
<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>
<p>Ruby on RailsではデフォルトでRubyの <code>Logger</code> クラスがログ出力に利用されており、その <code>Logger</code> クラスにはログローテーション機能が含まれています。</p>
<p><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></p>
<p>例えば以下のように設定することで、ファイルサイズが10MBを超えたらログをローテーションし、古いログファイルを最大30件保持するような動作が実現できます。</p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">config/application.rb</span></div>
        <pre class="language-ruby"><code class="language-ruby">config<span class="token punctuation">.</span>logger <span class="token operator">=</span> <span class="token constant">Logger</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span><span class="token string">'log/application.log'</span><span class="token punctuation">,</span> <span class="token number">30</span><span class="token punctuation">,</span> <span class="token number">10</span> <span class="token operator">*</span> <span class="token number">1024</span> <span class="token operator">*</span> <span class="token number">1024</span><span class="token punctuation">)</span>
</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>
<p><code>/etc/logrotate.d/myapp</code> に以下のような設定を記述する</p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">/etc/logrotate.d/myapp</span></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>
<p>最近はAWSのマネージドサービスを組み合わせてシステムを構築することも多くなってきたので、こういったLinuxの設定周りはあまりやらなくなってきましたが、こういった運用周りの設定は嫌いじゃないです。</p>


Railsのログのログローテーションはlogrotateを使うことにした

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

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

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


AWSのELBとTailwind CSSを使ってシンプルなメンテナンス画面を表示する

<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>
<p>CentOSのバージョンを調べる方法です。</p>
<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>ホストマシン
<ul>
<li>macOS Big Sur 11.5.2</li>
<li>VirtualBox 6.1.26 r145957 (Qt5.6.3)</li>
<li>Vagrant 2.2.18</li>
</ul>
</li>
<li>ゲストマシン
<ul>
<li>CentOS Linux release 7.9.2009 (Core)</li>
</ul>
</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>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash"><span class="token function">cat</span> /etc/redhat-release
</code></pre>

      </div>
      
      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">出力結果の例</span></div>
        <pre class="language-text"><code class="language-text">CentOS Linux release 7.9.2009 (Core)
</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>
<p>開発しているシステムのローカル開発環境を構築するためにMySQLをインストールする必要があり、どのパッケージを選ぶべきか検討するためにバージョンを確認する必要が出てきました。</p>


CentOSのバージョンを調べる方法

<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>
<p>Vagrantで管理するCentOS7を <code>$ vagrant up</code> で起動しようとしたときに以下のようなエラーが出た場合の対処方法です。</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">Bringing machine <span class="token string">'default'</span> up with <span class="token string">'virtualbox'</span> provider<span class="token punctuation">..</span>.
<span class="token operator">==</span><span class="token operator">></span> default: Clearing any previously <span class="token builtin class-name">set</span> forwarded ports<span class="token punctuation">..</span>.
<span class="token operator">==</span><span class="token operator">></span> default: Clearing any previously <span class="token builtin class-name">set</span> network interfaces<span class="token punctuation">..</span>.
<span class="token operator">==</span><span class="token operator">></span> default: Preparing network interfaces based on configuration<span class="token punctuation">..</span>.
    default: Adapter <span class="token number">1</span>: nat
    default: Adapter <span class="token number">2</span>: hostonly
<span class="token operator">==</span><span class="token operator">></span> default: Forwarding ports<span class="token punctuation">..</span>.
    default: <span class="token number">22</span> <span class="token punctuation">(</span>guest<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">></span> <span class="token number">2222</span> <span class="token punctuation">(</span>host<span class="token punctuation">)</span> <span class="token punctuation">(</span>adapter <span class="token number">1</span><span class="token punctuation">)</span>
    default: <span class="token number">29324</span> <span class="token punctuation">(</span>guest<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">></span> <span class="token number">29324</span> <span class="token punctuation">(</span>host<span class="token punctuation">)</span> <span class="token punctuation">(</span>adapter <span class="token number">1</span><span class="token punctuation">)</span>
<span class="token operator">==</span><span class="token operator">></span> default: Running <span class="token string">'pre-boot'</span> VM customizations<span class="token punctuation">..</span>.
<span class="token operator">==</span><span class="token operator">></span> default: Booting VM<span class="token punctuation">..</span>.
<span class="token operator">==</span><span class="token operator">></span> default: Waiting <span class="token keyword">for</span> machine to boot. This may take a few minutes<span class="token punctuation">..</span>.
    default: SSH address: <span class="token number">127.0</span>.0.1:2222
    default: SSH username: vagrant
    default: SSH auth method: private key
<span class="token operator">==</span><span class="token operator">></span> default: Machine booted and ready<span class="token operator">!</span>
<span class="token punctuation">[</span>default<span class="token punctuation">]</span> GuestAdditions versions on your <span class="token function">host</span> <span class="token punctuation">(</span><span class="token number">6.1</span>.26<span class="token punctuation">)</span> and guest <span class="token punctuation">(</span><span class="token number">6.0</span>.10<span class="token punctuation">)</span> <span class="token keyword">do</span> not match.
読み込んだプラグイン:fastestmirror


 One of the configured repositories failed <span class="token punctuation">(</span>不明<span class="token punctuation">)</span>,
 and yum doesn<span class="token string">'t have enough cached data to continue. At this point the only
 safe thing yum can do is fail. There are a few ways to work "fix" this:

     1. Contact the upstream for the repository and get them to fix the problem.

     2. Reconfigure the baseurl/etc. for the repository, to point to a working
        upstream. This is most often useful if you are using a newer
        distribution release than is supported by the repository (and the
        packages for the previous distribution release still work).

     3. Disable the repository, so yum won'</span>t use it by default. Yum will <span class="token keyword">then</span>
        just ignore the repository <span class="token keyword">until</span> you permanently <span class="token builtin class-name">enable</span> it again or use
        --enablerepo <span class="token keyword">for</span> temporary usage:

            yum-config-manager --disable <span class="token operator">&lt;</span>repoid<span class="token operator">></span>

     <span class="token number">4</span>. Configure the failing repository to be skipped, <span class="token keyword">if</span> it is unavailable.
        Note that yum will try to contact the repo. when it runs <span class="token function">most</span> commands,
        so will have to try and fail each <span class="token function">time</span> <span class="token punctuation">(</span>and thus. yum will be be much
        slower<span class="token punctuation">)</span>. If it is a very temporary problem though, this is often a <span class="token function">nice</span>
        compromise:

            yum-config-manager --save --setopt<span class="token operator">=</span><span class="token operator">&lt;</span>repoid<span class="token operator">></span>.skip_if_unavailable<span class="token operator">=</span>true

Cannot retrieve metalink <span class="token keyword">for</span> repository: epel/x86_64. Please verify its path and try again
Unmounting Virtualbox Guest Additions ISO from: /mnt
umount: /mnt: not mounted
<span class="token operator">==</span><span class="token operator">></span> default: Checking <span class="token keyword">for</span> guest additions <span class="token keyword">in</span> VM<span class="token punctuation">..</span>.
    default: The guest additions on this VM <span class="token keyword">do</span> not match the installed version of
    default: VirtualBox<span class="token operator">!</span> In <span class="token function">most</span> cases this is fine, but <span class="token keyword">in</span> rare cases it can
    default: prevent things such as shared folders from working properly. If you see
    default: shared folder errors, please <span class="token function">make</span> sure the guest additions within the
    default: virtual machine match the version of VirtualBox you have installed on
    default: your <span class="token function">host</span> and reload your VM.
    default:
    default: Guest Additions Version: <span class="token number">6.0</span>.10
    default: VirtualBox Version: <span class="token number">6.1</span>
The following SSH <span class="token builtin class-name">command</span> responded with a non-zero <span class="token builtin class-name">exit</span> status.
Vagrant assumes that this means the <span class="token builtin class-name">command</span> failed<span class="token operator">!</span>

<span class="token function">umount</span> /mnt

Stdout from the command:



Stderr from the command:

umount: /mnt: not mounted
</code></pre>

      </div>
      <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>ホストマシン
<ul>
<li>macOS Big Sur 11.5.2</li>
<li>VirtualBox 6.1.26 r145957 (Qt5.6.3)</li>
<li>Vagrant 2.2.18</li>
</ul>
</li>
<li>ゲストマシン
<ul>
<li>CentOS Linux release 7.1.1503 (Core)</li>
</ul>
</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>
<p>仮想マシンにSSH接続する</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">vagrant <span class="token function">ssh</span>
</code></pre>

      </div>
      <div class="msg "><p><code>vagrant up</code> でエラーが出ていても、仮想マシン自体は起動しているのでSSHはできる。</p>
</div>
</li>
<li>
<p>yumのミラーレポジトリを無効化する</p>
<ul>
<li>
<p><code>/etc/yum.repos.d/epel.repo</code> を以下のように編集する</p>

      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">/etc/yum.repos.d/epel.repo</span></div>
        <pre class="diff-highlight language-diff-text"><code class="diff-highlight language-diff-text">[epel]
name=Extra Packages for Enterprise Linux 7 - $basearch
<span class="token deleted-sign deleted language-text"><span class="token prefix deleted">-</span> #baseurl=http://download.fedoraproject.org/pub/epel/7/$basearch
</span><span class="token inserted-sign inserted language-text"><span class="token prefix inserted">+</span> baseurl=http://download.fedoraproject.org/pub/epel/7/$basearch
</span><span class="token deleted-sign deleted language-text"><span class="token prefix deleted">-</span> mirrorlist=https://mirrors.fedoraproject.org/metalink?repo=epel-7&amp;arch=$basearch
</span><span class="token inserted-sign inserted language-text"><span class="token prefix inserted">+</span> #mirrorlist=https://mirrors.fedoraproject.org/metalink?repo=epel-7&amp;arch=$basearch
</span>failovermethod=priority
enabled=1
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-7

[epel-debuginfo]
name=Extra Packages for Enterprise Linux 7 - $basearch - Debug
<span class="token deleted-sign deleted language-text"><span class="token prefix deleted">-</span> #baseurl=http://download.fedoraproject.org/pub/epel/7/$basearch/debug
</span><span class="token inserted-sign inserted language-text"><span class="token prefix inserted">+</span> baseurl=http://download.fedoraproject.org/pub/epel/7/$basearch/debug
</span><span class="token deleted-sign deleted language-text"><span class="token prefix deleted">-</span> #mirrorlist=https://mirrors.fedoraproject.org/metalink?repo=epel-debug-7&amp;arch=$basearch
</span><span class="token inserted-sign inserted language-text"><span class="token prefix inserted">+</span> mirrorlist=https://mirrors.fedoraproject.org/metalink?repo=epel-debug-7&amp;arch=$basearch
</span>failovermethod=priority
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-7
gpgcheck=1

[epel-source]
name=Extra Packages for Enterprise Linux 7 - $basearch - Source
<span class="token deleted-sign deleted language-text"><span class="token prefix deleted">-</span> #baseurl=http://download.fedoraproject.org/pub/epel/7/SRPMS
</span><span class="token inserted-sign inserted language-text"><span class="token prefix inserted">+</span> baseurl=http://download.fedoraproject.org/pub/epel/7/SRPMS
</span><span class="token deleted-sign deleted language-text"><span class="token prefix deleted">-</span> #mirrorlist=https://mirrors.fedoraproject.org/metalink?repo=epel-source-7&amp;arch=$basearch
</span><span class="token inserted-sign inserted language-text"><span class="token prefix inserted">+</span> mirrorlist=https://mirrors.fedoraproject.org/metalink?repo=epel-source-7&amp;arch=$basearch
</span>failovermethod=priority
enabled=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-7
gpgcheck=1
</code></pre>

      </div>
      </li>
</ul>
</li>
<li>
<p>仮想マシンを再起動する</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">vagrant reload
</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>
<p>開発しているシステムのローカル開発環境はVagrantで管理していて、仮想マシンの構成を変更したタイミングでBoxを作っていますが、久々に過去のBoxから新たにマシンを起動したところ上述のエラーが発生してしまいました。</p>
<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>
<p>Vagrantでのローカル開発環境は、今回のようなケースや、macOSのアップデート時にうまく動かなくなることが多いです。また、Boxの容量も1〜2GBになるので、他の開発者に渡すにもコストがかかっています。そろそろDocker化したいと思っています。</p>
<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://qiita.com/gatuwo_jp/items/cf1f4131c0e370107548" rel="nofollow">yumで、Cannot retrieve metalink for repository エラーが出た時の対処</a></li>
</ul>


vagrant upが「One of the configured repositories failed」エラーで失敗するときの対処方法

<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>
<p>CentOS7上で稼働するMySQLサーバーのバージョンを5.6から5.7にアップデートする手順です。</p>
<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>ホストマシン
<ul>
<li>macOS Big Sur 11.5.2</li>
<li>VirtualBox 6.1.26 r145957 (Qt5.6.3)</li>
<li>Vagrant 2.2.18</li>
</ul>
</li>
<li>ゲストマシン
<ul>
<li>CentOS Linux release 7.1.1503 (Core)</li>
</ul>
</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>
<div class="msg "><p>以下のコマンドは全て root ユーザーに切り替えた上で実行する</p>
</div>
<ul>
<li>
<p>スキーマとデータのバックアップ</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">mysqldump <span class="token punctuation">\</span>
  -uroot <span class="token punctuation">\</span>
  -p <span class="token punctuation">\</span>
  -A <span class="token punctuation">\</span>
  <span class="token operator">></span> ~/dump-20210922.sql
</code></pre>

      </div>
      </li>
<li>
<p>MySQLの設定ファイルをバックアップ</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash"><span class="token function">cp</span> -p /etc/my.cnf ~/my.cnf.20210922
<span class="token function">cp</span> -pr /etc/my.cnf.d/ ~/my.cnf.d.20210922
</code></pre>

      </div>
      </li>
<li>
<p>現在のバージョンを確認</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">mysqld --version
</code></pre>

      </div>
      
      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">実行結果</span></div>
        <pre class="language-text"><code class="language-text">mysqld  Ver 5.6.29 for Linux on x86_64 (MySQL Community Server (GPL))
</code></pre>

      </div>
      </li>
<li>
<p>mysqldを停止する</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">systemctl stop mysqld
</code></pre>

      </div>
      </li>
<li>
<p>現在インストールされているMySQL関連のパッケージを確認</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum list installed <span class="token operator">|</span> <span class="token function">grep</span> mysql
</code></pre>

      </div>
      
      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">実行結果</span></div>
        <pre class="language-text"><code class="language-text">mysql-community-client.x86_64    5.6.29-2.el7                        @mysql56-community
mysql-community-common.x86_64    5.6.29-2.el7                        @mysql56-community
mysql-community-devel.x86_64     5.6.29-2.el7                        @mysql56-community
mysql-community-libs.x86_64      5.6.29-2.el7                        @mysql56-community
mysql-community-release.noarch   el7-5                               @/mysql-community-release-el7-5.noarch
mysql-community-server.x86_64    5.6.29-2.el7                        @mysql56-community
mysql-connector-python.x86_64    2.1.3-1.el7                         @mysql-connectors-community
mysql-utilities.noarch           1.5.6-1.el7                         @mysql-tools-community
</code></pre>

      </div>
      </li>
<li>
<p>必要なパッケージをインストール</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum -y <span class="token function">install</span> yum-utils
</code></pre>

      </div>
      <div class="msg "><p>後で使う yum-config-manager をインストールすることが目的</p>
</div>
</li>
<li>
<p>インストールされているMySQL関連のパッケージを削除</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum -y remove mysql*
</code></pre>

      </div>
      <details><summary>実行結果（例）</summary><div class="details-content">
      <div class="code-block-container">
        
        <pre class="language-text"><code class="language-text">読み込んだプラグイン:fastestmirror
依存性の解決をしています
--> トランザクションの確認を実行しています。
---> パッケージ mysql-community-client.x86_64 0:5.6.29-2.el7 を 削除
---> パッケージ mysql-community-common.x86_64 0:5.6.29-2.el7 を 削除
---> パッケージ mysql-community-devel.x86_64 0:5.6.29-2.el7 を 削除
---> パッケージ mysql-community-libs.x86_64 0:5.6.29-2.el7 を 削除
--> 依存性の処理をしています: libmysqlclient.so.18()(64bit) のパッケージ: 2:postfix-2.10.1-6.el7.x86_64
--> 依存性の処理をしています: libmysqlclient.so.18(libmysqlclient_18)(64bit) のパッケージ: 2:postfix-2.10.1-6.el7.x86_64
---> パッケージ mysql-community-release.noarch 0:el7-5 を 削除
---> パッケージ mysql-community-server.x86_64 0:5.6.29-2.el7 を 削除
---> パッケージ mysql-connector-python.x86_64 0:2.1.3-1.el7 を 削除
---> パッケージ mysql-utilities.noarch 0:1.5.6-1.el7 を 削除
--> トランザクションの確認を実行しています。
---> パッケージ postfix.x86_64 2:2.10.1-6.el7 を 削除
--> 依存性解決を終了しました。

依存性を解決しました

==================================================================================================================
Package                      アーキテクチャー
                                          バージョン            リポジトリー                                 容量
==================================================================================================================
削除中:
mysql-community-client       x86_64      5.6.29-2.el7          @mysql56-community                           88 M
mysql-community-common       x86_64      5.6.29-2.el7          @mysql56-community                          2.1 M
mysql-community-devel        x86_64      5.6.29-2.el7          @mysql56-community                           21 M
mysql-community-libs         x86_64      5.6.29-2.el7          @mysql56-community                          9.2 M
mysql-community-release      noarch      el7-5                 @/mysql-community-release-el7-5.noarch      4.3 k
mysql-community-server       x86_64      5.6.29-2.el7          @mysql56-community                          245 M
mysql-connector-python       x86_64      2.1.3-1.el7           @mysql-connectors-community                 1.1 M
mysql-utilities              noarch      1.5.6-1.el7           @mysql-tools-community                      5.0 M
依存性関連での削除をします:
postfix                      x86_64      2:2.10.1-6.el7        @anaconda                                    12 M

トランザクションの要約
==================================================================================================================
削除  8 パッケージ (+1 個の依存関係のパッケージ)

インストール容量: 383 M
Downloading packages:
Running transaction check
Running transaction test
Transaction test succeeded
Running transaction
  削除中                  : mysql-utilities-1.5.6-1.el7.noarch                                                1/9
  削除中                  : mysql-community-devel-5.6.29-2.el7.x86_64                                         2/9
  削除中                  : mysql-connector-python-2.1.3-1.el7.x86_64                                         3/9
  削除中                  : mysql-community-release-el7-5.noarch                                              4/9
  削除中                  : mysql-community-server-5.6.29-2.el7.x86_64                                        5/9
  削除中                  : mysql-community-client-5.6.29-2.el7.x86_64                                        6/9
  削除中                  : 2:postfix-2.10.1-6.el7.x86_64                                                     7/9
  削除中                  : mysql-community-libs-5.6.29-2.el7.x86_64                                          8/9
  削除中                  : mysql-community-common-5.6.29-2.el7.x86_64                                        9/9
  検証中                  : mysql-community-common-5.6.29-2.el7.x86_64                                        1/9
  検証中                  : mysql-community-libs-5.6.29-2.el7.x86_64                                          2/9
  検証中                  : mysql-connector-python-2.1.3-1.el7.x86_64                                         3/9
  検証中                  : mysql-community-client-5.6.29-2.el7.x86_64                                        4/9
  検証中                  : mysql-community-release-el7-5.noarch                                              5/9
  検証中                  : mysql-community-server-5.6.29-2.el7.x86_64                                        6/9
  検証中                  : 2:postfix-2.10.1-6.el7.x86_64                                                     7/9
  検証中                  : mysql-community-devel-5.6.29-2.el7.x86_64                                         8/9
  検証中                  : mysql-utilities-1.5.6-1.el7.noarch                                                9/9

削除しました:
  mysql-community-client.x86_64 0:5.6.29-2.el7            mysql-community-common.x86_64 0:5.6.29-2.el7
  mysql-community-devel.x86_64 0:5.6.29-2.el7             mysql-community-libs.x86_64 0:5.6.29-2.el7
  mysql-community-release.noarch 0:el7-5                  mysql-community-server.x86_64 0:5.6.29-2.el7
  mysql-connector-python.x86_64 0:2.1.3-1.el7             mysql-utilities.noarch 0:1.5.6-1.el7

依存性の削除をしました:
  postfix.x86_64 2:2.10.1-6.el7

完了しました!
</code></pre>

      </div>
      </div></details>
<div class="msg "><p>実行結果に表示されている通り、依存する postfix も削除されていることに注意。</p>
</div>
</li>
<li>
<p>RPMパッケージをインストール</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum -y <span class="token function">install</span> http://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm
</code></pre>

      </div>
      <div class="msg "><p><code>mysql80-community-release-el7-3.noarch.rpm</code> の部分は、 <code>https://dev.mysql.com/downloads/repo/yum/</code> からインストール対象のマシンに合うものを選ぶ。</p>
</div>
<div class="msg "><p>今回はMySQL 5.7をインストールするが、最新のRPMパッケージには過去のバージョンも含まれるので、 <code>mysql80-</code> という名前のものをインストールしていて問題ない。</p>
</div>
</li>
<li>
<p>インストールするMySQLのバージョンを5.7に設定</p>
<ul>
<li>
<p>以下のコマンドで不要なものの削除・必要なものの追加を行う</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum-config-manager --disable mysql56-community
yum-config-manager --disable mysql80-community
yum-config-manager --enable  mysql57-community
</code></pre>

      </div>
      </li>
<li>
<p>以下のコマンドで設定を確認する</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum repolist all <span class="token operator">|</span> <span class="token function">grep</span> mysql
</code></pre>

      </div>
      
      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">設定が完了した状態の出力の例</span></div>
        <pre class="language-text"><code class="language-text">mysql-cluster-7.5-community/x86_64 MySQL Cluster 7.5 Community      無効
mysql-cluster-7.5-community-source MySQL Cluster 7.5 Community - So 無効
mysql-cluster-7.6-community/x86_64 MySQL Cluster 7.6 Community      無効
mysql-cluster-7.6-community-source MySQL Cluster 7.6 Community - So 無効
mysql-cluster-8.0-community/x86_64 MySQL Cluster 8.0 Community      無効
mysql-cluster-8.0-community-source MySQL Cluster 8.0 Community - So 無効
mysql-connectors-community/x86_64  MySQL Connectors Community       有効:    212
mysql-connectors-community-source  MySQL Connectors Community - Sou 無効
mysql-tools-community/x86_64       MySQL Tools Community            有効:    132
mysql-tools-community-source       MySQL Tools Community - Source   無効
mysql-tools-preview/x86_64         MySQL Tools Preview              無効
mysql-tools-preview-source         MySQL Tools Preview - Source     無効
mysql55-community/x86_64           MySQL 5.5 Community Server       無効
mysql55-community-source           MySQL 5.5 Community Server - Sou 無効
mysql56-community/x86_64           MySQL 5.6 Community Server       無効
mysql56-community-source           MySQL 5.6 Community Server - Sou 無効
mysql57-community/x86_64           MySQL 5.7 Community Server       有効:    524
mysql57-community-source           MySQL 5.7 Community Server - Sou 無効
mysql80-community/x86_64           MySQL 8.0 Community Server       無効
mysql80-community-source           MySQL 8.0 Community Server - Sou 無効
</code></pre>

      </div>
      </li>
</ul>
</li>
<li>
<p>MySQLをインストール</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">yum -y <span class="token function">install</span> <span class="token punctuation">\</span>
  mysql <span class="token punctuation">\</span>
  mysql-devel <span class="token punctuation">\</span>
  mysql-server <span class="token punctuation">\</span>
  mysql-utilities
</code></pre>

      </div>
      </li>
<li>
<p>バージョンを確認</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">mysqld --version
</code></pre>

      </div>
      
      <div class="code-block-container">
        <div class="code-block-filename-container"><span class="code-block-filename">実行結果</span></div>
        <pre class="language-text"><code class="language-text">mysqld  Ver 5.7.35 for Linux on x86_64 (MySQL Community Server (GPL))
</code></pre>

      </div>
      </li>
<li>
<p>MySQLサーバーを起動</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">systemctl start mysqld
</code></pre>

      </div>
      </li>
<li>
<p>データベースの中身をアップデート</p>

      <div class="code-block-container">
        
        <pre class="language-bash"><code class="language-bash">mysql_upgrade <span class="token punctuation">\</span>
  -u root <span class="token punctuation">\</span>
  -p
</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>
<p>MySQL 5.6のサポートが2021/2/5に終了されるため、運用しているサービスのデータベースとして使っているMySQLのバージョンを上げる必要が出てきました。本番環境・ステージング環境のMySQLはAmazon RDSで稼働させているので、RDSの自動アップデート機能を使ってバージョンを上げることができましたが、ローカル開発環境はMac上にVirtualBox + Vagrant + CentOS7で構築していたため、手作業でのアップデートが必要となりました。</p>
<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>
<p>ローカル開発環境なので、正直既存のデータやスキーマが消えても特に問題はありません。Dockerを使っていればDockerfileを書き換えるだけでバージョンを変えることができるので、本手順は今後はあまり必要にならない作業かもしれません。そろそろM1のMacBookの購入を検討しているので、今回対象としたシステムのローカル開発環境も近々Dockerにしようと思います。その前にきちっとこの作業をやってみることができてよかったです。</p>
<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://trios.pro/mysql-centos7-install/" rel="nofollow">【丁寧に解説】MySQL5.7をCentOS7にインストールする方法</a>
<ul>
<li><code>yum-config-manager</code> でインストールするMySQLのバージョンを制御するあたりを参照しました。</li>
</ul>
</li>
<li><a href="https://optimal-sdw.com/blog/code-db/article_37" rel="nofollow">MySQL5.6から5.7へのアップグレード手順 (全文検索でngramを利用するために)</a>
<ul>
<li>全体の工程を把握することができました。</li>
<li>おそらくMySQL 8.0がリリースされる前の情報なので、 <code>yum-config-manager</code> で <code>mysql80-community</code> を無効化する手順がなく、手順通りに実施するとMySQL 8.0がインストールされてしまい若干ハマりました。</li>
</ul>
</li>
</ul>
