christiangda.amazon_cloudwatch_agent

概要 バージョン 洞察

Ansible Role: christiangda.amazon_cloudwatch_agent

このロールはAWS CloudWatch Agentをインストールします。

このロールをインストールする最良の方法は、コマンドansible-galaxy install christiangda.amazon_cloudwatch_agentを使用することです。Ansible Galaxyリポジトリはchristiangda.amazon_cloudwatch_agentです。

リポジトリのコードはここにあります。

特徴:

  • AWS EC2インスタンスおよびオンプレミスインスタンスで動作します。
  • Python、Ansible、オペレーティングシステムの異なるバージョンをサポートします（詳細はこちら）。
  • AWS配布パッケージからCloudWatch Agentをダウンロードしてインストールします。
  • 設定が変更されるとサービスを再読み込みします。
  • デフォルトのエージェント設定ファイルを提供します（最小限の設定であり、推奨されません）。
  • CloudWatch Agentのログファイルをローテーションします。
  • 独自のJSONファイル / YAMLファイルまたはインライン設定を読み込むことを許可します。
  • amd64およびarm64アーキテクチャをサポートしています。

注意点:

  • バージョン2.x.yはバージョン1.x.yとは互換性がありません。
  • バージョン2.x.y以降、デフォルトでEPELリポジトリをインストールしなくなったため、ユーザーが処理する必要があります。代わりに私のansible rolechristiangda.epel_repoをお勧めします。
  • バージョン2.x.y以降、このロールはAWS CLIプロファイルを作成しなくなったため、こちらもユーザーが処理する必要があります。代わりに私のansible roleschristiangda.awscliとchristiangda.awscli_configureをお勧めします。
  • 指定した設定ファイルにおいてcollectdによるカスタムメトリクスの取得を利用する場合、自動的にcollectd OSパッケージがインストールされます。OSによってはEPELリポジトリが必要な場合があります。
  • RedHatユーザーは、依存パッケージのインストールの問題を回避するため、有効なサブスクリプションを持つことが重要です。

詳細についてはVERSION.mdを参照してください。

必要条件

このロールはRedHat、CentOS、Amazon Linux、Debian、Ubuntuディストリビューションで動作します。

  • RedHat
    • 7
    • 8
  • CentOS
    • 7
    • 8
    • stream8
  • Rocky Linux
    • 8
    • 9
  • Amazon Linux
    • 2
  • Ubuntu
    • 14.04 (*)
    • 16.04 (*)
    • 18.*
    • 20.*
    • 21.*
    • 22.*
  • Debian
    • Stretch (9)
    • buster (10)
    • bullseye (11)
    • Bookworm (12)

PythonとAnsibleバージョンの互換性マトリックスはこちらで確認できます。

ロール変数

変数 デフォルト値
cwa_conf_json_file_content "" --> 空
cwa_agent_mode "ec2"
cwa_aws_region ""
cwa_use_credentials false
cwa_profile "AmazonCloudWatchAgent"
cwa_agent_profile_path /root
cwa_http_proxy "" --> 空
cwa_https_proxy "" --> 空
cwa_no_proxy "169.254.169.254"
cwa_logrotate_file_size "10M"
cwa_logrotate_files 5
cwa_debug false

詳細: defaults/main.yamlファイルを参照してください。

依存関係

使用例

cwa_agent_mode: "onPremise"の場合

# ansible-vaultを使用してプロビジョニングする必要があります
# 例:
# ansible-vault encrypt_string --ask-vault-pass --name 'cwa_access_key' 'AKIAIOSFODNN7EXAMPLE'
# ansible-vault encrypt_string --ask-vault-pass --name 'cwa_secret_key' 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'

