2 プラグイン

概要

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

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

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

Zabbix エージェント 2 がサポートするすべてのメトリクスは、プラグインによって収集されます。
このページでは、ユーザーの観点から見たプラグイン設定の基本原則を説明し、Zabbix が提供する組み込みプラグインとロード可能プラグインの両方を一覧表示します。

プラグインの設定

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

すべてのプラグインは Plugins.* パラメータを使用して設定します。これは、Zabbix agent 2 の設定ファイルの一部として指定することも、プラグイン独自の設定ファイルで指定することもできます。 プラグインが個別の設定ファイルを使用する場合、このファイルへのパスは Zabbix agent 2 設定ファイルの Include パラメータで指定する必要があります。

一般的なプラグインパラメータは、次の構造になります。

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

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

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

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

すべてのパラメータ名は、次の要件に従う必要があります。

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

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

デフォルト値

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

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

例えば、Plugins.Mysql.Default.Username=zabbix、Plugins.MongoDB.Default.Uri=tcp://127.0.0.1:27017 などです。

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

名前付きセッション

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

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

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

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

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

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

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

パラメータの優先順位

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

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

例 1

2 つのインスタンス「MySQL1」と「MySQL2」の監視。

設定パラメータ:

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

この設定の結果、各セッション名は アイテムキー の connString として使用できます。例えば、mysql.ping[MySQL1] または mysql.ping[MySQL2] です。

例2

アイテムキーで一部のパラメータを指定します。

設定パラメータ:

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

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

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

• セッションパラメータのURI: 192.0.2.234:5432
• アイテムキーのユーザー名: new_username
• セッションパラメータのパスワード（アイテムキーで省略されているため）: session_password
• アイテムキーのデータベース名: 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 エージェント 2 の組み込みプラグインは、追加設定なしですぐに利用できます。 追加情報については、プラグイン名をクリックしてプラグインリポジトリを参照してください。

ロード可能なプラグイン

Zabbix agent 2 のロード可能なプラグインは、すぐに利用できる状態では提供されておらず、別途インストールする必要があります。

• Linux では、パッケージを使用するか（例: Ubuntu で Ember+ を apt install zabbix-agent2-plugin-ember-plus でインストール）、プラグインをビルドできます
• Windows では、MSI からインストールするか、プラグインをビルドできます

追加情報を含むプラグイン README ファイルがあるプラグインリポジトリに移動するには、プラグイン名をクリックしてください。