チェックプラグイン - check-mysql

check-mysql は MySQL の監視を行うチェックプラグインです。使用するサブコマンドに応じた条件でチェック監視が可能です。

サブコマンド

使用可能なサブコマンドは以下の通りです。

コマンド 監視内容 参照先 備考
uptime MySQL サーバの稼働時間 SHOW GLOBAL STATUS の Uptime
readonly MySQL サーバが読み取り専用になっているか SHOW GLOBAL VARIABLES の read_only
replication MySQL サーバのレプリケーションの状態 SHOW REPLICA STATUS
・IO_Running および SQL_Running がどちらも Yes の状態か
・Seconds_Behind の値が閾値を超えているか		 ・接続するユーザに REPLICATION CLIENT 権限が必要
・MySQL 8.0.22 より前のバージョンは SHOW SLAVE STATUS の結果を参照
connection MySQL サーバのコネクション数 SHOW GLOBAL STATUS の Threads_connected

指定可能なオプション

以下のオプションはすべてのサブコマンドで指定可能です。

オプション 省略形 説明 デフォルト値
--host= -H 対象のホスト localhost
--port= -p 接続ポート 3306
--socket= -S ソケットファイルの指定
--user= -u ユーザ名 root
--password= -P パスワード
--tls TLS 接続を有効にする
--tls-root-cert= TLS 接続時のルート証明書の指定
--tls-skip-verify TLS 接続時に証明書を検証しない
-help -h コマンドのヘルプを表示
check-mysql connection -h のように実行するとサブコマンドごとのヘルプを表示

閾値オプション

以下の閾値に関するオプションはサブコマンドによって条件が異なります。オプションの指定がない場合はデフォルト値が閾値になります。

サブコマンド オプション 省略形 説明 デフォルト値
uptime --critical=
--warning=		 -c
-w		 Uptime が指定した秒数を下回る場合 0 (critical)
0 (warning)
readonly なし
replication --critical=
--warning=		 -c
-w		 Seconds_Behind が指定した秒数を上回る場合 250 (critical)
200 (warning)
connection --critical=
--warning=		 -c
-w		 Threads_Connected が指定した数を上回る場合 250 (critical)
200 (warning)

エージェントへの設定例

MySQL のコネクション数が 250 を上回る場合に Warning、280 を上回る場合に Critical のアラートを発生させる設定は以下のようになります。

[plugin.checks.check-mysql-sample]
command = ["check-mysql", "connection", "--host", "127.0.0.1", "--port", "3306", "--user", "USER", "--password", "PASSWORD", "--warning", "250", "--critical", "280"]

上記の設定をターミナルなどから直接実行して確認するには、以下のように実行してください。

check-mysql connection --host=127.0.0.1 --port=3306 --user=USER --password=PASSWORD --warning=250 --critical=280

Tips

MySQL の接続情報の記述方法

check-mysql の実行に必要な接続情報は --password オプションに直接記述する以外の方法もあります。（command の内容を配列指定ではなく、文字列指定で記述する必要があります。）

コマンドを利用する

文字列指定で記述した場合 command の内容はシェル経由の実行となりますので、パスワードを出力するコマンドの利用も出来ます。

mackerel-agent.conf

command = "check-mysql ・・・ --password="パスワードを出力するコマンド"

環境変数を利用する

設定ファイルに環境変数を定義してオプションに変数を指定することが出来ます。

mackerel-agent.conf

command = "check-mysql ・・・ --password=$MYSQL_PASSWORD ・・・"
env = { "MYSQL_PASSWORD" = "xxxxx" }

また、mackerel-agentのプロセスに適用された環境変数も利用できます。詳しくは環境変数を適用するをご確認ください。

トラブルシューティング

Couldn't ... というエラーメッセージが出力される

接続情報が誤っている、接続するユーザに MySQL の情報を閲覧する権限が与えられていない可能性があります。
check-mysql をホスト上で手動実行して情報の取得が可能か確認してください。

リポジトリ

https://github.com/mackerelio/go-check-plugins/tree/master/check-mysql