- hosts: servers
    gather_facts: True
    roles:
      - role: christiangda.epel_repo # EPELリポジトリがインストールされていない場合
        when: >
          ansible_os_family == 'RedHat' and (
            ansible_distribution == 'CentOS' or
            ansible_distribution == 'RedHat' or
            ansible_distribution == 'Amazon'
          )
      - role: christiangda.awscli_configure # AWS CLIプロファイルが設定されていない場合
        vars:
          awscliconf_path: '/root'
          awscliconf_files:
            credentials:
              - AmazonCloudWatchAgent:
                  aws_access_key_id: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    30376338613338326663373366303234623665633339303338613463313564633832363237306137
                    3362643039616631323339383332306536333962346133310a383265376665316235653261616136
                    61306566623531356263346439633761633830323636646236373736353530396134636536666532
                    3939636433636364310a316639366139366566623337623536346661633339343766323936346336
                    65333035366635396138656132643262626438333961326266396466626464643766
                  aws_secret_access_key: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    65643230613939303737336632346432393234616437383532386139616364316233333933643735
                    6633636261383163323362623562323333323533336564310a323030343431366135343035326635
                    33623161376634643939636464306139386662303034616531346632303039643238373834616266
                    3064623232373233610a346432646565396235316631626137653731376365333531323866626665
                    62656638623330643539653763636364363738653932653831316238633939356462653636633463
                    6130613761633565616533633332376565373062396565396261
            config:
              - profile AmazonCloudWatchAgent:
                  region: "eu-west-1"
      - role: christiangda.amazon_cloudwatch_agent # ロールが提供する最小限のエージェント設定を使用
          vars:
              cwa_agent_mode: "onPremise"
              cwa_aws_region: "eu-west-1"
              cwa_profile: "AmazonCloudWatchAgent"

cwa_agent_mode: "ec2"の場合

JSON設定ファイルからの読み込み

---
- hosts: servers
    gather_facts: True
    roles:
      - role: christiangda.amazon_cloudwatch_agent # 提供されたJSONファイルを使用
          vars:
              cwa_agent_mode: "ec2"
              cwa_conf_json_file_content: "{{ lookup('file', 'files/CloudWatch.json') | from_json }}"

YAML設定ファイルからの読み込み

---
- hosts: servers
    gather_facts: True
    roles:
      - role: christiangda.amazon_cloudwatch_agent # 提供されたYAMLファイルを使用
          vars:
              cwa_agent_mode: "ec2"
              cwa_conf_json_file_content: "{{ lookup('file', 'files/CloudWatch.yaml') | from_yaml }}"

インラインYAML設定ファイルの使用

---
- hosts: centos7, centos6, ubuntu1804, ubuntu1810, debian8, debian9, amzn2
  become: True
  roles:
    - role: christiangda.epel_repo # EPELリポジトリがインストールされていない場合
        when: >
          ansible_os_family == 'RedHat' and (
            ansible_distribution == 'CentOS' or
            ansible_distribution == 'RedHat' or
            ansible_distribution == 'Amazon'
          )
      - role: christiangda.awscli_configure # AWS CLIプロファイルが設定されていない場合
        vars:
          awscliconf_path: '/root'
          awscliconf_files:
            credentials:
              - AmazonCloudWatchAgent:
                  aws_access_key_id: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    30376338613338326663373366303234623665633339303338613463313564633832363237306137
                    3362643039616631323339383332306536333962346133310a383265376665316235653261616136
                    61306566623531356263346439633761633830323636646236373736353530396134636536666532
                    3939636433636364310a316639366139366566623337623536346661633339343766323936346336
                    65333035366635396138656132643262626438333961326266396466626464643766
                  aws_secret_access_key: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    65643230613939303737336632346432393234616437383532386139616364316233333933643735
                    6633636261383163323362623562323333323533336564310a323030343431366135343035326635
                    33623161376634643939636464306139386662303034616531346632303039643238373834616266
                    3064623232373233610a346432646565396235316631626137653731376365333531323866626665
                    62656638623330643539653763636364363738653932653831316238633939356462653636633463
                    6130613761633565616533633332376565373062396565396261
            config:
              - profile AmazonCloudWatchAgent:
                  region: "eu-west-1"
    - role: christiangda.amazon_cloudwatch_agent # オンラインYAML設定を使用
      vars:
        cwa_agent_mode: onPremise
        cwa_aws_region: "eu-west-1"
        cwa_profile: "AmazonCloudWatchAgent"
        cwa_conf_json_file_content:
          agent:
            metrics_collection_interval: 60
            region: es-west-1
            logfile: "/opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log"
            debug: false
          metrics:
            metrics_collected:
              cpu:
                resources:
                  - "*"
                measurement:
                  - name: cpu_usage_idle
                    rename: CPU_USAGE_IDLE
                    unit: Percent
                  - name: cpu_usage_nice
                    unit: Percent
                  - cpu_usage_guest
                totalcpu: false
                metrics_collection_interval: 10
                append_dimensions:
                  test: test1
                  date: "2017-10-01"
              netstat:
                measurement:
                  - tcp_established
                  - tcp_syn_sent
                  - tcp_close
                metrics_collection_interval: 60
              processes:
                measurement:
                  - running
                  - sleeping
                  - dead
            append_dimensions:
              ImageId: "${aws:ImageId}"
              InstanceId: "${aws:InstanceId}"
              InstanceType: "${aws:InstanceType}"
              AutoScalingGroupName: "${aws:AutoScalingGroupName}"
            aggregation_dimensions:
              - - AutoScalingGroupName
              - - InstanceId
                - InstanceType
              - []
          logs:
            logs_collected:
              files:
                collect_list:
                  - file_path: "/opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log"
                    log_group_name: amazon-cloudwatch-agent.log
                    log_stream_name: amazon-cloudwatch-agent.log
                    timezone: UTC
                  - file_path: "/opt/aws/amazon-cloudwatch-agent/logs/test.log"
                    log_group_name: test.log
                    log_stream_name: test.log
                    timezone: Local
            log_stream_name: my_log_stream_name
            force_flush_interval: 15

