前回までの 第 1 回 Zabbix を動かしてみよう、第 2 回 Zabbix のさまざまな監視機能を試してみよう では、Zabbix のインストールから監視設定まで、Zabbix の一通りの使い方を紹介しました。

今回は、Zabbix の Web 管理画面で行ったさまざまな操作を管理画面を使用せずに行える Zabbix API について解説します。
また、PhpZabbixApi を用いた PHP 言語による Zabbix API の使用方法について解説します。

2.Zabbix API の概要

Zabbix API を使用すると、管理画面を使用せずに Zabbix に蓄積されている各種データを取得したり、各種設定を行ったりすることができます。
Zabbix API は Zabbix 2.0 から正式な機能として提供されています。

Zabbix API は JSON-RPC というプロトコルを用いて HTTP で Zabbix フロントエンドにアクセスして、Zabbix を操作することができます。
API 用の URL に対して、JSON 形式のデータを送ることで、JSON 形式のレスポンスが返ります。
API はメソッド名とパラメータから構成されます。

Zabbix API の操作手順は以下になります。

1. 認証用 API（user.login）を実行してアクセストークンを取得する
2. 1.のアクセストークンを用いて API にアクセスする

Zabbix API のリファレンスは Zabbix マニュアルの API を参照してください。

代表的な Zabbix API の例を以下に挙げます。

3.PhpZabbixApi について

Zabbix API は cURL などの汎用の HTTP クライアントツールや、HTTP や JSON に対応した言語を用いることで使用できますが、認証や JSON データの作成を自前で行うのは煩雑になります。

そこで、各種言語に提供されている Zabbix API 用のライブラリを用いることで、Zabbix API を容易に扱うことができるようになります。

本記事では、PhpZabbixApi を用いて Zabbix API を使用します。
PhpZabbixApi は PHP 用の Zabbix API ライブラリです。

4.PhpZabbixApi のインストール

PhpZabbixApi ライブラリのインストール自体は非常に簡単です。

以下のサイトの「Download ZIP」からライブラリをダウンロードして、実行する PHP スクリプトから参照できるようにします。
https://github.com/confirm/PhpZabbixApi

本手順では、composer によってライブラリを準備することを前提とします。
(プロキシなどがあれば実行前に設定しておく)

# git clone https://github.com/confirm/PhpZabbixApi.git
# cd PhpZabbixApi
# composer update

また、PHP スクリプトをコマンドラインから実行できるように、コマンドライン版の PHP をインストールしておいてください。

5.Zabbix API の基本操作

1. アクセス URL
Zabbix API にアクセスするための URL は以下になります。

（Zabbix フロントエンドのトップ URL）/api_jsonrpc.php

例えば、Zabbix の管理画面URLのトップが http://www.example.com/zabbix/ の場合、 http://www.example.com/zabbix/api_jsonrpc.php になります。
Zabbix フロントエンドと同じホスト上であれば http://localhost/zabbix/api_jsonrpc.php になります。

2. 認証と API の呼び出し
実際に PhpZabbixApi を使って Zabbix フロントエンドにアクセスし、 API を呼び出してみましょう。

ここでは、「apiinfo.version」という、Zabbix API のバージョンを取得するメソッドを呼び出します。

<?php

require_once __DIR__.'/vendor/autoload.php';

use Confirm\ZabbixApi\Exception;
use Confirm\ZabbixApi\ZabbixApi;

try {
    $api = new ZabbixApi('http://localhost/zabbix/api_jsonrpc.php', 'Admin', 'zabbix');
    $res = $api->apiinfoVersion();
    var_dump($res);
} catch (Exception $e) {
    echo $e->getMessage() . "\n";
}

?>

上記の内容を apiinfoVersion.php というファイルに保存し、コマンドライン版 PHP で実行します。
スクリプトの実行に成功すると、以下のような結果が出力されます。

$ php apiinfoVersion.php
string(6) "5.0.17"

6.メソッド名とパラメータについて

Zabbix API のリファレンスを PhpZabbixApi に読み替えるには、以下のルールを使用します。

1. メソッド名
以下のように、ピリオドの後の単語の 1 文字目を大文字にして結合します。

apiinfo.version → apiinfoVersion()
item.getobjects → itemGetObjects()

2. パラメータ
JSON のオブジェクト（{ } の部分）は PHP の配列でキーと値を使用し、JSON の配列（[ ] の部分）は PHP の数値添字配列で表します。

JSON の文字列、数値はそのまま PHP の文字列、数値を使用します。

誤った型を使用するとサーバからエラーが返ります。

{ "host": "server1" } → array( 'host' => 'server1' )
{ "applications": [ "609", "610" ] } →array( 'applications' => array( '609', '610' ) )

PHP プログラムでは params の内容を引数に渡します。
params 以外の項目は PhpZabbixApi により自動的に生成されるため不要です。

JSON 形式で記述された以下のリクエストを PhpZabbixApi で送る場合は、以下のようにします（以下はテンプレートを作成する例です）。

JSON 形式:

