ハートビーツからお届けする技術情報の初回シリーズ、Nagiosについての第4回です。

第3回ではNagiosの監視プラグインで、aptでインストールできるものをご紹介しましたので 今回は自作監視プラグインの作り方をご紹介します。
(ただし、ここではサービス監視に関するものをご紹介します。ホスト監視についてや、 細かい仕様については公式ドキュメントのNagios Plugin APIなどをご覧下さい。）

プラグインを使って監視をしたいサーバで動くプログラミング言語であれば、どんな言語でも構いません。 前回ご紹介したプラグインはC言語で書かれていますが、シェルスクリプトや Perl,Ruby,Pythonで書いても構わないんです。

Nagiosで動くプラグインを作るための2つの約束事を、順番にご紹介しましょう。

約束事1：プラグイン自体の返り値が0,1,2,3のどれかであること

プラグインの終了コードは、サービスのプラグインとして使う場合は

• 0:OK
• 1:WARNING
• 2:CRITICAL
• 3:UNKNOWN

を表します。例えばシェルスクリプトであればexitコマンドで 終了コードを指定してプログラムを終了することが出来ます。

約束事2：最低でも一行のテキストを標準出力へ出力すること

終了コードの補足情報として、テキストを1行持たせることが出来ます。 例えばシェルスクリプトであれば、echoコマンドなどを使うだけです。 ただし2行目以降は無視されてしまいますので、改行をいれずに出力して下さい。 1行も出力が無い場合にはNagios側がエラーと見なしてしまい、UNKNOWNとして補足されてしまいます。

サンプルコード

以上を踏まえたcheck_dummyをシェルスクリプトで簡単に作ってみましょう。 check_dummyはもらった引数が0,1,2,3であれば、それに応じたステータスをそのまま返すプラグインです。

#!/bin/sh

# 終了コード
OK=0
WARNING=1
CRITICAL=2
UNKNOWN=3

# オプションを1つ受け取って、変数 status に格納します。
if [ $# != 1 ]
then
  echo "Just 1 argument is permitted."
  exit $UNKNOWN
else
  status=$1
fi

# 変数 status が 0,1,2,3 のどれかなら、それに応じたステータスを返し、終了します。
# 0,1,2,3 以外であれば UNKNOWN としてみましょう。
case $status in
  0)  echo "** OK **"
      exit $OK ;;
  1)  echo "** WARNING **"
      exit $WARNING ;;
  2)  echo "** CRITICAL **"
      exit $CRITICAL ;;
  3)  echo "** UNKNOWN **"
      exit $UNKNOWN ;;
  *)  echo "The argument $status is not permitted."
      exit $UNKNOWN ;;
esac

# 上で分岐が網羅されていれば、ここには来ませんが、念のため。
echo "** Error **"
exit $UNKNOWN

とても簡単なスクリプトでしたが、雰囲気はつかんで頂けたでしょうか？

応用例

ハートビーツでは主にaptでインストールできるプラグインを使用していますが、各案件に応じたプラグインを作成することもよくあります。

例えば1時間に3通受信して欲しいメールがあり、3通未満であればエラーを出すような監視がしたいとしましょう。 メールに対する監視であれば、Procmailと連携させるととても便利です。

受信して欲しいメールが来たら、Procmailから何らかのスクリプトへ処理を受け渡し、どこかのファイルへ受信数を保存します。プラグインとして実装すべき部分は、その保存された受信数を見に行き、ある時間に3通未満であればWARNINGやCRITICALとする部分のみです。

他には、会員制のホームページがあったとして、ログインした後に所定のページを回るまでに何秒かかるかを監視することも出来ます。 弊社ではLWP::UserAgentを利用して、Perlでこれを実装しています。

今あるプラグインを無理に作らなくても結構ですが、少し手を加えることでNagiosで出来ることはグンと広がります。是非挑戦してみてください！

ハートビーツからお届けする技術情報の初回シリーズの、Nagiosについての第3回です。

今回は、Nagiosの監視プラグインについてご紹介します。

独自に作るのも簡単にできるんですが、まずはaptでインストールできるものを一通りご紹介します。これだけでもかなりの量があるので、さっと試す分には十分だと思います。

いずれのコマンドも、たいがい-hオプションをつけてコマンドラインで実行するとUsageが表示されるので、困ったらやってみましょう。

nagios-plugins-basic

