Docs » Available host and application monitors » Configure application receivers for networks » SNMP agent

SNMP agent ๐Ÿ”—

Description ๐Ÿ”—

The Splunk Distribution of OpenTelemetry Collector provides this integration as the SNMP agent monitor type using the Smart Agent Receiver.

Use this monitor 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:

Installation ๐Ÿ”—

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration ๐Ÿ”—

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which youโ€™ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

Note

Provide an SNMP monitor entry in your Smart Agent or Collector configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector ๐Ÿ”—

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/snmp:
    type: telegraf/snmp
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/snmp receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/snmp]

Smart Agent ๐Ÿ”—

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
  - type: telegraf/snmp
    ...  # Additional config

The following is a sample Smart Agent monitor configuration:

monitors:
 - 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:

monitors:
 - 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"

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings ๐Ÿ”—

The following table shows the configuration options for the SNMP agent monitor:

Option

Required

Type

Description

host

No

string

Host name or IP address of the SNMP agent. Host and port are concatenated and appended to the list of SNMP agents to connect to.

port

No

integer

Port of the SNMP agent host. Port and Host are concatenated and appended to the list of SNMP agents to connect to. The default value is 0.

agents

No

list of strings

List of SNMP agent address and ports to query for information. For example, 0.0.0.0:5555. If an address is supplied without a port, the default port is 161.

retries

No

integer

Number of retries. The default value is 0.

community

No

string

SNMP community to use. The default value is public.

maxRepetitions

No

uint8

Maximum number of iterations for repeating variables The default value is 50.

contextName

No

string

SNMP v3 context name to use with requests.

secLevel

No

string

Security level to use for SNMP v3 messages: noAuthNoPriv, authNoPriv, or authPriv. The default value is noAuthNoPriv.

secName

No

string

Name to used to authenticate with SNMP v3 requests.

authProtocol

No

string

Protocol to used to authenticate SNMP v3 requests: "MD5", "SHA", or "" (default).

authPassword

No

string

Password used to authenticate SNMP v3 requests.

privProtocol

No

string

Protocol used for encrypted SNMP v3 messages: DES, AES, or "" (default).

privPassword

No

string

Password used to encrypt SNMP v3 messages.

engineID

No

string

The SNMP v3 engine ID.

engineBoots

No

uint32

The SNMP v3 engine boots. The default value is 0.

engineTime

No

uint32

The SNMP v3 engine time. The default value is 0.

name

No

string

The top-level measurement name.

fields

No

list of objects (see below)

The top-level SNMP fields.

tables

No

list of objects (see below)

SNMP Tables.

The nested fields configuration object has the following fields:

Option

Required

Type

Description

name

No

string

Name of the field. The OID is used if no value is supplied.

oid

No

string

The OID to retrieve.

oidIndexSuffix

No

string

The subidentifier to strip off when matching indexes to other fields.

oidIndexLength

No

integer

The index length after the table OID. The index is truncated after this length to remove length index suffixes or nonfixed values. The default value is 0.

isTag

No

bool

Whether to output the field as a tag. The default value is false.

conversion

No

string

Controls the type conversion applied to the value: "float(X)", "float", "int", "hwaddr", "ipaddr", or "" (default).

The nested tables configuration object has the following fields:

Option

Required

Type

Description

name

No

string

Metric name. If not supplied the OID is used.

inheritTags

No

list of strings

Top level tags to inherit.

indexAsTag

No

bool

Add a tag for the table index for each row. The default value is false.

field

No

list of objects (see below)

Specifies the tags and values to look up.

oid

No

string

The OID to retrieve.

The nested field configuration object has the following fields:

Option

Required

Type

Description

name

No

string

Name of the field. The OID are used if no value is supplied.

oid

No

string

The OID to retrieve.

oidIndexSuffix

No

string

The sub-identifier to strip off when matching indexes to other fields.

oidIndexLength

No

integer

The index length after the table OID. The index is truncated after this length to remove length index suffixes or nonfixed values. The default value is 0.

isTag

No

bool

Whether to output the field as a tag. The default value is false.

conversion

No

string

Controls the type conversion applied to the value: "float(X)", "float", "int", "hwaddr", "ipaddr", or "" (default).

Metrics ๐Ÿ”—

The Smart Agent doesnโ€™t filter the metrics coming out of this monitor.

Get help ๐Ÿ”—

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.