{
    "jsonrpc": "2.0",
    "method": "template.create",
    "params": {
        "host": "Test template",
        "groups": {
            "groupid": 1
        },
        "hosts": [
            {
                "hostid": "10364"
            },
            {
                "hostid": "10365"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

PHPZabbixAPI の場合:

$res = $api->templateCreate( array(
                                'host' => 'Test template',
                                'groups' => array(
                                    'groupid' => 1
                                ),
                                'hosts' => array(
                                    array('hostid' => '10364'),
                                    array('hostid' => '10365')
                                )
                            ) );

Zabbix API で指定する各パラメータの詳細については、Zabbix API リファレンスを参照してください。

具体的に指定する値については、あらかじめ管理画面で登録しておいた設定項目の情報を API で取得し、その内容を参照すると分かりやすいです。

以下の例では、新しく「Test template」を作成し、ホストを割り当てています。

<?php

require_once __DIR__.'/vendor/autoload.php';

use Confirm\ZabbixApi\Exception;
use Confirm\ZabbixApi\ZabbixApi;

try {
    $api = new ZabbixApi('http://localhost/zabbix/api_jsonrpc.php', 'Admin', 'zabbix');
    $res = $api->templateCreate( array(
                                    'host' => 'Test template',
                                    'groups' => array(
                                                'groupid' => 1
                                                ),
                                    'hosts' => array(
                                                array('hostid' => '10364'),
                                                array('hostid' => '10365')
                                                )
                                    ) );
    var_dump($res);
} catch (Exception $e) {
    echo $e->getMessage() . "\n";
}

?>

スクリプトを実行します。

$ php templateCreate.php
array(1) {
  ["templateids"]=>
  array(1) {
    [0]=>
    string(5) "10441"
  }
}

次に、Web ブラウザで Zabbix の管理画面にログインし、[設定] → [テンプレート] より、「Test template」が作成されており、追加したホストが割り当てられていることを確認します。
(例では、「Test template」でフィルタリングしています)

7.アイテムの一括登録

実際に Zabbix API を使用して設定を行い、それが管理画面に反映されているかを見てみましょう。
以下のスクリプトは、テンプレート名からテンプレートの templateid を取得し、テンプレートに対して複数のアイテムをまとめて登録します。
すでに同名のアイテムがあるとエラーになるので注意してください。

<?php

require_once __DIR__.'/vendor/autoload.php';

use Confirm\ZabbixApi\Exception;
use Confirm\ZabbixApi\ZabbixApi;

try {
    $api = new ZabbixApi('http://localhost/zabbix/api_jsonrpc.php', 'Admin', 'zabbix');

    // Test templateテンプレートの templateid を取得
    $tmpls = $api->templateGet( array('output' => 'extend',
                                        'filter' => array('host' => 'Test template') ) );

    // テンプレート情報が配列で返ってくるので、templateid を取り出す
    foreach ($tmpls as $tmpl) {
        $hostid = $tmpl["templateid"];
    }

    // CPU usage アイテムを作成
    $res = $api->itemCreate( array( 'name' => 'CPU usage (API)',
                                        'key_' => 'system.cpu.util[,user,avg1]',
                                        'hostid' => $hostid,
                                        // type 0: Zabbix エージェント
                                        'type' => 0,
                                        // value_type 0: 浮動小数
                                        'value_type' => 0,
                                        'delay' => 30,
                                    ) );
    var_dump($res);

    // Load average アイテムを作成
    $res = $api->itemCreate( array( 'name' => 'Load average (API)',
                                        'key_' => 'system.cpu.load[]',
                                        'hostid' => $hostid,
                                        'type' => 0,
                                        'value_type' => 0,
                                        'delay' => 30,
                                    ) );
    var_dump($res);

    // Disk free アイテムを作成
    $res = $api->itemCreate( array( 'name' => 'Disk free (API)',
                                        'key_' => 'vfs.fs.size[/,free]',
                                        'hostid' => $hostid,
                                        'type' => 0,
                                        // value_type 3: 符号なし整数
                                        'value_type' => 3,
                                        'delay' => 60,
                                        'units' => 'B'
                                    ) );
    var_dump($res);

    // Disk usage アイテムを作成
    $res = $api->itemCreate( array( 'name' => 'Disk usage (API)',
                                        'key_' => 'vfs.fs.size[/,used]',
                                        'hostid' => $hostid,
                                        'type' => 0,
                                        'value_type' => 3,
                                        'delay' => 60,
                                        'units' => 'B'
                                    ) );
    var_dump($res);

    // Log (messages)アイテムを作成
    $res = $api->itemCreate( array( 'name' => 'Log (messages) (API)',
                                        'key_' => 'log[/var/log/messages,"warning|error",,100]',
                                        'hostid' => $hostid,
                                        // type 7: Zabbixエージェント（アクティブ）
                                        'type' => 7,
                                        // value_type 2: ログ
                                        'value_type' => 2,
                                        'delay' => 60,
                                    ) );
    var_dump($res);

} catch (Exception $e) {
    // 例外が発生した場合、メッセージを表示する
    echo $e->getMessage() . "\n";
}

?>

スクリプトを実行し、アイテムの作成に成功すると以下のような結果が出力されます（id の値は毎回変わります）。

$ php itemCreate.php
array(1) {
  ["itemids"]=>
  array(1) {
    [0]=>
    string(5) "36633"
  }
}
array(1) {
  ["itemids"]=>
  array(1) {
    [0]=>
    string(5) "36636"
  }
}
array(1) {
  ["itemids"]=>
  array(1) {
    [0]=>
    string(5) "36639"
  }
}
array(1) {
  ["itemids"]=>
  array(1) {
    [0]=>
    string(5) "36642"
  }
}
array(1) {
  ["itemids"]=>
  array(1) {
    [0]=>
    string(5) "36645"
  }
}

次に、Web ブラウザで Zabbix の管理画面にログインし、[設定] → [テンプレート] の「Test template」の「アイテム (n)」をクリックし、アイテムが登録されていることを確認します。

8.グラフとスクリーンの作成

次に、グラフとスクリーンを Zabbix API を使用して作成してみましょう。

まず、以下のスクリプトでグラフを作成します。

<?php

require_once __DIR__.'/vendor/autoload.php';

use Confirm\ZabbixApi\Exception;
use Confirm\ZabbixApi\ZabbixApi;

try {
    $api = new ZabbixApi('http://localhost/zabbix/api_jsonrpc.php', 'Admin', 'zabbix');

    // 各アイテムの情報を取得
    $items = $api->itemGet( array('host' => 'Test template',
                                'filter' => array('name' => 'CPU usage (API)') ) );
    foreach ($items as $item) {
        $itemcpu = $item['itemid'];
    }

    $items = $api->itemGet( array('host' => 'Test template',
                                'filter' => array('name' => 'Load average (API)') ) );
    foreach ($items as $item) {
        $itemload = $item['itemid'];
    }

    // CPU load 折れ線グラフを作成（CPU 使用率 + ロードアベレージ）
    $res = $api->graphCreate( array('name' => 'CPU load/usage (API)',
                                        'width' => 900,
                                        'height' => 200,
                                        'gitems' => array(
                                                array(
                                                        'itemid' => $itemcpu,
                                                        'color' => 'C80000',
                                                        'yaxisside' => 0
                                                ),
                                                array(
                                                        'itemid' => $itemload,
                                                        'color' => '00C800',
                                                        'sortorder' => 1,
                                                        'yaxisside' => 1
                                                )
                                        )
                                ) );
    var_dump($res);

} catch (Exception $e) {
    // 例外が発生した場合、メッセージを表示する
    echo $e->getMessage() . "\n";
}

?>

スクリプトを実行します。

$ php graphCreate.php
array(1) {
  ["graphids"]=>
  array(1) {
    [0]=>
    string(4) "1849"
  }
}

今回の例では2行1列のスクリーンを作成するため、手動でも、任意のグラフを作成しておきます。

次に、以下のスクリプトでスクリーンを作成します。

<?php

require_once __DIR__.'/vendor/autoload.php';

use Confirm\ZabbixApi\Exception;
use Confirm\ZabbixApi\ZabbixApi;

try {
    $api = new ZabbixApi('http://localhost/zabbix/api_jsonrpc.php', 'Admin', 'zabbix');

    // zabbix-agentに属するグラフからscreenitems情報を作成
    $screenitems = array();
    $y = 0;

    $graphs = $api->graphGet( array('hostids' => '10364') );
    foreach ($graphs as $graph) {
        print $graph["graphid"] ." ";
        print $graph["name"] ."\n";

        // resourcetype: 0: グラフ, (x, y): スクリーン上の位置
        $screenitems[] = array( 'resourcetype' => 0,
                                'resourceid' => $graph["graphid"],
                                'rowspan' => 1,
                                'colspan' => 1,
                                'x' => 0,
                                'y' => $y++ );
    }
    var_dump($screenitems);

    // スクリーンを作成し（2 行 1 列）、グラフを追加
    $res = $api->screenCreate( array('name' => 'New screen (API)',
                                        'hsize' => 1,
                                        'vsize' => 2,
                                        'screenitems' => $screenitems
                                    ) );
    var_dump($res);

} catch (Exception $e) {
    // 例外が発生した場合、メッセージを表示する
    echo $e->getMessage() . "\n";
}

?>

スクリプトを実行します。

$ php screenCreate.php
1853  CPU usage
1850  CPU load/usage (API)
array(2) {
  [0]=>
  array(6) {
    ["resourcetype"]=>
    int(0)
    ["resourceid"]=>
    string(4) "1853"
    ["rowspan"]=>
    int(1)
    ["colspan"]=>
    int(1)
    ["x"]=>
    int(0)
    ["y"]=>
    int(0)
  }
  [1]=>
  array(6) {
    ["resourcetype"]=>
    int(0)
    ["resourceid"]=>
    string(4) "1850"
    ["rowspan"]=>
    int(1)
    ["colspan"]=>
    int(1)
    ["x"]=>
    int(0)
    ["y"]=>
    int(1)
  }
}
array(1) {
  ["screenids"]=>
  array(1) {
    [0]=>
    string(2) "85"
  }
}

Zabbix の管理画面で、[監視データ] → [スクリーン] を開き、「スクリーン」で「New screen (API)」を選択して、スクリーンが作成されていることを確認します。

9.まとめ

今回は、Zabbix の管理画面上で行う各種操作を管理画面を使用せずに行える Zabbix API について解説しました。

Zabbix API を活用することで、さまざまな Zabbix の設定作業を自動化することができ、作業にかかるコストを大幅に削減することが可能になります。

前回の記事では、Zabbix のインストール、基本的な設定、監視対象と基本的な監視項目の設定方法までを行いました。

今回は、その他の監視機能の説明や、指定した条件による障害検知とアラートメールの送信、グラフ表示機能などを紹介します。

2. Zabbix の監視機能について

Zabbix では多種多様な用途、目的に対応するために、さまざまな監視方法に対応しています。

以下は Zabbix 5.0 が対応している各機能の概要です。

3. Zabbix エージェント監視の種類

ここでは、使用頻度が高いと思われる Zabbix エージェントの監視項目のうち、代表的なものを紹介します。

その他のキーや監視タイプについては、Zabbix マニュアルの以下の項目を参照してください。

• Zabbix マニュアル アイテムタイプ
• Zabbix マニュアル アイテムタイプ – Zabbix エージェント

Zabbix エージェントの代表的なキー一覧

Zabbix エージェント（アクティブ）の代表的なキー一覧

4. ログ監視について

ログの監視を行うには、Zabbix エージェント (アクティブ) を使用する必要があります。

通常の Zabbix エージェントは、サーバから定期的にデータを要求しに行きますが、Zabbix エージェント (アクティブ) は、エージェント自身が能動的に監視を行い、データをサーバに送信します。

log[file,<regexp>,<encoding>,<maxlines>,<mode>,<output>,<maxdelay>,<options>]

は、1 つのログファイルのみを監視します。

logrt[file_format,<regexp>,<encoding>,<maxlines>,<mode>,<output>,<maxdelay>,<options>]

は、ローテートされた複数のログファイルを監視します。

ファイル名の候補は正規表現で指定します。

例えば、「/var/log/^messages-[0-9]{8}$」であれば「/var/log/messages-20211025」などのファイルが対象になります。

また、ログ監視では Zabbix エージェントを動作させるユーザー (zabbix) がログファイルにアクセスする権限が必要になりますので注意してください。

5. メディアタイプとメディアの設定

障害を検知した場合にメールを送信するには、事前にメディアタイプとメディアを設定しておく必要があります。

まずメディアタイプでメールの送信に使用するメールサーバを設定します。

1. 1. [管理] → [メディアタイプ] をクリックし、メディアタイプ一覧から「Email」をクリックします。
   2. 「SMTPサーバー」、「SMTP helo」、「送信元メールアドレス」を環境に合わせて適切に編集し、[更新] をクリックします。
   3. 次にユーザーのメール送信先を設定します。ここでは Admin について設定します。
   4. 画面左下の [ユーザー設定] をクリックし、Admin ユーザーの設定ページを開きます。
   5. [メディア] タブをクリックし、[追加] をクリックすると、設定フォームが開くので以下の内容を設定し、[追加] をクリックします。

追加が完了すると以下の表示に変わります。設定に問題がなければ [更新] をクリックします。

以上で、Zabbix が障害を検知した際に指定したアドレスにメールが送信されるようになりました。

また、今回はメールの設定を紹介しましたが、Webhook を用いて Slack や Microsoft Teams などのツールに通知を送信することも可能です。

6. トリガーの設定

Zabbix では、障害と復旧の検知の設定をトリガーと呼びます。

前回は CPU 使用率を監視するアイテムを作成しました。

今回は、それに対して、5 分間の CPU 使用率の平均値が一定の閾値を上回った場合は障害と判定し、アラートメールを送信するように設定してみましょう。

まずトリガーを作成します。

1. [設定] → [テンプレート] を選択します。
2. テンプレート一覧から「テストテンプレート」行の [トリガー] をクリックします。
3. 画面右上の [トリガーの作成] をクリックします。
4. 以下の項目を入力し、[保存] をクリックします。

トリガーの条件式はテキストボックスに直接入力することもできますし、テキストボックス右横の [追加] ボタンをクリックし、設定フォームの項目に設定内容を入力することでも追加できます。項目を入力したら [挿入] をクリックします。

トリガーの作成に成功すると、以下のようにトリガー一覧に表示されます。(トリガー作成直後の場合は、まだ値を取得できていないためエラーが表示されることがあります。)

また、「テストテンプレート」をリンクしているホスト「Zabbix-agent」にも「テストテンプレート」で作成したトリガーが設定されたことが分かります。

トリガーの設定により、障害を検知できるようになりました。次は障害を検知した際に通知をする設定を行います。

7. アクションの設定

Zabbix では、障害発生時や復旧時の動作の設定をアクションと呼びます。

先程設定したトリガーで障害を検知した場合に、指定したユーザーにメールを送信するアクションを作成します。

1. 1. [設定] → [アクション] を選択します。
   2. 画面右上の [アクションの作成] をクリックします。
   3. [アクション] タブで以下の項目を入力します。

実行条件については [追加] をクリックして条件を追加することができます。

• [実行内容] タブをクリックし、アクションの実行内容を設定します。今回は [デフォルトのアクション実行ステップの間隔」と「メンテナンス中の場合に実行を保留」はデフォルトのままとします。[実行内容] の [追加] をクリックし、設定フォームを開きます。
• 以下の項目を設定します。その他はデフォルトのままとします。

ここで通知メッセージについてですが、[メッセージのカスタマイズ] にチェックを入れることで任意のメッセージ設定を行うことができますが、今回はメディアタイプ「Email」に元々設定されているメッセージテンプレートを利用します。

メディアタイプ「Email」の障害通知のメッセージテンプレートは [管理] → [メディアタイプ] → 「Email」の [メッセージテンプレート] タブから確認および設定ができます。[障害] のメッセージテンプレートは以下となっています。

メッセージに記載されている {EVENT.NAME} などはマクロと呼ばれています。例えば {EVENT.NAME} であれば障害名、{HOST.NAME} であれば障害が発生したホスト名にメッセージを送信する際に変換してくれます。マクロについては Zabbix マニュアルもご参照ください。

• Zabbix マニュアル マクロ

このメッセージテンプレートによりメディアタイプ「Email」を他のアクションでも使用する場合に同じ形式のメッセージを通知することができます。

次に [復旧時の実行内容] についても同様に設定をします。障害復旧に関するメッセージテンプレートも用意されていますのでこちらについても [メッセージのカスタマイズ] にはチェックを入れません。

今回は [更新時の実行内容] は設定をしません。ここまでの設定ができたら [更新] をクリックします。

すると、アクションの一覧に作成したアクション「Report problems to user」が表示されます。

以上で障害検知した際の通知を送信する条件や実行内容を設定することができました。

8. 障害検知の確認

それでは、実際に疑似的に障害を発生させ、それが検知されるかを確認してみましょう。

Zabbix エージェントが動作している監視対象のホストにログインし、以下のコマンドを実行して 5 分以上待ち、Ctrl-C で停止します。

※ CPU 使用率が 100 % になるため、実際にサービスが稼働しているホストでは実行しないでください。

$ yes > /dev/null
(Ctrl-Cで停止)

[監視データ] → [障害] から現在発生中の障害や履歴を確認することができます。

障害の発生時刻や継続期間 (発生してから現在までの経過時間) などの情報を確認することができます。

また、ユーザーのメディアで設定したメールアドレスに、以下のような障害通知メールが届きます。

通知内容から 2021/10/22 10:20:27 にホスト「Zabbix-agent」で障害が発生したことが分かります。

件名:
Problem: CPU usage is too high

メッセージ:
Problem started at 10:20:27 on 2021.10.22
Problem name: CPU usage is too high
Host: Zabbix-agent
Severity: Average
Operational data: 98.37074
Original problem ID: 15 

本障害が復旧した際には以下のような復旧通知メールが届きます。

こちらの通知内容では同日の 10:22:27 に復旧していることが分かります。

件名:
Resolved in 2m 0s: CPU usage is too high

メッセージ:
Problem has been resolved at 10:22:27 on 2021.10.22
Problem name: CPU usage is too high
Problem duration: 2m 0s
Host: Zabbix-agent
Severity: Average
Original problem ID: 15 

ここまでで Zabbix における障害を検知する設定 (トリガーの設定)、障害を検知した際にメッセージを送信する通知先の設定 (メディアタイプおよびユーザーの設定)、通知の条件や内容を設定 (アクションの設定) を行いました。

9. グラフの作成

Zabbix では、特に設定を行わなくても各アイテムの履歴をグラフで表示することができますが、複数の監視項目のデータを 1 つのグラフにまとめて表示することもできます。

これにより、一目でシステムの状態を把握することができます。

なお、事前に以下のアイテムを「テストテンプレート」に作成しておきます。

それでは以下の手順で「テストテンプレート」にグラフを作成します。

1. 1. [設定] → [テンプレート] をクリックします。
   2. テンプレート一覧から「テストテンプレート」行の [グラフ] をクリックします。
   3. 画面右上の [グラフの作成] をクリックし、以下の項目を入力します。

1. [アイテム] の [追加] をクリックし、対象のアイテムにチェックを入れて選択します。追加された項目について以下のように設定します。
   

   名前	関数	グラフの形式	Y軸	色
   テストテンプレート： CPU load	平均	線	右	1A7C11
   テストテンプレート： CPU usage	平均	線	左	F63100

2. [保存] をクリックします。
3. 

今回は「テストテンプレート」にグラフを作成したので、リンクしているホスト「Zabbix-agent」にも上記のグラフが作成されます。

それではホスト「Zabbix-agent」のグラフを確認してみましょう。

[監視データ] → [ホスト] で「Zabbix-agent」行の [グラフ] を選択すると、以下のようにグラフが表示されます。

「CPU load」は右側の Y 軸を、「CPU usage」は左側の Y 軸を参照します。

また、画面上部で表示期間を指定できるほか、現在表示している期間から直接表示期間を短くすることができます。

黄色で囲まれた範囲が表示されます。

また、グラフの下に各アイテム名と [最新値] などの表示がありますが、表示期間の中でのそのアイテムの最新値や最大値を表示しています。グラフ上にオレンジ色の点線がありますが、アイテム「CPU usage」を使用しているトリガー「CPU usage is too high」の閾値を表しています。

最後に、グラフをドラッグし、デスクトップなどにドロップすることで現在表示しているグラフを画像ファイルとして保存することが可能です。

10. ダッシュボード

ダッシュボードは、任意のグラフや障害履歴、ホストの状態などを一つの画面にカスタマイズして表示させることができます。

Zabbix にログインした際にデフォルトで「Global view」というダッシュボードが表示されます。

「Global view」では「システム情報」、「ホスト稼働状況」、「深刻度ごとの障害数」、「Zabbix サーバが稼働しているサーバの時刻」、「障害」、「お気に入りのマップ」、「お気に入りのグラフ」のウィジェットが用意されています。

「システム情報」にはホストやアイテム数の情報など Zabbix サーバのシステム情報が表示されます。

「ホスト稼働状況」にはホストの状態が「利用可能」、「利用不可」、「不明」で分類されて、表示されます。

「深刻度ごとの障害数」には文面の通り、現在発生している障害数が深刻度ごとに表示されます。

「障害」には障害発生の履歴が表示されます。

「お気に入りのマップ」、「お気に入りのグラフ」についてはデフォルトでは何も表示されません。任意のマップやグラフの画面でお気に入り登録する必要があります。今回は「マップ」については紹介していませんので省略させていただきます。

それでは「9. グラフの作成」で作成したグラフ「Zabbix-agent: CPU load/usage」をお気に入り登録してみましょう。

[監視] → [ホスト] で「Zabbix-agent」行の「グラフ」をクリックします。

画面右上の星アイコンをクリックすることでお気に入り登録ができます。登録すると星アイコンが黄色に変わります。

それでは [監視データ] → [ダッシュボード] で「Global view」に戻ります。

「お気に入りのグラフ」に「Zabbix-agent: CPU load/usage」のリンクが表示されました。不要になった場合は名前の右側にある×アイコンをクリックするとお気に入りが解除されます。

また、お気に入りの登録はユーザー単位で行います。Admin ユーザーで「Zabbix-agent: CPU load/usage」をお気に入りにした場合は Admin ユーザーでログインした際には「お気に入りのグラフ」に表示されますが、他のユーザーでログインした際には表示されません。

「お気に入りのグラフ」にはグラフのリンクのみ表示されますので、実際にグラフ「Zabbix-agent: CPU load/usage」を「Global view」に表示させてみましょう。

ダッシュボードの変更は画面右上の「ダッシュボードの変更」をクリックし、設定を行います。

「ウィジェットの追加」をクリックして、以下の項目を入力します。

上記の設定を行い、[追加] をクリックします。そうすると添付画像のように「障害」ウィジェットの下に「グラフ」ウィジェットが表示されるようになります。問題がないようでしたら画面右上の「変更を保存」をクリックして、設定を完了します。

11. まとめ

Zabbix は、オープンソースの企業向けシステム監視ツールです。
Web ベースの使いやすい管理インタフェース、大規模な監視への対応、可視化機能などが特長です。

今回は、Zabbix エージェントをインストールした監視対象機器の動作状況が管理画面から閲覧できるようになるまでを扱います。

Zabbix 導入の全体の流れを理解したり、初めての方が作業の感覚を掴めるように、画面を交えながらインストールから基本的な設定まで解説していきます。

2. 対象環境

Zabbix の要件とサポートする環境はシステム要件をご確認ください。

今回は以下の環境に Zabbix を導入します。

なお、別途管理画面にアクセスするための Web ブラウザを動作させるコンピュータが必要です。

本記事では Windows 10 で Firefox 93.0 を使用します。

なお、本環境では SELinux および ファイアウォールの設定は無効化しています。

3. 必要なソフトウェア

Zabbix の動作には以下のソフトウェアが必要になります。
詳細はソフトウェア要件をご確認ください。

• Apache/Nginx
• PHP
• PostgreSQL/MySQL/ etc.

本記事では、Apache, PostgreSQL を使います。
またバージョンは以下のディストリビューション標準のものを使用します。

• Apache httpd 2.4.6
• PostgreSQL 9.2.24

# yum install httpd postgresql postgresql-server

PHP については Zabbix 5.0 では PHP 7.2 以上を使う必要があります。PHP のインストールは後述します。

4. Zabbix サーバ のインストール

今回は Zabbix のダウンロードページで以下のプラットフォームを選択した際の rpm を取得してインストールを行います。

まず、rpm パッケージをインストールします。

# rpm -Uvh https://repo.zabbix.com/zabbix/5.0/rhel/7/x86_64/zabbix-release-5.0-1.el7.noarch.rpm
# yum clean all

次に Zabbix サーバをインストールします。

# yum install zabbix-server-pgsql

続いて Zabbix フロントエンドをインストールしますが、その前に SCL リポジトリを追加します。

# yum install centos-release-scl

/etc/yum.repos.d/zabbix.repo を編集し、zabbix-frontend リポジトリを有効にします。

# vi /etc/yum.repos.d/zabbix.repo

[zabbix-frontend]
...
enabled=1
...

Zabbix フロントエンドパッケージをインストールします。また、この過程で依存関係により php72 もインストールされます。

# yum install zabbix-web-pgsql-scl zabbix-apache-conf-scl zabbix-web-japanese

ここまでで以下のパッケージがインストールされます。(2021/10/26 現在)

# yum list installed | grep zabbix
fping.x86_64                              3.16-1.el7                 @zabbix-non-supported
zabbix-apache-conf-scl.noarch             5.0.17-1.el7               @zabbix-frontend
zabbix-release.noarch                     5.0-1.el7                  installed  
zabbix-server-pgsql.x86_64                5.0.17-1.el7               @zabbix    
zabbix-web.noarch                         5.0.17-1.el7               @zabbix-frontend
zabbix-web-deps-scl.noarch                5.0.17-1.el7               @zabbix-frontend
zabbix-web-japanese.noarch                5.0.17-1.el7               @zabbix-frontend
zabbix-web-pgsql-scl.noarch               5.0.17-1.el7               @zabbix-frontend

# yum list installed | grep rh-php
rh-php72.x86_64                           1-2.el7                    @centos-sclo-rh
rh-php72-php-bcmath.x86_64                7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-cli.x86_64                   7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-common.x86_64                7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-fpm.x86_64                   7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-gd.x86_64                    7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-json.x86_64                  7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-ldap.x86_64                  7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-mbstring.x86_64              7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-pdo.x86_64                   7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-pear.noarch                  1:1.10.5-1.el7             @centos-sclo-rh
rh-php72-php-pgsql.x86_64                 7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-process.x86_64               7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-xml.x86_64                   7.2.24-1.el7               @centos-sclo-rh
rh-php72-php-zip.x86_64                   7.2.24-1.el7               @centos-sclo-rh
rh-php72-runtime.x86_64                   1-2.el7                    @centos-sclo-rh

5. データベースの作成

データベースの初期化

# PGSETUP_INITDB_OPTIONS="-E utf8 --no-locale" /usr/bin/postgresql-setup initdb
Initializing database ... OK

PostgreSQL の起動

# systemctl start postgresql

postgres ユーザーにパスワードを設定

# sudo -u postgres psql -c "alter user postgres with password 'postgres'"

パスワード認証を有効にするため pg_hba.conf を編集

# vi /var/lib/pgsql/data/pg_hba.conf
-------
# TYPE DATABASE USER ADDRESS METHOD

# "local" is for Unix domain socket connections only
local all all md5
# IPv4 local connections:
host all all 127.0.0.1/32 md5
# IPv6 local connections:
host all all ::1/128 md5
-------

PostgreSQL の再起動

# systemctl restart postgresql

zabbix ユーザー、Zabbix 初期データベース作成

# sudo -u postgres createuser --pwprompt zabbix
Enter password for new role: (今回は zabbix をパスワードとします)
Enter it again:
Password: (postgres ユーザーのパスワードを入力します)
# sudo -u postgres createdb -O zabbix zabbix
# zcat /usr/share/doc/zabbix-server-pgsql-5.0.17/create.sql.gz | sudo -u zabbix psql zabbix

6. Zabbix サーバ の設定・起動

/etc/zabbix/zabbix_server.conf を編集し、DB に関する設定をします。

# vi /etc/zabbix/zabbix_server.conf
DBName=zabbix
DBUser=zabbix
DBPassword=zabbix

次にフロントエンドのタイムゾーンを Asia/Tokyo にします。

# vi /etc/opt/rh/rh-php72/php-fpm.d/zabbix.conf
php_value[date.timezone] = Asia/Tokyo

zabbix-server, httpd, php-fpm を起動します。
また、postgresql も含め自動起動を有効にします。

# systemctl start zabbix-server httpd rh-php72-php-fpm
# systemctl enable zabbix-server httpd rh-php72-php-fpm postgresql
Created symlink from /etc/systemd/system/multi-user.target.wants/zabbix-server.service to /usr/lib/systemd/system/zabbix-server.service.
Created symlink from /etc/systemd/system/multi-user.target.wants/httpd.service to /usr/lib/systemd/system/httpd.service.
Created symlink from /etc/systemd/system/multi-user.target.wants/rh-php72-php-fpm.service to /usr/lib/systemd/system/rh-php72-php-fpm.service.
Created symlink from /etc/systemd/system/multi-user.target.wants/postgresql.service to /usr/lib/systemd/system/postgresql.service.

これで Zabbix サーバのインストールから起動までが完了しました。

7. Web フロントエンドでセットアップ

次に Web フロントエンドでセットアップを行います。

Web ブラウザから http://(Zabbix/ サーバのホスト名 or IP アドレス)/zabbix にアクセスし、画面の指示に従って初期設定を行います。
アクセスできない場合は SELinux および firewalld の設定が正しく行われているかを確認してください。

[Next step] をクリックし「Check of pre-requisites」ですべて OK になっていることを確認します。

問題がなければ [Next step] をクリックし次に進みます。

次にデータベースの設定をします。以下の情報を入力し、[Next step] をクリックします。

※「Database port」を 0 にすると、「Database type」に「PostgreSQL」を選択した場合、自動的に 5432 が設定されます。

「Zabbix server details」ではフロントエンドから Zabbix サーバへの接続先を設定します。

今回のように Zabbix サーバとフロントエンドを同じホストで動作させる場合はデフォルトのままで構いません。

次に「Pre-Installation summary」で設定内容を確認します。よければ [Next step] をクリックし次に進みます。

「Install」で 「Congratulations! You have successfully installed Zabbix frontend.」が表示されたらインストール完了です。

[Finish] をクリックして完了します。

8. Zabbix エージェントをインストール

それでは次は Zabbix エージェントをインストールします。
今回 Zabbix エージェントをインストールするサーバは Zabbix サーバをインストールしたサーバとは別のサーバです。

なお、Zabbix サーバがインストールされているサーバにも Zabbix エージェントをインストールし、Zabbix サーバ自身の監視も行なうことが一般的です。

まずは Zabbix のレポジトリを追加します。

# rpm -Uvh https://repo.zabbix.com/zabbix/5.0/rhel/7/x86_64/zabbix-release-5.0-1.el7.noarch.rpm
# yum clean all

次に zabbix-agent のみインストールします。

# yum install zabbix-agent

インストールができたら設定ファイルを編集します。

9. Zabbix エージェントの設定・起動

以下のパラメータについて変更を行います。

今回の環境の場合は以下のように設定します。

# vi /etc/zabbix/zabbix_agentd.conf
Server=192.168.5.1
Hostname=zabbix-agent
ServerActive=192.168.5.1

設定が完了したら zabbix-agent の起動および自動起動有効化をします。

# systemctl start zabbix-agent
# systemctl enable zabbix-agent
Created symlink from /etc/systemd/system/multi-user.target.wants/zabbix-agent.service to /usr/lib/systemd/system/zabbix-agent.service.

Zabbix エージェントはデフォルトで 10050 番ポートを使用します。
ファイアウォールが有効な場合は 10050 番ポートへの接続を受け付けるようにしてください。

これで Zabbix エージェントのインストールから起動までが完了しました。

10. 管理画面へのログイン

それでは管理画面にログインしましょう。

インストール直後の状態ではデフォルトで特権管理者が存在します。

ログインフォームにこれらの情報を入力し、「Admin」ユーザーでログインします。

ログイン後にパスワードを変更することを推奨します。

ログインに成功したらダッシュボード画面が表示されます。

デフォルトの言語は英語ですので、日本語に変更する場合は画面左下の [User settings] から変更を行います。

[Language] を [Japanese (ja_JP)] に変更します。また、パスワードの変更を行う際も、画面内の
[Change password] から変更することが可能です。変更項目を入力したら [Update] をクリックします。

日本語表記に変わったことが確認できました。

以降は日本語表記で説明します。

11. ユーザーとユーザーグループ

画面左側の [管理] → [ユーザー] を選択すると、

現在登録されているユーザーとその所属ユーザーグループが表示されます。

インストール直後の状態では「Admin」ユーザーと「guest」ユーザーのみが登録されています。

Zabbix のユーザーは「ユーザー」、「管理者」、「特権管理者」の 3 種類があります。

• ユーザー
  監視データなどの閲覧のみ権限があります。
• 管理者
  「ユーザー」の権限に加えて、監視項目などの設定が可能になります。
• 特権管理者
  「管理者」の権限に加えて、ユーザーの作成や認証方法の設定など Zabbix の管理が可能になります。

なお、Admin ユーザーの種類は「特権管理者」、guest ユーザーの種類は「ユーザー」として用意されています。

ユーザーグループについてはグループ毎に特定のホストグループに対する権限の付与が可能です。

guest ユーザーが所属している Guests グループおよび Admin ユーザーが所属している Zabbix administrators グループの権限はこのようになっています。

• Guests グループ
  どのホストグループに対してもあらゆる権限がありません。
• Zabbix administrators グループ
  すべてのホストグループに対して権限が付与されています。

データを表示するのみの閲覧専用グループや、データの表示だけでなく監視設定も行うことができる管理作業用グループを用意するなど用途に応じて、ユーザーグループを用意しておくと便利です。

ユーザーとユーザーグループの詳細については Zabbix マニュアルの以下の項目を参照してください。

• Zabbix マニュアル ユーザーとユーザーグループ

それでは新規ユーザーを作成してみましょう。

新規ユーザーを作成するには、画面右上の [ユーザーの作成] をクリックします。

ここではゲスト相当のユーザーを作成します。以下の項目を入力し、[追加] をクリックします。

「user」が作成されたことが確認できました。ただし、 「user」は Guests グループに所属しているため監視設定や障害情報を表示する権限はないのでご注意ください。

12. ホストの登録

ここからは実際に監視を行うための設定を行います。
最初に監視対象のホストを登録します。

1. 1. 画面左側の [設定] → [ホスト] を選択します。
   2. 画面右上の [ホストの作成] をクリックします。
   3. 以下の項目を入力し、[追加] をクリックします。

ホストの一覧に作成したホストが表示されます。

13. テンプレートの作成

次に、監視項目 (アイテム) を登録するためのテンプレートを設定します。

アイテムは直接ホストに登録することもできますが、テンプレートを使用することで、複数のアイテムをグループ化してまとめて扱うことができるので便利です。

Zabbix ではあらかじめさまざまなテンプレートが登録されていますので、これらをサンプルとして使うこともできます。ここでは新規にテンプレートを作成してみます。

1. 1. [設定] → [テンプレート] を選択します。
   2. 画面右上の [テンプレートの作成] をクリックします。
   3. 以下の項目を入力し、[追加] をクリックします。

14. アイテムの登録

続いて、先ほど作成した「テストテンプレート」に監視項目を追加します。
Zabbix では監視項目のことをアイテムと呼びます。
アイテムはホストもしくはテンプレートに対し、登録します。

ここでは、例として監視対象サーバの CPU 使用率を取得するアイテムを作成します。

[設定] → [テンプレート] を選択するとテンプレートの一覧が表示されます。

画面上部の [名前] 検索窓に「テストテンプレート」と入力し、[適用] をクリックします。

そうすると「テストテンプレート」が表示されます。

「テストテンプレート」行の「アイテム」をクリックします。

画面右上の [アイテムの作成] をクリックし、アイテムを作成します。

以下の項目を入力します。
なお、[キー] には直接アイテムキーを入力することも可能ですが、[選択] をクリックすると別ウィンドウが開き、キーを一覧から選択することも可能です。

「system.cpu.util[,,]」は、「すべての CPU の最近 1 分間の平均使用率」という意味になります。

[追加] をクリックすることでアイテムを登録できますが、今回は登録する前にテストを行います。
[テスト] ではアイテムを追加する前に意図したデータを取得できるかテストすることができます。

現在疎通が取れているホスト「Zabbix-agent」(192.168.5.2) に対しテストを行います。

[ホストのアドレス] に 192.168.5.2 を、[ポート] に 10050 を入力し [値の取得とテスト] をクリックします。

値の取得ができていることを確認できたので、[追加] をクリックしてアイテムの追加を行います。

「テストテンプレート」のアイテム一覧に先ほど追加したアイテムが表示されました。

以上で、テンプレートへのアイテムの追加および確認ができました。

15. テンプレートのリンク

次に「テストテンプレート」をホスト「Zabbix-agent」にリンクさせます。

Zabbix ではホストにテンプレートを適用することを「リンク」と呼びます。

1. [設定] → [ホスト] から「Zabbix-agent」をクリックします。
2. [テンプレート] タグを開き、[新規テンプレートをリンク] に「テストテンプレート」と入力し、選択します。
3. [更新] をクリックすると「Zabbix-agent」に「テストテンプレート」が適用され、先ほど作成したアイテムが「Zabbix-agent」に追加されていることが分かります。

アイテムの数が 1 に、テンプレートカラムには「テストテンプレート」が表示されていることが確認できます。

16. 監視データの確認

実際に監視対象から情報を取得できているかを確認しましょう。
[監視データ] → [最新データ] を選択すると以下のように「Zabbix-agent」の CPU 使用率が取得できているでしょうか。

アイテム行の右端の [グラフ] をクリックすると過去の履歴をグラフで参照することができます。

データを表示させる時間範囲は柔軟に指定ができます。添付画像のグラフは [最新の1時間] のデータを表示させています。

17. まとめ

今回は、Zabbix をインストールし、監視対象と監視項目を設定して実際に監視が行えるようになるまでを解説しました。

次回は、その他の監視項目や、障害の発生を検知してアラートメールを送信したり、より便利に監視を行うための機能を紹介します。