Zabbix Documentation 3.0

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:appendix:config:zabbix_server

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:appendix:config:zabbix_server [2016/02/15 07:40]
martins-v missing space
manual:appendix:config:zabbix_server [2020/02/13 12:51] (current)
martins-v adding more warning on MaxHousekeeperDelete
Line 1: Line 1:
-==== - #1 Zabbix server ====+==== 1 Zabbix server ====
  
-<​note>​The default values reflect daemon defaults, not the values in the shipped configuration files.</​note>​+=== Overview ===
  
-The parameters supported in a Zabbix server configuration file:+This section lists parameters supported in a Zabbix server configuration file (zabbix_server.conf). Note that: 
 + 
 +  * The default values reflect daemon defaults, not the values in the shipped configuration files; 
 +  * Zabbix supports configuration files only in UTF-8 encoding without [[https://​en.wikipedia.org/​wiki/​Byte_order_mark|BOM]];​ 
 +  * Comments starting with "#"​ are only supported in the beginning of the line. 
 + 
 +=== Parameters ===
  
 ^Parameter^Mandatory^Range^Default^Description^ ^Parameter^Mandatory^Range^Default^Description^
Line 9: Line 15:
 | AllowRoot| no | |0 |Allow the server to run as '​root'​. If disabled and the server is started by '​root',​ the server will try to switch to the '​zabbix'​ user instead. Has no effect if started under a regular user.\\ 0 - do not allow\\ 1 - allow\\ This parameter is supported since Zabbix 2.2.0. | | AllowRoot| no | |0 |Allow the server to run as '​root'​. If disabled and the server is started by '​root',​ the server will try to switch to the '​zabbix'​ user instead. Has no effect if started under a regular user.\\ 0 - do not allow\\ 1 - allow\\ This parameter is supported since Zabbix 2.2.0. |
 | CacheSize| no | 128K-8G |8M |Size of configuration cache, in bytes.\\ Shared memory size for storing host, item and trigger data.\\ Upper limit used to be 2GB before Zabbix 2.2.3. ​ | | CacheSize| no | 128K-8G |8M |Size of configuration cache, in bytes.\\ Shared memory size for storing host, item and trigger data.\\ Upper limit used to be 2GB before Zabbix 2.2.3. ​ |
-| CacheUpdateFrequency| no | 1-3600 |60 |How often Zabbix will perform update of configuration cache, in seconds. |+| CacheUpdateFrequency| no | 1-3600 |60 |How often Zabbix will perform update of configuration cache, in seconds.\\ See also [[:​manual/​concepts/​server#​server_process|runtime control]] options.  ​|
 | DBHost| no | |localhost |Database host name.\\ In case of MySQL localhost or empty string results in using a socket. In case of PostgreSQL\\ only empty string results in attempt to use socket.| | DBHost| no | |localhost |Database host name.\\ In case of MySQL localhost or empty string results in using a socket. In case of PostgreSQL\\ only empty string results in attempt to use socket.|
-| DBName| yes | | |Database name.\\ For SQLite3 ​path to database file must be providedDBUser and DBPassword are ignored. |+| DBName| yes | | |Database name or path to database file for SQLite3 (multi-process architecture of Zabbix does not allow to use [[https://​www.sqlite.org/​inmemorydb.html|in-memory database]], e.g. '':​memory:'',​ ''​file::​memory:?​cache=shared''​ or ''​file:​memdb1?​mode=memory&​cache=shared''​).|
 | DBPassword| no | | |Database password. Ignored for SQLite.\\ Comment this line if no password is used. | | DBPassword| no | | |Database password. Ignored for SQLite.\\ Comment this line if no password is used. |
 | DBPort| no | 1024-65535 |3306 |Database port when not using local socket. Ignored for SQLite. | | DBPort| no | 1024-65535 |3306 |Database port when not using local socket. Ignored for SQLite. |
Line 17: Line 23:
 | DBSocket| no | |/​tmp/​mysql.sock |Path to MySQL socket. | | DBSocket| no | |/​tmp/​mysql.sock |Path to MySQL socket. |
 | DBUser| no | | |Database user. Ignored for SQLite. | | DBUser| no | | |Database user. Ignored for SQLite. |
-| DebugLevel| no | 0-5 |3 |Specifies debug level:\\ 0 - basic information about starting and stopping of Zabbix processes\\ 1 - critical information\\ 2 - error information\\ 3 - warnings\\ 4 - for debugging (produces lots of information)\\ 5 - extended debugging (produces even more information) |+| DebugLevel| no | 0-5 |3 |Specifies debug level:\\ 0 - basic information about starting and stopping of Zabbix processes\\ 1 - critical information\\ 2 - error information\\ 3 - warnings\\ 4 - for debugging (produces lots of information)\\ 5 - extended debugging (produces even more information)\\ See also [[:​manual/​concepts/​server#​server_process|runtime control]] options.  ​|
 | ExternalScripts| no | |/​usr/​local/​share/​zabbix/​externalscripts |Location of external scripts (depends on compile-time installation variable //​datadir//​). | | ExternalScripts| no | |/​usr/​local/​share/​zabbix/​externalscripts |Location of external scripts (depends on compile-time installation variable //​datadir//​). |
 | Fping6Location| no | |/​usr/​sbin/​fping6 |Location of fping6.\\ Make sure that fping6 binary has root ownership and SUID flag set.\\ Make empty ("​Fping6Location="​) if your fping utility is capable to process IPv6 addresses. | | Fping6Location| no | |/​usr/​sbin/​fping6 |Location of fping6.\\ Make sure that fping6 binary has root ownership and SUID flag set.\\ Make empty ("​Fping6Location="​) if your fping utility is capable to process IPv6 addresses. |
Line 23: Line 29:
 | HistoryCacheSize| no | 128K-2G |16M |Size of history cache, in bytes.\\ Shared memory size for storing history data. | | HistoryCacheSize| no | 128K-2G |16M |Size of history cache, in bytes.\\ Shared memory size for storing history data. |
 | HistoryIndexCacheSize| no | 128K-2G |4M |Size of history index cache, in bytes.\\ Shared memory size for indexing history data stored in history cache.\\ The index cache size needs roughly 100 bytes to cache one item.\\ This parameter is supported since Zabbix 3.0.0. | | HistoryIndexCacheSize| no | 128K-2G |4M |Size of history index cache, in bytes.\\ Shared memory size for indexing history data stored in history cache.\\ The index cache size needs roughly 100 bytes to cache one item.\\ This parameter is supported since Zabbix 3.0.0. |
-| HousekeepingFrequency| no | 0-24 |1 |How often Zabbix will perform housekeeping procedure (in hours).\\ Housekeeping is removing outdated information from the database.\\ //Note//: To prevent housekeeper from being overloaded (for example, when history and trend periods are greatly reduced), no more than 4 times HousekeepingFrequency hours of outdated information are deleted in one housekeeping cycle, for each item. Thus, if HousekeepingFrequency is 1, no more than 4 hours of outdated information (starting from the oldest entry) will be deleted per cycle.\\ //Note//: To lower load on server startup housekeeping is postponed for 30 minutes after server start. Thus, if HousekeepingFrequency is 1, the very first housekeeping procedure after server start will run after 30 minutes, and will repeat with one hour delay thereafter. This postponing behavior is in place since Zabbix 2.4.0.\\ Since Zabbix 3.0.0 it is possible to disable automatic housekeeping by setting HousekeepingFrequency to 0. In this case the housekeeping procedure can only be started by //​housekeeper_execute//​ runtime control option and the period of outdated information deleted in one housekeeping cycle is 4 times the period since the last housekeeping cycle, but not less than 4 hours and not greater than 4 days. |+| HousekeepingFrequency| no | 0-24 |1 |How often Zabbix will perform housekeeping procedure (in hours).\\ Housekeeping is removing outdated information from the database.\\ //Note//: To prevent housekeeper from being overloaded (for example, when history and trend periods are greatly reduced), no more than 4 times HousekeepingFrequency hours of outdated information are deleted in one housekeeping cycle, for each item. Thus, if HousekeepingFrequency is 1, no more than 4 hours of outdated information (starting from the oldest entry) will be deleted per cycle.\\ //Note//: To lower load on server startup housekeeping is postponed for 30 minutes after server start. Thus, if HousekeepingFrequency is 1, the very first housekeeping procedure after server start will run after 30 minutes, and will repeat with one hour delay thereafter. This postponing behavior is in place since Zabbix 2.4.0.\\ Since Zabbix 3.0.0 it is possible to disable automatic housekeeping by setting HousekeepingFrequency to 0. In this case the housekeeping procedure can only be started by //​housekeeper_execute//​ runtime control option and the period of outdated information deleted in one housekeeping cycle is 4 times the period since the last housekeeping cycle, but not less than 4 hours and not greater than 4 days.\\ See also [[:​manual/​concepts/​server#​server_process|runtime control]] options.  ​|
 | Include| no | | |You may include individual files or all files in a directory in the configuration file.\\ To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: ''/​absolute/​path/​to/​config/​files/​*.conf''​. Pattern matching is supported since Zabbix 2.4.0.\\ See [[special_notes_include|special notes]] about limitations. | | Include| no | | |You may include individual files or all files in a directory in the configuration file.\\ To only include relevant files in the specified directory, the asterisk wildcard character is supported for pattern matching. For example: ''/​absolute/​path/​to/​config/​files/​*.conf''​. Pattern matching is supported since Zabbix 2.4.0.\\ See [[special_notes_include|special notes]] about limitations. |
 | JavaGateway| no | | |IP address (or hostname) of Zabbix Java gateway.\\ Only required if Java pollers are started.\\ This parameter is supported since Zabbix 2.0.0. ​ | | JavaGateway| no | | |IP address (or hostname) of Zabbix Java gateway.\\ Only required if Java pollers are started.\\ This parameter is supported since Zabbix 2.0.0. ​ |
Line 31: Line 37:
 | LoadModule| no |  |  |Module to load at server startup. Modules are used to extend functionality of the server.\\ Format: LoadModule=<​module.so>​\\ The modules must be located in directory specified by LoadModulePath.\\ It is allowed to include multiple LoadModule parameters. ​ | | LoadModule| no |  |  |Module to load at server startup. Modules are used to extend functionality of the server.\\ Format: LoadModule=<​module.so>​\\ The modules must be located in directory specified by LoadModulePath.\\ It is allowed to include multiple LoadModule parameters. ​ |
 | LoadModulePath| no |  |  |Full path to location of server modules.\\ Default depends on compilation options. ​ | | LoadModulePath| no |  |  |Full path to location of server modules.\\ Default depends on compilation options. ​ |
-| LogFile| no | | |Name of log file. |+| LogFile| ​yes, if LogType is set to //file//, otherwise\\ ​no | | |Name of log file. |
 | LogFileSize| no | 0-1024 |1 |Maximum size of log file in MB.\\ 0 - disable automatic log rotation.\\ //Note//: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew. | | LogFileSize| no | 0-1024 |1 |Maximum size of log file in MB.\\ 0 - disable automatic log rotation.\\ //Note//: If the log file size limit is reached and file rotation fails, for whatever reason, the existing log file is truncated and started anew. |
 | LogType| no | | file |Log output type:\\ //file// - write log to file specified by LogFile parameter,​\\ //system// - write log to syslog,\\ //console// - write log to standard output.\\ This parameter is supported since Zabbix 3.0.0. | | LogType| no | | file |Log output type:\\ //file// - write log to file specified by LogFile parameter,​\\ //system// - write log to syslog,\\ //console// - write log to standard output.\\ This parameter is supported since Zabbix 3.0.0. |
 | LogSlowQueries| no | 0-3600000 |0 |How long a database query may take before being logged (in milliseconds).\\ 0 - don't log slow queries.\\ This option becomes enabled starting with DebugLevel=3.\\ This parameter is supported since Zabbix 1.8.2. ​ | | LogSlowQueries| no | 0-3600000 |0 |How long a database query may take before being logged (in milliseconds).\\ 0 - don't log slow queries.\\ This option becomes enabled starting with DebugLevel=3.\\ This parameter is supported since Zabbix 1.8.2. ​ |
-| MaxHousekeeperDelete| no | 0-1000000 |5000 |No more than '​MaxHousekeeperDelete'​ rows (corresponding to [tablename],​ [field], [value]) will be deleted per one task in one housekeeping cycle.\\ SQLite3 does not use this parameter, deletes all corresponding rows without a limit.\\ If set to 0 then no limit is used at all. In this case you must know what you are doing!\\ This parameter is supported since Zabbix 1.8.2 and applies only to deleting history and trends of already deleted items. ​ |+| MaxHousekeeperDelete| no | 0-1000000 |5000 |No more than '​MaxHousekeeperDelete'​ rows (corresponding to [tablename],​ [field], [value]) will be deleted per one task in one housekeeping cycle.\\ If set to 0 then no limit is used at all. In this case you must know what you are doing, so as not to [[zabbix_server#​footnotes|overload the database!]] **<​sup>​[[zabbix_server#​footnotes|1]]</​sup>​**\\ This parameter is supported since Zabbix 1.8.2 and applies only to deleting history and trends of already deleted items. ​ |
 | PidFile| no | |/​tmp/​zabbix_server.pid |Name of PID file. | | PidFile| no | |/​tmp/​zabbix_server.pid |Name of PID file. |
 | ProxyConfigFrequency| no | 1-604800 | 3600 | How often Zabbix server sends configuration data to a Zabbix proxy in seconds. Used only for proxies in a passive mode.\\ This parameter is supported since Zabbix 1.8.3. | | ProxyConfigFrequency| no | 1-604800 | 3600 | How often Zabbix server sends configuration data to a Zabbix proxy in seconds. Used only for proxies in a passive mode.\\ This parameter is supported since Zabbix 1.8.3. |
Line 54: Line 60:
 | StartPingers| no | 0-1000 |1 |Number of pre-forked instances of ICMP pingers.\\ The upper limit used to be 255 before version 1.8.5. | | StartPingers| no | 0-1000 |1 |Number of pre-forked instances of ICMP pingers.\\ The upper limit used to be 255 before version 1.8.5. |
 | StartPollersUnreachable| no | 0-1000 |1 |Number of pre-forked instances of pollers for unreachable hosts (including IPMI and Java).\\ Since Zabbix 2.4.0, at least one poller for unreachable hosts must be running if regular, IPMI or Java pollers are started.\\ The upper limit used to be 255 before version 1.8.5.\\ This option is missing in version 1.8.3. | | StartPollersUnreachable| no | 0-1000 |1 |Number of pre-forked instances of pollers for unreachable hosts (including IPMI and Java).\\ Since Zabbix 2.4.0, at least one poller for unreachable hosts must be running if regular, IPMI or Java pollers are started.\\ The upper limit used to be 255 before version 1.8.5.\\ This option is missing in version 1.8.3. |
-| StartPollers| no | 0-1000 |5 |Number of pre-forked instances of pollers.\\ ​The upper limit used to be 255 before version 1.8.5. |+| StartPollers| no | 0-1000 |5 |Number of pre-forked instances of pollers.\\ ​//Note// that a non-zero value is required for internal, aggregated and calculated items to work. |
 | StartProxyPollers| no | 0-250 |1 |Number of pre-forked instances of pollers for passive proxies.\\ The upper limit used to be 255 before version 1.8.5.\\ This parameter is supported since Zabbix 1.8.3. | | StartProxyPollers| no | 0-250 |1 |Number of pre-forked instances of pollers for passive proxies.\\ The upper limit used to be 255 before version 1.8.5.\\ This parameter is supported since Zabbix 1.8.3. |
 | StartSNMPTrapper| no | 0-1 |0 |If set to 1, SNMP trapper process will be started.\\ This parameter is supported since Zabbix 2.0.0. ​ | | StartSNMPTrapper| no | 0-1 |0 |If set to 1, SNMP trapper process will be started.\\ This parameter is supported since Zabbix 2.0.0. ​ |
Line 74: Line 80:
 | ValueCacheSize| no | 0,128K-64G |8M |Size of history value cache, in bytes.\\ Shared memory size for caching item history data requests.\\ Setting to 0 disables value cache (not recommended).\\ When value cache runs out of the shared memory a warning message is written to the server log every 5 minutes.\\ This parameter is supported since Zabbix 2.2.0. | | ValueCacheSize| no | 0,128K-64G |8M |Size of history value cache, in bytes.\\ Shared memory size for caching item history data requests.\\ Setting to 0 disables value cache (not recommended).\\ When value cache runs out of the shared memory a warning message is written to the server log every 5 minutes.\\ This parameter is supported since Zabbix 2.2.0. |
 | VMwareCacheSize| no |256K-2G ​ |8M  |Shared memory size for storing VMware data.\\ A VMware internal check zabbix[vmware,​buffer,​...] can be used to monitor the VMware cache usage (see  [[manual:​config:​items:​itemtypes:​internal|Internal checks]]).\\ Note that shared memory is not allocated if there are no vmware collector instances configured to start.\\ This parameter is supported since Zabbix 2.2.0. ​ | | VMwareCacheSize| no |256K-2G ​ |8M  |Shared memory size for storing VMware data.\\ A VMware internal check zabbix[vmware,​buffer,​...] can be used to monitor the VMware cache usage (see  [[manual:​config:​items:​itemtypes:​internal|Internal checks]]).\\ Note that shared memory is not allocated if there are no vmware collector instances configured to start.\\ This parameter is supported since Zabbix 2.2.0. ​ |
-| VMwareFrequency| no |10-86400 ​ |60  |Delay in seconds between data gathering from a single VMware service.\\ This delay should be set to the least delay period ​of an VMware monitoring item.\\ This parameter is supported since Zabbix 2.2.0. | +| VMwareFrequency| no |10-86400 ​ |60  |Delay in seconds between data gathering from a single VMware service.\\ This delay should be set to the least update interval ​of any VMware monitoring item.\\ This parameter is supported since Zabbix 2.2.0. | 
-| VMwarePerfFrequency | no |10-86400 ​ |60  |Delay in seconds between ​VMware ​performance ​collector based data gathering ​from a single VMware service.\\ This delay should be set to the least delay period ​of an VMware monitoring item.\\ This parameter is supported since Zabbix 2.2.9, 2.4.4|+| VMwarePerfFrequency | no |10-86400 ​ |60  |Delay in seconds between performance ​counter statistics retrieval ​from a single VMware service.\\ This delay should be set to the least update interval ​of any VMware monitoring ​[[:​manual/​config/​items/​itemtypes/​simple_checks/​vmware_keys#​footnotes|item]] that uses VMware performance counters.\\ This parameter is supported since Zabbix 2.2.9, 2.4.4|
 | VMwareTimeout | no | 1-300 |10 |The maximum number of seconds vmware collector will wait for a response from VMware service (vCenter or ESX hypervisor).\\ This parameter is supported since Zabbix 2.2.9, 2.4.4| | VMwareTimeout | no | 1-300 |10 |The maximum number of seconds vmware collector will wait for a response from VMware service (vCenter or ESX hypervisor).\\ This parameter is supported since Zabbix 2.2.9, 2.4.4|
  
-<note>Zabbix supports configuration files only in UTF-8 encoding without [[https://en.wikipedia.org/​wiki/​Byte_order_mark|BOM]].\\ \\  Comments starting with "#"​ are only supported ​in the beginning of the line.</​note>​+== Footnotes == 
 + 
 +<sup>**1**</sup> When a lot of items are deleted it increases the load to the database, because the housekeeper will need to remove all the history data that these items hadFor example, if we only have to remove 1 item prototype, but this prototype is linked to 50 hosts and for every host the prototype is expanded to 100 real items, 5000 items in total have to be removed (1*50*100). If 500 is set for MaxHousekeeperDelete (MaxHousekeeperDelete=500), ​the housekeeper process will have to remove up to 2500000 values (5000*500) for the deleted items from history and trends tables in one cycle.