「Ansible 徹底入門」を読んでる途中だけど Ansible Callback Plugin(CloudWatch Logs にイベントを送信するプラグイン) を作ってみたのメモ

$ python --version
Python 2.7.13

$ ansible --version
ansible 2.2.1.0
  config file = /path/to/.ansible.cfg
  configured module search path = Default w/o overrides

プラグインの置き場

ansible.cfg で指定します。

[default]
callback_plugins = ~/path/to/plugins
callback_whitelist = cloudwatch_logs

callback_plugins に指定したディレクトリにプラグインを設置。設置しただけではダメのようで、callback_whitelist に利用したいプラグイン名を記述する必要があるとのことです。（実施に試してところ、callback_whitelist への記載が不要な挙動だったので引き続き調べたい）

Playbook

引き続き、前の記事で紹介した Datadog のタグを管理するモジュールを利用する Playbook を利用します。

- hosts: localhost
  tasks:
    - name: Test datadog_tags(present)
      datadog_tags:
        state: present
        host: myhost
        tags: 'aa,bb,cc,dd'
        api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        app_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    - name: Test datadog_tags(absent)
      datadog_tags:
        state: absent
        host: myhost
        api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        app_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

プロビジョニング

$ ansible-playbook datadog.yml
 [WARNING]: Host file not found: /etc/ansible/hosts

 [WARNING]: provided hosts list is empty, only localhost is available


PLAY [localhost] ***************************************************************

TASK [setup] *******************************************************************
ok: [localhost]

TASK [Test datadog_tags(present)] **********************************************
changed: [localhost]

TASK [Test datadog_tags(absent)] ***********************************************
changed: [localhost]

PLAY RECAP *********************************************************************
localhost                  : ok=3    changed=2    unreachable=0    failed=0

CloudWatch Logs を確認

プラグインのデフォルトでは AWS_PROFILE は default が設定され、Log Group は ansible 及び Log Stream が provision が設定されます。

$ aws --profile ${AWS_PROFILE} --region ${AWS_REGION} \
  logs get-log-events \
    --log-group-name ansible --log-stream-name provision | jq '.events|sort_by(.timestamp)|.[-2,-1]'
{
  "ingestionTime": 1490456583837,
  "timestamp": 1490456583257,
  "message": "{'log_action': 'ansible ok', 'status': 'OK', 'host': 'myhost', 'session': 'b8891b28-1171-11e7-9524-3c15c2bdc014', 'ansible_type': 'task', 'ansible_playbook': 'datadog.yml', 'ansible_host': 'localhost', 'ansible_task': TASK: Test datadog_tags(present), 'ansible_result': '{\"changed\": false}'}"
}
{
  "ingestionTime": 1490456583837,
  "timestamp": 1490456583260,
  "message": "{'log_action': 'ansible stats', 'status': 'OK', 'host': 'myhost', 'session': 'b8891b28-1171-11e7-9524-3c15c2bdc014', 'ansible_type': 'finish', 'ansible_playbook': 'datadog.yml', 'ansible_result': '{\"localhost\": {\"ok\": 2, \"failures\": 0, \"unreachable\": 0, \"changed\": 0, \"skipped\": 0}}'}"
}

実装にあたり

Callback Plugin では以下のようなイベントをフックすることが出来ます。

$ grep v2_ plugins/cloudwatch_logs.py
    def v2_playbook_on_start(self, playbook):
    def v2_playbook_on_stats(self, stats):
    def v2_runner_on_ok(self, result, **kwargs):
    def v2_runner_on_skipped(self, result, **kwargs):
    def v2_playbook_on_import_for_host(self, result, imported_file):
    def v2_playbook_on_not_import_for_host(self, result, missing_file):
    def v2_runner_on_failed(self, result, **kwargs):
    def v2_runner_on_unreachable(self, result, **kwargs):
    def v2_runner_on_async_failed(self, result, **kwargs):