Prometheus blackbox est un exporter prometheus spécialiser pour interroger des urls et retouner des informations de cette interrogation au format prometheus (si l'interrogation s'est bien déroulé, combien de temps pour effectuer la requête, le code de retour http, etc...).
Ce dossier contient un exemple de configuration pour un déploiment sur kubernetes en utilisant le chart helm de prometheus community
L'exemple est basé sur une configuration pour postgrest.
Ce chart permet d'installer, configurer des sondes blackbox.
Etant donné que tout se configure via le fichier values.yaml d'une chart Helm, il n'est pas possible de profiter de l'interpolation des variables.
Si c'est une limitation, voir l'autre exemple qui propose l'installation et la configuration des sondes blackbox à la main.
Blackbox a besoin d'une target (aka une url), optionnellement un module (comment effectuer la requête et traier la réponse du serveur - par défaut les réponses HTTP 200 sont valides).
Par défaut, blackbox écoute sur le port 9115
curl http://blackbox:9115/probe?target=http://monurl/live
La métrique la plus intéressante est probe_success, qui retourne 1 si l'interrogation de l'url a réussi d'après le module fourni.
# HELP probe_dns_lookup_time_seconds Returns the time taken for probe dns lookup in seconds
# TYPE probe_dns_lookup_time_seconds gauge
probe_dns_lookup_time_seconds 0.000847574
# HELP probe_duration_seconds Returns how long the probe took to complete in seconds
# TYPE probe_duration_seconds gauge
probe_duration_seconds 0.002591255
# HELP probe_failed_due_to_regex Indicates if probe failed due to regex
# TYPE probe_failed_due_to_regex gauge
probe_failed_due_to_regex 0
# HELP probe_http_content_length Length of http content response
# TYPE probe_http_content_length gauge
probe_http_content_length -1
# HELP probe_http_duration_seconds Duration of http request by phase, summed over all redirects
# TYPE probe_http_duration_seconds gauge
probe_http_duration_seconds{phase="connect"} 0.000676965
probe_http_duration_seconds{phase="processing"} 0.000663609
probe_http_duration_seconds{phase="resolve"} 0.000847574
probe_http_duration_seconds{phase="tls"} 0
probe_http_duration_seconds{phase="transfer"} 0.000119573
# HELP probe_http_redirects The number of redirects
# TYPE probe_http_redirects gauge
probe_http_redirects 0
# HELP probe_http_ssl Indicates if SSL was used for the final redirect
# TYPE probe_http_ssl gauge
probe_http_ssl 0
# HELP probe_http_status_code Response HTTP status code
# TYPE probe_http_status_code gauge
probe_http_status_code 200
# HELP probe_http_uncompressed_body_length Length of uncompressed response body
# TYPE probe_http_uncompressed_body_length gauge
probe_http_uncompressed_body_length 0
# HELP probe_http_version Returns the version of HTTP of the probe response
# TYPE probe_http_version gauge
probe_http_version 1.1
# HELP probe_ip_addr_hash Specifies the hash of IP address. It's useful to detect if the IP address changes.
# TYPE probe_ip_addr_hash gauge
probe_ip_addr_hash 8.46910751e+08
# HELP probe_ip_protocol Specifies whether probe ip protocol is IP4 or IP6
# TYPE probe_ip_protocol gauge
probe_ip_protocol 4
# HELP probe_success Displays whether or not the probe was a success
# TYPE probe_success gauge
probe_success 1
Diagramme de séquence
Les urls suivantes sont disponibles:
- /probe: sonde une url et retourne les métriques liés à ce sondage
- /config: affiche la config
- /metrics: affiche les métriques liées à blackbox (ne pas confondre avec /probe qui renvoie des métriques mais celle de l'url sondée)
Les modules permettent de définir le comportement de blackbox pour effectuer la requête (utilisation d'IPv4/6, TLS, token d'authentification) et quelles sont les retours considérés comme valide.