https://github.com/sensu-plugins/sensu-extensions-snmp-trap
Check extension to receive SNMP traps and translate them into check results
https://github.com/sensu-plugins/sensu-extensions-snmp-trap
sensu-extensions sensu-extensions-snmp-trap snmp
Last synced: 5 months ago
JSON representation
Check extension to receive SNMP traps and translate them into check results
- Host: GitHub
- URL: https://github.com/sensu-plugins/sensu-extensions-snmp-trap
- Owner: sensu-plugins
- License: mit
- Created: 2016-08-22T16:07:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T19:17:46.000Z (over 4 years ago)
- Last Synced: 2024-10-31T14:26:16.313Z (about 1 year ago)
- Topics: sensu-extensions, sensu-extensions-snmp-trap, snmp
- Language: Ruby
- Homepage: https://rubygems.org/gems/sensu-extensions-snmp-trap
- Size: 199 KB
- Stars: 4
- Watchers: 14
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Sensu SNMP Trap Extension
A SNMP trap listener for the Sensu client process. This check
extension creates a SNMPv2 trap listener, loads & imports MIB files,
and attempts to translate SNMP traps into Sensu check results. Sensu
proxy clients are created for SNMP devices, using the device hostname
as the client name, when a SNMP trap is received.
The SNMP trap to Sensu check result translation logic is currently
being improved. Failure to translate the SNMP trap will produce a
check result (and event) like the following (addresses have been
redacted):
## Inspiration
This SNMP trap extension was inspired by the work done by Toby Jackson
on [SNMPTrapHandler](https://github.com/warmfusion/sensu-extension-snmptrap).
## Installation
This extension requires Sensu version >= 0.26.
On a Sensu client machine.
```
sensu-install -e snmp-trap:0.0.33
```
Edit `/etc/sensu/conf.d/extensions.json` to load it.
``` json
{
"extensions": {
"snmp-trap": {
"version": "0.0.33"
}
}
}
```
## Configuration
Edit `/etc/sensu/conf.d/snmp_trap.json` to change its configuration.
``` json
{
"snmp_trap": {
"community": "secret",
"result_attributes": {
"datacenter": "DC01"
},
"result_status_map": [
["authenticationFailure", 0]
],
"client_socket_bind": "192.168.0.3",
"client_socket_port": 1234
}
}
```
|attribute|type|default|description|
|----|----|----|---|
|bind|string|0.0.0.0|IP to bind the SNMP trap listener to|
|port|integer|1062|Port to bind the SNMP trap listener to|
|community|string|"public"|SNMP community string to use|
|mibs_dir|string|"/etc/sensu/mibs"|MIBs directory to import and load MIBs from|
|imported_dir|string|"$TMPDIR/sensu_snmp_imported_mibs"|Directory to store imported MIB data in|
|handlers|array|["default"]|Handlers to specify in Sensu check results|
|result_attributes|hash|{}|Custom check result attributes to add to every SNMP trap Sensu check result|
|result_map|array|[]|SNMP trap varbind to Sensu check result translation mappings|
|result_status_map|array|[]|SNMP trap varbind to Sensu check result status mappings|
|client_socket_bind|string|"127.0.0.1"|IP to send events to when handled|
|client_socket_port|integer|3030|Port to send events to when handled|
### Result Map Examples
The configurable result map allows you to define SNMP trap varbind to
Sensu check result attribute mappings. A mapping is comprised of a
varbind name regular expression and a check attribute. For example, if
you expect SNMP traps with a varbind name that contains
"AlertDescription" and you would like to use its value as the Sensu
check result output:
``` json
{
"snmp_trap": {
"...": "...",
"result_map": [
["/description/i", "output"]
]
}
}
```
Configuring a result map does not replace the built-in mappings, the
configured mappings take precedence over them.
### Result Status Map Examples
The configurable result status map allows you to define SNMP trap
varbind to numeric Sensu check result status value mappings. A
mapping is comprised of a varbind name regular expression and an check
exit status (e.g. 1-255). For example, if you expect SNMP traps with a
varbind name that contains "CriticalError" and you would like to set
the Sensu check result status to `2` (critical):
``` json
{
"snmp_trap": {
"...": "...",
"result_status_map": [
["/critical/i", 2]
]
}
}
```
Configuring a result status map does not replace the built-in
mappings, the configured mappings take precedence over them.