AWS EC2インスタンスの最小限の設定

---
- hosts: all
    gather_facts: True
    become: true
    become_user: root
    become_method: sudo
    remote_user: ec2-user
    roles:
    - role: christiangda.amazon_cloudwatch_agent # "EC2インスタンス"上でロールのデフォルトエージェント設定を使用と仮定

インベントリファイルサンプル

[all]
10.14.x.y
10.14.v.z

[amazon-1]
10.14.x.y

[amazon-2]
10.14.v.z

使用方法

ansible-playbook my-playbook.yml \
    --inventory inventory \
    --private-key [~/key.pemの場所] \
    --become \
    --become-user=ec2-user \
    --user ec2-user

開発 / 貢献

このロールはMoleculeを使用してテストされており、Pythonバーチャル環境を使用して開発されました。

メインのgitブランチは以下の通りです。

  • master
  • develop

このプロジェクトに貢献したい場合は、次のことを行う必要があります。

参照:

環境の準備

  • Python 3
mkdir ansible-roles
cd ansible-roles/

python3 -m venv venv
source venv/bin/activate
pip install pip --upgrade
pip install ansible
pip install molecule
pip install 'molecule[docker]'
pip install 'molecule[podman]'
pip install 'molecule[lint]'
pip install molecule-vagrant
pip install python-vagrant
pip install selinux
pip install docker
pip install pytest
pip install pytest-mock
pip install pylint
pip install rope
pip install autopep8
pip install yamllint
pip install flake8
pip install ansible-lint

リポジトリをクローンしてシンボリックリンクを作成

注: まずメインリポジトリをフォークします

git clone https://github.com/<あなたのGitHubユーザー>/ansible-role-amazon-cloudwatch-agent.git
ln -s ansible-role-amazon-cloudwatch-agent christiangda.amazon_cloudwatch_agent
cd christiangda.amazon_cloudwatch_agent

Moleculeテストを実行

利用可能なシナリオ:

  • default --> --driver-name docker
  • podman --> --driver-name podman
  • vagrant --> --driver-name vagrant

デフォルトのシナリオ

ステップバイステップ

molecule create [--scenario-name default]
molecule converge [--scenario-name default]
molecule verify [--scenario-name default]
molecule destroy [--scenario-name default]

または

すべて一度に

molecule test [--scenario-name default]

podmanシナリオ

ステップバイステップ

molecule create --scenario-name podman
molecule converge --scenario-name podman
molecule verify --scenario-name podman
molecule destroy --scenario-name podman

または

すべて一度に

molecule test --scenario-name podman

vagrantシナリオ

ステップバイステップ

molecule create --scenario-name vagrant
molecule converge --scenario-name vagrant
molecule verify --scenario-name vagrant
molecule destroy --scenario-name vagrant

または

すべて一度に

molecule test --scenario-name vagrant

加えて、VMを使用してテストしたい場合、VagrantとVirtualBoxを使用した非常に良いansible-playgroundプロジェクトがありますので、ぜひ試してみてください。

ライセンス

このモジュールはGNU General Public License Version 3の下でリリースされています:

作者情報

プロジェクトについて

Ansible Role for AWS CloudWatch Agent

role agent amazon aws centos cloud cloudwatch debian linux logs metrics redhat system ubuntu utilities
インストール
ansible-galaxy install christiangda.amazon_cloudwatch_agent
GitHub リポジトリ
60 スター
46 フォーク
11 オープンな問題
ライセンス
gpl-3.0
ダウンロード
421.5k
所有者