prometheus.exporter.snmp
The prometheus.exporter.snmp
component embeds the snmp_exporter
.
The snmp_exporter
lets you collect SNMP data and expose them as Prometheus metrics.
Note
prometheus.exporter.snmp
uses the latest configuration introduced in version v0.27.0 of the Prometheussnmp_exporter
.
Usage
prometheus.exporter.snmp "<LABEL>" {
config_file = "<SNMP_CONFIG_FILE_PATH>"
target "<TARGET_NAME>" {
address = "<TARGET_ADDRESS>"
}
}
or
prometheus.exporter.snmp "<LABEL>" {
config_file = "<SNMP_CONFIG_FILE_PATH>"
targets = <TARGET_LIST>
}
Arguments
You can use the following arguments with prometheus.exporter.snmp
:
The config_file
argument points to a YAML file defining which snmp_exporter modules to use.
Refer to snmp_exporter for details on how to generate a configuration file.
The config
argument must be a YAML document as string defining which SNMP modules and authorizations to use.
config
is typically loaded by using the exports of another component.
For example,
local.file.LABEL.content
remote.http.LABEL.content
remote.s3.LABEL.content
Set config_merge_strategy
to merge
to add additional configuration to the embedded SNMP configuration.
For example, if you need to add a few custom auth
settings without regenerating the whole configuration.
The targets
argument is an alternative to the target block. This is useful when SNMP targets are supplied by another component.
The following labels can be set to a target:
name
: The name of the target (required).address
or__address__
: The address of SNMP device (required).module
: SNMP modules to use for polling, separated by comma.auth
: The SNMP authentication profile to use.walk_params
: The configuration to use for this target.
Any other labels defined are added to the scraped metrics.
Blocks
You can use the following blocks with prometheus.exporter.snmp
:
target
The target
block defines an individual SNMP target.
The target
block may be specified multiple times to define multiple targets.
The label of the block is required and is used in the target’s job
label.
walk_param
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.
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 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
doesn’t expose any component-specific debug information.
Debug metrics
prometheus.exporter.snmp
doesn’t expose any component-specific debug metrics.
Example
The following example uses a prometheus.scrape
component to collect metrics from prometheus.exporter.snmp
:
prometheus.exporter.snmp "example" {
config_file = "snmp_modules.yml"
target "network_switch_1" {
address = "192.168.1.2"
module = "system,if_mib"
walk_params = "public"
labels = {
"env" = "dev",
}
}
target "network_router_2" {
address = "192.168.1.3"
module = "system,if_mib,mikrotik"
walk_params = "private"
}
walk_param "private" {
retries = "2"
}
walk_param "public" {
retries = "2"
}
}
// Configure a prometheus.scrape component to collect SNMP metrics.
prometheus.scrape "demo" {
targets = prometheus.exporter.snmp.example.targets
forward_to = [ /* ... */ ]
}
The following example uses an embedded configuration with secrets:
Replace the following:
<PROMETHEUS_REMOTE_WRITE_URL>
: The URL of the Prometheusremote_write
compatible server to send metrics to.<USERNAME>
: The username to use for authentication to theremote_write
API.<PASSWORD>
: The password to use for authentication to theremote_write
API.
The following example uses the alternative way to pass targets:
prometheus.exporter.snmp "example" {
config_file = "snmp_modules.yml"
targets = [
{
"name" = "network_switch_1",
"address" = "192.168.1.2",
"module" = "system,if_mib",
"walk_params" = "public",
"env" = "dev",
},
{
"name" = "network_router_2",
"address" = "192.168.1.3",
"module" = "system,if_mib,mikrotik",
"walk_params" = "private",
},
]
walk_param "private" {
retries = "2"
}
walk_param "public" {
retries = "2"
}
}
// Configure a prometheus.scrape component to collect SNMP metrics.
prometheus.scrape "demo" {
targets = prometheus.exporter.snmp.example.targets
forward_to = [ /* ... */ ]
}
The following example uses the local.file
component to read targets from a YAML file and send them to the prometheus.exporter.snmp
component:
local.file "targets" {
filename = "targets.yml"
}
prometheus.exporter.snmp "example" {
config_file = "snmp_modules.yml"
targets = encoding.from_yaml(local.file.targets.content)
walk_param "private" {
retries = "2"
}
walk_param "public" {
retries = "2"
}
}
// Configure a prometheus.scrape component to collect SNMP metrics.
prometheus.scrape "demo" {
targets = prometheus.exporter.snmp.example.targets
forward_to = [ /* ... */ ]
}
The YAML file in this example looks like this:
- name: t1
address: localhost:161
module: default
auth: public_v2
- name: t2
address: localhost:161
module: default
auth: public_v2
The following example uses the discovery.file
component to send targets to the prometheus.exporter.snmp
component:
discovery.file "example" {
files = ["targets.yml"]
}
prometheus.exporter.snmp "example" {
config_file = "snmp_modules.yml"
targets = discovery.file.example.targets
}
// Configure a prometheus.scrape component to collect SNMP metrics.
prometheus.scrape "demo" {
targets = prometheus.exporter.snmp.example.targets
forward_to = [ /* ... */ ]
}
The YAML file in this example looks like this:
- targets:
- localhost:161
labels:
name: t1
module: default
auth: public_v2
- targets:
- localhost:161
labels:
name: t2
module: default
auth: public_v2
Compatible components
prometheus.exporter.snmp
has exports that can be consumed by the following components:
- Components that consume Targets
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.