blackbox_exporter

(★ 5,836)

Blackbox prober exporter

Owner Repos

prometheus ★ 65,773

The Prometheus monitoring system and time series database.

Go
node_exporter ★ 13,711

Exporter for machine metrics

Go
alertmanager ★ 8,589

Prometheus Alertmanager

Go
client_golang ★ 6,019

Prometheus instrumentation library for Go applications

Go
client_python ★ 4,360

Prometheus instrumentation library for Python applications

Python
client_js ★ 3,482

Prometheus client for node.js

JavaScript

File Explorer

ZIP Download
  • .dockerignore
  • .gitignore
  • .golangci.yml
  • .promu.yml
  • .yamllint
  • blackbox.yml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONFIGURATION.md
  • Dockerfile
  • Dockerfile.distroless
  • example.yml
  • go.mod
  • go.sum
  • LICENSE
  • main.go
  • main_test.go
  • MAINTAINERS.md
  • Makefile
  • Makefile.common
  • NOTICE
  • README.md
  • SECURITY.md
  • VERSION

# Installation Guide

go
Prerequisites

Setup Steps

docker run --rm -p 9115/tcp --name blackbox_exporter -v $(pwd):/config quay.io/prometheus/blackbox-exporter:latest --config.file=/config/blackbox.yml

Run Blackbox Exporter using the Docker image.

./blackbox_exporter --config.file=blackbox.yml

Run the compiled binary directly.

Key Commands

docker run --rm -p 9115/tcp --name blackbox_exporter -v $(pwd):/config quay.io/prometheus/blackbox-exporter:latest --config.file=/config/blackbox.yml

Run blackbox_exporter inside a Docker container.

You may need to enable IPv6 in your Docker configuration if required.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Link
Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

docker build

View Details ▼

Build an image from a Dockerfile.

docker build .

Build a Docker image using the Dockerfile in the current directory:

docker build {{github.com/creack/docker-firefox}}

Build a Docker image from a Dockerfile at a specified URL:

docker build {{[-t|--tag]}} {{name:tag}} .

Build a Docker image and tag it:

🔍

docker run

View Details ▼

This command is an alias of `docker container run`.

tldr docker container run

View documentation for the original command:

🔍

http

View Details ▼

HTTPie: an HTTP client designed for testing, debugging, and generally interacting with APIs and HTTP servers.
See also: `xh`.

http {{https://example.com}}

Make a simple GET request (shows response headers and content):

http {{[-p|--print]}} {{H|B|h|b|m|Hh|Hhb|...}} {{https://example.com}}

Print specific parts of the content (`H`: request headers, `B`: request body, `h`: response headers, `b`: response body, `m`: response metadata):

http {{GET|POST|HEAD|PUT|PATCH|DELETE|...}} --proxy {{http|https}}:{{http://localhost:8080|socks5://localhost:9050|...}} {{https://example.com}}

Specify the HTTP method when sending a request and use a proxy to intercept the request:

🔍

timeout

View Details ▼

Run a command with a time limit.

timeout 3s sleep 10

Run `sleep 10` and terminate it after 3 seconds:

timeout {{[-s|--signal]}} {{INT|HUP|KILL|...}} {{5s}} {{sleep 10}}

Send a signal to the command after the time limit expires (`TERM` by default, `kill -l` to list all signals):

timeout {{[-v|--verbose]}} {{0.5s|1m|1h|1d|...}} {{command}}

Send verbose output to `stderr` showing signal sent upon timeout:

// repository documentation