• check_apt - apt(apt-getのapt)でエラーがないか、更新すべきファイルが残っていないか確認します。チェックに少し時間がかかるので、あまりに頻繁にチェックすると問題になるかもしれません
• check_by_ssh - あるホストにsshでログインし、引数で指定したコマンドを実行して結果を確認します。パスワードは指定できないので、パスフレーズなしの公開鍵認証でのログインを想定しているようです
• check_clamd - あるホストのClamd(アンチウィルスのClamAVのデーモン)と通信可能か確認します。
• check_cluster - 複数のホストorサービスをまとめてclusterとして定義し、そのclusterの状態が正常かどうかをNagiosサーバで確認します。ホスト・サービスの指定にはon-demand macro(on-demand service macro, on-demand host macro)を使うため、コマンドラインでの実行は難しいかもしれません
• check_dhcp - DHCPサーバの動作を確認します。応答すべきDHCPサーバのIPアドレスをチェックしたりできます
• check_disk - 自ホストのディスクの空き容量を確認します。容量指定・%指定ができます
• check_dummy - 引数で指定されたステータスを返します
• check_file_age - 自ホストのファイルが指定秒数以内に更新されていることを確認します。閾値として、指定サイズ以上であるということも合わせて確認できます
• check_ftp - あるホストにftp接続ができることを確認します
• check_http - あるホストにHTTP(HTTPS)接続ができることを確認します。文字列検知、認証、ユーザエージェント指定などに対応しています
• check_icmp - あるホストにICMPパケットを送り、応答を確認します
• check_ide_smart - 自ホストのディスクのSMART値を確認します
• check_imap - あるホストにIMAP(IMAPS)接続ができることを確認します
• check_ircd - あるホストにIRC接続ができることを確認します。同時接続数も同時に確認できます
• check_jabber - あるホストにJABBER(over SSL)接続ができることを確認します
• check_load - 自ホストのロードアベレージを確認します。1分平均、5分平均、15分平均を確認できます
• check_log - 自ホストのあるファイルに対してパターンマッチで出力を確認します。ファイルを2つ指定し、2つのファイルに対してパターンマッチを適用した結果が異なるかどうかを確認します
• check_mailq - 自ホストのメールキュー滞留数を確認します。sendmail、qmail、postfix、eximに対応しています
• check_mrtg - 自ホストのMRTGログファイルを確認します。MRTGで取得した値・データの最終更新時間を確認できます。値の平均値・最大値の確認もできます
• check_mrtgtraf - 自ホストのMRTGログファイルを確認します。MRTGで取得した値・データの最終更新時間を確認できます。値の平均値・最大値の確認もできます。2値が同時に確認できるのが特徴です
• check_nagios - 自ホストのnagiosログファイルを確認します。ログファイルが指定した時間以内に更新されていることを確認します
• check_nntp - あるホストにNNTP接続できることを確認します
• check_nntps - あるホストにNNTPS接続できることを確認します
• check_nt - あるホスト(Windows)のNSClientからデータを取得し、値が閾値を超過していないことを確認します
• check_ntp - deprecatedとのこと。check_ntp_peerかcheck_ntp_timを使いましょう
• check_ntp_peer - あるホストのNTPサーバの動作を確認します。時刻ずれの大きさも確認できます
• check_ntp_time - あるホストの、NTPサーバとの時間のずれを確認します。時刻ずれの大きさも確認できます
• check_nwstat - あるNovellサーバのMRTGEXT NLMと通信し、様々な値を確認します
• check_overcr - あるホストのOver-CR collector daemonと通信し、様々な値を確認します
• check_ping - あるホストにPINGを実行し、応答時間・パケットロスを確認します
• check_pop - あるホストにPOP(POP3S)通信ができることを確認します
• check_procs - 自ホストのプロセスの状態を確認します。プロセス数、プロセスの状態(state)、PID,VSZ,RSS,PCPU,USER,引数,コマンドなどを条件として加えることができます
• check_real - あるホストにRTSP接続できることを確認します(動画再生のREALの意)
• check_sensors - lm_sensorsを使い、自ホストのハードウェアステータスを確認します
• check_simap - あるホストにSIMAP(SIMAPS)接続ができることを確認します。SIMAP接続が何なのかは、いまいちよくわかりません。IMAPとIMAPSのことでしょうか...
• check_smtp - あるホストにSMTP(SMTP with TLS)接続できることを確認します
• check_spop - 3あるホストにSPOP(SPOPS)接続ができることを確認します。SPOP接続が何なのかは、いまいちよくわかりません。POP3とPOP3Sのことでしょうか...
• check_ssh - あるホストにSSH接続ができることを確認します
• check_ssmtp - あるホストにSSMTP(SSMTPS)接続できることを確認します。SSMTP接続が何なのかは、いまいちよくわかりません。SMTPSのことでしょうか...
• check_swap - 自ホストのSWAP空き容量が所定以上であることを確認します
• check_tcp - あるホストにTCP(SSL)接続ができることを確認します
• check_time - あるホストの時刻がずれていないことを確認します
• check_udp - あるホストにUDP(SSL)接続ができることを確認します
• check_ups - あるホストのUPSの状態を確認します。温度、ステータスを確認できます。www.networkupstools.orgのNetwork UPS Toolsが必要です
• check_users - 自ホストのログインユーザ数を確認します

