Skip to content

Commit

Permalink
Fix README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Jan-Otto Kröpke <[email protected]>
  • Loading branch information
jkroepke committed Jul 14, 2023
1 parent 6816b9e commit e6b3cee
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<prober>.<setting>`, 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
Expand All @@ -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
```


Expand Down

0 comments on commit e6b3cee

Please sign in to comment.