Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

DocumentationGrafana AgentFlow modeReferenceComponentsprometheus.exporter.snmp

prometheus.exporter.snmp

The prometheus.exporter.snmp component embeds snmp_exporter. snmp_exporter lets you collect SNMP data and expose them as Prometheus metrics.

Usage

river Copy

prometheus.exporter.snmp "LABEL" {
  config_file = "PATH_SNMP_CONFIG_FILE"
  
  target "TARGET_NAME" {
    address = "TARGET_ADDRESS" 
  }

  walk_param "PARAM_NAME" {
  }
  
  ...
}

Arguments

The following arguments can be used to configure the exporter’s behavior. Omitted fields take their default values.

The config_file argument points to a YAML file defining which snmp_exporter modules to use. See snmp_exporter for details on how to generate a config file.

Blocks

The following blocks are supported inside the definition of prometheus.exporter.snmp to configure collector-specific options:

target block

The target block defines an individual SNMP target. The target block may be specified multiple times to define multiple targets.

walk_param block

The walk_param block defines an individual SNMP connection profile that can be used to override default SNMP settings. The walk_param block may be specified multiple times to define multiple SNMP connection profiles.

version 1 will use GETNEXT, 2 and 3 use GETBULK.

auth block

The auth block defines an individual SNMP authentication profile that can be used to override default SNMP auth settings.

username is required if v3 is used. -u option to NetSNMP. security_level can be noAuthNoPriv, authNoPriv or authPriv. -l option to NetSNMP. password is also known as authKey. Is required if security_level is authNoPriv or authPriv. -a option to NetSNMP. auth_protocol is used if security_level is authNoPriv or authPriv. Possible values are MD5, SHA, SHA224, SHA256, SHA384, or SHA512. -a option to NetSNMP. priv_protocol is used if security_level is authPriv. Possible values are DES, AES, AES192, or AES256. -x option to NetSNMP. priv_password is also known as privKey. Is required if security_level is authPriv. -x option to NetSNMP. context_name is required if context is configured on the device. -n option to NetSNMP.

Exported fields

The following fields are exported and can be referenced by other components.

For example, the targets can either be passed to a discovery.relabel component to rewrite the targets’ label sets, or to a prometheus.scrape component that collects the exposed metrics.

The exported targets will use the configured in-memory traffic address specified by the run command.

Component health

prometheus.exporter.snmp is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.snmp does not expose any component-specific debug information.

Debug metrics

prometheus.exporter.snmp does not expose any component-specific debug metrics.

Example

This example uses a prometheus.scrape component to collect metrics from prometheus.exporter.snmp:

river Copy

prometheus.exporter.snmp "example" {
	config_file = "snmp_modules.yml"

	target "network_switch_1" {
		address     = "192.168.1.2"
		module      = "if_mib"
		walk_params = "public"
	}

	target "network_router_2" {
		address     = "192.168.1.3"
		module      = "mikrotik"
		walk_params = "private"
	}

	walk_param "private" {
		version = "2"

		auth {
			community = "secret"
		}
	}

	walk_param "public" {
		version = "2"

		auth {
			community = "public"
		}
	}
}
// Configure a prometheus.scrape component to collect SNMP metrics.
prometheus.scrape "demo" {
	targets    = prometheus.exporter.snmp.example.targets
	forward_to = [ /* ... */ ]
}