12 PostgreSQLプラグイン

概要

Zabbixエージェント 2 の設定ファイルは、プラグインの設定に使用されます。これらの Zabbixエージェント 2 の設定パラメータは、PostgreSQL プラグインの運用でサポートされています。

これらは専用の設定ファイル（例: postgresql.conf）に指定し、その後 Include ディレクティブを使用してこのファイルを Zabbixエージェント 2 の設定に追加することを推奨します。

PostgreSQL プラグインはロード可能なプラグインであり、PostgreSQL plugin repository で利用でき、完全に説明されています。

注意:

  • デフォルト値は、配布される設定ファイル内の値ではなく、プロセスのデフォルト値を反映しています。
  • 値では environment variables をサポートしています。
  • Zabbix は、BOM なしの UTF-8 エンコーディングの設定ファイルのみをサポートしています。
  • "#" で始まるコメントは、行頭でのみサポートされています。

オプション

Parameter Description
-V --version プラグインのバージョンおよびライセンス情報を表示します。
-h --help ヘルプ情報を表示します（短縮形）。
-t, --test <item key> テスト用にプラグインを起動します（プラグイン設定は無視されます）。

パラメータ

Parameter Mandatory Range Default Description
Plugins.PostgreSQL.Default.CacheMode no prepare PostgreSQL接続のキャッシュモード。
サポートされる値:
prepare (デフォルト) - PostgreSQLサーバー上にプリペアドステートメントを作成します。
describe - サーバー上にステートメントを作成せずに、匿名のプリペアドステートメントを使用してステートメントを記述します。
"describe" は主に、PgBouncer のような接続プーラーを実行している場合など、環境でプリペアドステートメントが許可されていない場合に有用です。
Plugins.PostgreSQL.CallTimeout no 1-30 global timeout リクエストが完了するまでの最大待機時間（秒）。
Plugins.PostgreSQL.CustomQueriesPath no /usr/local/share/zabbix/custom-queries/postgreSQL for Unix systems

*:\Program Files\Zabbix Agent 2\Custom Queries\PostgreSQL for Windows systems, where * is the drive name from the ProgramFiles environment variable		 カスタムクエリを含む .sql ファイルが格納されたディレクトリのフルパス名。
Plugins.PostgreSQL.CustomQueriesEnabled no false 設定すると、postgresql.custom.query アイテムキーの実行を有効にします。無効な場合、カスタムクエリディレクトリパスからクエリは読み込まれません。
Plugins.PostgreSQL.Default.Database no PostgreSQLへの接続に使用するデフォルトのデータベース。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.PostgreSQL.Default.Password no PostgreSQLへの接続に使用するデフォルトのパスワード。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.PostgreSQL.Default.TLSCAFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)		 Zabbix agent 2 と監視対象データベース間の暗号化通信において、ピア証明書の検証に使用する最上位 CA 証明書を含むファイルのフルパス名。名前付きセッションで値が指定されていない場合に使用されます。
Plugins.PostgreSQL.Default.TLSCertFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)		 Zabbix agent 2 と監視対象データベース間の暗号化通信に使用する PostgreSQL 証明書または証明書チェーンを含むファイルのフルパス名。名前付きセッションで値が指定されていない場合に使用されます。
Plugins.PostgreSQL.Default.TLSConnect no Zabbix agent 2 と監視対象データベース間の通信に使用する暗号化タイプ。名前付きセッションで値が指定されていない場合に使用されます。
サポートされる値:
required - ID チェックなしで、転送モードとして TLS を使用して接続します。
verify_ca - TLS を使用して接続し、証明書を検証します。
verify_full - TLS を使用して接続し、証明書を検証し、DBHost で指定されたデータベース ID（CN）がその証明書と一致することを検証します。
暗号化タイプが未定義の場合は、暗号化されない接続を意味します。
Plugins.PostgreSQL.Default.TLSKeyFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)		 Zabbix agent 2 と監視対象データベース間の暗号化通信に使用する PostgreSQL 秘密鍵を含むファイルのフルパス名。名前付きセッションで値が指定されていない場合に使用されます。
Plugins.PostgreSQL.Default.Uri no PostgreSQLへの接続に使用するデフォルト URI。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。

埋め込み認証情報を含めてはいけません（含まれていても無視されます）。
URI 形式に一致している必要があります。
サポートされるスキーム: tcp, unix。
例: tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Default.User no PostgreSQLへの接続に使用するデフォルトのユーザー名。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.PostgreSQL.KeepAlive no 60-900 300 未使用のプラグイン接続が閉じられるまでの最大待機時間（秒）。
Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode no prepare PostgreSQL接続のキャッシュモード。
<SessionName> - アイテムキーで使用するセッション名を定義します。
サポートされる値:
prepare (デフォルト) - PostgreSQLサーバー上にプリペアドステートメントを作成します。
describe - サーバー上にステートメントを作成せずに、匿名のプリペアドステートメントを使用してステートメントを記述します。
"describe" は主に、PgBouncer のような接続プーラーを実行している場合など、環境でプリペアドステートメントが許可されていない場合に有用です。
Plugins.PostgreSQL.Sessions.<SessionName>.Database no セッション接続用のデータベース。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.PostgreSQL.Sessions.<SessionName>.Password no Must match the password format. セッション接続用のパスワード。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile no
(yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full)		 最上位 CA 証明書を含む、ピア証明書検証用ファイルのフルパス名。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified PostgreSQL 証明書または証明書チェーンを含むファイルのフルパス名。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect no PostgreSQL接続の暗号化タイプ。
<SessionName> - アイテムキーで使用するセッション名を定義します。

サポートされる値:
required - ID チェックなしで、転送モードとして TLS を使用して接続します。
verify_ca - TLS を使用して接続し、証明書を検証します。
verify_full - TLS を使用して接続し、証明書を検証し、DBHost で指定されたデータベース ID（CN）がその証明書と一致することを検証します。
暗号化タイプが未定義の場合は、暗号化されない接続を意味します。
Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile is specified PostgreSQL 秘密鍵を含むファイルのフルパス名。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.PostgreSQL.Sessions.<SessionName>.Uri no 名前付きセッションの接続文字列。
<SessionName> - アイテムキーで使用するセッション名を定義します。

埋め込み認証情報を含めてはいけません（含まれていても無視されます）。
URI 形式に一致している必要があります。
サポートされるスキーム: tcp, unix。
例: tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Sessions.<SessionName>.User no 名前付きセッションのユーザー名。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.PostgreSQL.System.Path yes PostgreSQLプラグイン実行ファイルへのパス。
使用例: Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql
Plugins.PostgreSQL.Timeout no 1-30 global timeout リクエスト実行タイムアウト（リクエストが完了するまで待機する秒数。これを超えるとリクエストは停止されます）。

関連項目: