Skip to content

Commit

Permalink
fix: removed snmptranslate from readme and fix default path (influxda…
Browse files Browse the repository at this point in the history
  • Loading branch information
MyaLongmire authored Nov 23, 2021
1 parent ba8c29a commit 2b43934
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 26 deletions.
40 changes: 14 additions & 26 deletions plugins/inputs/snmp_trap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,8 @@ notifications (traps and inform requests).
Notifications are received on plain UDP. The port to listen is
configurable.

### Prerequisites
## Configuration

This plugin uses the `snmptranslate` programs from the
[net-snmp][] project. These tools will need to be installed into the `PATH` in
order to be located. Other utilities from the net-snmp project may be useful
for troubleshooting, but are not directly used by the plugin.

These programs will load available MIBs on the system. Typically the default
directory for MIBs is `/usr/share/snmp/mibs`, but if your MIBs are in a
different location you may need to make the paths known to net-snmp. The
location of these files can be configured in the `snmp.conf` or via the
`MIBDIRS` environment variable. See [`man 1 snmpcmd`][man snmpcmd] for more
information.

### Configuration
```toml
[[inputs.snmp_trap]]
## Transport, local address, and port to listen on. Transport must
Expand Down Expand Up @@ -55,7 +42,7 @@ information.
# priv_password = ""
```

#### Using a Privileged Port
### Using a Privileged Port

On many operating systems, listening on a privileged port (a port
number less than 1024) requires extra permission. Since the default
Expand All @@ -73,7 +60,7 @@ the privileged port.
To use a privileged port on Linux, you can use setcap to enable the
CAP_NET_BIND_SERVICE capability on the telegraf binary:

```
```shell
setcap cap_net_bind_service=+ep /usr/bin/telegraf
```

Expand All @@ -84,21 +71,22 @@ On Mac OS, listening on privileged ports is unrestricted on versions

- snmp_trap
- tags:
- source (string, IP address of trap source)
- name (string, value from SNMPv2-MIB::snmpTrapOID.0 PDU)
- mib (string, MIB from SNMPv2-MIB::snmpTrapOID.0 PDU)
- oid (string, OID string from SNMPv2-MIB::snmpTrapOID.0 PDU)
- version (string, "1" or "2c" or "3")
- context_name (string, value from v3 trap)
- engine_id (string, value from v3 trap)
- community (string, value from 1 or 2c trap)
- source (string, IP address of trap source)
- name (string, value from SNMPv2-MIB::snmpTrapOID.0 PDU)
- mib (string, MIB from SNMPv2-MIB::snmpTrapOID.0 PDU)
- oid (string, OID string from SNMPv2-MIB::snmpTrapOID.0 PDU)
- version (string, "1" or "2c" or "3")
- context_name (string, value from v3 trap)
- engine_id (string, value from v3 trap)
- community (string, value from 1 or 2c trap)
- fields:
- Fields are mapped from variables in the trap. Field names are
- Fields are mapped from variables in the trap. Field names are
the trap variable names after MIB lookup. Field values are trap
variable values.

### Example Output
```

```shell
snmp_trap,mib=SNMPv2-MIB,name=coldStart,oid=.1.3.6.1.6.3.1.1.5.1,source=192.168.122.102,version=2c,community=public snmpTrapEnterprise.0="linux",sysUpTimeInstance=1i 1574109187723429814
snmp_trap,mib=NET-SNMP-AGENT-MIB,name=nsNotifyShutdown,oid=.1.3.6.1.4.1.8072.4.0.2,source=192.168.122.102,version=2c,community=public sysUpTimeInstance=5803i,snmpTrapEnterprise.0="netSnmpNotificationPrefix" 1574109186555115459
```
Expand Down
1 change: 1 addition & 0 deletions plugins/inputs/snmp_trap/snmp_trap.go
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ func init() {
lookupFunc: lookup,
ServiceAddress: "udp://:162",
Timeout: defaultTimeout,
Path: []string{"/usr/share/snmp/mibs"},
Version: "2c",
}
})
Expand Down

0 comments on commit 2b43934

Please sign in to comment.