You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.
Table of Contents

13 Redis plugin

Overview

The configuration file of Zabbix agent 2 is used to configure plugins. These Zabbix agent 2 configuration parameters are supported for operating the Redis plugin.

It is recommended to specify them in their own configuration file (e.g. redis.conf) and then use the Include directive for adding this file to the Zabbix agent 2 configuration.

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.

Parameters

Parameter Mandatory Range Default Description
Plugins.Redis.Default.Password no Default password for connecting to Redis; used if no value is specified in an item key or named session.
Plugins.Redis.Default.Uri no tcp://localhost:6379 Default URI for connecting to Redis; used if no value is specified in an item key or named session.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Supported schemes: tcp, unix; a scheme can be omitted.
A port can be omitted (default=6379).
Examples: tcp://localhost:6379
localhost
unix:/var/run/redis.sock
Plugins.Redis.Default.User no Default user to send to the protected Redis server; used if no value is specified in an item key or named session.
Plugins.Redis.KeepAlive no 60-900 300 The maximum time of waiting (in seconds) before unused plugin connections are closed.
Plugins.Redis.Sessions.<SessionName>.Password no Named session password.
<SessionName> - define the session name to be used in item keys.
Plugins.Redis.Sessions.<SessionName>.Uri no Connection string of a named session.
<SessionName> - define the session name to be used in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Supported schemes: tcp, unix; a scheme can be omitted.
A port can be omitted (default=6379).
Examples: tcp://localhost:6379
localhost
unix:/var/run/redis.sock
Plugins.Redis.Sessions.<SessionName>.User no User to send to the protected Redis server.
<SessionName> - define the session name to be used in item keys.
Plugins.Redis.Timeout no 1-30 global timeout Request execution timeout (the duration, in seconds, to wait for a request to complete before shutting it down).

See also: