Table of Contents
12 PostgreSQLプラグイン
概要
Zabbix agent 2の設定ファイルは、プラグインの設定に使用されます。これらのZabbix agent 2の設定パラメータは、PostgreSQLプラグインの操作をサポートしています。
これらのパラメータは独自の設定ファイル(例: postgresql.conf)に指定し、Includeディレクティブを使用してこのファイルをZabbix agent 2の設定に追加することを推奨します。
PostgreSQLプラグインはロード可能なプラグインであり、PostgreSQLプラグインリポジトリで利用可能で、完全に説明されています。
注意:
- デフォルト値は、出荷時の設定ファイルの値ではなく、プロセスのデフォルト値を反映しています。
- 値は環境変数をサポートしています。
- Zabbixは、BOMなしのUTF-8エンコーディングのみの設定ファイルをサポートします。
- "#"で始まるコメントは、行頭のみサポートされます。
オプション
| パラメータ | 説明 |
|---|---|
| -V --version | プラグインのバージョンとライセンス情報を表示します。 |
| -h --help | ヘルプ情報を表示します（省略形）。 |
| -t, --test <item key> | テストのためにプラグインを起動します（プラグイン設定は無視されます）。 |
パラメーター
| パラメーター | 必須 | 範囲 | デフォルト | 説明 |
|---|---|---|---|---|
| Plugins.PostgreSQL.Default.CacheMode | いいえ | prepare | PostgreSQL接続のキャッシュモード。 サポートされる値: prepare（デフォルト）- PostgreSQLサーバー上でプリペアドステートメントを作成します。 describe - サーバー上でステートメントを作成せずに、匿名のプリペアドステートメントを使用してステートメントを記述します。 「describe」は、PgBouncerのようなコネクションプーラーを実行している場合など、プリペアドステートメントが許可されていない環境で主に有用です。 |
|
| Plugins.PostgreSQL.CallTimeout | いいえ | 1-30 | グローバルタイムアウト | リクエストが完了するまでの最大待機時間（秒単位）。 |
| Plugins.PostgreSQL.CustomQueriesPath | いいえ | Unixシステムの場合は/usr/local/share/zabbix/custom-queries/postgreSQLWindowsシステムの場合は *:\Program Files\Zabbix Agent 2\Custom Queries\PostgreSQL（*はProgramFiles環境変数のドライブ名） |
カスタムクエリを含む.sqlファイルが格納されているディレクトリのフルパス名。 |
|
| Plugins.PostgreSQL.CustomQueriesEnabled | いいえ | false | 設定すると、postgresql.custom.queryアイテムキーの実行を有効にします。無効にすると、カスタムクエリディレクトリパスからクエリは読み込まれません。 |
|
| Plugins.PostgreSQL.Default.Database | いいえ | PostgreSQLへの接続に使用するデフォルトのデータベース。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。 | ||
| Plugins.PostgreSQL.Default.Password | いいえ | PostgreSQLへの接続に使用するデフォルトのパスワード。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。 | ||
| Plugins.PostgreSQL.Default.TLSCAFile | いいえ (Plugins.PostgreSQL.Default.TLSConnectがverify_caまたはverify_fullに設定されている場合は必須) |
Zabbix agent 2と監視対象データベース間の暗号化通信のためのピア証明書検証用の最上位CA証明書を含むファイルのフルパス名。名前付きセッションで値が指定されていない場合に使用されます。 | ||
| Plugins.PostgreSQL.Default.TLSCertFile | いいえ (Plugins.PostgreSQL.Default.TLSConnectがverify_caまたはverify_fullに設定されている場合は必須) |
Zabbix agent 2と監視対象データベース間の暗号化通信のためのPostgreSQL証明書または証明書チェーンを含むファイルのフルパス名。名前付きセッションで値が指定されていない場合に使用されます。 | ||
| Plugins.PostgreSQL.Default.TLSConnect | いいえ | Zabbix agent 2と監視対象データベース間の通信の暗号化タイプ。名前付きセッションで値が指定されていない場合に使用されます。 サポートされる値: required - IDチェックなしでTLSをトランスポートモードとして使用して接続します。 verify_ca - TLSを使用して接続し、証明書を検証します。 verify_full - TLSを使用して接続し、証明書を検証し、DBHostで指定されたデータベースID（CN）が証明書と一致することを検証します。 暗号化タイプが未定義の場合は、暗号化されていない接続となります。 |
||
| Plugins.PostgreSQL.Default.TLSKeyFile | いいえ (Plugins.PostgreSQL.Default.TLSConnectがverify_caまたはverify_fullに設定されている場合は必須) |
Zabbix agent 2と監視対象データベース間の暗号化通信のためのPostgreSQL秘密鍵を含むファイルのフルパス名。名前付きセッションで値が指定されていない場合に使用されます。 | ||
| Plugins.PostgreSQL.Default.Uri | いいえ | PostgreSQLへの接続に使用するデフォルトのURI。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。 埋め込み認証情報を含めないでください（無視されます）。 URI形式に一致する必要があります。 サポートされるスキーム: tcp, unix。例: tcp://127.0.0.1:5432tcp://localhostunix:/var/run/postgresql/.s.PGSQL.5432 |
||
| Plugins.PostgreSQL.Default.User | いいえ | PostgreSQLへの接続に使用するデフォルトのユーザー名。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。 | ||
| Plugins.PostgreSQL.KeepAlive | いいえ | 60-900 | 300 | 未使用のプラグイン接続が閉じられるまでの最大待機時間（秒単位）。 |
| Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode | いいえ | prepare | PostgreSQL接続のキャッシュモード。 <SessionName> - アイテムキーで使用するセッション名を定義します。 サポートされる値: prepare（デフォルト）- PostgreSQLサーバー上でプリペアドステートメントを作成します。 describe - サーバー上でステートメントを作成せずに、匿名のプリペアドステートメントを使用してステートメントを記述します。 「describe」は、PgBouncerのようなコネクションプーラーを実行している場合など、プリペアドステートメントが許可されていない環境で主に有用です。 |
|
| Plugins.PostgreSQL.Sessions.<SessionName>.Database | いいえ | セッション接続用のデータベース。 <SessionName> - アイテムキーで使用するセッション名を定義します。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.Password | いいえ | パスワード形式に一致する必要があります。 | セッション接続用のパスワード。 <SessionName> - アイテムキーで使用するセッション名を定義します。 |
|
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile | いいえ (Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnectがverify_caまたはverify_fullに設定されている場合は必須) |
最上位CA証明書ピア証明書検証を含むファイルのフルパス名。 <SessionName> - アイテムキーで使用するセッション名を定義します。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile | Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFileが指定されている場合は必須 | PostgreSQL証明書または証明書チェーンを含むファイルのフルパス名。 <SessionName> - アイテムキーで使用するセッション名を定義します。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect | いいえ | PostgreSQL接続の暗号化タイプ。 <SessionName> - アイテムキーで使用するセッション名を定義します。 サポートされる値: required - IDチェックなしでTLSをトランスポートモードとして使用して接続します。 verify_ca - TLSを使用して接続し、証明書を検証します。 verify_full - TLSを使用して接続し、証明書を検証し、DBHostで指定されたデータベースID（CN）が証明書と一致することを検証します。 暗号化タイプが未定義の場合は、暗号化されていない接続となります。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile | Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFileが指定されている場合は必須 | PostgreSQL秘密鍵を含むファイルのフルパス名。 <SessionName> - アイテムキーで使用するセッション名を定義します。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.Uri | いいえ | 名前付きセッションの接続文字列。 <SessionName> - アイテムキーで使用するセッション名を定義します。 埋め込み認証情報を含めないでください（無視されます）。 URI形式に一致する必要があります。 サポートされるスキーム: tcp, unix。例: tcp://127.0.0.1:5432tcp://localhostunix:/var/run/postgresql/.s.PGSQL.5432 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.User | いいえ | 名前付きセッションのユーザー名。 <SessionName> - アイテムキーで使用するセッション名を定義します。 |
||
| Plugins.PostgreSQL.System.Path | はい | PostgreSQLプラグイン実行ファイルへのパス。 使用例: Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql |
||
| Plugins.PostgreSQL.Timeout | いいえ | 1-30 | グローバルタイムアウト | リクエスト実行のタイムアウト（リクエストが完了するまで待機する秒数）。 |
参照:
- 一般的なZabbix agent 2の設定パラメーターの説明: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- プラグインの設定手順