From c53d3de98d84406c54ee9054685b20f3828d3661 Mon Sep 17 00:00:00 2001 From: Brian Brazil Date: Sat, 5 Sep 2015 20:39:38 +0100 Subject: [PATCH] Add config docs --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 287e3e5..f71628d 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,34 @@ HTTP, HTTPS and TCP. make ./blackbox_exporter +Visiting [http://localhost:9115/probe?address=google.com&module=http2xx](http://localhost:9115/probe?address=google.com&module=http2xx) +will return metrics for a HTTP probe against google.com. + +## Configuration + +A configuration showing all options is below: +``` +modules: + http2xx: + prober: http + timeout: 5s + http: + valid_status_codes: [] # Defaults to 2xx + no_follow_redirects: false + fail_if_ssl: false + fail_if_not_ssl: false + tcpconnect: + prober: tcp + timeout: 5s + icmp: + prober: icmp + timeout: 5s +``` + +HTTP, HTTPS (via the `http` prober), TCP socket and ICMP (v4 only) are currently supported. +Additiona modules can be defined to meet your needs. + + ## Prometheus Configuration The blackbox exporter needs to be passed the target as a parameter, this can be -- 2.25.1