nagios-plugins-extra

• check_fping - fpingを使ってあるホストの死活を確認します。使うためにはfpingコマンドにsuidフラグを立てる必要があります
• check_game - qstatを使ってあるホストのゲームサーバの状態を確認します

nagios-plugins-standard

• check_bgpstate - あるホストのBGPセッションを確認します
• check_breeze - あるホストのBreezecom wirelessの電波の強さを確認します
• check_dig - あるホストのDNSサービス稼働を、digを使って確認します
• check_disk_smb - あるホストのSMB共有ディスクの、ディスク使用量を確認します
• check_dns - あるホストに対してDNSクエリを発行し、結果として得られたIPアドレスが想定通りであるかを確認します
• check_flexlm - 自ホストのライセンスファイルを見て、Flexlmのライセンスを確認します
• check_hpjd - HPのプリンタ(JetDirect cardのついたもの)のステータスを確認します
• check_ifoperstatus - あるホストの、あるNICのoperational statusを確認します
• check_ifstatus - あるホストの、各NICのoperational statusを確認します
• check_ldap - あるホストのLDAP(SSL,TLS対応)応答が時間内にあることを確認します
• check_ldaps - 同上。This detection is deprecated, please use 'check_ldap' with the '--starttls' or '--ssl' flags to define the behaviour explicitly instead. とのこと。
• check_linux_raid - 自ホスト(linux)のraid(おそらくsoftware raid)のステータスを確認します
• check_mysql - あるホストのmysqlの状態を確認します。スレーブとして正常に機能しているか確認もできます
• check_mysql_query - あるホストのmysqlにクエリを発行し、結果を確認します
• check_oracle - あるホストのOracleの状態を確認します
• check_pgsql - あるホストのPostgreSQLの状態を確認します
• check_radius - あるホストのRADIUSと通信できるか確認します
• check_rpc - あるホストのRPCが利用できるか確認します
• check_snmp - SNMPを利用して、あるホストの状態を確認します。OIDを指定して値を取得し、結果をもとに判定ができます
• check_wave - あるホストの信号の強さを確認できるようです。いまいちよくわかりません

ハートビーツからお届けする技術情報の初回シリーズとして、 弊社でも利用しているNagiosについて書いてみます。

・・・といっても、現代はリポジトリが整備されていて、 インストールだけならとても簡単です。
そこで今回はインストールだけならいかに簡単かご紹介します。

aptitudeで楽々インストール

$ sudo aptitude install apache2

Nagiosをインストール

これもaptitudeで楽々インストール
※dpkg-statoverrideは、ブラウザから各種操作を実施するために現時点では必要

$ sudo aptitude install nagios3 \
 nagios3-common \
 nagios3-doc \
 nagios-images
$ sudo dpkg-statoverride --update --add nagios www-data 2710 /var/lib/nagios3/rw
$ sudo dpkg-statoverride --update --add nagios nagios 751 /var/lib/nagios3

ブラウザからアラーム音を出すために、音声ファイルをとってきておきます。

$ cd /tmp
$ wget http://downloads.sourceforge.net/project/nagios/nagios-2.x/nagios-2.12/nagios-2.12.tar.gz?use_mirror=jaist  
$ tar zxf nagios-2.12.tar.gz  
$ sudo find nagios-2.12/ -name "*.wav" -exec cp '{}' /usr/share/nagios3/htdocs/media/. \;

監視プラグインをインストール

$ sudo aptitude install nagios-plugins \
 nagios-plugins \
 nagios-plugins-basic \
 nagios-plugins-extra \
 nagios-plugins-standard \
 nagios-nrpe-plugin \
 nagios-snmp-plugins

nrpe(監視エージェント)デーモンをインストール

内部監視を実施する場合に必要です。

$ sudo aptitude install nagios-nrpe-server

以上でインストール完了です。実に簡単ですね！
ただし、ちゃんと設定しないと動かないのは相変わらずです。

と、いうわけで、次回は設定について解説する予定です。