manual:config:items:itemtypes:zabbix_agent

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
Next revision Both sides next revision
manual:config:items:itemtypes:zabbix_agent [2021/01/26 13:55]
marinagen links updated
manual:config:items:itemtypes:zabbix_agent [2021/04/16 19:21]
martins-v fixing typo
Line 82: Line 82:
 | ||||| | |||||
 ^net.tcp.port[<​ip>,​port] ​ ^^^^^ ^net.tcp.port[<​ip>,​port] ​ ^^^^^
-^ |Checks if it is possible to make TCP connection to specified port.  |0 - cannot connect\\ \\ 1 - can connect ​ |**ip** - IP address ​(default is 127.0.0.1)\\ **port** - port number ​ |Example:\\ => net.tcp.port[,​80] -> can be used to test availability of web server running on port 80.\\ \\ For simple TCP performance testing use net.tcp.service.perf[tcp,<​ip>,<​port>​]\\ \\ Note that these checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually). \\ \\ Old naming: //​check_port[*]//​|+^ |Checks if it is possible to make TCP connection to specified port.  |0 - cannot connect\\ \\ 1 - can connect ​ |**ip** - IP or DNS name (default is 127.0.0.1)\\ **port** - port number ​ |Example:\\ => net.tcp.port[,​80] -> can be used to test availability of web server running on port 80.\\ \\ For simple TCP performance testing use net.tcp.service.perf[tcp,<​ip>,<​port>​]\\ \\ Note that these checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually). \\ \\ Old naming: //​check_port[*]//​|
 | ||||| | |||||
 ^net.tcp.service[service,<​ip>,<​port>​] ​ ^^^^^ ^net.tcp.service[service,<​ip>,<​port>​] ​ ^^^^^
Line 100: Line 100:
 | ||||| | |||||
 ^proc.cpu.util[<​name>,<​user>,<​type>,<​cmdline>,<​mode>,<​zone>​] ​ ^^^^^ ^proc.cpu.util[<​name>,<​user>,<​type>,<​cmdline>,<​mode>,<​zone>​] ​ ^^^^^
-^ |Process CPU utilisation ​percentage. ​ |Float ​ |**name** - process name (default is //all processes//​)\\ **user** - user name (default is //all users//)\\ **type** - CPU utilisation ​type:\\ //total// (default), //user//, //​system//​\\ **cmdline** - filter by command line (it is a regular expression<​sup>​**[[#​footnotes|4]]**</​sup>​) \\ **mode** - data gathering mode: //avg1// (default), //avg5//, //avg15//\\ **zone** - target zone: //current// (default), //all//. This parameter is supported on Solaris only.  |Examples:​\\ => proc.cpu.util[,​root] -> CPU utilisation ​of all processes running under the "​root"​ user\\ => proc.cpu.util[zabbix_server,​zabbix] -> CPU utilisation ​of all zabbix_server processes running under the zabbix user\\ \\ The returned value is based on single CPU core utilisation ​percentage. For example CPU utilisation ​of a process fully using two cores is 200%. \\ \\ The process CPU utilisation ​data is gathered by a collector which supports the maximum of 1024 unique (by name, user and command line) queries. Queries not accessed during the last 24 hours are removed from the collector.\\ \\ //Note// that when setting the ''​zone''​ parameter to //current// (or default) in case the agent has been compiled on a Solaris without zone support, but running on a newer Solaris where zones are supported, then the agent will return NOTSUPPORTED (the agent cannot limit results to only the current zone). However, //all// is supported in this case.\\ \\ This key is supported since Zabbix 3.0.0 and is available on several platforms (see [[manual:​appendix:​items:​supported_by_platform|Items supported by platform]]). |+^ |Process CPU utilization ​percentage. ​ |Float ​ |**name** - process name (default is //all processes//​)\\ **user** - user name (default is //all users//)\\ **type** - CPU utilization ​type:\\ //total// (default), //user//, //​system//​\\ **cmdline** - filter by command line (it is a regular expression<​sup>​**[[#​footnotes|4]]**</​sup>​) \\ **mode** - data gathering mode: //avg1// (default), //avg5//, //avg15//\\ **zone** - target zone: //current// (default), //all//. This parameter is supported on Solaris only.  |Examples:​\\ => proc.cpu.util[,​root] -> CPU utilization ​of all processes running under the "​root"​ user\\ => proc.cpu.util[zabbix_server,​zabbix] -> CPU utilization ​of all zabbix_server processes running under the zabbix user\\ \\ The returned value is based on single CPU core utilization ​percentage. For example CPU utilization ​of a process fully using two cores is 200%. \\ \\ The process CPU utilization ​data is gathered by a collector which supports the maximum of 1024 unique (by name, user and command line) queries. Queries not accessed during the last 24 hours are removed from the collector.\\ \\ //Note// that when setting the ''​zone''​ parameter to //current// (or default) in case the agent has been compiled on a Solaris without zone support, but running on a newer Solaris where zones are supported, then the agent will return NOTSUPPORTED (the agent cannot limit results to only the current zone). However, //all// is supported in this case.\\ \\ This key is supported since Zabbix 3.0.0 and is available on several platforms (see [[manual:​appendix:​items:​supported_by_platform|Items supported by platform]]). |
 | ||||| | |||||
 ^proc.mem[<​name>,<​user>,<​mode>,<​cmdline>,<​memtype>​] ​ ^^^^^ ^proc.mem[<​name>,<​user>,<​mode>,<​cmdline>,<​memtype>​] ​ ^^^^^
Line 132: Line 132:
 | ||||| | |||||
 ^system.cpu.util[<​cpu>,<​type>,<​mode>,<​logical_or_physical>​] ​ ^^^^^ ^system.cpu.util[<​cpu>,<​type>,<​mode>,<​logical_or_physical>​] ​ ^^^^^
-^ |CPU utilisation ​percentage. ​ |Float ​ |**cpu** - //<CPU number>//​ or //all// (default)\\ **type** - possible values:\\ //user// (default), //idle//, //nice//, //system// (default for Windows), //iowait//, //​interrupt//,​ //​softirq//,​ //steal//, //guest// (on Linux kernels 2.6.24 and above), //​guest_nice//​ (on Linux kernels 2.6.33 and above).\\ See also [[:​manual/​appendix/​items/​supported_by_platform|platform-specific]] details for this parameter.\\ **mode** - possible values:\\ //avg1// (one-minute average, default), //avg5//, //avg15// \\ **logical_or_physical** (since version 5.0.3; AIX only) -  possible values:\\ //logical// (default), //​physical//​. |Example:\\ => system.cpu.util[0,​user,​avg5]\\ \\ Old naming: //​system.cpu.idleX,​ system.cpu.niceX,​ system.cpu.systemX,​ system.cpu.userX// ​ |+^ |CPU utilization ​percentage. ​ |Float ​ |**cpu** - //<CPU number>//​ or //all// (default)\\ **type** - possible values:\\ //user// (default), //idle//, //nice//, //system// (default for Windows), //iowait//, //​interrupt//,​ //​softirq//,​ //steal//, //guest// (on Linux kernels 2.6.24 and above), //​guest_nice//​ (on Linux kernels 2.6.33 and above).\\ See also [[:​manual/​appendix/​items/​supported_by_platform|platform-specific]] details for this parameter.\\ **mode** - possible values:\\ //avg1// (one-minute average, default), //avg5//, //avg15// \\ **logical_or_physical** (since version 5.0.3; AIX only) -  possible values:\\ //logical// (default), //​physical//​. |Example:\\ => system.cpu.util[0,​user,​avg5]\\ \\ Old naming: //​system.cpu.idleX,​ system.cpu.niceX,​ system.cpu.systemX,​ system.cpu.userX// ​ |
 | ||||| | |||||
 ^system.hostname[<​type>​] ​ ^^^^^ ^system.hostname[<​type>​] ​ ^^^^^
Line 209: Line 209:
 | ||||| | |||||
 ^vfs.file.exists[file,<​types_incl>,<​types_excl>​] ​ ^^^^^ ^vfs.file.exists[file,<​types_incl>,<​types_excl>​] ​ ^^^^^
-^ |Checks if file exists. ​ |0 - not found\\ \\ 1 - file of the specified type exists ​ |**file** - full path to file\\ **types_incl** - list of file types to include, possible values: //file// (regular file, default (if types_excl is not set)), //dir// (directory),​ //sym// (symbolic link), //sock// (socket), //bdev// (block device), //cdev// (characer ​device), //fifo// (FIFO), //dev// (synonymous with %%"​bdev,​cdev"​%%),​ //all// (all mentioned types, default if types_excl is set).\\ **types_excl** - list of file types to exclude, see types_incl for possible values (by default no types are excluded) |Multiple types must be separated with a comma and the entire set enclosed in quotes %%""​%%.\\ On Windows the double quotes have to be backslash '​\'​ escaped and the whole item key enclosed in double quotes when using the command line utility for calling zabbix_get.exe or agent2.\\ \\ If the same type is in both <​types_incl>​ and <​types_excl>,​ files of this type are excluded.\\ \\ Examples:\\ => vfs.file.exists[/​tmp/​application.pid]\\ => vfs.file.exists[/​tmp/​application.pid,​%%"​file,​dir,​sym"​%%]\\ => vfs.file.exists[/​tmp/​application_dir,​dir]\\ \\ The file size limit depends on [[manual:​appendix:​items:​large_file_support|large file support]].\\ \\ The ''​types_incl'',​ ''​types_excl''​ parameters are supported since Zabbix 5.0.2.\\ Note that the item may turn unsupported in Windows if a directory is searched within a non-existing directory, e.g. vfs.file.exists[C:​\no\dir,​dir] (where '​no'​ does not exist). ​ |+^ |Checks if file exists. ​ |0 - not found\\ \\ 1 - file of the specified type exists ​ |**file** - full path to file\\ **types_incl** - list of file types to include, possible values: //file// (regular file, default (if types_excl is not set)), //dir// (directory),​ //sym// (symbolic link), //sock// (socket), //bdev// (block device), //cdev// (character ​device), //fifo// (FIFO), //dev// (synonymous with %%"​bdev,​cdev"​%%),​ //all// (all mentioned types, default if types_excl is set).\\ **types_excl** - list of file types to exclude, see types_incl for possible values (by default no types are excluded) |Multiple types must be separated with a comma and the entire set enclosed in quotes %%""​%%.\\ On Windows the double quotes have to be backslash '​\'​ escaped and the whole item key enclosed in double quotes when using the command line utility for calling zabbix_get.exe or agent2.\\ \\ If the same type is in both <​types_incl>​ and <​types_excl>,​ files of this type are excluded.\\ \\ Examples:\\ => vfs.file.exists[/​tmp/​application.pid]\\ => vfs.file.exists[/​tmp/​application.pid,​%%"​file,​dir,​sym"​%%]\\ => vfs.file.exists[/​tmp/​application_dir,​dir]\\ \\ The file size limit depends on [[manual:​appendix:​items:​large_file_support|large file support]].\\ \\ The ''​types_incl'',​ ''​types_excl''​ parameters are supported since Zabbix 5.0.2.\\ Note that the item may turn unsupported in Windows if a directory is searched within a non-existing directory, e.g. vfs.file.exists[C:​\no\dir,​dir] (where '​no'​ does not exist). ​ |
 | ||||| | |||||
 ^vfs.file.md5sum[file] ​ ^^^^^ ^vfs.file.md5sum[file] ​ ^^^^^