Homepage of ZABBIX :: An Enterprise-Class Open Source Distributed Monitoring Solution

Product / Documentation / Configuration / Items /

Items
Supported by platform
ZABBIX Agent
SNMP Agent
Simple checks
Internal checks
Aggregate checks

ZABBIX Agent

Flexible and non-flexible parameters

Flexible parameter is parameter which accepts argument. For example, vfs.fs.free[*] is flexible parameter. * is any string that will be passed as argument of the parameter. vfs.fs.free[/], vfs.fs.free[/opt] - correct definitions.

String between [] may contain the following characters:

0-9a-zA-Z.:,()_/[space]

List of supported parameters

ZABBIX AGENT

Key	Description	Return value	Parameters	Comments
agent.ping	Check the agent usability.	Always return `1`.		Can be used as a TCP ping. *old naming:* "ping"
agent.version	Version of zabbix_agent(d) running on monitored host	String value.		Example of returned value: 1.0beta10
kernel.maxfiles	Maximum number of opened file supported by OS.	Number of files.
kernel.maxproc	Maximum number of processes supported by OS.	Number of processes.
net.if.collisions[if]	Out-of-window collision.	Number of collisions.	`if` - interface
net.if.in[if <,mode>]	Network interface incoming statistic.	Numeric value.	`if` - interface `mode` - bytes number of bytes (default) packets number of packets errors number of errors dropped number of dropped packets	Examples: `net.if.in[eth0,packets] net.if.in[eth1]` You may use this key with Delta (speed per second) in order to get bytes per second statistics.
net.if.out[if <,mode>]	Network interface outgoing statistic.	Numeric value.	`if` - interface `mode` - bytes number of bytes (default) packets number of packets errors number of errors dropped number of dropped packets	Examples: `net.if.out[eth0,errors] net.if.out[eth0]` You may use this key with Delta (speed per second) in order to get bytes per second statistics.
net.tcp.dns[ip, zone]	Checks if DNS service is up.	`0` - DNS is down `1` - DNS is up	`ip` - IP address of DNS server `zone` - zone to test the DNS	Example: `net.tcp.dns[127.0.0.1,zabbix.com]`
net.tcp.listen[port]	Checks if this port is in LISTEN state.	`0` - it is not `1` - it is in LISTEN state	`port` - port number	Example: `net.tcp.listen[80]`
net.tcp.port[<ip>, port]	Check, if it is possible to make TCP connection to port number `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`. Old naming: `check_port[*]`
net.tcp.service[service <,ip> <,port>]	Check if `service` is running and accepting TCP connections.	`0` - `service` is down `1` - `service` is running `2` - timeout connecting to the `service`	`service` - one of `ssh`, `service.ntp`, `ldap`, `smtp`, `ftp`, `http`, `pop`, `nntp`, `imap`, `tcp` `ip` - IP address (default is `127.0.0.1`) `port` - port number (by default standard `service` port number is used)	Example: `net.tcp.service[ftp,,45]` can be used to test availability of FTP server on TCP port 45. Old naming: `check_service[*]`
net.tcp.service.perf[service <,ip> <,port>]	Check performance of `service`	`0` - `service` is down `sec` - number of seconds spent while connecting to the `service`	`service` - one of `ssh`, `service.ntp`, `ldap`, `smtp`, `ftp`, `http`, `pop`, `nntp`, `imap`, `tcp` `ip` - IP address (default is `127.0.0.1`) `port` - port number (by default standard `service` port number is used)	Example: `net.tcp.service.perf[ssh]` can be used to test speed of initial response from SSH server. Old naming: `check_service[*]`
proc.mem[<name> <,user> <,mode><,cmdline>]	Memory used by process `name` running under user `user`	Memory used by process.	`name` - process name `user` - user name (default is all users) `mode` - one of `avg`, `max`, `min`, `sum` (default) `cmdline` - filter by command line	Example: `proc.mem[,root]` - memory used by all processes running under user "root". `proc.mem[zabbix_server,zabbix]` - memory used by all processes `zabbix_server` running under user `zabbix` `proc.mem[,oracle,max,oracleZABBIX]` - memory used by most memory hungry process running under `oracle` having `oracleZABBIX` in its command line
proc.num[<name> <,user> <,state><,cmdline>]	Number of processes `name` having `state` running under user `user`	Number of processes.	`name` - process name `user` - user name (default is all users) `state` - one of `all` (default), `run`, `sleep`, `zomb` `cmdline` - filter by command line	Example: `proc.num[,mysql]` - number of processes running under user `mysql` `proc.num[apache2,www-data]` - number of `apache2` running under user `www-data` `proc.num[,oracle,sleep,oracleZABBIX]` - number of processes in `sleep` state running under `oracle` having `oracleZABBIX` in its command line
system.cpu.intr	Device interrupts.	Interrupts counts.
system.cpu.load[<cpu> <,mode>]	CPU(s) load.	Processor load.	`cpu` - CPU number (default is all CPUs) `mode` - one of `avg1` (default),`avg5` (average within 5 minutes), `avg15`	Example: `system.cpu.load[]` Note that returned value is not percentage. Old naming: `system.cpu.loadX`
system.cpu.switches	Context switches.	Switches count.		Old naming: `system[switches]`
system.cpu.util[<cpu> <,type> <,mode>]	CPU(s) utilisation.	Processor load in percents	`cpu` - CPU number (default is all CPUs) `type` - one of `idle`, `nice`, `user` (default), `system` `mode` - one of `avg1` (default),`avg5` (average within 5 minutes), `avg15`	Old naming: `system.cpu.idleX`, `system.cpu.niceX`, `system.cpu.systemX`, `system.cpu.userX`
system.run[command<,mode>]	Run specified command on the host.	Text result of the command	`command` - command for execution `mode` - one of `wait` (default, wait end of execution), `nowait` (do no wait)	Example: `system.run[ls -l /]` - detailed file list of root directory. Note: To enable this functionality, agent configuration file must have `EnableRemoteCommands=1` option.
system.hostname	Return host name.	String value		Example of returned value www.zabbix.com
system.localtime	System local time.	Time in seconds.
system.swap.in[<device> <,type>]	Swap in.	Swap statistics	`device` - swap device (default is `all`), `type` - one of `count` (default, number of swapins), `pages` (pages swapped in)	Example: `system.swap.in[,bytes]` Old naming: `swap[in]`
system.swap.out[<device> <,type>]	Swap in.	Swap statistics	`device` - swap device (default is `all`), `type` - one of `count` (default, number of swapouts), `pages` (pages swapped out)	Example: `system.swap.out[,pages]` Old naming: `swap[out]`
system.swap.size[<device> <,mode>]	Swap space.	Number of bytes or percentage	`device` - swap device (default is `all`), `type` - one of `free` (default, free swap space), `total` (total swap space), `pfree` (free swap space, percentage), `pused` (used swap space, percentage)	Example: `system.swap.size[,pfree]` - percentage of free swap space Old naming: `system.swap.free`, `system.swap.total`
system.uname	Returns detailed host information.	String value		Example of returned value: FreeBSD localhost 4.4-RELEASE FreeBSD 4.4-RELEASE #0: Tue Sep 18 11:57:08 PDT 2001 murray@builder.FreeBSD.org: /usr/src/sys/compile/GENERIC i386
system.uptime	System's uptime in seconds.	Number of seconds		Use Units `s` or `uptime` to get readable values.
system.users.num	Number of users connected.	Number of users		Command `who` is used on agent side.
vfs.dev.read[device <,type>]	Disk read statistics.	Numeric value	`device` - disk device (default is `all`), `type` - one of `sectors` (default), `operations`	Example: `vfs.dev.read[,operations]` Old naming: `io[*]`
vfs.dev.write[device <,type>]	Disk write statistics.	Numeric value	`device` - disk device (default is `all`), `type` - one of `sectors` (default), `operations`	Example: `vfs.dev.write[,operations]` Old naming: `io[*]`
vfs.file.cksum[file]	Calculate file check sum	File check sum calculated by algorithm used by UNIX `cksum`.	`file` - full path to file	Example of returned value: 1938292000 Example: `vfs.file.cksum[/etc/passwd]`
vfs.file.exists[file]	Check if file exists	`0` - file does not exist `1` - file exists	`file` - full path to file	Example: `vfs.file.exists[/tmp/application.pid]`
vfs.file.md5sum[file]	File's MD5 check sum	MD5 hash of the file. Can be used only for files less than 64MB, unsupported otherwise.		Example of returned value: b5052decb577e0fffd622d6ddc017e82 Example: `vfs.file.md5sum[/etc/zabbix/zabbix_agentd.conf]`
vfs.file.regexp[file, regexp]	Find string in a file	Matched string	`file` - full path to file, `regexp` - GNU regular expression	Example: `vfs.file.regexp[/etc/passwd,zabbix]`
vfs.file.regmatch[file, regexp]	Find string in a file	`0` - expression not found `1` - found	`file` - full path to file, `regexp` - GNU regular expression	Example: `vfs.file.regexp[/var/log/app.log,error]`
vfs.file.size[file]	File size	Size in bytes.	`file` - full path to file	File must have read permissions for user `zabbix` Example: `vfs.file.size[/var/log/syslog]`
vfs.file.time[file<, mode>]	File time information.	Number of seconds.	`file` - full path to file `mode` - one of `modify` (default, modification time), `access` - last access time, `change` - last change time	Example: `vfs.file.time[/etc/passwd,modify]`
vfs.fs.inode[fs <,mode>]	Number of inodes	Numeric value	`fs` - filesystem, `mode` - one of `total` (default), `free`, `used`, `pfree` (free, percentage), `pused` (used, percentage)	Example: `vfs.fs.inode[/,pfree]` Old naming: `vfs.fs.inode.free[]`, `vfs.fs.inode.pfree[]`, `vfs.fs.inode.total[*]`
vfs.fs.size[fs <,mode>]	Disk space	Disk space in KB	`fs` - filesystem, `mode` - one of `total` (default), `free`, `used`, `pfree` (free, percentage), `pused` (used, percentage)	In case of a mounted volume, disk space for local file system is returned. Example: `vfs.fs.size[/tmp,free]` Old naming: `vfs.fs.free[]`, `vfs.fs.total[]`, `vfs.fs.used[]`, `vfs.fs.pfree[]`, `vfs.fs.pused[*]`
vm.memory.size[<mode>]	Memory size	Memory size in bytes	`mode` - one of `total` (default), `shared`, `total`, `buffers`, `cached`	Old naming: `vm.memory.buffers`, `vm.memory.cached`, `vm.memory.free`, `vm.memory.shared`, `vm.memory.total`
web.page.get[host,<path>,<port>]	Get content of WEB page	`host` - hostname, `path` - path to HTML document (default is /), `port` - port number (default is 80)	WEB page source as text	Returns `EOF` on fail. Example: `web.page.get[www.zabbix.com,index.php,80]`
web.page.perf[host,<path>,<port>]	Get timing of loading full WEB page	Time in seconds	`host` - hostname, `path` - path to HTML document (default is /), `port` - port number (default is 80)	Example: `web.page.perf[www.zabbix.com,index.php,80]`
web.page.regexp[host, <path>, <port>, <regexp>, <length>,]	Get first occurence of regexp in WEB page	Matched string	`host` - hostname, `path` - path to HTML document (default is /), `port` - port number (default is 80), `regexp` - GNU regular expression, `length` - number of characters to return	Returns `EOF` on fail. Example: `web.page.get[www.zabbix.com, index.php, 80, OK, 2]`

Linux-specific note. ZABBIX agent must have read-onle access to filesystem /proc. Kernel patches from www.grsecurity.org limit access rights of non-privileged users.

WIN32-SPECIFIC PARAMETERS

This section contains description of parameter supported by ZABBIX WIN32 agent only.

Key	Description	Return value	Comments
agent[avg_collector_time]	Average time spent by collector thread on each sample processing for last minute.	Time in milliseconds
agent[max_collector_time]	Maximum time spent by collector thread on each sample processing for last minute.	Time in milliseconds
agent[accepted_requests]	Total number of requests accepted by agent for processing.	Number of requests
agent[rejected_requests]	Total number of requests rejected by agent for processing.	Number of requests
agent[timed_out_requests]	Total number of requests timed out in processing.	Number of requests
agent[accept_errors]	Total number of accept() system call errors.	Number of system calls
agent[processed_requests]	Total number of requests successfully processed by agent.	Number of requests
agent[failed_requests]	Total number of requests with errors in processing.	Number of requests	These requests generated ZBX_ERROR return code
agent[unsupported_requests]	Total number of requests for unsupported parameters.	Number of requests	These requests generated ZBX_UNSUPPORTED return code
perf_counter[*]	Value of any performance counter, where parameter is the counter path.	Value of the counter	Performance Monitor can be used to obtain list of available counters. Note that this parameter will return correct value only for counters that require just one sample (like `\System\Threads`). It will not work as expected for counters that require more that one sample - like CPU utilisation.
service_state[*]	State of service. Parameter is service name.	0 - running 1 - paused 2 - start pending 3 - pause pending 4 - continue pending 5 - stop pending 6 - stopped 7 - unknown 255 - SCM communication error	Parameter must be real service name as it seen in service properties under "Name:", not service display name!
proc_info[<process>:<attribute>:<type>]	Different information about specific process(es).	<process> - process name (same as in proc_cnt[] parameter) <attribute> - requested process attribute.	The following attributes are currenty supported: vmsize - Size of process virtual memory in Kbytes wkset - Size of process working set (amount of physical memory used by process) in Kbytes pf - Number of page faults ktime - Process kernel time in milliseconds utime - Process user time in milliseconds io_read_b - Number of bytes read by process during I/O operations io_read_op - Number of read operation performed by process io_write_b - Number of bytes written by process during I/O operations io_write_op - Number of write operation performed by process io_other_b - Number of bytes transferred by process during operations other than read and write operations io_other_op - Number of I/O operations performed by process, other than read and write operations gdiobj - Number of GDI objects used by process userobj - Number of USER objects used by process <type> - representation type (meaningful when more than one process with the same name exists). Valid values are: min - minimal value among all processes named <process> max - maximal value among all processes named <process> avg - average value for all processes named <process> sum - sum of values for all processes named <process> Examples: 1. In order to get the amount of physical memory taken by all Internet Explorer processes, use the following parameter: proc_info[iexplore.exe:wkset:sum] 2. In order to get the average number of page faults for Internet Explorer processes, use the following parameter: proc_info[iexplore.exe:pf:avg] Note: All io_xxx,gdiobj and userobj attributes available only on Windows 2000 and later versions of Windows, not on Windows NT 4.0.