Bitnami/containers
2
0
Fork 0
mirror of https://github.com/bitnami/containers.git synced 2026-03-17 14:57:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Silvio
2018-04-03 17:16:19 +02:00
parent a71455ef53
commit 7d7bf24334
1 changed files with 5 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
bitnami/blackbox-exporter/README.md
View File

@@ -86,178 +86,6 @@ Generic placeholders are defined as follows:
`<regex>`: a regular expression
The other placeholders are specified separately.
##Module
```yaml
# The protocol over which the probe will take place (http, tcp, dns, icmp).
prober: <prober_string>
# How long the probe will wait before giving up.
[ timeout: <duration> ]
# The specific probe configuration - at most one of these should be specified.
[ http: <http_probe> ]
[ tcp: <tcp_probe> ]
[ dns: <dns_probe> ]
[ icmp: <icmp_probe> ]
```
<http_probe>
```yaml
# Accepted status codes for this probe. Defaults to 2xx.
[ valid_status_codes: <int>, ... | default = 2xx ]
# Accepted HTTP versions for this probe.
[ valid_http_versions: <string>, ... ]
# The HTTP method the probe will use.
[ method: <string> | default = "GET" ]
# The HTTP headers set for the probe.
headers:
[ <string>: <string> ... ]
# Whether or not the probe will follow any redirects.
[ no_follow_redirects: <boolean> | default = false ]
# Probe fails if SSL is present.
[ fail_if_ssl: <boolean> | default = false ]
# Probe fails if SSL is not present.
[ fail_if_not_ssl: <boolean> | default = false ]
# Probe fails if response matches regex.
fail_if_matches_regexp:
[ - <regex>, ... ]
# Probe fails if response does not match regex.
fail_if_not_matches_regexp:
[ - <regex>, ... ]
# Configuration for TLS protocol of HTTP probe.
tls_config:
[ <tls_config> ]
# The HTTP basic authentication credentials for the targets.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
# The bearer token for the targets.
[ bearer_token: <secret> ]
# The bearer token file for the targets.
[ bearer_token_file: <filename> ]
# HTTP proxy server to use to connect to the targets.
[ proxy_url: <string> ]
# The preferred IP protocol of the HTTP probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
# The body of the HTTP request used in probe.
body: [ <string> ]
```
<tcp_probe>
```yaml
# The preferred IP protocol of the TCP probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
# The source IP address.
[ source_ip_address: <string> ]
# The query sent in the TCP probe and the expected associated response.
# starttls upgrades TCP connection to TLS.
query_response:
[ - [ [ expect: <string> ],
[ send: <string> ],
[ starttls: <boolean | default = false> ]
], ...
]
# Whether or not TLS is used when the connection is initiated.
[ tls: <boolean | default = false> ]
# Configuration for TLS protocol of TCP probe.
tls_config:
[ <tls_config> ]
<dns_probe>
# The preferred IP protocol of the DNS probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
# The source IP address.
[ source_ip_address: <string> ]
[ transport_protocol: <string> | default = "udp" ] # udp, tcp
query_name: <string>
[ query_type: <string> | default = "ANY" ]
# List of valid response codes.
valid_rcodes:
[ - <string> ... | default = "NOERROR" ]
validate_answer_rrs:
fail_if_matches_regexp:
[ - <regex>, ... ]
fail_if_not_matches_regexp:
[ - <regex>, ... ]
validate_authority_rrs:
fail_if_matches_regexp:
[ - <regex>, ... ]
fail_if_not_matches_regexp:
[ - <regex>, ... ]
validate_additional_rrs:
fail_if_matches_regexp:
[ - <regex>, ... ]
fail_if_not_matches_regexp:
[ - <regex>, ... ]
```
<icmp_probe>
```yaml
# The preferred IP protocol of the ICMP probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
# The source IP address.
[ source_ip_address: <string> ]
# Set the DF-bit in the IP-header. Only works with ip4 and on *nix systems.
[ dont_fragment: <boolean> | default = false ]
# The size of the payload.
[ payload_size: <int> ]
```
<tls_config>
```yaml
# Disable target certificate validation.
[ insecure_skip_verify: <boolean> | default = false ]
# The CA cert to use for the targets.
[ ca_file: <filename> ]
# The client cert file for the targets.
[ cert_file: <filename> ]
# The client key file for the targets.
[ key_file: <filename> ]
# Used to verify the hostname for the targets.
[ server_name: <string> ]
```
##Prometheus Configuration
The blackbox exporter needs to be passed the target as a parameter, this can be done with relabelling.
Example config:
```yaml
@@ -268,8 +96,8 @@ scrape_configs:
module: [http_2xx] # Look for a HTTP 200 response.
static_configs:
- targets:
- http://bitnami.com # Target to probe with http.
- https://bitnami.com # Target to probe with https.
- http://prometheus.io # Target to probe with http.
- https://prometheus.io # Target to probe with https.
- http://example.com:8080 # Target to probe with http on port 8080.
relabel_configs:
- source_labels: [__address__]
@@ -280,9 +108,11 @@ scrape_configs:
replacement: 127.0.0.1:9115 # The blackbox exporter's real hostname:port.
```
[Further information](https://github.com/prometheus/blackbox_exporter/blob/master/CONFIGURATION.md)
### Mounting a volume
Check the [Persisting your data](# Persisting your application) section to add custom volumes to the Blackbox_exporter container
Check the [Persisting your data](#Persisting your application) section to add custom volumes to the Blackbox_exporter container
# Logging