Menu
Open source

prometheus.exporter.snmp

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

Note

prometheus.exporter.snmp uses the latest configuration introduced in version 0.23 of the Prometheus snmp_exporter.

Usage

river
prometheus.exporter.snmp "LABEL" {
  config_file = SNMP_CONFIG_FILE_PATH

  target "TARGET_NAME" {
    address = TARGET_ADDRESS
  }
}

Arguments

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

NameTypeDescriptionDefaultRequired
config_filestringSNMP configuration file defining custom modules.no
configstring or secretSNMP configuration as inline string.no

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 auths 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

Blocks

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

HierarchyNameDescriptionRequired
targettargetConfigures an SNMP target.yes
walk_paramwalk_paramSNMP connection profiles to override default SNMP settings.no

target block

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 will be used in the target’s job label.

NameTypeDescriptionDefaultRequired
addressstringThe address of SNMP device.yes
modulestringSNMP module to use for polling.""no
authstringSNMP authentication profile to use.""no
walk_paramsstringConfig to use for this target.""no

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.

NameTypeDescriptionDefaultRequired
namestringName of the module to override.no
max_repetitionsintHow many objects to request with GET/GETBULK.25no
retriesintHow many times to retry a failed request.3no
timeoutdurationTimeout for each individual SNMP request.no

Exported fields

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

NameTypeDescription
targetslist(map(string))The targets that can be used to collect exporter metrics.

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 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
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" {
        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 = [ /* ... */ ]
}

This example is the same above with using an embedded configuration (with secrets):

river
local.file "snmp_config" {
    path      = "snmp_modules.yml"
    is_secret = true
}

prometheus.exporter.snmp "example" {
    config = local.file.snmp_config.content

    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" {
        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 = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
    endpoint {
        url = PROMETHEUS_REMOTE_WRITE_URL

        basic_auth {
            username = USERNAME
            password = PASSWORD
        }
    }
}

Replace the following:

  • PROMETHEUS_REMOTE_WRITE_URL: The URL of the Prometheus remote_write-compatible server to send metrics to.
  • USERNAME: The username to use for authentication to the remote_write API.
  • PASSWORD: The password to use for authentication to the remote_write API.

Compatible components

prometheus.exporter.snmp has exports that can be consumed by the following components:

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.