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

Link to this comparison view

Both sides previous revision Previous revision
manual:config:items:itemtypes:snmptrap [2016/11/10 08:35]
manual:config:items:itemtypes:snmptrap [2017/08/24 19:36]
martins-v removing auto numbering
Line 1: Line 1:
 +==== 3 SNMP traps ====
 +=== Overview ===
 +Receiving SNMP traps is the opposite to querying SNMP-enabled devices. ​
 +In this case the information is sent from a SNMP-enabled device and is collected or "​trapped"​ by Zabbix.
 +Usually traps are sent upon some condition change and the agent connects to the server on port 162 (as opposed to port 161 on the agent side that is used for queries). Using traps may detect some short problems that occur amidst the query interval and may be missed by the query data.
 +Receiving SNMP traps in Zabbix is designed to work with **snmptrapd** and one of the built-in mechanisms for passing the traps to Zabbix - either a perl script or SNMPTT.
 +The workflow of receiving a trap:
 +  - **snmptrapd** receives a trap
 +  - snmptrapd passes the trap to SNMPTT or calls Perl trap receiver
 +  - SNMPTT or Perl trap receiver parses, formats and writes the trap to a file
 +  - Zabbix SNMP trapper reads and parses the trap file
 +  - For each trap Zabbix finds all "SNMP trapper"​ items with host interfaces matching the received trap address. Note that only the selected "​IP"​ or "​DNS"​ in host interface is used during the matching.
 +  - For each found item, the trap is compared to regexp in "​snmptrap[regexp]"​. The trap is set as the value of **all** matched items. If no matching item is found and there is an "​snmptrap.fallback"​ item, the trap is set as the value of that.
 +  - If the trap was not set as the value of any item, Zabbix by default logs the unmatched trap. (This is configured by "Log unmatched SNMP traps" in Administration -> General -> Other.)
 +=== - Configuring SNMP traps ===
 +Configuring the following fields in the frontend is specific for this item type:
 +  * Your host must have an SNMP interface
 +In //​Configuration -> Hosts//, in the **Host interface** field set an SNMP interface with the correct IP or DNS address. The address from each received trap is compared to the IP and DNS addresses of all SNMP interfaces to find the corresponding hosts.
 +  * Configure the item
 +In the **Key** field use one of the SNMP trap keys:
 +^  Key                                       ^^^
 +^  Description ​ ^  Return value  ^  Comments ​ ^
 +| |||
 +^snmptrap[regexp] |||
 +| Catches all SNMP traps that match the [[:​manual/​regular_expressions|regular expression]] specified in **regexp**. If regexp is unspecified,​ catches any trap. | SNMP trap | This item can be set only for SNMP interfaces. \\ This item is supported since Zabbix **2.0.0.**\\ //Note//: Starting with Zabbix 2.0.5, user macros and global regular expressions are supported in the parameter of this item key.  |
 +| |||
 +^snmptrap.fallback |||
 +| Catches all SNMP traps that were not caught by any of the snmptrap[] items for that interface. | SNMP trap | This item can be set only for SNMP interfaces.\\ This item is supported since Zabbix **2.0.0.** ​ |
 +<​note>​Multi-line regexp matching is not supported at this time.</​note>​
 +Set the **Type of information** to be '​Log'​ for the timestamps to be parsed. Note that other formats such as '​Numeric'​ are also acceptable but might require a custom trap handler.
 +<note tip>For SNMP trap monitoring to work, it must first be correctly set up.</​note>​
 +=== - Setting up SNMP trap monitoring ===
 +== Configuring Zabbix server/​proxy ==
 +To read the traps, Zabbix server or proxy must be configured to start the SNMP trapper process and point to the trap file that is being written by SNMPTT or a perl trap receiver. To do that, edit the configuration file ([[manual:​appendix:​config:​zabbix_server|zabbix_server.conf]] or [[manual:​appendix:​config:​zabbix_proxy|zabbix_proxy.conf]]):​
 +  - StartSNMPTrapper=1
 +  - SNMPTrapperFile=[TRAP FILE]
 +<note warning>​If systemd parameter **[[http://​​software/​systemd/​man/​systemd.exec.html#​PrivateTmp=|PrivateTmp]]** is used, this file is unlikely to work in ///​tmp//​.</​note>​
 +== Configuring SNMPTT ==
 +At first, snmptrapd should be configured to use SNMPTT.
 +<note tip>For the best performance,​ SNMPTT should be configured as a daemon using **snmptthandler-embedded** to pass the traps to it. See instructions for configuring SNMPTT in its homepage:\\ [[http://​​docs/​snmptt.shtml]]</​note>​
 +When SNMPTT is configured to receive the traps, configure SNMPTT to log the traps:
 +  - log traps to the trap file which will be read by Zabbix:\\ log_enable = 1\\ log_file = [TRAP FILE]
 +  - set the date-time format:\\ date_time_format = %H:%M:%S %Y/%m/%d = [DATE TIME FORMAT]
 +Now format the traps for Zabbix to recognise them (edit snmptt.conf):​
 +  - Each FORMAT statement should start with "​ZBXTRAP [address]",​ where [address] will be compared to IP and DNS addresses of SNMP interfaces on Zabbix. E.g.:\\ EVENT coldStart . "​Status Events"​ Normal\\ FORMAT ZBXTRAP $aA Device reinitialized (coldStart)
 +  - See more about SNMP trap format below.
 +<note important>​Do not use unknown traps - Zabbix will not be able to recognise them. Unknown traps can be handled by defining a general event in snmptt.conf:​\\ EVENT general .* "​General event" Normal</​note>​
 +== Configuring Perl trap receiver ==
 +Requirements:​ Perl, Net-SNMP compiled with %%--%%enable-embedded-perl (done by default since Net-SNMP 5.4)\\ \\ Perl trap receiver (look for misc/​snmptrap/​ can be used to pass traps to Zabbix server directly from snmptrapd. To configure it:
 +  * add the perl script to snmptrapd configuration file (snmptrapd.conf),​ e.g.:\\ perl do %%"​[FULL PATH TO PERL RECEIVER SCRIPT]"​%%;​
 +  * configure the receiver, e.g:\\ $SNMPTrapperFile = '[TRAP FILE]';​\\ $DateTimeFormat = '[DATE TIME FORMAT]';​
 +<note tip>If script name is not quoted, snmptrapd will refuse to start up with messages, similar to these:
 +  Regexp modifiers "/​l"​ and "/​a"​ are mutually exclusive at (eval 2) line 1, at end of line
 +  Regexp modifier "/​l"​ may not appear twice at (eval 2) line 1, at end of line
 +== SNMP trap format ==
 +All customised perl trap receivers and SNMPTT trap configuration must format the trap in the following way:
 +**[timestamp] [the trap, part 1] ZBXTRAP [address] [the trap, part 2]**, where
 +  * [timestamp] - timestamp used for log items
 +  * ZBXTRAP - header that indicates that a new trap starts in this line
 +  * [address] - IP address used to find the host for this trap
 +Note that "​ZBXTRAP"​ and "​[address]"​ will be cut out from the message during processing. If the trap is formatted otherwise, Zabbix might parse the traps unexpectedly. \\ \\ Example trap:\\ 11:30:15 2011/07/27 . Normal "​Status Events"​ localhost - ZBXTRAP Link down on interface 2.  Admin state: 1.  Operational state: 2\\ This will result in the following trap for SNMP interface with IP=​\\ 11:30:15 2011/07/27 . Normal "​Status Events"​ localhost - Link down on interface 2.  Admin state: 1.  ​
 +=== - System requirements ===
 +== Log rotation ==
 +Zabbix does not provide any log rotation system - that should be handled by the user. The log rotation should first rename the old file and only later delete it so that no traps are lost:\\
 +  - Zabbix opens the trap file at the last known location and goes to step 3
 +  - Zabbix checks if the currently opened file has been rotated by comparing the inode number to the define trap file's inode number. If there is no opened file, Zabbix resets the last location and goes to step 1.
 +  - Zabbix reads the data from the currently opened file and sets the new location.
 +  - The new data are parsed. If this was the rotated file, the file is closed and goes back to step 2.
 +  - If there was no new data, Zabbix sleeps for 1 second and goes back to step 2.
 +<note important>​The maximum log file size supported by Zabbix is 2 gigabytes. The log file must be rotated before reaching this limit.</​note>​
 +== File system ==
 +Because of the trap file implementation,​ Zabbix needs the file system to support inodes to differentiate files (the information is acquired by a stat() call).
 +=== - Setup example ===
 +This example uses snmptrapd + SNMPTT to pass traps to Zabbix server. Setup:
 +  - **zabbix_server.conf** - configure Zabbix to start SNMP trapper and set the trap file:\\ StartSNMPTrapper=1\\ SNMPTrapperFile=/​tmp/​my_zabbix_traps.tmp
 +  - **snmptrapd.conf** - add SNMPTT as the trap handler:\\ traphandle default snmptt
 +  - **snmptt.ini** - configure output file and time format:\\ log_file = /​tmp/​my_zabbix_traps.tmp\\ date_time_format = %H:%M:%S %Y/%m/%d
 +  - **snmptt.conf** - define a default trap format: \\ EVENT general .* %%"​General event"​%% Normal\\ FORMAT ZBXTRAP $aA $ar
 +  - Create an SNMP item TEST:\\ Host's SNMP interface IP:\\ Key: %%snmptrap["​General"​]%%\\ Log time format: hh:mm:ss yyyy/MM/dd
 +This results in:
 +  - Command used to send a trap:\\ snmptrap -v 1 -c public '​.'​ '​'​ 6 33 '​55'​ . ​ s <​nowiki>"​teststring000"</​nowiki>​
 +  - The received trap:\\ 15:48:18 2011/07/26 . Normal %%"​General event"​%% localhost - ZBXTRAP
 +  - Value for item TEST:\\ 15:48:18 2011/07/26 . Normal %%"​General event"​%% localhost -
 +<note tip>This simple example uses SNMPTT as **traphandle**. For better performance on production systems, use embedded Perl to pass traps from snmptrapd to SNMPTT or directly to Zabbix.</​note>​
 +=== - See also ===
 +  * [[https://​​wiki/​Start_with_SNMP_traps_in_Zabbix|CentOS based SNMP trap tutorial on]]