チェック監視項目を追加する

チェック監視はチェックプラグインの実行結果を監視する機能です。エージェントはチェックプラグインを定期的に実行し、その結果を Mackerel に送信します。チェック監視項目は 1 つあたり 1 ホストメトリックとしてカウントされます。ホストメトリック監視やサービスメトリック監視との違いについてはメトリック監視とチェック監視の違いを参照してください。

チェックプラグインについて
エージェントへの設定例
チェックプラグイン仕様
チェック監視のアラート通知
メトリック監視とチェック監視の違い
Ruby によるプラグインのサンプル

チェックプラグインについて

チェック監視を行うためには目的の監視処理を行うプログラムが必要です。そのために利用できるものとして、公式のチェックプラグイン集を公開しています。詳しくは、チェック監視に公式チェックプラグイン集を使うを参照してください。

また、チェックプラグインにはユーザが自作したプログラムも使用できます。そのプログラムは目的の監視処理を行い、監視結果に応じた終了ステータスを返す必要があります。詳しくはチェックプラグイン仕様を参照してください。

エージェントへの設定例

チェック監視の設定はエージェントの設定ファイルに追加します。以下は check-ssh.rb という自作のプログラムを使用した監視の設定例です。各項目の意味は設定項目を参照してください。（必須項目以外は必要に応じて設定します）

[plugin.checks.ssh]
command = ["ruby", "/path/to/check-ssh.rb"]
check_interval = 5
timeout_seconds = 45
max_check_attempts = 3
prevent_alert_auto_close = true
notification_interval = 60
custom_identifier = "SOME_IDENTIFIER"
env = { HOST = "hostname", PORT = "port" }
memo = "This check monitor is ..."

設定項目

設定項目	必須	説明	デフォルト値
[plugin.checks.XXX]	◯	設定ファイル用のキーです。`plugin.checks.` までは固定です。2 つ目のドット以降（XXX）の文字列が監視ルールの名前として使用されます。XXX の部分にドットを含めることはできません。	なし
command	◯	エージェントが定期的に実行し、その終了ステータスや標準出力内容を監視結果として使用します。公式チェックプラグインのほか、ユーザが自作したプログラムや任意のコマンドなども実行できます。	なし
check_interval		チェック監視の実行間隔を分で指定します。エージェントのバージョンが v0.67.0 以降であれば `10m` や `1h` のような表現でも記述できます。設定可能な範囲は 1 分から 60 分です。1 分未満を指定した場合は 1 分、60 分以上を指定した場合は 60 分として扱われます。	1（分）
timeout_seconds		プラグインの処理におけるタイムアウト時間を秒で指定します。各プラグイン実行の多重起動の制御はされませんので、プラグインの実行間隔（check_interval）を超えないように設定をすることを推奨します。	30（秒）
max_check_attempts		最大試行回数を指定します。ここで指定した回数以上、OK 以外の結果が連続した場合にアラートが発生します。 `prevent_alert_auto_close` と併用した場合、指定した数値に関わらず `1` として扱われます。	1
prevent_alert_auto_close		このチェックプラグインによる監視で発生したアラートが自動クローズされなくなります。 `max_check_attempts` と併用した場合、 `max_check_attempts` は常に `1` として扱われます。	false
notification_interval		アラート通知の再送間隔を分で指定します。エージェントのバージョンが v0.67.0 以降であれば `10m` や `1h` のような表現でも記述できます。省略した場合は再送されません。10 分未満は指定できません。10 分未満を指定した場合は 10 分として扱われます。	指定なし
custom_identifier		監視の実行結果を mackerel-agent が動作しているホストではなく、ここで指定した識別子のホストの監視として扱います。チェック結果が OK でなかった場合、ここで指定したホストのアラートとして発報されます。 AWS / Azure / Google Cloud インテグレーションで連携したホストなど、エージェントがインストールできないホストにチェック監視を追加する場合に有用です。詳細は AWSインテグレーションのドキュメントを参照してください。この値は API のホスト情報の取得で確認が可能です。	指定なし
env		環境変数を設定できます。設定を行ったプラグインでのみ有効です。	指定なし
action		`command` に設定したコマンドの実行直後に、ここに記述したアクションが毎回実行されます。詳しくは action の記述方法を参照してください。	指定なし
memo		チェック監視に対してメモを設定できます。ここで指定した文字列は、アラート通知、アラート詳細画面、ホスト詳細画面で確認できます。	指定なし

action の記述方法

action = {} の形で以下の項目を記述します。各項目はカンマ区切りで同時に記述が可能です。

設定値	説明
command	`command` に設定したコマンドの実行直後に毎回実行されます。コマンドの実行結果に応じて行いたい処理がある場合などに使用します。後述の環境変数が利用できます。（プラグインの `command` と区別するために本項では `action.command` として扱います）
env	`action.command` に渡す環境変数を指定できます。TOMLの Table もしくは Inline Table で指定します。
user	ここで指定したユーザーで `action.command` を実行します。Windows 環境には非対応です。
timeout_seconds	`action.command` の処理におけるタイムアウト時間を秒で指定します。（デフォルト: 30秒）

以下は command の実行結果（MACKEREL_STATUS）が OK 以外の場合に action.command を実行する設定の例です。

action = { command = "bash -c '[ \"$MACKEREL_STATUS\" != \"OK\" ]' && ruby /path/to/notify_something.rb", env = { NOTIFY_API_KEY = "API_KEY" }, user = "someone", timeout_seconds = 45 }

action で利用可能な環境変数

環境変数	説明
MACKEREL_STATUS	直前の `command` の実行結果です。`OK`, `WARNING`, `CRITICAL`, `UNKNOWN` のいずれかになります。（`max_check_attempts` は考慮されません）
MACKEREL_PREVIOUS_STATUS	前回の `command` の実行結果です。エージェント起動後の初回実行時は空文字列です。2 回目以降は `OK`, `WARNING`, `CRITICAL`, `UNKNOWN` のいずれかになります。（`max_check_attempts` は考慮されません）
MACKEREL_CHECK_MESSAGE	直前の `command` の標準出力結果です。Windows では結果を取得できない場合があります。

チェックプラグイン仕様

command の終了ステータスに応じて以下のように扱われます。

終了ステータス	アラートレベル
0	OK
1	WARNING
2	CRITICAL
0, 1, 2 以外	UNKNOWN

また、標準出力には補助的なメッセージを追加できます。メッセージ長の上限は 1024 文字までです。その出力は Mackerel に送信され、ホスト詳細画面やアラート詳細画面に表示されます。そのため、パスワードなどの秘匿情報が送信されないようにご注意ください。

公式プラグインで利用しているユーティリティライブラリである、github.com/mackerelio/checkers を利用したプラグインの開発方法については、checkersを利用してチェックプラグインを作成するを参照してください。

チェック監視のアラート通知

アラートが発生した場合と、発生後にアラートのステータスが変化した場合に通知が行われます。ステータスが OK になった場合も含みます。

以下はアラートのステータス変化とその際の通知の有無を示した例です。

監視実行回数	1 回目	2 回目	3 回目	4 回目	5 回目	6 回目
ステータス	CRITICAL	WARNING	WARNING	CRITICAL	CRITICAL	OK
アラート通知	あり	あり	なし	あり	なし	あり

アラートのステータスやメッセージの内容が変化した場合、その内容はアラート詳細画面にも反映されます。なお、メッセージの内容が変化しただけの場合は通知は行われません。

メトリック監視とチェック監視の違い

ホストメトリック監視やサービスメトリック監視などのメトリック監視とチェック監視では以下のような点で異なります。

メトリック監視
- ホスト側はメトリック値を Mackerel に投稿します。その値と閾値との比較やアラート通知は Mackerel 側で行われます。
- メトリックがグラフとして描画されます。
- 監視ルールの設定は Web コンソールもしくは Web API で行います。
- 監視ルールの追加による料金は発生しません。（課金対象はメトリックそのものです）
チェック監視
- プラグインを実行するホスト内で OK / NG (CRITICAL or WARNING or UNKNOWN) の判定を行い、その結果を Mackerel に送信します。Mackerel は受け取った結果に応じてアラートを通知します。
- メトリックが投稿されないためグラフは描画されません。
- 監視ルールの設定は mackerel-agent の設定ファイルで行います。Web コンソールで設定の追加や変更はできません。
- 1 つあたり 1 ホストメトリックとしてカウントされます。1 ホストあたりのメトリック数の上限については料金を参照してください。また、上限超過時の仕様についてはプラン上限超過時のホスト台数換算についてを参照してください。
監視イメージ
- 【左】メトリック監視【右】チェック監視

Ruby によるプラグインのサンプル

6 面ダイスの値をメッセージとして、値が 4 及び 5 のときは WARNING を、6 のときは CRITICAL を Mackerel に投稿するプラグインです。

#!/usr/bin/env ruby
dice = rand(6)+1
puts "value is #{dice}"
exit (dice >= 6 ? 2 : dice >= 4 ? 1 : 0)

チェックプラグインを設定したエージェントを実行すると、以下のようにホスト詳細に監視中であることが表示されます。

アラートが発生した際には以下の様な表示となり、アラート詳細画面で詳細が確認できます。