Blackbox exporter: Difference between revisions

From wikinotes
m (Will moved page Prometheus blackbox exporter to Blackbox exporter without leaving a redirect)
 
(30 intermediate revisions by the same user not shown)
Line 1: Line 1:
Prometheus exporter that probes endpoints over HTTP/HTTPS/DNS/TCP/ICMP.
[[prometheus]] exporter that probes endpoints over HTTP/HTTPS/DNS/TCP/ICMP.


= Documentation =
= Documentation =
Line 18: Line 18:
|-
|-
| <code>9115</code> || default port
| <code>9115</code> || default port
|-
| <code>http://localhost:9115</code> || simple web-ui, with sample probe to prometheus.io
|-
|-
| <code>${PREFIX}/etc/blackbox_exporter.yml</code> || config
| <code>${PREFIX}/etc/blackbox_exporter.yml</code> || config
Line 24: Line 26:
</blockquote><!-- Locations -->
</blockquote><!-- Locations -->


= Install =
= Notes =
<blockquote>
<blockquote>
<syntaxhighlight lang="bash">
{| class="wikitable"
pacman -S prometheus-blackbox-exporter  # Archlinux
|-
pkg install blackbox_exporter          # FreeBSD
| [[blackbox_exporter install]]
</syntaxhighlight>
|-
</blockquote><!-- Install -->
| [[blackbox_exporter configuration]]
 
|-
= Configuration =
| [[blackbox_exporter usage]]
<blockquote>
|-
* You define your own test-modules (endpoints test-conditions) in <code>blackbox_exporter.yml</code>.
| [[blackbox_exporter debugging]]
* You configure test-modules to test endpoints with in your <code>prometheus.yml</code>.
|-
 
|}
== Define Test-Modules ==
</blockquote><!-- Notes -->
<blockquote>
<syntaxhighlight lang="yaml">
# /usr/local/etc/blackbox_exporter.yml
 
modules:
  http_2xx:
    prober: http
    timeout: 5s
    http:
      valid_status_codes: 2xx
      method: GET
      follow_redirects: true
      fail_if_not_ssl: true
 
  http_401:
    prober: http
    timeout: 5s
    http:
      valid_status_codes: 401
      method: GET
      follow_redirects: true
      fail_if_not_ssl: true
</syntaxhighlight>
 
Here we configure two test-modules.<br>
The first tests for a HTTP-2XX return-code, the second for an HTTP-401.
 
See the sample config where all options/types are documented.
</blockquote><!-- Define Test-Modules -->
 
== Use Modules ==
<blockquote>
<syntaxhighlight lang="yaml">
# /usr/local/etc/prometheus.yml
 
global:
  scrape_interval: 120s
 
scrape_configs:
  - job_name: http_2xx
    params:
      module: [http_2xx]
    static_configs:
      - targets:
        - https://foo.com
        - https://bar.net
    relabel_configs:
      - source_labels: [__address__]
        target_label: __param_target
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:9115
 
</syntaxhighlight>
 
This config creates a scrape-job that uses our <code>http_2xx</code> module to test both <code>https://foo.com</code> and <code>https://bar.net</code>.
</blockquote><!-- Use Modules -->
</blockquote><!-- Configuration -->

Latest revision as of 14:31, 20 February 2022

prometheus exporter that probes endpoints over HTTP/HTTPS/DNS/TCP/ICMP.

Documentation

github https://github.com/prometheus/blackbox_exporter
config syntax https://github.com/prometheus/blackbox_exporter/blob/master/CONFIGURATION.md
example config https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

Locations

9115 default port
http://localhost:9115 simple web-ui, with sample probe to prometheus.io
${PREFIX}/etc/blackbox_exporter.yml config

Notes

blackbox_exporter install
blackbox_exporter configuration
blackbox_exporter usage
blackbox_exporter debugging
Retrieved from "http://willpittman.net:8080/index.php?title=Blackbox_exporter&oldid=29021"