Redisプラグイン

概要

設定パラメータを使用すると、Redisプラグインの動作をカスタマイズできます。

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

特にパラメータが必須であると明記されていない限り、すべてのパラメータは任意です。

次の点に注意してください。

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

Parameter details

Plugins.Redis.Default.Password

Specify the default password for connecting to Redis.
Used if no value is specified in an item key or named session.

Plugins.Redis.Default.TLSConnect

Specify the level of encryption required for Zabbix agent 2 communications.
An empty or unset value is treated as no TLS.

Range: required - encrypted, unverified (only for testing), verify_ca - encrypted, server certificate, verify_full - encrypted, server certificate and server name verified with SAN

Plugins.Redis.Default.TLSCAFile

Specify full pathname of the file containing the top-level CA(s) certificates.

Plugins.Redis.Default.TLSCertFile

Specify full pathname of the file containing the agent certificate.

Plugins.Redis.Default.TLSKeyFile

Specify full pathname of the file containing the agent private key.

Plugins.Redis.Default.Uri

Specify the default URI for connecting to Redis.
Used if no value is specified in an item key or named session.
Embedded credentials will be ignored. Must match the URI format.
Supported schemes: tcp, unix
A scheme can be omitted.
A port can be omitted (default=6379).

Default: tcp://localhost:6379

Examples:

tcp://localhost:6379
localhost
unix:/var/run/redis.sock
Plugins.Redis.Default.User

Specify the default username for connecting to Redis.
Used if no value is specified in an item key or named session.

Default: default

Plugins.Redis.KeepAlive

Set the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300 Range: 60-900

Plugins.Redis.Sessions.<SessionName>.Password

Specify the named session password for connecting to Redis.
<SessionName> - define the session name to be used in item keys.

Plugins.Redis.Sessions.<SessionName>.TLSConnect

Specify the level of encryption required for Zabbix agent 2 communications for named session.
<SessionName> - define the session name to be used in item keys.
An empty or unset value is treated as no TLS.

Range: required - encrypted, unverified (only for testing), verify_ca - encrypted, server certificate, verify_full - encrypted, server certificate and server name verified with SAN

Plugins.Redis.Sessions.<SessionName>.TLSCAFile

Specify full pathname of the file containing the top-level CA(s) certificates for named session.
<SessionName> - define the session name to be used in item keys.

Mandatory: yes, if Plugins.Redis.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full

Plugins.Redis.Sessions.<SessionName>.TLSCertFile

Specify full pathname of the file containing containing the agent certificate for named session.
<SessionName> - define the session name to be used in item keys.

Plugins.Redis.Sessions.<SessionName>.TLSKeyFile

Specify full pathname of the file containing the agent private key for named session.
<SessionName> - define the session name to be used in item keys.

Plugins.Redis.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to Redis.
<SessionName> - define the session name to be used in item keys.
Embedded credentials will be ignored. Must match the URI format.
Supported schemes: tcp, unix
A scheme can be omitted.
A port can be omitted (default=6379).

Default: tcp://localhost:6379

Examples:

tcp://localhost:6379
localhost
unix:/var/run/redis.sock
Plugins.Redis.Sessions.<SessionName>.User

Specify the named session username for connecting to Redis.
<SessionName> - define the session name to be used in item keys.

Plugins.Redis.Timeout

Set the request execution timeout (the duration, in seconds, to wait for a request to complete before shutting it down).

Default: global timeout Range: 1-30

パラメーター

Parameter Mandatory Range Default Description
Plugins.Redis.Default.Password no Redis への接続に使用するデフォルトパスワード。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.Redis.Default.TLSConnect no クライアント（Zabbix エージェント 2）の TLS 検証要件。

サポートされる値:
required - 暗号化、未検証（テスト用のみ）
verify_ca - 暗号化、サーバー証明書
verify_full - 暗号化、SAN によりサーバー証明書とサーバー名を検証
空の値、または未設定の値は tls なしとして扱われます。
Plugins.Redis.Default.TLSCAFile no 最上位 CA 証明書を含むファイルのデフォルトの完全パス名。
Plugins.Redis.Default.TLSCertFile no エージェントの証明書を含むファイルのデフォルトの完全パス名。
Plugins.Redis.Default.TLSKeyFile no エージェントの秘密鍵を含むファイルのデフォルトの完全パス名。
Plugins.Redis.Default.Uri no tcp://localhost:6379 Redis への接続に使用するデフォルト URI。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。

埋め込み資格情報を含めないでください（無視されます）。
URI 形式に一致している必要があります。
サポートされるスキーム: tcp, unix。スキームは省略できます。
ポートは省略できます（default=6379）。
例: tcp://localhost:6379
localhost
unix:/var/run/redis.sock
Plugins.Redis.Default.User no default 保護された Redis サーバーに送信するデフォルトユーザー。アイテムキーまたは名前付きセッションで値が指定されていない場合に使用されます。
Plugins.Redis.KeepAlive no 60-900 300 未使用のプラグイン接続が閉じられるまでの最大待機時間（秒）。
Plugins.Redis.Sessions.<SessionName>.Password no 名前付きセッションのパスワード。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.Redis.Sessions.<SessionName>.TLSConnect no クライアント（Zabbix エージェント 2）の TLS 検証要件。
<SessionName> - アイテムキーで使用するセッション名を定義します。

サポートされる値:
required - 暗号化、未検証（テスト用のみ）
verify_ca - 暗号化、サーバー証明書
verify_full - 暗号化、SAN によりサーバー証明書とサーバー名を検証
空の値、または未設定の値は tls なしとして扱われます。
Plugins.Redis.Sessions.<SessionName>.TLSCAFile no
(yes, if TLSConnect is verify_ca or verify_full)		 Redis サーバー証明書の検証に使用する最上位 CA 証明書を含むファイルの完全パス名。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.Redis.Sessions.<SessionName>.TLSCertFile no クライアント認証用のエージェントの証明書を含むファイルの完全パス名。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.Redis.Sessions.<SessionName>.TLSKeyFile no クライアント認証用のエージェントの秘密鍵を含むファイルの完全パス名。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.Redis.Sessions.<SessionName>.Uri no localhost:6379 名前付きセッションの接続文字列。
<SessionName> - アイテムキーで使用するセッション名を定義します。

埋め込み資格情報を含めないでください（無視されます）。
URI 形式に一致している必要があります。
サポートされるスキーム: tcp, unix。スキームは省略できます。
ポートは省略できます（default=6379）。
例: tcp://localhost:6379
localhost
unix:/var/run/redis.sock
Plugins.Redis.Sessions.<SessionName>.User no default 保護された Redis サーバーに送信するユーザー。
<SessionName> - アイテムキーで使用するセッション名を定義します。
Plugins.Redis.Timeout no 1-30 global timeout リクエストの実行タイムアウト（リクエストが完了するまで待機してから停止する秒数）。

参照: