Datadog公式のツール dog 使用方法まとめ host 編です。
目次
host Modes
host とありますが、操作できるのは mute|unmute のみです。
| サブコマンド | 説明 |
|---|---|
| mute | ホストのmute(通知無効化) |
| unmute | ホストのunmute(通知無効化解除) |
mute
usage: dog host mute [-h] [--end END] [--message MESSAGE] [--override]
host_name
optional arguments:
| ロングオプション | 説明 |
|---|---|
| –end | 終了日時を指定。POSIX timestamp。指定無しの場合は forever(無限) |
| –message | 関連付けるメッセージ本文 |
| –override | 既に mute 状態の場合でも終了期間を上書きする |
実行例
$ host_name="i-XXXXXXXX"
$ dog host mute ${host_name}
{"action": "Muted", "downtime_id": XXXXXXX33, "hostname": "i-XXXXXXXX"}
[Infrastracture List]、または、[Manage Downtime] で確認できます。
デフォルトで設定されるスケジュールは登録日時から Forever です。
既に mute 済みの場合は override オプションを使用するようメッセージが出力されます。
$ dog host mute ${host_name}
ERROR: host:i-XXXXXXXX is already muted. To mute this host with a different end timestamp, add ?override=true to your request.
message オプション
downtime にメッセージを関連付けます。各種通知を行うことも可能です。
$ dog host mute --end $(date -d '1 hour' +'%s') --message "1時間無効化します @slack-xxxxxx" ${host_name}
{"action": "Muted", "downtime_id": XXXXXXX73, "hostname": "i-XXXXXXXX", "end": NNNNNNNNN9, "message": "1\u6642\u9593\u7121\u52b9\u5316\u3057\u307e\u3059 @slack-xxxxxx"}
指定したスケジュール(登録日時から1時間)、通知設定が入ります。
- Slackへの通知例
既に mute 済みの場合は、end、message 共に更新不可です。オプション無し時と同様に override オプションを使用するようメッセージが出力されます。
$ dog host mute --end $(date -d '2 hour' +'%s') --message "2時間無効化に伸ばします" ${host_name}
ERROR: host:i-XXXXXXXX is already muted. To mute this host with a different end timestamp, add ?override=true to your request.
override オプション
unmuteの状態に加え、既にmute済みでも更新できるようになります。
$ dog host mute --end $(date -d '2 hour' +'%s') --message "2時間無効化に伸ばします" --override ${host_name}
{"action": "Muted", "downtime_id": XXXXXXX75, "hostname": "i-XXXXXXXX", "end": NNNNNNNNN0, "message": "2\u6642\u9593\u7121\u52b9\u5316\u306b\u4f38\u3070\u3057\u307e\u3059"}
unmute
オプションはありません。
usage: dog host unmute [-h] host_name
実行例
$ host_name="i-XXXXXXXX"
$ dog host unmute ${host_name}
{"action": "Unmuted", "downtime_id": XXXXXXX33, "hostname": "i-XXXXXXXX"}
unmute 済みの場合はメッセージ出力のみです。
$ dog host unmute ${host_name}
ERROR: host:i-XXXXXXXX is not muted.
monitor {mute|unmute} コマンドはモニターを軸にタグ(スコープ)による指定を行うのに対し、 指定 host 単体の全モニターが対象になります。 対象ホストをメンテナンス(mute)状態にしたい場合に利用できると思います。
