SNMP agent π
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
snmp
monitor type to collect metrics from SNMP agents.
This integration is available for Kubernetes, Windows, and Linux.
Note
This monitor doesnβt support MIB lookups.
Benefits π
After you configure the integration, you can access these features:
View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata catalog.
Installation π
Follow these steps to deploy this integration:
Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the integration, as described in the Configuration section.
Restart the Splunk Distribution of the OpenTelemetry Collector.
Configuration π
To use this integration of a Smart Agent monitor with the Collector:
Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.
Example π
To activate this integration, add the following to your Collector configuration:
receivers:
smartagent/snmp:
type: telegraf/snmp
... # Additional config
Next, add the monitor to the service.pipelines.metrics.receivers
section of your configuration file:
service:
pipelines:
metrics:
receivers: [smartagent/snmp]
Advanced configuration example π
The following is a sample Smart Agent monitor configuration:
receivers:
smartagent/snmp:
type: telegraf/snmp
agents: "127.0.0.1:161"
version: 2
community: "public"
fields:
name: "uptime"
oid: ".1.3.6.1.2.1.1.3.0"
The following is a sample Smart Agent monitor configuration using a discovery rule:
receivers:
smartagent/snmp:
type: telegraf/snmp
discoveryRule: container_name =~ "snmp" && port == 161
version: 2
community: "public"
fields:
name: "uptime"
oid: ".1.3.6.1.2.1.1.3.0"
Configuration settings π
The following table shows the configuration options for the SNMP agent monitor:
Option |
Required |
Type |
Description |
---|---|---|---|
|
No |
|
|
|
No |
|
|
|
No |
|
|
|
No |
|
Number of retries. The default value is |
|
No |
|
SNMP community to use. The default value is |
|
No |
|
|
|
No |
|
SNMP v3 context name to use with requests. |
|
No |
|
|
|
No |
|
Name to used to authenticate with SNMP v3 requests. |
|
No |
|
|
|
No |
|
Password used to authenticate SNMP v3 requests. |
|
No |
|
|
|
No |
|
Password used to encrypt SNMP v3 messages. |
|
No |
|
The SNMP v3 engine ID. |
|
No |
|
The SNMP v3 engine boots. The default value is |
|
No |
|
The SNMP v3 engine time. The default value is |
|
No |
|
The top-level measurement name. |
|
No |
|
The top-level SNMP fields. |
|
No |
|
SNMP Tables. |
The nested fields
configuration object has the following fields:
Option |
Required |
Type |
Description |
---|---|---|---|
|
No |
|
Name of the field. The OID is used if no value is supplied. |
|
No |
|
The OID to retrieve. |
|
No |
|
|
|
No |
|
|
|
No |
|
|
|
No |
|
|
The nested tables
configuration object has the following fields:
Option |
Required |
Type |
Description |
---|---|---|---|
|
No |
|
Metric name. If not supplied the OID is used. |
|
No |
|
Top level tags to inherit. |
|
No |
|
|
|
No |
|
Specifies the tags and values to look up. |
|
No |
|
The OID to retrieve. |
The nested field
configuration object has the following fields:
Option |
Required |
Type |
Description |
---|---|---|---|
|
No |
|
Name of the field. The OID are used if no value is supplied. |
|
No |
|
The OID to retrieve. |
|
No |
|
|
|
No |
|
|
|
No |
|
|
|
No |
|
|
Metrics π
By default this monitor has no fixed metrics. Instead, it will create metrics based on your configuration. Look for tags as especified in the settings.
All metrics are custom.
Troubleshooting π
If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.
Available to Splunk Observability Cloud customers
Submit a case in the Splunk Support Portal .
Contact Splunk Support .
Available to prospective customers and free trial users
Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.