User Tools

Site Tools


Sidebar

1.8:manual:config:items

19 Items

An item is a single performance or availability check (metric).

1 Item key

1.1 Flexible and non-flexible parameters

A flexible parameter is a parameter which accepts an argument. For example, vfs.fs.size[*] is a flexible parameter. '*' is any string that will be passed as an argument to the parameter. Correct definition examples:

  • vfs.fs.size[/]
  • vfs.fs.size[/opt]
1.2 Key format

Item key format, including key parameters, must follow syntax rules. The following illustrations depict supported syntax. Allowed elements and characters at each point can be determined by following the arrows - if some block can be reached through the line, it is allowed, if not - it is not allowed.

Item key

To construct a valid item key, one starts with specifying the key name, then there's a choice to either have parameters or not - as depicted by the two lines that could be followed.

Key name

The key name itself has a limited range of allowed characters, which just follow each other. Allowed characters are:

0-9a-zA-Z_-.

Which means:

  • all numbers;
  • all lowercase letters;
  • all uppercase letters;
  • underscore;
  • dash;
  • dot.

Key parameters

An item key can have multiple parameters that are comma separated.

Individual key parameter

Each key parameter can be either a quoted string, an unquoted string or an array.

The parameter can also be left empty, thus using the default value. In that case, the appropriate number of commas must be added if any further parameters are specified. For example, item key icmpping[,,200,,500] would specify that the interval between individual pings is 200 milliseconds, timeout - 500 milliseconds, and all other parameters are left at their defaults.

Parameter - quoted string

If the key parameter is a quoted string, any Unicode character is allowed, and included double quotes must be backslash escaped.

Parameter - unquoted string

If the key parameter is an unquoted string, any Unicode character is allowed except comma and right square bracket (]).

Parameter - array

If the key parameter is an array, it is again enclosed in square brackets, where individual parameters come following multiple parameters specifying rules and syntax.

1.3 Available encodings

The parameter “encoding” is used to specify encoding for processing corresponding item checks, so that data acquired will not be corrupted. For a list of supported encodings (code page identifiers), please consult respective documentation, such as documentation for libiconv (GNU Project) or Microsoft Windows SDK documentation for “Code Page Identifiers”. If an empty “encoding” parameter is passed, then ANSI with system specific extension (Windows) or UTF-8 (default locale for newer Unix/Linux distributions, see your system's settings) is used by default.

2 Unsupported items

An item can become unsupported if its value can not be retrieved for some reason. Such items are still rechecked at a fixed interval, configurable in Administration section.

3 Supported by Platform

In the following lists parameters that are included in angle brackets <like_this> are optional.

Items marked with “X” are supported, the ones marked with ”-” are not supported.
If an item is marked with ”?”, it is not known whether it is supported or not.
If an item is marked with “r”, it means that it requires root privileges.
If a parameter is marked with “i”, it means that it is ignored.

NetBSD
OpenBSD▼▼
Mac OS X▼▼
Tru64▼▼
AIX▼▼
HP-UX▼▼
Solaris▼▼
FreeBSD▼▼
Linux 2.6▼▼
Linux 2.4▼▼
Windows▼▼
Parameter / system ▼▼
▼▼ 1 2 3 4 5 6 7 8 9 10 11
agent.hostname X X X X X X X X X X X
agent.ping X X X X X X X X X X X
agent.version X X X X X X X X X X X
kernel.maxfiles - X X X - - - ? X X X
kernel.maxproc - - X X X - - ? X X X
log[file,<regexp>,<encoding>,<maxlines>] X X X X X X X X X X X
logrt[file_format,<regexp>,<encoding>,<maxlines>] X X X X X X X X X X X
eventlog[name,<regexp>,<severity>,<source>,<eventid>,
<maxlines>]
X - - - - - - - - - -
net.if.collisions[if] - X X X X - X - - X r
net.if.in[if,<mode>] X X X X X - X - - X r
modebytes (default) X X X X X1 - X - - X r
packets X X X X X - X - - X r
errors X X X X X1 - X - - X r
dropped X X X X - - - - - X r
net.if.list X - - - - - - - - - -
net.if.out[if,<mode>] X X X X X - X - - X r
modebytes (default) X X X X X1 - X - - X r
packets X X X X X - X - - X r
errors X X X X X1 - X - - X r
dropped X X X - - - - - - - -
net.if.total[if,<mode>] X X X X X - X - - X r
modebytes (default) X X X X X1 - X - - X r
packets X X X X X - X - - X r
errors X X X X X1 - X - - X r
dropped X X X - - - - - - - -
net.tcp.dns[<ip>,zone] - X X X X X X X X X X
net.tcp.dns.query[<ip>,zone,<type>] - X X X X X X X X X X
net.tcp.listen[port] X X X X X - - - - - -
net.tcp.port[<ip>,port] X X X X X X X X X X X
net.tcp.service[service,<ip>,<port>] X X X X X X X X - X X
net.tcp.service.perf[service,<ip>,<port>] X X X X X X X X - X X
net.udp.listen[port] - X X - - - - - - - -
1 2 3 4 5 6 7 8 9 10 11
proc.mem[<name>,<user>,<mode>,<cmdline>] - X X X X - X X ? X X
modesum (default) - X X X X - X X ? X X
avg - X X X X - X X ? X X
max - X X X X - X X ? X X
min - X X X X - X X ? X X
proc.num[<name>,<user>,<state>,<cmdline>] X X X X X - X X ? X X
stateall (default) - X X X X - X X ? X X
sleep - X X X X - X X ? X X
zomb - X X X X - X X ? X X
run - X X X X - X X ? X X
sensor[device,sensor,<mode>] - X - - - - - - - X -
services[<type>,<state>,<exclude>] X - - - - - - - - - -
system.boottime - X X X X - - - - X X
system.cpu.intr - X X X X - X - - X X
system.cpu.load[<cpu>,<mode>] X X X X X X - X ? X X
modeavg1 (default) X X X X X X - X ? X X
avg5 X X X X X X - X ? X X
avg15 X X X X X X - X ? X X
system.cpu.num[<type>] X X X X X X X - - X X
typeonline (default) X X X X X X X - - X X
max - X X X X - - - - - -
system.cpu.switches - X X X X - X - - X X
system.cpu.util[<cpu>,<type>,<mode>] X X X X X X X X ? X X
typeuser (default) - X X X X X X X ? X X
nice - X X X - X - X ? X X
idle - X X X X X X X ? X X
system X X X X - X X X ? X X
kernel - - - - X - - - - - -
iowait - - X - - - X - - - -
wait - - - - X - - - - - -
interrupt - - X X - - - - - X -
softirq - - X - - - - - - - -
steal - - X - - - - - - - -
modeavg1 (default) X X X X - X X X ? X -
avg5 X X X X - X X - ? X -
avg15 X X X X - X X - ? X -
1 2 3 4 5 6 7 8 9 10 11
system.hostname[<type>] X X X X X X X X X X X
system.localtime X X X X X X X X X X X
typeutc (default) X X X X X X X X X X X
local X X X X X X X X X X X
system.run[command,<mode>] X X X X X X X X X X X
modewait (default) X X X X X X X X X X X
nowait X X X X X X X X X X X
system.stat[resource,<type>] - - - - - - X - - - -
system.swap.in[<device>,<type>] (specifying a device is only supported under Linux)- X X - X - - - - X -
type
(pages will only work if
device was not specified)
count (default under all except Linux)- X X - X - - - - X -
sectors - X X - - - - - - - -
pages (default under Linux)- X X - X - - - - X -
system.swap.out[<device>,<type>] (specifying a device is only supported under Linux)- X X - X - - - - X -
type
(pages will only work if
device was not specified)
count (default under all except Linux)- X X - X - - - - X -
sectors - X X - - - - - - - -
pages (default under Linux)- X X - X - - - - X -
system.swap.size[<device>,<type>] X X X X X - - X ? X -
typefree (default) X X X X X - - X ? X -
total X X X X X - - X ? X -
used - X X X - - - - - X -
pfree - X X X X - - - ? X -
pused - X X X X - - - ? X -
system.uname X X X X X X X X - X X
system.uptime X X X X X - X ? ? X X
system.users.num - X X X X X X X - X X
1 2 3 4 5 6 7 8 9 10 11
vfs.dev.read[<device>,<type>,<mode>] - X X X X - - - - X -
type

(defaults are different
under various OSes)
sectors - X X - - - - - - - -
operations - X X X X - - - - X -
bytes - - - X X - - - - X -
sps - X X - - - - - - - -
ops - X X X - - - - - - -
bps - - - X - - - - - - -
mode
(compatible only with
type in: sps, ops, bps)
avg1 (default) - X X X - - - - - i -
avg5 - X X X - - - - - i -
avg15 - X X X - - - - - i -
vfs.dev.write[<device>,<type>,<mode>] - X X X X - - - - X -
type

(defaults are different
under various OSes)
sectors - X X - - - - - - - -
operations - X X X X - - - - X -
bytes - - - X X - - - - X -
sps - X X - - - - - - - -
ops - X X X - - - - - - -
bps - - - X - - - - - - -
mode
(compatible only with
type in: sps, ops, bps)
avg1 (default) - X X X - - - - - i -
avg5 - X X X - - - - - i -
avg15 - X X X - - - - - i -
vfs.file.cksum[file] X X X X X X X X - X X
vfs.file.exists[file] X X X X X X X X X X X
vfs.file.md5sum[file] X X X X X X X X - X X
vfs.file.regexp[file,regexp,<encoding>] X X X X X X X X - X X
vfs.file.regmatch[file,regexp,<encoding>] X X X X X X X X - X X
vfs.file.size[file] X X X X X X X X - X X
1 2 3 4 5 6 7 8 9 10 11
vfs.file.time[file,<mode>] X X X X X X X X - X X
modemodify (default) X X X X X X X X - X X
access X X X X X X X X - X X
change X X X X X X X X - X X
vfs.fs.inode[fs,<mode>] - X X X X X X X ? X X
modetotal (default) - X X X X X X X ? X X
free - X X X X X X X ? X X
used - X X X X X X X ? X X
pfree - X X X X X X X ? X X
pused - X X X X X X X ? X X
vfs.fs.size[fs,<mode>] X X X X X X X X ? X X
modetotal (default) X X X X X X X X ? X X
free X X X X X X X X ? X X
used X X X X X X X X ? X X
pfree X X X X X X X X ? X X
pused X X X X X X X X ? X X
vm.memory.size[<mode>] X X X X X X X X ? X X
modetotal (default) X X X X X X X X ? X X
free X X X X X X X X ? X X
used - - - X - - - - - X X
shared - X X X - - - - ? X X
buffers - X X - - - - - ? X X
cached X X X X - - X - ? X X
pfree X X X X - - - - - X X
pused - - - X - - - - - X X
available - X X - - - - - - - -
web.page.get[host,<path>,<port>] X X X X X X X X X X X
web.page.perf[host,<path>,<port>] X X X X X X X X X X X
web.page.regexp[host,<path>,<port>,<regexp>,<length>] X X X X X X X X X X X
1 2 3 4 5 6 7 8 9 10 11

(1) These values for these items are not supported for loopback interfaces on Solaris systems prior to Solaris 10 6/06 as byte, error and utilisation statistics are not stored and/or reported by the kernel. However, if you're monitoring a Solaris system via net-snmp, values may be returned as net-snmp carries legacy code from the cmu-snmp dated as old as 1997 that, upon failing to read byte values from the interface statistics returns the packet counter (which does exist on loopback interfaces) multiplied by an arbitrary value of 308. This makes the assumption that the average length of a packet is 308 octets, which is a very rough estimation as the MTU limit on Solaris systems for loopback interfaces is 8892 bytes.

These values should not be assumed to be correct or even closely accurate. They are guestimates. The Zabbix agent does not do any guess work, but net-snmp will return a value for these fields.

4 Zabbix Agent

List of supported parameters

Key
Description Return value Parameters Comments
agent.hostname
Returns agent host name. String value - Returns the actual value of the agent hostname from a configuration file.
This item is supported starting from version 1.8.13.
agent.ping
Check the agent availability. Returns '1' if agent is available, nothing if unavailable. - Use function nodata() to check for host unavailability.
agent.version
Version of Zabbix Agent. String - Example of returned value: 1.8.2
kernel.maxfiles
Maximum number of opened files supported by OS. Number of files. Integer.
kernel.maxproc
Maximum number of processes supported by OS. Number of processes.
Integer.
log[file,<regexp>,<encoding>,<maxlines>]
Monitoring of log file. Log. file – full file name
regexp – regular expression for pattern
encoding - Code Page identifier
maxlines - Maximum number of new lines per second the agent will send to Zabbix Server or Proxy. This parameter overrides the 'MaxLinesPerSecond' option in zabbix_agentd.conf
Must be configured as an Active Check.
Example:
log[/home/zabbix/logs/logfile,,,100]
See detailed description.
logrt[file_pattern,<regexp>,<encoding>,<maxlines>]
Monitoring of log file with log rotation support. Log. file_pattern – absolute path to file and regexp describing the file name pattern
regexp – regular expression describing the required content pattern
encoding - Code Page identifier
maxlines - Maximum number of new lines per second the agent will send to Zabbix Server or Proxy. This parameter overrides the 'MaxLinesPerSecond' option in zabbix_agentd.conf
Must be configured as an Active Check.

Examples:
logrt["/home/zabbix/logs/^logfile[0-9]{1,3}$",,,100] - will match a file like "logfile1" (will not match ".logfile1")
logrt["/home/user/logfile_.*_[0-9]{1,3}","pattern_to_match","UTF-8",100] - will collect data from files such “logfile_abc_1” or “logfile__001”.

Log rotation is based on last modification times of files.
See detailed description.
eventlog[name,<regexp>,<severity>,<source>,<eventid>,<maxlines>]
Monitoring of event logs. Log. name – event log name
regexp – regular expression
severity – regular expression
The parameter accepts the following values: “Information”, “Warning”, “Error”, “Failure Audit”, “Success Audit”
source - Source identifier
eventid - regular expression
maxlines - Maximum number of new lines per second the agent will send to Zabbix Server or Proxy. This parameter overrides the 'MaxLinesPerSecond' option in zabbix_agentd.conf
Must be configured as an Active Check.

Examples:

eventlog[Application]

eventlog[Security,,"Failure Audit",,529|680]

eventlog[System,,"Warning|Error"]

eventlog[System,,,,^1$]

eventlog[System,,,,@TWOSHORT] - here custom regular expression TWOSHORT is defined as type Result is TRUE and expression itself is ^1$|^70$.
net.if.collisions[if]
Out-of-window collision. Number of collisions.
Integer.
if - interface
net.if.in[if,<mode>]
Network interface incoming statistic. Integer. if - interface
mode
bytes number of bytes (default)
packets number of packets
errors number of errors
dropped number of dropped packets
Multi-byte interface names on Windows supported since Zabbix agent version 1.8.6.

Examples:
net.if.in[eth0,errors]
net.if.in[eth0]
You may use this key with Delta (speed per second) in order to get bytes per second statistics.
net.if.list
List of network interfaces: Type Status IPv4 Description String Supported since Zabbix agent version 1.8.1. Multi-byte interface names supported since Zabbix agent version 1.8.6. Disabled interfaces are not listed.

Note that enabling/disabling some components may change their ordering in the Windows interface name.
net.if.out[if,<mode>]
Network interface outgoing statistic. Integer. if - interface
mode
bytes number of bytes (default)
packets number of packets
errors number of errors
dropped number of dropped packets
Multi-byte interface names on Windows supported since Zabbix agent version 1.8.6.

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.if.total[if,<mode>]
Sum of network interface incoming and outgoing statistics. Integer. if - interface
mode
bytes number of bytes (default)
packets number of packets
errors number of errors
dropped number of dropped packets
Examples:
net.if.total[eth0,errors]
net.if.total[eth0]
You may use this key with Delta (speed per second) in order to get bytes per second statistics.
Note that dropped packets are supported only if both net.if.in and net.if.out work for dropped packets on your platform.
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 (ignored)
zone - zone to test the DNS
Example:
net.tcp.dns[127.0.0.1,zabbix.com]

Internationalized domain names are not supported, please use IDNA encoded names instead.
net.tcp.dns.query[<ip>,zone,<type>]
Performs a query for the supplied DNS record type. On success returns a character string with the required type of information. ip - IP address of DNS server (ignored)
zone - zone to test the DNS
type - Record type to be queried (default is SOA)
Example:
net.tcp.dns.query[127.0.0.1,zabbix.com,MX]
type can be one of:
A, NS, CNAME, MB, MG, MR, PTR, MD, MF, MX, SOA, NULL, WKS, HINFO, MINFO, TXT, SRV

SRV record type is supported on Unix since Zabbix agent version 1.8.6.

Internationalized domain names are not supported, please use IDNA encoded names instead.
net.tcp.listen[port]
Checks if this TCP port is in LISTEN state. 0 - it is not
1 - it is in LISTEN state
port - TCP port number Example:
net.tcp.listen[80]

On Linux supported since Zabbix agent version 1.8.4
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[*]
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).
net.tcp.service[service,<ip>,<port>]
Check if service is running and accepting TCP connections. 0 - service is down
1 - service is running
service - one of ssh, 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[*]
Note that before Zabbix version 1.8.3 service.ntp should be used instead of ntp.
Note that these checks may result in additional messages in system daemon logfiles (SMTP and SSH sessions being logged usually).
Checking of encrypted protocols (like IMAP on port 993 or POP on port 995) is currently not supported. As a workaround, please use net.tcp.port for checks like these.
Checking of LDAP by Windows agent is currently not supported.
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, 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_perf[*]
Note that before Zabbix version 1.8.3 service.ntp should be used instead of ntp.
Checking of encrypted protocols (like IMAP on port 993 or POP on port 995) is currently not supported. As a workaround, please use net.tcp.service.perf[tcp,<ip>,<port>] for checks like these.
Checking of LDAP by Windows agent is currently not supported.
net.udp.listen[port]
Checks if this UDP port is in LISTEN state. 0 - it is not
1 - it is in LISTEN state
port - UDP port number Example:
net.udp.listen[68]

On Linux supported since Zabbix agent version 1.8.4
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
On Windows, only name and user arguments are supported.
sensor[device,sensor,<mode>]
Hardware sensor reading. device - device name (if <mode> is used, it is a regular expression)
sensor - sensor name (if <mode> is used, it is a regular expression)
mode - one of avg, max, min (if omitted, device and sensor are treated verbatim).
On Linux 2.4, reads /proc/sys/dev/sensors. Example:
sensor[w83781d-i2c-0-2d,temp1]
Prior to Zabbix 1.8.4, format sensor[temp1] was used.

On OpenBSD, reads hw.sensors MIB. Example:
sensor[cpu0,temp0] - one temperature of one CPU
sensor[cpu[0-2]$,temp,avg] - average temperature of the first three CPU's
Supported on OpenBSD since Zabbix 1.8.4.
system.boottime
Timestamp of system boot. Integer. Time in seconds.
system.cpu.intr
Device interrupts. Integer.
system.cpu.load[<cpu>,<mode>]
CPU load.Processor load.
Float.
cpu - CPU number (default is all CPUs, only default “all” is supported)
mode - one of avg1 (default),avg5 (average within 5 minutes), avg15
Example:
system.cpu.load[]
Old naming: system.cpu.loadX
system.cpu.num[<type>]
Number of CPUs. Number of available processors. type - one of online (default), max Example:
system.cpu.num
system.cpu.switches
Context switches. Switches count. Old naming: system[switches]
system.cpu.util[<cpu>,<type>,<mode>]
CPU(s) utilisation. Processor utilisation in percents cpu - CPU number (default is all CPUs)
type - one of idle, nice, user (default), system, kernel, iowait, interrupt, softirq, steal
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
Example:
system.cpu.util[0,user,avg5]
system.hostname[<type>]
Returns host name. String value type (only on Windows, ignored on other systems) - netbios (default) or host On Windows the value is acquired from either GetComputerName() (for netbios) or gethostname() (for host) function and from “hostname” command on other systems.

Example of returned value
www.zabbix.com

Parameter for this item is supported starting from version 1.8.6.
system.localtime
System time. Integer or string value. utc - (default) the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds.
local - the time in the 'yyyy-mm-dd,hh:mm:ss.nn,+hh:mm' format
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 not 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.stat[resource,<type>]
Virtual memory statistics Numeric value ent - number of processor units this partition is entitled to receive (float)
kthr,<type> - information about kernel thread states:
r - average number of runnable kernel threads (float)
b - average number of kernel threads placed in the Virtual Memory Manager wait queue (float)
memory,<type> - information about the usage of virtual and real memory:
avm - active virtual pages (integer)
fre - size of the free list (integer)
page,<type> - information about page faults and paging activity:
fi - file page-ins per second (float)
fo - file page-outs per second (float)
pi - pages paged in from paging space (float)
po - pages paged out to paging space (float)
fr - pages freed (page replacement) (float)
sr - pages scanned by page-replacement algorithm (float)
faults,<type> - trap and interrupt rate:
in - device interrupts (float)
sy - system calls (float)
cs - kernel thread context switches (float)
cpu,<type> - breakdown of percentage usage of processor time:
us - user time (float)
sy - system time (float)
id - idle time (float)
wa - idle time during which the system had outstanding disk/NFS I/O request(s) (float)
pc - number of physical processors consumed (float)
ec - the percentage of entitled capacity consumed (float)
lbusy - indicates the percentage of logical processor(s) utilization that occurred while executing at the user and system level (float)
app - indicates the available physical processors in the shared pool (float)
disk,<type> - disk statistics:
bps - indicates the amount of data transferred (read or written) to the drive in bytes per second (integer)
tps - indicates the number of transfers per second that were issued to the physical disk/tape (float)
This item is supported starting from version 1.8.1.
system.swap.in[<device>,<type>]
Swap in (from device, into memory) statisticsNumeric valuedevice - swap device (default is all), type - one of count (number of swapins), sectors (sectors swapped in), pages (pages swapped in). See supported by platform for details on defaults.Example: system.swap.in[,pages]
Old naming: swap[in]
system.swap.out[<device>,<type>]
Swap out (from memory, onto device) statisticsNumeric valuedevice - swap device (default is all), type - one of count (number of swapouts), sectors (sectors swapped out), pages (pages swapped out). See supported by platform for details on defaults.Example: system.swap.out[,pages]
Old naming: swap[out]
system.swap.size[<device>,<type>]
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>,<mode>]
Disk read statistics. Integer for type in: sectors, operations, bytes
Float for type in: sps, ops, bps
device - disk device (default is “all”1)
type - one of sectors, operations, bytes, sps, ops, bps (must specify exactly which parameter to use, since defaults are different under various OSes).
sps, ops, bps means: sectors, operations, bytes per second respectively
mode - one of avg1 (default),avg5 (average within 5 minutes), avg15.
Compatible only with type in: sps, ops, bps
Default values of 'type' parameter for different OSes:
FreeBSD - bps
Linux - sps
OpenBSD - operations
Solaris - bytes

Example: vfs.dev.read[,operations] Old naming: io[*]

The type parameters ops, bps and sps on supported platforms are limited to 8 devices (7 individual devices and one “all”).

Supports LVM since Zabbix 1.8.6.

Until Zabbix 1.8.6, only relative device names may be used (for example, sda), since 1.8.6 optional /dev/ prefix may be used (for example, /dev/sda)
vfs.dev.write[<device>,<type>,<mode>]
Disk write statistics. Integer for type in: sectors, operations, bytes
Float for type in: sps, ops, bps
device - disk device (default is “all”1)
type - one of sectors, operations, bytes, sps, ops, bps (must specify exactly which parameter to use, since defaults are different under various OSes).
sps, ops, bps means: sectors, operations, bytes per second respectively
mode - one of avg1 (default),avg5 (average within 5 minutes), avg15.
Compatible only with type in: sps, ops, bps
Default values of 'type' parameter for different OSes:
FreeBSD - bps
Linux - sps
OpenBSD - operations
Solaris - bytes

Example: vfs.dev.write[,operations] Old naming: io[*]

The type parameters ops, bps and sps on supported platforms are limited to 8 devices (7 individual devices and one “all”).

Supports LVM since Zabbix 1.8.6.

Until Zabbix 1.8.6, only relative device names may be used (for example, sda), since 1.8.6 optional /dev/ prefix may be used (for example, /dev/sda)
vfs.file.cksum[file]
Calculate file checksum File checksum, calculated by algorithm used by UNIX cksum. file - full path to file Example of returned value:
1938292000

Example:
vfs.file.cksum[/etc/passwd]

Old naming: cksum
vfs.file.exists[file]
Check if file exists 1 - regular file or a link (symbolic or hard) to regular file exists.

0 - otherwise
file - full path to file Example: vfs.file.exists[/tmp/application.pid]

The return value depends on what S_ISREG POSIX macro returns.
vfs.file.md5sum[file]
File's MD5 checksum MD5 hash of the file. file - full path to file Example of returned value:
b5052decb577e0fffd622d6ddc017e82

Example:
vfs.file.md5sum[/etc/zabbix/zabbix_agentd.conf]

The file size limit (64 MB) for this item was removed in version 1.8.6.
vfs.file.regexp[file,regexp,<encoding>]
Find string in a file Matched string or EOF if expression not found file - full path to file
regexp - GNU regular expression
encoding - Code Page identifier
Only the first matching line is returned.
Example: vfs.file.regexp[/etc/passwd,zabbix]
vfs.file.regmatch[file,regexp,<encoding>]
Find string in a file 0 - expression not found
1 - found
file - full path to file
regexp - GNU regular expression
encoding - Code Page identifier
Example: vfs.file.regmatch[/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. Unix timestamp. file - full path to the 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 bytes 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, free, buffers, cached, pfree, available 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 Web page source as text host - hostname
path - path to HTML document (default is /)
port - port number (default is 80)
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)
Returns 0 on fail. Example:
web.page.perf[www.zabbix.com,index.php,80]
web.page.regexp[host,<path>,<port>,<regexp>,<length>]
Get first occurrence 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 - maximum number of characters to return
Returns EOF in case of no match or any other failures (such as timeout, failed connection, etc). Example:
web.page.regexp[www.zabbix.com,index.php,80,OK,2]

See this section for the difference of an item being performed as a passive or an active check.

[1] If default “all” is used for the first parameter of vfs.dev.* keys then the keys will return summary statistics, including: all block devices like sda, sbd and their partitions sda1, sda2, sdb3 … and multiple devices (MD raid) based on those block devices/partitions and logical volumes (LVM) based on those block devices/partitions.
In such cases returned values should be considered only as relative value (dynamic in time) but not as absolute values.

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

5 Windows-specific parameters

This section contains descriptions of parameters supported by Zabbix Windows agent only.

Key
Description Return value Comments
perf_counter[counter,<interval>]
Value of any performance counter, where “counter” is the counter path, and “interval” is the time period for storing the average value.Average value of the “counter” during last “interval” seconds. Default value, if not given, for “interval” is 1. Performance Monitor can be used to obtain list of available counters. Until version 1.6 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. Since 1.6 interval is used, so the check returns an average value for last “interval” seconds every time.
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 – no such service
Parameter must be real service name as seen in service properties under “Name:” or name of EXE file.
services[<type>,<state>,<exclude>]
List of services, separated by a newline or 0, if list would be empty. type - one of all (default), automatic, manual, disabled
state - one of all (default), stopped, started, start_pending, stop_pending, running, continue_pending, pause_pending, paused
exclude - list of services to exclude it from the result.
Excluded services should be written in double quotes, separated by comma, without spaces.
This parameter is supported starting from version 1.8.1.
Examples:
services[,started] - list of started services
services[automatic, stopped] - list of stopped services, that should be run
services[automatic, stopped, “service1,service2,service3”] - list of stopped services, that should be run, excluding services with names service1,service2 and service3
proc_info[<process>,<attribute>,<type>]
Different information about specific process(es). <process> - process name (same as in proc_cnt[] parameter)
<attribute> - requested process attribute.
<type> - representation type (meaningful when more than one process with the same name exists)
The following attributes are currently 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

Valid types 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.

6 SNMP Agent

Zabbix must be configured with SNMP support in order to be able to retrieve data provided by SNMP agents.

If monitoring SNMPv3 devices, make sure that msgAuthoritativeEngineID (also known as snmpEngineID or “Engine ID”) is never shared by two devices. It must be unique for each device.

For SNMPv3 privacy and authentication currently MD5 and DES protocols are supported.

The following steps have to be performed in order to add monitoring of SNMP parameters:

Step 1

Create a host for the SNMP device.

Enter an IP address. Set the host Status to NOT MONITORED. You can use one of the SNMP templates (Template_SNMPv1_Device, Template_SNMPv2_Device), which will automatically add the set of items. However, the template may not be compatible with the host.

SNMP checks do not use Agent port, it is ignored.

Step 2

Find out the SNMP string of the item you want to monitor.

After creating the host, use 'snmpwalk' (part of ucd-snmp/net-snmp software which you should have installed as part of the Zabbix installation) or equivalent tool:

shell> snmpwalk <host or host IP> public

This will give you a list of SNMP strings and their last value. If it doesn't then it is possible that the SNMP 'community' is different from the standard public in which case you will need to find out what it is. You would then go through the list until you find the string you want to monitor, e.g. you wanted to monitor the bytes coming in to your switch on port 3 you would use:

interfaces.ifTable.ifEntry.ifOctetsIn.3 = Counter 32: 614794138

You should now use the snmpget command to find the OID for interfaces.ifTable.ifEntry.ifInOctets.3:

shell> snmpget -On 10.62.1.22 interfaces.ifTable.ifEntry.ifOctetsIn.3

where the last number in the string is the port number you are looking to monitor. This should give you something like the following:

.1.3.6.1.2.1.2.2.1.10.3 = Counter32: 614794138

again the last number in the OID is the port number.

3COM seem to use port numbers in the hundreds, e.g. port 1 = port 101, port 3 = port 103, but Cisco use regular numbers, e.g. port 3 = 3.

Step 3

Create an item for monitoring.

So, now go back to Zabbix and click on Items, selecting the SNMP host you created earlier. Depending on whether you used a template or not when creating your host, you will have either a list of SNMP items associated with your host or just a new item box. We will work on the assumption that you are going to create the item yourself using the information you have just gathered using snmpwalk and snmpget, so enter a plain English description in the 'Description' field of the new item box. Make sure the 'Host' field has your switch/router in it and change the 'Type' field to “SNMPv* agent”. Enter the community (usually public) and enter the numeric OID that you retrieved earlier in to the 'SNMP OID' field, i.e. .1.3.6.1.2.1.2.2.1.10.3

Enter the 'SNMP port' as 161 and the 'Key' as something meaningful, e.g. SNMP-InOctets-Bps. Choose a Multiplier if you want one and enter an 'update interval' and 'keep history' if you want it to be different from the default. Set the 'Status' to Monitored, the 'Type of information' to Numeric (float) and the 'Store value' to DELTA (important otherwise you will get cumulative values from the SNMP device instead of the latest change).

Now save the item and go back to the hosts area of Zabbix. From here check that the SNMP device Status shows 'Monitored' and check in Latest data for your SNMP data!

Example 1

General example

ParameterDescription
Community public
OID 1.2.3.45.6.7.8.0 (or .1.2.3.45.6.7.8.0)
Key <Unique string to be used as reference to triggers>
For example, “my_param”.

Note that OID can be given in either numeric or string form. However, in some cases, string OID must be converted to numeric representation. Utility snmpget may be used for this purpose:

shell> snmpget -On localhost public enterprises.ucdavis.memory.memTotalSwap.0

Monitoring of SNMP parameters is possible if either --with-net-snmp or --with-ucd-snmp flag was specified while configuring Zabbix sources.

Example 2

Monitoring of Uptime

ParameterDescription
Community public
Oid MIB::sysUpTime.0
Key router.uptime
Value type Float
Units uptime
Multiplier 0.01

7 Simple checks

Simple checks are normally used for agent-less monitoring or for remote checks of services. Note that Zabbix agent is not needed for simple checks. Zabbix server is responsible for processing of simple checks (making external connections, etc).

All simple checks, except tcp and tcp_perf, accept one optional parameter:

  • port - port number. If missing, standard default service port is used.

Examples of using simple checks:

ftp,155
http
http_perf,8080 

IP is taken from the Zabbix host definition.

Checking of encrypted protocols (like IMAP on port 993 or POP on port 995) is currently not supported. As a workaround, please use tcp and tcp_perf for checks like these.

List of supported simple checks:

Key
Description Return value
ftp,<port>
Checks if FTP server is running and accepting connections 0 - FTP server is down
1 - FTP server is running
ftp_perf,<port>
Checks if FTP server is running and accepting connections 0 - FTP server is down
Otherwise, number of seconds spent connecting to FTP server.
http,<port>
Checks if HTTP server is running and accepting connections 0 - HTTP server is down
1 - HTTP server is running
http_perf,<port>
Checks if HTTP (web) server is running and accepting connections 0 - HTTP (web) server is down
Otherwise, number of seconds spent connecting to HTTP server.
icmpping[<target>,<packets>,<interval>,<size>,<timeout>]
Checks if server is accessible by ICMP ping
target - host IP or DNS name
packets - number of packets
interval - time between successive packets in milliseconds
size - packet size in bytes
timeout - timeout in milliseconds
0 - ICMP ping fails
1 - ICMP ping successful

Example: icmpping[,4] - if at least one packet of the four is returned, the item will return 1.
icmppingloss[<target>,<packets>,<interval>,<size>,<timeout>]
Return percentage of lost packets
target - host IP or DNS name
packets - number of packets
interval - time between successive packets in milliseconds
size - packet size in bytes
timeout - timeout in milliseconds
Loss of packets in percents
icmppingsec[<target>,<packets>,<interval>,<size>,<timeout>,<mode>]
Return ICMP ping response time
target - host IP or DNS name
packets - number of packets
interval - time between successive packets in milliseconds
size - packet size in bytes
timeout - timeout in milliseconds
mode - one of min, max, avg (default)
Number of seconds

If host is not available (timeout reached), the item will return 0.
imap,<port>
Checks if IMAP server is running and accepting connections 0 - IMAP server is down
1 - IMAP server is running
imap_perf,<port>
Checks if IMAP server is running and accepting connections 0 - IMAP server is down
Otherwise, number of seconds spent connecting to IMAP server.
ldap,<port>
Checks if LDAP server is running and accepting connections 0 - LDAP server is down
1 - LDAP server is running
ldap_perf,<port>
Checks if LDAP server is running and accepting connections 0 - LDAP server is down
Otherwise, number of seconds spent connecting to LDAP server.
nntp,<port>
Checks if NNTP server is running and accepting connections 0 - NNTP server is down
1 - NNTP server is running
nntp_perf,<port>
Checks if NNTP server is running and accepting connections 0 - NNTP server is down
Otherwise, number of seconds spent connecting to NNTP server.
ntp,<port>
Checks if NTP server is running and accepting connections 0 - NTP server is down
1 - NTP server is running
ntp_perf,<port>
Checks if NTP server is running and accepting connections 0 - NTP server is down
Otherwise, number of seconds spent connecting to NTP server.
pop,<port>
Checks if POP server is running and accepting connections 0 - POP server is down
1 - POP server is running
pop_perf,<port>
Checks if POP server is running and accepting connections 0 - POP server is down
Otherwise, number of seconds spent connecting to POP server.
smtp,<port>
Checks if SMTP server is running and accepting connections 0 - SMTP server is down
1 - SMTP server is running
smtp_perf,<port>
Checks if SMTP server is running and accepting connections 0 - SMTP server is down
Otherwise, number of seconds spent connecting to SMTP server.
ssh,<port>
Checks if SSH server is running and accepting connections 0 - SSH server is down
1 - SSH server is running
ssh_perf,<port>
Checks if SSH server is running and accepting connections 0 - SSH server is down
Otherwise, number of seconds spent connecting to SSH server.
tcp,port
Checks if TCP service is running and accepting connections 0 - TCP service is down
1 - TCP service is running
tcp_perf,port
Checks if TCP service is running and accepting connections 0 - the service on the port is down
Otherwise, number of seconds spent connecting to the TCP service.
Timeout processing

Zabbix will not process a simple check longer than Timeout seconds defined in Zabbix server configuration file.

ICMP pings

Zabbix uses external utility fping for processing of ICMP pings. The utility is not part of Zabbix distribution and has to be additionally installed. If the utility is missing, has wrong permissions or its location does not match FpingLocation defined in configuration file, ICMP pings (icmpping, icmppingsec and icmppingloss) will not be processed.

fping must be executable by user Zabbix daemons run as and setuid root. Run these commands as user root in order to setup correct permissions:

shell> chown root:zabbix /usr/sbin/fping
shell> chmod 4710 /usr/sbin/fping

The default values for ICMP checks parameters:

ParameterValue Descriptionfping flagMinMax
packets 3 pings to the target-C110000
interval 1000 milliseconds, “fping” default-p20
size 56 or 68bytes, “fping” default; 56 bytes on x86, 68 bytes on x86_64-b2465507
timeout 500 milliseconds, “fping” default-t50

Warning: fping defaults can differ depending on platform and version - if in doubt, check fping documentation.

Zabbix writes addresses to be checked to a temporary file, which is then passed to fping. If items have different parameters, only ones with identical parameters are written to a single file.

8 Internal checks

