You can use our guided install process to install the syslog monitoring agent, or install the agent manually. This doc covers prerequisites to start this install process and a step-by-step walk through of your install options.
Prerequisites
Before you can start, you'll need to sign up for a New Relic account. If you choose to install the agent manually, you also need:
To receive SNMP Traps, the agent 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.
Target devices must be configured to accept SNMP polling from the agent's host IP address. Some samples of basic SNMP configurations can be found here (this is not an all-inclusive list):
Our network monitoring container supports all major versions of SNMP (v1, v2c, and v3), including both Traps and Informs. 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.
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)
$
dockercp$id:/etc/ktranslate/snmp-base.yaml .
$
dockerrm-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. Additionally, it is recommended to set discovery.check_all_ips: true to avoid discovery issues on devices with tightened security postures.
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
Run ktranslate to poll target devices and listen for incoming SNMP Traps by running:
bash
$
docker run -d--name ktranslate-snmp --restart unless-stopped --pull=always -p162:1620/udp \
>
-v`pwd`/snmp-base.yaml:/snmp-base.yaml \
>
# Replace with your license key
>
-eNEW_RELIC_API_KEY=$YOUR_NR_LICENSE_KEY\
>
kentik/ktranslate:v2 \
>
-snmp /snmp-base.yaml \
>
# Replace with your account ID
>
-nr_account_id=$YOUR_NR_ACCOUNT_ID\
>
# If your organization 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 \
>
# Use this field to create a unique value for `tags.container_service` inside of New Relic
>
-service_name=$UNIQUE_NAME\
>
# These settings initiate an immediate discovery job and schedule it to run every 180 minutes
>
-snmp_discovery_on_start: true\
>
-snmp_discovery_min=180\
>
nr1.snmp
Tip
It is not necessary to run a dedicated agent for trap collection as all SNMP polling agents will run a passive listener. By default the container will listen on the host's port 162 (UDP); but you can change the published port mapping in the docker run command - -p 162:1620/udp.
Investigate your network performance data in the New Relic UI.
Did this doc help with your installation?
What's next?
You can set up some additional agents to complement your SNMP data: