From e6b3ceef0757a8625d41e15945d81fe4e13e371b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan-Otto=20Kr=C3=B6pke?= Date: Fri, 14 Jul 2023 17:49:17 +0200 Subject: [PATCH] Fix README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jan-Otto Kröpke --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 09b79418..4d6ca127 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,11 @@ In addition to static probes, configured via a [configuration file](CONFIGURATIO query parameter on the endpoint `/scrape/dynamic`. Most of the probe configuration can be configured via HTTP query parameter with the schema `.`, e.g. `http.method=POST`. -HTTP query parameter supports only the configuration of top-level parameter. The configuration of sub level parameters needs to be passed as JSON document, e.g. +HTTP query parameter supports only the configuration of top-level parameter. + +If the value of the property is an array, the query parameter needs to be passed with an suffix `[]`, e.g.: `http.valid_http_versions[]` + +The configuration of sub level parameters needs to be passed as JSON document, e.g. `http.http_client_config={"tls_config":{"insecure_skip_verify":true}}` instead `http.http_client_config.tls_config.insecure_skip_verify=true`. ### Examples @@ -158,19 +162,20 @@ scrape_configs: metrics_path: /probe/dynamic params: prober: [http] - http.method: ["POST"] - http.valid_http_versions: ["200", "204"] + http.method: ["OPTIONS"] + http.valid_http_versions[]: ["HTTP/2"] + http.valid_status_codes[]: ["204","301","405"] http.http_client_config: ['{"tls_config":{"insecure_skip_verify":true}}'] static_configs: - targets: - - http://prometheus.io # Target to probe with http. + - https://expired.badssl.com 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 # The blackbox exporter's real hostname:port. + replacement: 127.0.0.1:9115 ```