Internal checks allow monitoring of the internals of Zabbix. Internal checks are calculated by Zabbix server.

Internal checks are still processed by Zabbix pollers.

Key
Description Comments
zabbix[boottime]
Startup time of Zabbix server process in seconds. In seconds since the epoch.
zabbix[history]
Number of values stored in table HISTORY Do not use if MySQL InnoDB, Oracle or PostgreSQL is used!
zabbix[history_log]
Number of values stored in table HISTORY_LOG Do not use if MySQL InnoDB, Oracle or PostgreSQL is used!
This item is supported starting from version 1.8.3.
zabbix[history_str]
Number of values stored in table HISTORY_STR Do not use if MySQL InnoDB, Oracle or PostgreSQL is used!
zabbix[history_text]
Number of values stored in table HISTORY_TEXT Do not use if MySQL InnoDB, Oracle or PostgreSQL is used!
This item is supported starting from version 1.8.3.
zabbix[history_uint]
Number of values stored in table HISTORY_UINT Do not use if MySQL InnoDB, Oracle or PostgreSQL is used!
This item is supported starting from version 1.8.3.
zabbix[items]
Number of items in Zabbix database
zabbix[items_unsupported]
Number of unsupported items in Zabbix database
zabbix[log]
Stores warning and error messages generated by Zabbix server. Character. Add item with this key to have Zabbix internal messages stored.
zabbix[process,<type>,<mode>,<state>]
Time a particular Zabbix process or a group of processes (identified by <type> and <mode>) spent in <state> in percentage. It is calculated for last minute only.

If <mode> is Zabbix process number that is not running (for example, with 5 pollers running <mode> is specified to be 6), such an item will turn into unsupported state.
Minimum and maximum refers to the usage percentage for a single process. So if in a group of 3 pollers usage percentages per process were 2, 18 and 66, min would return 2 and max would return 66.
Processes report what they are doing in shared memory and the self-monitoring process summarizes that data each second. State changes (busy/idle) are registered upon change - thus a process that becomes busy registers as such and doesn't change or update the state until it becomes idle. This ensures that even fully hung processes will be correctly registered as 100% busy.
Currently, “busy” means “not sleeping”, but in the future additional states might be introduced - waiting for locks, performing database queries, etc.
On Linux and most other systems, resolution is 1/100 of a second.
The following process types are currently supported:
alerter - process for sending notifications
configuration syncer - process for managing in-memory cache of configuration data
db watchdog - sender of a warning message in case DB is not available
discoverer - process for discovery of devices
escalator - process for escalation of actions
history syncer - history DB writer
http poller - web monitoring poller
housekeeper - process for removal of old historical data
icmp pinger - poller for icmpping checks
ipmi poller - poller for IPMI checks
node watcher - process for sending historical data and configuration changes between nodes
self-monitoring - process for collecting internal server statistics
poller - normal poller for passive checks
proxy poller - poller for passive proxies
timer - process for evaluation of time-related trigger functions and maintenances
trapper - trapper for active checks, traps, inter-node and -proxy communication
unreachable poller - poller for unreachable devices

Note: You can also see these process types in a server log file.

Valid modes are:
avg - average value for all processes of a given type (default)
count - returns number of forks for a given process type, <state> should not be specified
max - maximum value
min - minimum value
<process number> - process number (between 1 and the number of pre-forked instances). For example, if 4 trappers are running, the value is between 1 and 4.

Valid states are:
busy - process is in busy state, for example, processing request (default).
idle - process is in idle state doing nothing.

Examples:
zabbix[process,poller,avg,busy] - average time of poller processes spent doing something during the last minute
zabbix[process,”icmp pinger”,max,busy] - maximum time spent doing something by any ICMP pinger process during the last minute
zabbix[process,trapper,count] - amount of currently running trapper processes

This item is supported starting from version 1.8.5.
zabbix[proxy,<name>,<param>]
Access to Proxy related information. <name> - Proxy name
List of supported parameters (<param>):
lastaccess – timestamp of last heart beat message received from Proxy
For example, zabbix[proxy,”Germany”,lastaccess]
Trigger function fuzzytime() can be used to check availability of proxies.
zabbix[queue,<from>,<to>]
Number of server monitored items in the Queue which are delayed by <from> to <to> seconds, inclusive. <from> - default: 6 seconds
<to> - default: infinity
Suffixes s,m,h,d,w are supported for these parameters.
Parameters from and to are supported starting from version 1.8.3.
zabbix[requiredperformance]
Required performance of the Zabbix server, in new values per second expected. Approximately correlates with “Required server performance, new values per second” in Reports → Status of Zabbix. Supported since Zabbix 1.6.2.
zabbix[trends]
Number of values stored in table TRENDS Do not use if MySQL InnoDB, Oracle or PostgreSQL is used!
zabbix[trends_uint]
Number of values stored in table TRENDS_UINT Do not use if MySQL InnoDB, Oracle or PostgreSQL is used!
This item is supported starting from version 1.8.3.
zabbix[triggers]
Number of triggers in Zabbix database
zabbix[uptime]
Uptime of Zabbix server process in seconds.
zabbix[wcache,<cache>,<mode>]
CacheMode
valuesall Number of values processed by Zabbix server, except not supported.Counter.
float Counter.
uint Counter.
str Counter.
log Counter.
text Counter.
not supported Number of processed not supported items. Counter.
This item is supported starting from version 1.8.6.
historypfree Free space in the history buffer in percentage. Low number indicates performance problems on the database side.
total
used
free
trendpfree
total
used
free
text pfree
total
used
free
zabbix[rcache,<cache>,<mode>]
Cache Mode
bufferpfree
total
used
free

9 Aggregated checks

Aggregate checks do not require any agent running on a host being monitored. Zabbix server collects aggregate information by doing direct database queries.

Syntax of an aggregate item's key

groupfunc["Host group","Item key",itemfunc,parameter]

Multiple host groups may be used since Zabbix 1.8.2 by inserting a comma-delimited array.

Supported group functions:

GROUP FUNCTIONDESCRIPTION
grpavg Average value
grpmax Maximum value
grpmin Minimum value
grpsum Sum of values

Supported item functions:

ITEM FUNCTIONDESCRIPTION
avg Average value
count Number of values
last Last value
max Maximum value
min Minimum value
sum Sum of values

