English 日本語 한국어

Log in Start now

Go to network monitoring UI

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. If you haven't already, sign up for free! No credit card required.

If you choose to install SNMP manually, you also need:
- A New Relic account ID.
- A New Relic .

Linux host prerequisites

If you're using linux, you need:

SSH access to the host
Access to install/remove applications and services
Network access as defined in the network prerequisites

Important

To receive SNMP Traps, KTranslate must bind to UDP 162. In a host-based install, the following command will be included during the install process. When executed, KTranslate will be run with elevated privileges.

sudo setcap cap_net_bind_service=+ep /usr/bin/ktranslate

Docker prerequisites

We recommend using Kentik's ktranslate docker container to deploy SNMP monitoring. To use it, you need:

Docker installed in a Linux host
Ability to launch new containers via command line

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

Check the network security prerequisites for SNMP.

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 > Add more data.
Scroll down until you see Network and click SNMP.
Follow the steps outlined in the guided installation process. You can use docker or linux.
one.newrelic.com > Add more data > Network > SNMP to set up SNMP data monitoring.
If you have a proxy, add it to the ktranslate.env file in /etc/default/ after installation, but before starting the ktranslate service. The ktranslate.env file needs to be similar to:
```
NR_ACCOUNT_ID=12345678
  NEW_RELIC_API_KEY=****************************************
  HTTPS_PROXY=https://user:password@hostname:port
  KT_FLAGS="-snmp /etc/ktranslate/snmp-base.yaml \
  -metrics=jchf \
  -tee_logs=true \
  -service_name=snmp-collector \
  -snmp_discovery_on_start=true \
  -snmp_discovery_min=180 \
  nr1.snmp"
```
Visualize your network performance data in New Relic.

Before reading about installing SNMP manually, consider using our guided install process to avoid errors:

If you follow this manual installation process, support may be unable to assist you if issues arise. If you still wish to proceed, do the following:

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. If you intend to collect SNMP traps we also recommend changing the default value of listener: 127.0.0.1:1620 to listener: 0.0.0.0:1620
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.

Did this doc help with your installation?

Collection of SNMP traps

It is not necessary to run a dedicated agent for trap collection as all SNMP polling agents will run this passive listener.

Ktranslate listens for incoming SNMP traps on UDP port 1620, but you can use a port redirect in your docker run... command to redirect packets sent to UDP 162 on the host into UDP 1620 on the container

bash

$docker run -d --name ktranslate-snmp --restart unless-stopped -p 162:1620/udp \
>  -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 \
>  -metrics=jchf \
>  -tee_logs=true \
>  -service_name=snmp \
>  nr1.snmp