Redis plugin

Overview

Configuration parameters allow customizing the Redis plugin behavior.

It is recommended to specify them in their own configuration file (e.g. redis.conf), rather than in the agent 2 configuration file. Then use the Include directive to include this file in the Zabbix agent 2 configuration.

All parameters are optional, unless explicitly stated that the parameter is mandatory.

This page is structured as:

• Parameter overview (to see full details of a parameter, click its name)
• Parameter details

Note that:

• The default values reflect process defaults, not the values in the shipped configuration files.
• Values support environment variables.
• Zabbix supports configuration files only in UTF-8 encoding without BOM.
• Comments starting with "#" are only supported at the beginning of the line.

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|no
(yes, if TLSConnect is verify_ca or verify_full)| | |Full pathname of a file containing the top-level CA(s) certificates for Redis server certificate verification.
<SessionName> - define the session name to be used in item keys.| |Plugins.Redis.Sessions.<SessionName>.TLSCertFile|no| | |Full pathname of a file containing the agent's certificate for client authentication.
<SessionName> - define the session name to be used in item keys.| |Plugins.Redis.Sessions.<SessionName>.TLSKeyFile|no| | |Full pathname of a file containing the agent's private key for client authentication.
<SessionName> - define the session name to be used in item keys.|

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

See also

• Description of general Zabbix agent 2 configuration parameters: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
• Instructions for configuring plugins