Amazon CloudWatch LogsでElastic Beanstalk環境を監視

Elastic Beanstalk で利用可能な Amazon CloudWatch Logs の監視機能

Elastic Beanstalk では、インスタンスがデフォルトで CloudWatch Logs エージェントをインストールした状態で作成される。これにより、各 Amazon EC2 インスタンスは、構成したロググループに対してメトリクスデータポイントを CloudWatch サービスに公開することが可能だ。

Elastic Beanstalk は、アプリケーション、システム、およびカスタムログファイルを Amazon EC2 インスタンスから監視およびアーカイブする。
メトリクスフィルターを使用して、特定のログストリームイベントに対応するアラームを設定できる。

Docker プラットフォームでのログストリーミング

インスタンスログを CloudWatch Logs にストリーミングする機能を有効にすると、Elastic Beanstalk はインスタンスからログファイルを CloudWatch Logs に送信する。Linux プラットフォームの場合、ロググループ名はログファイルのパスに「/aws/elasticbeanstalk/environment_name」を接頭辞として追加することで決まる。例えば、「/var/log/nginx/error.log」のロググループ名は「/aws/elasticbeanstalk/environment_name/var/log/nginx/error.log」になる。

Docker プラットフォームのログファイルと対応する CloudWatch Logs のロググループ名

プラットフォーム / ブランチ	インスタンスログのパス	CloudWatch Logs のロググループ名
Docker / 64bit Amazon Linux 2	`/var/log/eb-engine.log`	`/aws/elasticbeanstalk/environment_name/var/log/eb-engine.log`
	`/var/log/eb-hooks.log`	`/aws/elasticbeanstalk/environment_name/var/log/eb-hooks.log`
	`/var/log/docker`	`/aws/elasticbeanstalk/environment_name/var/log/docker`
	`/var/log/docker-events.log`	`/aws/elasticbeanstalk/environment_name/var/log/docker-events.log`
	`/var/log/eb-docker/containers/eb-current-app/stdouterr.log`	`/aws/elasticbeanstalk/environment_name/var/log/eb-docker/containers/eb-current-app/stdouterr.log`
	`/var/log/nginx/access.log`	`/aws/elasticbeanstalk/environment_name/var/log/nginx/access.log`
	`/var/log/nginx/error.log`	`/aws/elasticbeanstalk/environment_name/var/log/nginx/error.log`

CloudWatch Logs エージェントが EC2 インスタンスのログをストリーミングするためには、カスタムポリシーを EC2 インスタンスプロファイルにアタッチする必要がある。設定方法については、公式ドキュメントを参照。

LogStream の有効化

Elastic Beanstalk の CloudFormation で LogStream を有効にするには、aws:elasticbeanstalk:cloudwatch:logs:StreamLogsをtrueに設定する必要がある。

その他の有効化方法:

EC2 インスタンスのシステムメトリクス収集

EC2 インスタンスのシステムメトリクスを CloudWatch に連携することが可能。連携するためには、CloudWatch Logs Agent に対して設定を追加する必要がある。

.ebextensions/cloudwatch.config に以下の設定を行う。

files:
  "/opt/aws/amazon-cloudwatch-agent/bin/config.json":
    mode: "000600"
    owner: root
    group: root
    content: |
      {
        "agent": {
          "metrics_collection_interval": 60,
          "run_as_user": "root"
        },
        "metrics": {
          "namespace": "System/Linux",
          "append_dimensions": {
            "AutoScalingGroupName": "${aws:AutoScalingGroupName}"
          },
          "metrics_collected": {
            "mem": {
              "measurement": [
                "mem_used_percent"
              ]
            }
          }
        }
      }

container_commands:
  start_cloudwatch_agent:
    command: /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a fetch-config -m ec2 -s -c file:/opt/aws/amazon-cloudwatch-agent/bin/config.json

この例では、EC2 インスタンスのメモリ使用率が収集され、指定された間隔で（この場合は 60 秒ごとに）Amazon CloudWatch に送信される。

metrics_collectedには収集したいメトリクスを羅列する。指定できる項目はこちらに記載されている。

また、EC2 インスタンスプロファイルに、AWS 管理ポリシー CloudWatchAgentServerPolicy をアタッチする必要がある。

CloudWatch エージェント設定ファイル

agent: エージェントの全体的な設定
metrics: 収集と CloudWatch への発行に関するカスタムメトリクスを指定
logs: CloudWatch Logs に発行されるログファイルを指定
traces: AWS X-Ray に送信されるトレースのソースを指定

Agent

項目	説明	デフォルト値
metrics_collection_interval	メトリクス収集の頻度を指定。60 秒未満の場合、高解像度メトリクスとして収集。単位は sec(秒)	60
region	メトリクス送信先の AWS リージョンを指定。オンプレミスサーバーの場合は無視される。	EC2 インスタンスのリージョン
credentials	別の AWS アカウントにメトリクス、ログ、トレースを送信する際の IAM ロールを指定。	なし
role_arn	異なる AWS アカウントにメトリクス、ログ、トレースを送信する際の IAM ロールの ARN を指定。	なし
debug	デバッグログメッセージを使用するかどうかを指定。	false
aws_sdk_log_level	AWS SDK エンドポイントに対するログレベルを指定。バージョン 1.247350.0 以降でサポート。複数のオプションは、\| 文字で区切	なし
logfile	CloudWatch エージェントのログ出力先を指定。ログファイルは 100MB で更新、最大 7 日間、バックアップは 5 つまで保存。	Linux: /opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log
omit_hostname	メトリクスのディメンションにホスト名を含めるかどうかを指定。	false
run_as_user	CloudWatch エージェントを実行するユーザーを指定。Linux のみ有効。	root ユーザー
user_agent	CloudWatch エージェントが API 呼び出しに使用する user-agent 文字列を指定。	エージェントのバージョン、Go のバージョン、OS、アーキテクチャ、プラグインに基づく文字列
usage_data	Amazon CloudWatch エージェントが自身に関するヘルスおよびパフォーマンスデータを CloudWatch に送信するかどうかを指定。	true

Metrics セクション

Linux および Windows の共通のフィールド

項目	説明	デフォルト値
namespace	エージェントによって収集されるメトリクスに使用する名前空間。最大長は 255 文字。	CWAgent
append_dimensions	メトリクスに Amazon EC2 メトリクスのディメンションを追加。サポートされるキーと値のペアには、以下が含まれます: “ImageId” (AMI ID), “InstanceId” (インスタンス ID), “InstanceType” (インスタンスタイプ), “AutoScalingGroupName” (Auto Scaling グループ名)。これらのキーと値は変更不可。	なし
aggregation_dimensions	収集されたメトリクスが集計されるディメンションを指定。複数のディメンションを指定可能。	なし
endpoint_override	エージェントがメトリクスを送信するエンドポイントを指定。FIPS エンドポイントやプライベートリンクを指定可能。	なし
metrics_collected	収集するメトリクスを指定するセクション。必須項目。	なし
force_flush_interval	メトリクスがサーバーに送信されるまでにメモリバッファ内に残留する最大時間（秒単位）。	60 秒
credentials	異なるアカウントにメトリクスを送信する際に使用する IAM ロールを指定。	なし
role_arn	異なるアカウントにメトリクスを送信する際の認証用 IAM ロールの ARN を指定。	なし

ディメンションは、メトリクスのデータをカテゴリ別に整理するための「ラベル」のようなものです。たとえば、EC2 インスタンスのメトリクスデータを見たいとき、インスタンスごとにデータを分けたい場合に使います。ディメンションを使うことで、特定の条件に基づいてメトリクスをフィルタリングしたり、異なる条件下でのメトリクスを比較したりすることができます。

######## (Linux)metrics_collected セクション

########## 1. collectd

概要: CloudWatch エージェントにカスタムメトリクスを collectd プロトコルを使用して送信するためのオプション。
主要フィールド: collectdに関連する詳細設定が記述される。

########## 2. cpu

概要: Linux インスタンスで収集する CPU メトリクスを指定するオプション。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。デフォルトでは、元のメトリクスと集計メトリクスの両方が送信されます。
- resources: CPU ごとのメトリクスを収集するかどうかを指定。値は * のみ許容。
- totalcpu: すべての CPU コア間で集計されたメトリクスを報告するかを指定。デフォルトは true。
- measurement: 収集する CPU メトリクスの配列を指定。rename でメトリクスに別の名前変更可能。
- metrics_collection_interval: CPU メトリクスを収集する頻度を秒単位で指定。グローバル設定を上書きするために使用。
- append_dimensions: 特定の CPU メトリクスに対して追加のディメンションを指定。グローバルの append_dimensions に追加する形で使用。

{
  "cpu": {
    "drop_original_metrics": ["cpu_usage_idle", "cpu_usage_user"],
    "resources": "*",
    "totalcpu": true,
    "metrics_collection_interval": 60
  }
}

########## 3. disk

概要: Linux インスタンスで収集するディスクメトリクスを指定するオプション。マウントされたボリュームのみ対象。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。デフォルトでは、元のメトリクスと集計メトリクスの両方が送信されます。
- resources: 収集するディスクのマウントポイントを指定。値は * で全マウントポイント対象。デフォルトも全マウントポイント対象。
- measurement: 収集するディスクメトリクスの配列を指定。rename でメトリクス名を変更可能。
- ignore_file_system_types: 除外するファイルシステムのタイプを指定。例として sysfs、devtmpfs など。
- drop_device: ディスクメトリクスのディメンションとしてデバイス名を含めないように指定。デフォルトは false。
- metrics_collection_interval: ディスクメトリクスを収集する頻度を秒単位で指定。グローバル設定を上書きするために使用。
- append_dimensions: ディスクメトリクス専用の追加ディメンションを指定。グローバルの append_dimensions に追加する形で使用。

########## 4. diskio

概要: Linux インスタンスで収集するディスク I/O メトリクスを指定するオプション。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。デフォルトでは、元のメトリクスと集計メトリクスの両方が送信されます。
- resources: 収集するデバイスを指定。値として * を指定すると、すべてのデバイスからメトリクスが収集されます。デフォルトでは全デバイスが対象。
- measurement: 収集するディスク I/O メトリクスの配列を指定。rename でメトリクス名を変更可能。指定可能な値には reads、writes、read_bytes、write_bytes、read_time、write_time、io_time、iops_in_progress があります。
- metrics_collection_interval: ディスク I/O メトリクスを収集する頻度を秒単位で指定。グローバル設定を上書きするために使用。60 秒未満に設定すると高解像度メトリクスとして収集されます。
- append_dimensions: ディスク I/O メトリクス専用の追加ディメンションを指定。グローバルの append_dimensions に追加する形で使用。

########## 5. swap

概要: Linux インスタンスで収集するスワップメモリメトリクスを指定するオプション。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。デフォルトでは、元のメトリクスと集計メトリクスの両方が送信されます。
- measurement: 収集するスワップメモリメトリクスの配列を指定。指定可能な値は free、used、used_percent です。rename でメトリクス名を変更可能。
- metrics_collection_interval: スワップメモリメトリクスを収集する頻度を秒単位で指定。グローバル設定を上書きするために使用。60 秒未満に設定すると高解像度メトリクスとして収集されます。
- append_dimensions: スワップメモリメトリクス専用の追加ディメンションを指定。グローバルの append_dimensions に追加する形で使用。

########## 6. mem

概要: Linux インスタンスで収集するメモリメトリクスを指定するオプション。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。デフォルトでは、元のメトリクスと集計メトリクスの両方が送信されます。
- measurement: 収集するメモリメトリクスの配列を指定。指定可能な値は active、available、available_percent、buffered、cached、free、inactive、total、used、used_percent です。rename でメトリクス名を変更可能。
- metrics_collection_interval: メモリメトリクスを収集する頻度を秒単位で指定。グローバル設定を上書きするために使用。60 秒未満に設定すると高解像度メトリクスとして収集されます。
- append_dimensions: メモリメトリクス専用の追加ディメンションを指定。グローバルの append_dimensions に追加する形で使用。

########## 7. net

概要: Linux インスタンスで収集するネットワークメトリクスを指定するオプション。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。デフォルトでは、元のメトリクスと集計メトリクスの両方が送信されます。
- resources: 収集するネットワークインターフェイスを指定。* を指定するとすべてのインターフェイスからメトリクスを収集します。
- measurement: 収集するネットワークメトリクスの配列を指定。指定可能な値には bytes_sent、bytes_recv、drop_in、drop_out、err_in、err_out、packets_sent、packets_recv があります。
- metrics_collection_interval: ネットワークメトリクスを収集する頻度を秒単位で指定。60 秒未満に設定すると高解像度メトリクスとして収集されます。
- append_dimensions: ネットワークメトリクス専用の追加ディメンションを指定。グローバルの append_dimensions に追加する形で使用。

########## 8. netstat

概要: Linux インスタンスで収集する TCP 接続状態および UDP 接続メトリクスを指定するオプション。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。
- measurement: 収集する Netstat メトリクスの配列を指定。指定可能な値には tcp_close、tcp_close_wait、tcp_closing、tcp_established、tcp_fin_wait1、tcp_fin_wait2、tcp_last_ack、tcp_listen、tcp_syn_sent、tcp_syn_recv、tcp_time_wait、udp_socket があります。
- metrics_collection_interval: Netstat メトリクスを収集する頻度を秒単位で指定。
- append_dimensions: Netstat メトリクス専用の追加ディメンションを指定。

########## 9. processes

概要: Linux インスタンスで収集するプロセスメトリクスを指定するオプション。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。
- measurement: 収集するプロセスメトリクスの配列を指定。指定可能な値には blocked、dead、idle、paging、running、sleeping、stopped、total、total_threads、wait、zombies があります。
- metrics_collection_interval: プロセスメトリクスを収集する頻度を秒単位で指定。
- append_dimensions: プロセスメトリクス専用の追加ディメンションを指定。

########## 10. nvidia_gpu

概要: NVIDIA GPU アクセラレーターを搭載した Linux インスタンスで収集する GPU メトリクスを指定するオプション。NVIDIA System Management Interface (nvidia-smi) がインストールされている必要があります。
主要フィールド:
- drop_original_metrics: 指定したメトリクスの元の情報は送信されず、集計結果のみが CloudWatch に送信されます。
- measurement: 収集する NVIDIA GPU メトリクスの配列を指定。具体的なメトリクスについては、NVIDIA GPU メトリクスのドキュメントを参照。
- metrics_collection_interval: NVIDIA GPU メトリクスを収集する頻度を秒単位で指定。

########## 11. procstat

概要: 個別のプロセスからメトリクスを収集するオプション。
主要フィールド:
- 詳細: 収集するプロセスメトリクスの詳細は、「procstat プラグインでプロセスメトリクスを収集する」ドキュメントを参照。

########## 12. statsd

概要: StatsD プロトコルを使用してカスタムメトリクスを取得するオプション。CloudWatch エージェントは StatsD デーモンとして機能します。
主要フィールド:
- 詳細: 収集するメトリクスの詳細は、「StatsD を使用してカスタムメトリクスを取得する」ドキュメントを参照。

########## 13. ethtool

概要: ethtool プラグインを使用してネットワークメトリクスを収集するオプション。標準 ethtool ユーティリティや Amazon EC2 インスタンスのネットワークパフォーマンスメトリクスを収集します。
主要フィールド:
- 詳細: 収集するメトリクスの詳細は、「ネットワークパフォーマンスメトリクスの収集」ドキュメントを参照。

Amazon CloudWatch LogsでElastic Beanstalk環境を監視

Elastic Beanstalk で利用可能な Amazon CloudWatch Logs の監視機能

Docker プラットフォームでのログストリーミング

Docker プラットフォームのログファイルと対応する CloudWatch Logs のロググループ名

LogStream の有効化

EC2 インスタンスのシステムメトリクス収集

CloudWatch エージェント設定ファイル

Agent

Metrics セクション

Logs セクション

トレースセクション

参考資料

関連記事

だらけた日記

Amazon CloudWatch LogsでElastic Beanstalk環境を監視

Elastic Beanstalk で利用可能な Amazon CloudWatch Logs の監視機能

Docker プラットフォームでのログストリーミング

Docker プラットフォームのログファイルと対応する CloudWatch Logs のロググループ名

LogStream の有効化

EC2 インスタンスのシステムメトリクス収集

CloudWatch エージェント設定ファイル

Agent

Metrics セクション

Logs セクション

トレース セクション

参考資料

関連記事

だらけた日記

トレースセクション