Set up SNMP data monitoring

Set up your network devices so they send network data to New Relic.

Prerequisites and supported SNMP versions

New Relic prerequisites

A New Relic account. Don't have one? Sign up for free! No credit card required.
For manual install (guided install inputs them automatically):
- A New Relic account ID.
- A New Relic license key.

Linux host prerequisites

Docker installed in a Linux host.
SSH access to the Docker host, with the ability to launch new containers.

SNMP devices prerequisites

Configured network devices for SNMP polling from the ktranslate docker container. Some samples of basic SNMP configurations can be found here:

Cisco
- IOS
- NX-OS
Juniper
- Junos OS
Palo Alto
- PAN-OS

Network security prerequisites

Direction	Source	Destination	Ports	Protocol
Outbound	Docker host	`ktranslate` image on Docker Hub or Quay.io	443	TCP
Outbound	Docker host	New Relic Metric API US Endpoint: `https://metric-api.newrelic.com` EU Endpoint: `https://metric-api.eu.newrelic.com`	443	TCP
Outbound	Docker host	New Relic Log API US Endpoint: `https://log-api.newrelic.com` EU Endpoint: `https://log-api.eu.newrelic.com`	443	TCP
Outbound	Docker host	Target devices for SNMP polling	161 (default)	UDP
Inbound	Source devices for SNMP Trap data	Docker host	1620 (default)	UDP

Supported SNMP versions

Our network monitoring container supports all major versions of SNMP (v1, v2c, and v3). Additionally, SNMP v3 has support for the following authentication and privacy settings:

Setting	Protocol
Authentication	`NoAuth`
Authentication	`MD5`
Authentication	`SHA`
Authentication	`SHA224`
Authentication	`SHA256`
Authentication	`SHA384`
Authentication	`SHA512`
Privacy	`NoPriv`
Privacy	`DES`
Privacy	`AES`
Privacy	`AES192`
Privacy	`AES256`
Privacy	`AES192C`
Privacy	`AES256C`

Tip

We recommend using read-only community strings/authentication with SNMP.

Set up SNMP data monitoring in New Relic

Go to one.newrelic.com and click Add more data.
Scroll down until you see Network monitoring and click SNMP.
Follow the steps in New Relic.
one.newrelic.com > Add more data > Network monitoring > SNMP to set up SNMP data monitoring.
Visualize your network performance data in New Relic.

If you prefer to do the setup manually, proceed with the following steps.

On a Linux host with Docker installed, download the ktranslate image by running one of the following:
- Docker Hub
  bash
```
$docker pull kentik/ktranslate:v2
```
- Quay.io
  bash
```
$docker pull quay.io/kentik/ktranslate:v2
```
Copy the snmp-base.yaml file to the local $HOME directory of your Docker user, and discard the container by running
bash
```
$cd .
$id=$(docker create kentik/ktranslate:v2)
$docker cp $id:/etc/ktranslate/snmp-base.yaml .
$docker rm -v $id
```
Edit the snmp-base.yaml file and define the discovery.cidrs and discovery.default_communities attributes to appropriate values for your network.
Tip
We recommend to set discovery.add_mibs: true to automate the addition of all discovered MIBs into the global.mibs_enabled attribute.
Launch a short-lived container to execute discovery by running
bash
```
$docker run -ti --name ktranslate-discovery --rm --net=host \
>--user `id -u`:`id -g` \
>-v `pwd`/snmp-base.yaml:/snmp-base.yaml \
>kentik/ktranslate:v2 \
>    -snmp /snmp-base.yaml \
>    -log_level info \
>    -snmp_discovery=true
```
After the discovery run finishes, you should see an output similar to the following:
bash
```
$>[Info] KTranslate Adding 3 new snmp devices to the config, 0 replaced from 3
$# In this example, the discovery run found 3 new SNMP devices.
```
The discovered devices are listed in the snmp-base.yaml file's devices.{} section. By default, only the IF-MIB mib is polled. You can manually add other mibs to the global.mibs_enabled attribute if you did not set discovery.add_mibs: true before running the discovery.

Run ktranslate to poll target devices by running:

bash

$docker run -d --name ktranslate-snmp --restart unless-stopped --net=host \
>-v `pwd`/snmp-base.yaml:/snmp-base.yaml \
>-e NEW_RELIC_API_KEY=$YOUR_NR_LICENSE_KEY  \
>kentik/ktranslate:v2 \
>  -snmp /snmp-base.yaml \
>  -nr_account_id=$YOUR_NR_ACCOUNT_ID \
>  ## If your account is located in Europe, add the following flag:
$  ## -nr_region=EU \
$  ## If you want to use FedRAMP, add the following flag to use the FedRAMP authorized endpoints:
$  ## -nr_region=GOV \
$  -metrics=jchf \
>  -tee_logs=true \
>  -service_name=snmp \
>  nr1.snmp

To get better visibility into how your network is being used, set up network flow data monitoring.
To get insights into system messages from your devices, setup network syslog collection.
Visualize your network performance data in New Relic.

Collection of SNMP traps

By default the agent will listen for incoming SNMP traps on UDP port 1620 and it is not necessary to run a dedicated agent for trap collection as all SNMP polling agents will run this passive listener.

If you need to use the standard port of UDP 162 for your SNMP traps, the following steps will need to be followed for your container.

Update your snmp-base.yaml config file to change the listening IP from 127.0.0.1 to 0.0.0.0. (This allows the Docker container to listen on the docker0 interface for external packets.)

trap:
  listen: 0.0.0.0:1620
  community: hello
  version: ""
  transport: ""

Enable port forwarding during your docker run... command to redirect packets sent to UDP 162 on the host into UDP 1620 on the container: