2 プラグイン

概要

プラグインは、Zabbix の監視機能を拡張するオプションを提供します。プラグインは Go プログラミング言語で記述されており、Zabbix エージェント 2 でのみサポートされます。 プラグインは、C 言語で記述された ロード可能なモジュール や、Zabbix の機能を拡張するための その他の方法 に代わる手段を提供します。

以下の機能は、Zabbix エージェント 2 とそのプラグインに固有のものです。

• パッシブチェックとアクティブチェックの両方において、スケジュールされた間隔と柔軟な間隔のサポート
• スケジュールとタスクの同時実行を考慮したタスクキューの管理
• プラグインレベルのタイムアウト
• 起動時の Zabbix エージェント 2 とそのプラグインの互換性チェック

Zabbix 6.0 以降、プラグインはエージェント 2 に直接統合する必要がなくなり、ロード可能なプラグインとして追加できるようになりました。これにより、新しい監視メトリックを収集するための追加プラグインの作成プロセスが容易になります。

このページでは、Zabbix のネイティブプラグインとロード可能プラグインの一覧を示し、ユーザーの観点からプラグイン設定の原則について説明します。

プラグインの設定

このセクションでは、一般的なプラグイン設定の原則とベストプラクティスについて説明します。

すべてのプラグインは、Plugins.* パラメータを使用して設定されます。このパラメータは、Zabbix エージェント 2 の 設定ファイル の一部、またはプラグイン独自の 設定ファイル のいずれかです。プラグインが別の設定ファイルを使用する場合は、そのファイルへのパスを Zabbix エージェント 2 設定ファイルの Include パラメータに指定する必要があります。

一般的なプラグインパラメータの構造は次のとおりです。

Plugins.<PluginName>.<Parameter>=<Value>

さらに、2 つの特定のパラメータグループがあります。

• Plugins.<PluginName>.Default.<Parameter>=<Value> は、デフォルトのパラメータ値 を定義するために使用されます。

• Plugins.<プラグイン名>.<セッション名>.<パラメータ>=<値> は、名前付きセッション を介して、異なる監視対象ごとに個別のパラメータセットを定義するために使用されます。

すべてのパラメータ名は、以下の要件に準拠する必要があります。

• プラグイン名は大文字にすることをお勧めします。
• パラメータは大文字にする必要があります。
• 特殊文字は使用できません。
• ネストの最大レベルに制限はありません。
• パラメータの数に制限はありません。

例えば、Uptimeプラグインのみ、エージェントの再起動直後にスケジュールされた更新間隔が設定されていないアクティブチェックを実行するには、設定ファイルでPlugins.Uptime.System.ForceActiveChecksOnStart=1を設定します。 同様に、CPUプラグインの同時チェックのカスタム制限を設定するには、 設定ファイルでPlugins.CPU.System.Capacity=Nを設定します。

デフォルト値

接続関連のパラメータ（URI、ユーザー名、パスワードなど）のデフォルト値は、設定ファイルで以下の形式で設定できます。

Plugins.<プラグイン名>.Default.<パラメータ>=<値>

例：Plugins.Mysql.Default.Username=zabbix、Plugins.MongoDB.Default.Uri=tcp://127.0.0.1:27017 など

これらのパラメータの値がアイテムキーまたは名前付きセッションパラメータに指定されていない場合、プラグインはデフォルト値を使用します。デフォルトパラメータも定義されていない場合は、ハードコードされたデフォルト値が使用されます。

名前付きセッション

名前付きセッションは、プラグインパラメータの追加レベルを表し、監視対象のインスタンスごとに個別の認証パラメータセットを指定するために使用できます。 各名前付きセッションパラメータは、以下の構造を持つ必要があります。

Plugins.<プラグイン名>.Sessions.<セッション名>.<パラメータ>=<値>

URI、ユーザー名、パスワードを個別に指定する代わりに、connString アイテムキーパラメータとしてセッション名を使用できます。

アイテムキーでは、最初のパラメータは connString または URI のいずれかになります。 最初のキーパラメータがどのセッション名にも一致しない場合は、URI として扱われます。 アイテムキーに埋め込まれた URI 認証情報を渡すことはサポートされていないため、代わりに名前付きセッションパラメータを使用してください。

使用可能な 名前付きセッションパラメータ のリストは、プラグインによって異なります。

アイテムキーパラメータに新しい値を指定することにより、セッションパラメータを上書きすることができます（例 を参照）

名前付きセッションにパラメータが定義されていない場合、Zabbixエージェント2はデフォルトプラグインパラメータで定義された値を使用します。

パラメータの優先順位

Zabbix エージェント 2 プラグインは、接続関連のパラメータ値を以下の順序で検索します。

1. 最初のアイテムキーパラメータをセッション名と比較します。一致するものが見つからない場合は、実際の値として扱われます。この場合、ステップ 3 はスキップされます。一致するものが見つかった場合、パラメータ値（通常は URI）は、名前付きセッションで定義されている必要があります。
2. その他のパラメータは、アイテムキーが定義されている場合はそこから取得されます。
3. アイテムキーパラメータ（例：パスワード）が空の場合、プラグインは対応する名前付きセッションパラメータを探します。
4. セッションパラメータも指定されていない場合は、対応する デフォルトパラメータ で定義されている値が使用されます。
5. これらすべてが失敗した場合、プラグインはハードコードされたデフォルト値を使用します。

Example 1

Monitoring of two instances “MySQL1” and “MySQL2”.

Configuration parameters:

Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
       Plugins.Mysql.Sessions.MySQL1.User=mysql1_user
       Plugins.Mysql.Sessions.MySQL1.Password=unique_password
       Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.0:3306
       Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
       Plugins.Mysql.Sessions.MySQL2.Password=different_password

Item keys: mysql.ping[MySQL1], mysql.ping[MySQL2]

Example 2

Providing some of the parameters in the item key (supported since Zabbix 6.4.2).

Configuration parameters:

Plugins.Postgres.Sessions.Session1.Uri=tcp://192.0.2.234:5432
       Plugins.Postgres.Sessions.Session1.User=old_username
       Plugins.Postgres.Sessions.Session1.Password=session_password

Item key: pgsql.ping[session1,new_username,,postgres]

As a result of this configuration, the agent will connect to PostgreSQL using the following parameters:

• URI from session parameter: 192.0.2.234:5432
• Username from the item key: new_username
• Password from session parameter (since it is omitted in the item key): session_password
• Database name from the item key: postgres

例 3

デフォルトの設定パラメータを使用してメトリックを収集します。

設定パラメータ:

Plugins.PostgreSQL.Default.Uri=tcp://192.0.2.234:5432
       Plugins.PostgreSQL.Default.User=zabbix
       Plugins.PostgreSQL.Default.Password=password

アイテムキー: pgsql.ping[,,,postgres]

この設定の結果、エージェントは以下のパラメータを使用して PostgreSQL に接続します。

• デフォルトの URI: 192.0.2.234:5432
• デフォルトのユーザー名: zabbix
• デフォルトのパスワード: password
• アイテムキーのデータベース名: postgres

コネクション

プラグインによっては、複数のインスタンスから同時にメトリクスを収集することをサポートしています。
ローカルとリモートの両方のインスタンスを監視することができます。TCP および Unix ソケット接続がサポートされています。

インスタンスへの接続をオープン状態に保つようにプラグインを設定することをお勧めします。その利点は、ネットワークの輻輳、
レイテンシー、およびCPUとメモリの使用量を削減できることです。クライアントライブラリは、この処理を行います。

プラグイン

Zabbix agent 2 でサポートされているすべてのメトリックは、プラグインによって収集されます。

Built-in

Zabbixエージェント2用の以下のプラグインは、すぐにご利用いただけます。プラグイン名をクリックすると、プラグインリポジトリに移動し、詳細情報をご確認いただけます。

ロード可能

Zabbixエージェント2用のロード可能なプラグインは、そのままでは利用できないため、別途インストールする必要があります。

• Linuxの場合は、ロード可能なプラグインのビルドを参照してください。
• Windowsの場合は、MSIからのWindowsエージェントのインストールを参照してください。

プラグイン名をクリックすると、詳細情報を含むプラグインリポジトリに移動します。