Amount of values (prefixed with #) is not supported.

Examples of keys for aggregate items:

Example 1

Total disk space of host group 'MySQL Servers'.

grpsum["MySQL Servers","vfs.fs.size[/,total]",last,0]
Example 2

Average processor load of host group 'MySQL Servers'.

grpavg["MySQL Servers","system.cpu.load[,avg1]",last,0]
Example 3

Average (5min) number of queries per second for host group 'MySQL Servers'

grpavg["MySQL Servers",mysql.qps,avg,300]
Example 4

Average CPU load on all hosts in multiple host groups.

grpavg[["Servers A","Servers B","Servers C"],system.cpu.load,last,0]

10 External checks

External check is a check executed by Zabbix Server by running a shell script or a binary.

External checks do not require any agent running on a host being monitored.

Syntax of item's key:

script[parameters]
* script – name of the script.
* parameters – list of command line parameters. Parameters will be used in command line without any changes.

If you don't want to pass your parameters to the script you may use:

script[] or
script   <- this simplified syntax is supported starting from Zabbix 1.8.1

Zabbix server will find and execute the command in the directory defined in configuration parameter ExternalScripts in zabbix_server.conf. The command will be executed as the user Zabbix server runs as, so any access permissions or environment variables should be handled in a wrapper script, if necessary, and permissions on the command should allow that user to execute it. Only commands in the specified directory are available.

This directory is located on the Zabbix server. For custom command execution using Zabbix agents see user parameter documentation.

First command line parameter is host IP address or DNS name, other parameters are substituted by parameters.

Zabbix uses the first line (trimmed from trailing whitespace) in the standard output of the script as the value. The following lines, standard error and the exit code are discarded.

Do not overuse external checks! It can decrease performance of the Zabbix system a lot.

Example 1

Execute script check_oracle.sh with parameters ”-h 192.168.1.4”. Host DNS name 'www1.company.com'.

check_oracle.sh[-h 192.168.1.4]

Zabbix will execute:

check_oracle.sh www1.company.com -h 192.168.1.4.

11 SSH checks

Zabbix must be configured with SSH2 support.

The minimal supported libssh2 library version is 1.0.0.

SSH checks are used for agent-less monitoring. Note that Zabbix agent is not needed for SSH checks.

Actual commands to be executed must be placed in the Executed script field in the item configuration. Multiple commands can be executed one after another by placing them on a new line.

KeyDescriptionComments
ssh.run[<unique short description>,<ip>,<port>,<encoding>] Run a command by using SSH remote session

12 Telnet checks

Telnet checks are used for agent-less monitoring. Zabbix agent is not needed for Telnet checks.

Actual commands to be executed must be placed in the Executed script field in the item configuration. Multiple commands can be executed one after another by placing them on a new line.

Till version 1.8.1, supported characters that the prompt can end with:

  • $
  • #
  • >

Zabbix version 1.8.2 adds support for additional character:

  • %
KeyDescriptionComments
telnet.run[<unique short description>,<ip>,<port>,<encoding>]Run a command on a remote device using telnet connection

13 Calculated items

Support of calculated items was introduced in Zabbix 1.8.1

With calculated items you can create calculations on the basis of other items. Thus, calculated items are a way of creating virtual data sources. Item values will be periodically calculated based on an arithmetical expression.

Resulting data will be stored in the Zabbix database as for any other item - this means storing both history and trends values for fast graph generation. Calculated items may be used in trigger expressions, referenced by macros or other entities same as any other item type.

To use calculated items, choose the item type Calculated. The key is a unique item identifier (per host). You can create any key name using supported symbols. Calculation definition should be entered in the Formula field (named Expression in 1.8.1 and 1.8.2). There is virtually no connection between the formula and key. The key parameters are not used in formula in any way - variables may be passed to the formula with user macros.

The correct syntax of a simple formula is:

func(<key>|<hostname:key>,<parameter1>,<parameter2>,...)

Where:

ARGUMENTDEFINITION
func One of the functions supported in trigger expressions: last, min, max, avg, count, etc
key The key of another item whose data you want to use. It may be defined as key or hostname:key.
Note: Putting the whole key in double quotes (”…”) is strongly recommended to avoid incorrect parsing because of spaces or commas within the key.
If there are also quoted parameters within the key, those double quotes must be escaped by using the backslash (\). See Examples 5 and 6 below.
parameter(s) Any additional parameters that may be required. See Example 5 below.

All items that are referenced from the calculated item formula must exist and be collecting data. Also, if you change the item key of a referenced item, you have to manually update any formulas using that key.

A more complex formula may use a combination of functions, operators and brackets. You could use all functions and operators supported in trigger expressions. Note that syntax is slightly different, however logic and operator precedence are exactly the same.

Supported characters for a hostname:

a..zA..Z0..9 ._-

Supported characters for a key:

a..zA..Z0..9.,_

Supported characters for a function:

a..zA..Z0..9_

Unlike trigger expressions, Zabbix processes calculated items according to item update interval, not upon receiving a new value.

A calculated item may become unsupported in several cases:

  1. referenced item(s) not found
  2. no data to calculate a function
  3. division by zero
  4. incorrect syntax used
Example 1

Calculate percentage of free disk space on '/'.

Use of function last:

100*last("vfs.fs.size[/,free]")/last("vfs.fs.size[/,total]")

Zabbix will take the latest values for free and total disk spaces and calculate percentage according to the given formula.

Example 2

Calculate 10 minute average number of values processed by Zabbix.

Use of function avg:

avg("Zabbix Server:zabbix[wcache,values]",600)

Note that extensive use of calculated items with long time periods may affect performance of the Zabbix Server.

Example 3

Calculate total bandwidth on eth0.

Sum of two functions:

last("net.if.in[eth0,bytes]")+last("net.if.out[eth0,bytes]")
Example 4

Calculate percentage of incoming traffic.

More complex expression:

100*last("net.if.in[eth0,bytes]")/(last("net.if.in[eth0,bytes]")+last("net.if.out[eth0,bytes]"))
Example 5

Calculate count of records in a log file for last 10 minutes.

Take note of how double quotes are escaped within the quoted key and first function parameter is required:

count("logrt[\"/tmp/test.log\",\"some words pattern\"]",600)
Example 6

Using aggregated items correctly within a calculated item.

Take note of how double quotes are escaped within the quoted key:

last("grpsum[\"video\",\"net.if.out[eth0,bytes]\",\"last\",\"0\"]") / last("grpsum[\"video\",\"nginx_stat.sh[active]\",\"last\",\"0\"]")