This is documentation for the next version of Alloy. For the latest stable release, go to the latest version.

Documentation Grafana Alloy Reference Components prometheus prometheus.exporter.blackbox

prometheus.exporter.blackbox

The prometheus.exporter.blackbox component embeds blackbox_exporter. blackbox_exporter lets you collect blackbox metrics (probes) and expose them as Prometheus metrics.

Usage

alloy Copy

prometheus.exporter.blackbox "LABEL" {
  target {
    name    = "example"
    address = "EXAMPLE_ADDRESS"
  }
}

or

alloy Copy

prometheus.exporter.blackbox "LABEL" {
  targets = TARGET_LIST
}

Arguments

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

Either config_file or config must be specified. The config_file argument points to a YAML file defining which blackbox_exporter modules to use. The config argument must be a YAML document as string defining which blackbox_exporter modules 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

You can’t use both the targets argument and the target block in the same configuration file. The targets argument must be used when blackbox targets cannot be passed as a target block because another component supplies them.

You can set the following labels to a target:

• name: The name of the target to probe (required).
• address: The address of the target to probe (required).
• module: The blackbox module to use to probe.

The component passes any additional labels to the exported target.

Refer to blackbox_exporter for more information about generating a configuration file.

Blocks

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

target block

The target block defines an individual blackbox target. The target block may be specified multiple times to define multiple targets. name attribute is required and will be used in the target’s job label.

Labels specified in the labels argument won’t override labels set by blackbox_exporter.

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.blackbox is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.blackbox doesn’t expose any component-specific debug information.

Debug metrics

prometheus.exporter.blackbox doesn’t expose any component-specific debug metrics.

Examples

Collect metrics using a blackbox exporter configuration file

This example uses a prometheus.scrape component to collect metrics from prometheus.exporter.blackbox. It adds an extra label, env="dev", to the metrics emitted by the grafana target. The example target doesn’t have any added labels.

The config_file argument is used to define which blackbox_exporter modules to use. You can use the blackbox example config file.

alloy Copy

prometheus.exporter.blackbox "example" {
  config_file = "blackbox_modules.yml"

  target {
    name    = "example"
    address = "https://example.com"
    module  = "http_2xx"
  }

  target {
    name    = "grafana"
    address = "https://grafana.com"
    module  = "http_2xx"
    labels = {
      "env" = "dev",
    }
  }
}

// Configure a prometheus.scrape component to collect blackbox metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.blackbox.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.

Collect metrics using an embedded configuration

This example uses an embedded configuration:

alloy Copy

prometheus.exporter.blackbox "example" {
  config = "{ modules: { http_2xx: { prober: http, timeout: 5s } } }"

  target {
    name    = "example"
    address = "https://example.com"
    module  = "http_2xx"
  }

  target {
    name    = "grafana"
    address = "https://grafana.com"
    module  = "http_2xx"
    labels = {
      "env" = "dev",
    }
  }
}

// Configure a prometheus.scrape component to collect blackbox metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.blackbox.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
    }
  }
}

Collect metrics from a dynamic set of targets

This example is the same as above but the blackbox targets are discovered via a discovery.file component and sent to the prometheus.exporter.blackbox:

alloy Copy

discovery.file "example" {
  files = ["targets.yml"]
}

prometheus.exporter.blackbox "example" {
  config = "{ modules: { http_2xx: { prober: http, timeout: 5s } } }"
  targets = discovery.file.example.targets
}

prometheus.scrape "example" {
  targets    = prometheus.exporter.blackbox.example.targets
  forward_to = [prometheus.remote_write.example.receiver]
}

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

    basic_auth {
      username = USERNAME
      password = PASSWORD
    }
  }
}

The YAML file in this example looks like this:

yaml Copy

- targets:
  - localhost:9009
  labels:
    name: t1
    module: http_2xx
    other_label: example
- targets:
  - localhost:9009
  labels:
    name: t2
    module: http_2xx

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.blackbox has exports that can be consumed by the following components:

• Components that consume Targets