File blackbox_exporter-0.24.0.obscpio of Package prometheus-blackbox_exporter.29669
07070100000000000041ED0000000000000000000000026463639800000000000000000000000000000000000000000000002300000000blackbox_exporter-0.24.0/.circleci07070100000001000081A4000000000000000000000001646363980000084B000000000000000000000000000000000000002E00000000blackbox_exporter-0.24.0/.circleci/config.ymlversion: 2.1
orbs:
prometheus: prometheus/prometheus@0.17.1
executors:
# Whenever the Go version is updated here, .promu.yml should also be updated.
golang:
docker:
- image: cimg/go:1.20
jobs:
test:
executor: golang
steps:
- prometheus/setup_environment
- run: make
- prometheus/store_artifact:
file: blackbox_exporter
- run: git diff --exit-code
# IPv6 tests require the machine executor.
# See https://circleci.com/docs/2.0/faq/#can-i-use-ipv6-in-my-tests for details.
test-ipv6:
machine: true
working_directory: /home/circleci/.go_workspace/src/github.com/prometheus/blackbox_exporter
# Whenever the Go version is updated here, .travis.yml and .promu.yml
# should also be updated.
environment:
DOCKER_TEST_IMAGE_NAME: quay.io/prometheus/golang-builder:1.17-base
steps:
- checkout
- run:
name: enable ipv6
command: |
cat \<<'EOF' | sudo tee /etc/docker/daemon.json
{
"ipv6": true,
"fixed-cidr-v6": "2001:db8:1::/64"
}
EOF
sudo service docker restart
- run: docker run --rm -t -v "$(pwd):/app" "${DOCKER_TEST_IMAGE_NAME}" -i github.com/prometheus/blackbox_exporter -T
workflows:
version: 2
blackbox_exporter:
jobs:
- test:
filters:
tags:
only: /.*/
- test-ipv6:
filters:
tags:
only: /.*/
- prometheus/build:
name: build
filters:
tags:
only: /.*/
- prometheus/publish_master:
context: org-context
requires:
- test
- test-ipv6
- build
filters:
branches:
only: master
- prometheus/publish_release:
context: org-context
requires:
- test
- test-ipv6
- build
filters:
tags:
only: /^v[0-9]+(\.[0-9]+){2}(-.+|[^-.]*)$/
branches:
ignore: /.*/
07070100000002000081A40000000000000000000000016463639800000067000000000000000000000000000000000000002700000000blackbox_exporter-0.24.0/.dockerignore.build/
.tarballs/
!.build/linux-amd64/
!.build/linux-armv7
!.build/linux-arm64
!.build/linux-ppc64le
07070100000003000041ED0000000000000000000000036463639800000000000000000000000000000000000000000000002100000000blackbox_exporter-0.24.0/.github07070100000004000081A40000000000000000000000016463639800000348000000000000000000000000000000000000003300000000blackbox_exporter-0.24.0/.github/ISSUE_TEMPLATE.md<!--
Please note: GitHub issues should only be used for feature requests and
bug reports. For general discussions, please refer to one of the community channels
described in https://prometheus.io/community/.
For bug reports, please fill out the below fields and provide as much detail
as possible about your issue. For feature requests, you may omit the
following template.
-->
### Host operating system: output of `uname -a`
### blackbox_exporter version: output of `blackbox_exporter --version`
<!-- If building from source, run `make` first. -->
### What is the blackbox.yml module config.
### What is the prometheus.yml scrape config.
### What logging output did you get from adding `&debug=true` to the probe URL?
### What did you do that produced an error?
### What did you expect to see?
### What did you see instead?
07070100000005000081A4000000000000000000000001646363980000006E000000000000000000000000000000000000003000000000blackbox_exporter-0.24.0/.github/dependabot.ymlversion: 2
updates:
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "monthly"
07070100000006000041ED0000000000000000000000026463639800000000000000000000000000000000000000000000002B00000000blackbox_exporter-0.24.0/.github/workflows07070100000007000081A400000000000000000000000164636398000002FB000000000000000000000000000000000000003D00000000blackbox_exporter-0.24.0/.github/workflows/golangci-lint.ymlname: golangci-lint
on:
push:
paths:
- "go.sum"
- "go.mod"
- "**.go"
- "scripts/errcheck_excludes.txt"
- ".github/workflows/golangci-lint.yml"
- ".golangci.yml"
pull_request:
jobs:
golangci:
name: lint
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: install Go
uses: actions/setup-go@v3
with:
go-version: 1.20.x
- name: Install snmp_exporter/generator dependencies
run: sudo apt-get update && sudo apt-get -y install libsnmp-dev
if: github.repository == 'prometheus/snmp_exporter'
- name: Lint
uses: golangci/golangci-lint-action@v3.4.0
with:
version: v1.51.2
07070100000008000081A40000000000000000000000016463639800000156000000000000000000000000000000000000002400000000blackbox_exporter-0.24.0/.gitignore# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.o
*.a
*.so
# Folders
_obj
_test
# Architecture specific extensions/prefixes
*.[568vq]
[568vq].out
*.cgo1.go
*.cgo2.c
_cgo_defun.c
_cgo_gotypes.go
_cgo_export.*
_testmain.go
*.exe
dependencies-stamp
/blackbox_exporter
/.build
/.release
/.tarballs
.deps
*.tar.gz
/vendor
07070100000009000081A40000000000000000000000016463639800000086000000000000000000000000000000000000002700000000blackbox_exporter-0.24.0/.golangci.yml# Run only staticcheck for now. Additional linters will be enabled one-by-one.
linters:
enable:
- staticcheck
disable-all: true
0707010000000A000081A400000000000000000000000164636398000002B4000000000000000000000000000000000000002400000000blackbox_exporter-0.24.0/.promu.ymlgo:
# Whenever the Go version is updated here, .travis.yml and
# .circle/config.yml should also be updated.
version: 1.20
repository:
path: github.com/prometheus/blackbox_exporter
build:
flags: -a -tags netgo
ldflags: |
-X github.com/prometheus/common/version.Version={{.Version}}
-X github.com/prometheus/common/version.Revision={{.Revision}}
-X github.com/prometheus/common/version.Branch={{.Branch}}
-X github.com/prometheus/common/version.BuildUser={{user}}@{{host}}
-X github.com/prometheus/common/version.BuildDate={{date "20060102-15:04:05"}}
tarball:
files:
- blackbox.yml
- LICENSE
- NOTICE
0707010000000B000081A400000000000000000000000164636398000001C9000000000000000000000000000000000000002300000000blackbox_exporter-0.24.0/.yamllint---
extends: default
rules:
braces:
max-spaces-inside: 1
level: error
brackets:
max-spaces-inside: 1
level: error
commas: disable
comments: disable
comments-indentation: disable
document-start: disable
indentation:
spaces: consistent
indent-sequences: consistent
key-duplicates:
ignore: |
config/testdata/section_key_dup.bad.yml
line-length: disable
truthy:
ignore: |
.github/workflows/*.yml
0707010000000C000081A40000000000000000000000016463639800000AE9000000000000000000000000000000000000002600000000blackbox_exporter-0.24.0/CHANGELOG.md## 0.24.0 / 2023-05-16
* [CHANGE] Make Proxy Connect Headers consistent with Prometheus #1008
* [FEATURE] Add hostname parameter for TCP probe #981
* [FEATURE] Add support for HTTP request body as file #987
## 0.23.0 / 2022-12-02
* [SECURITY] Update Exporter Toolkit (CVE-2022-46146) #979
* [FEATURE] Support multiple Listen Addresses and systemd socket activation #979
* [FEATURE] Add leaf certificate details in a new `probe_ssl_last_chain_info` metric. #943
* [FEATURE] DNS: Add `Add probe_dns_query_succeeded` metric. #990
## 0.22.0 / 2022-08-02
* [FEATURE] HTTP: Add `skip_resolve_phase_with_proxy` option. #944
* [ENHANCEMENT] OAuth: Use Blackbox Exporter user agent when doing OAuth2
authenticated requests. #948
* [ENHANCEMENT] Print usage and help to stdout instead of stderr. #928
## 0.21.1 / 2022-06-17
* [BUGFIX] Fix a data race in HTTP probes. #929
## 0.21.0 / 2022-05-30
This Prometheus release is built with go1.18, which contains two noticeable
changes related to TLS and HTTP:
1. [TLS 1.0 and 1.1 disabled by default client-side](https://go.dev/doc/go1.18#tls10).
Blackbox Exporter users can override this with the `min_version` parameter of
[tls_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#tls_config).
2. [Certificates signed with the SHA-1 hash function are rejected](https://go.dev/doc/go1.18#sha1).
This doesn't apply to self-signed root certificates.
* [BUGFIX] Prevent setting negative timeouts when using a small scrape interval. #869
## 0.20.0 / 2022-03-16
* [FEATURE] Add support for grpc health check. #835
* [FEATURE] Add hostname parameter. #823
* [ENHANCEMENT] Add body_size_limit option to http module. #836
* [ENHANCEMENT] Change default user agent. #557
* [ENHANCEMENT] Add control of recursion desired flag for DNS probes. #859
* [ENHANCEMENT] Delay init of http phase values. #865
* [BUGFIX] Fix IP hash. #863
## 0.19.0 / 2021-05-10
In the HTTP probe, `no_follow_redirects` has been changed to `follow_redirects`.
This release accepts both, with a precedence to the `no_follow_redirects` parameter.
In the next release, `no_follow_redirects` will be removed.
* [CHANGE] HTTP probe: `no_follow_redirects` has been renamed to `follow_redirects`. #784
* [FEATURE] Add support for decompression of HTTP responses. #764
* [FEATURE] Enable TLS and basic authentication. #730
* [FEATURE] HTTP probe: *experimental* OAuth2 support. #784
* [ENHANCEMENT] Add a health endpoint. #752
* [ENHANCEMENT] Add a metric for unknown probes. #716
* [ENHANCEMENT] Use preferred protocol first when resolving hostname. #728
* [ENHANCEMENT] Validating the configuration tries to compile regexes. #729
* [BUGFIX] HTTP probe: Fix error checking. #723
* [BUGFIX] HTTP probe: Fix how the TLS phase is calculated. #758
0707010000000D000081A40000000000000000000000016463639800000098000000000000000000000000000000000000002C00000000blackbox_exporter-0.24.0/CODE_OF_CONDUCT.md# Prometheus Community Code of Conduct
Prometheus follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
0707010000000E000081A40000000000000000000000016463639800002978000000000000000000000000000000000000002A00000000blackbox_exporter-0.24.0/CONFIGURATION.md# Blackbox exporter configuration
The file is written in [YAML format](http://en.wikipedia.org/wiki/YAML), defined by the scheme described below.
Brackets indicate that a parameter is optional.
For non-list parameters the value is set to the specified default.
Generic placeholders are defined as follows:
* `<boolean>`: a boolean that can take the values `true` or `false`
* `<int>`: a regular integer
* `<duration>`: a duration matching the regular expression `[0-9]+(ms|[smhdwy])`
* `<filename>`: a valid path in the current working directory
* `<string>`: a regular string
* `<secret>`: a regular string that is a secret, such as a password
* `<regex>`: a regular expression
The other placeholders are specified separately.
See [example.yml](example.yml) for configuration examples.
```yml
modules:
[ <string>: <module> ... ]
```
### `<module>`
```yml
# The protocol over which the probe will take place (http, tcp, dns, icmp, grpc).
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> ]
[ grpc: <grpc_probe> ]
```
### `<http_probe>`
```yml
# 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> ... ]
# The maximum uncompressed body length in bytes that will be processed. A value of 0 means no limit.
#
# If the response includes a Content-Length header, it is NOT validated against this value. This
# setting is only meant to limit the amount of data that you are willing to read from the server.
#
# Example: 10MB
[ body_size_limit: <size> | default = 0 ]
# The compression algorithm to use to decompress the response (gzip, br, deflate, identity).
#
# If an "Accept-Encoding" header is specified, it MUST be such that the compression algorithm
# indicated using this option is acceptable. For example, you can use `compression: gzip` and
# `Accept-Encoding: br, gzip` or `Accept-Encoding: br;q=1.0, gzip;q=0.9`. The fact that gzip is
# acceptable with a lower quality than br does not invalidate the configuration, as you might
# be testing that the server does not return br-encoded content even if it's requested. On the
# other hand, `compression: gzip` and `Accept-Encoding: br, identity` is NOT a valid
# configuration, because you are asking for gzip to NOT be returned, and trying to decompress
# whatever the server returns is likely going to fail.
[ compression: <string> | default = "" ]
# Whether or not the probe will follow any redirects.
[ follow_redirects: <boolean> | default = true ]
# 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 body matches regex.
fail_if_body_matches_regexp:
[ - <regex>, ... ]
# Probe fails if response body does not match regex.
fail_if_body_not_matches_regexp:
[ - <regex>, ... ]
# Probe fails if response header matches regex. For headers with multiple values, fails if *at least one* matches.
fail_if_header_matches:
[ - <http_header_match_spec>, ... ]
# Probe fails if response header does not match regex. For headers with multiple values, fails if *none* match.
fail_if_header_not_matches:
[ - <http_header_match_spec>, ... ]
# Configuration for TLS protocol of HTTP probe.
tls_config:
[ <tls_config> ]
# The HTTP basic authentication credentials.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <filename> ]
# Sets the `Authorization` header on every request with
# the configured credentials.
authorization:
# Sets the authentication type of the request.
[ type: <string> | default: Bearer ]
# Sets the credentials of the request. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials of the request with the credentials read from the
# configured file. It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]
# HTTP proxy server to use to connect to the targets.
[ proxy_url: <string> ]
# Comma-separated string that can contain IPs, CIDR notation, domain names
# that should be excluded from proxying. IP and domain names can
# contain port numbers.
[ no_proxy: <string> ]
# Use proxy URL indicated by environment variables (HTTP_PROXY, https_proxy, HTTPs_PROXY, https_proxy, and no_proxy)
[ proxy_from_environment: <bool> | default: false ]
# Specifies headers to send to proxies during CONNECT requests.
[ proxy_connect_headers:
[ <string>: [<secret>, ...] ] ]
# Skip DNS resolution and URL change when an HTTP proxy (proxy_url or proxy_from_environment) is set.
[ skip_resolve_phase_with_proxy: <boolean> | default = false ]
# OAuth 2.0 configuration to use to connect to the targets.
oauth2:
[ <oauth2> ]
# Whether to enable HTTP2.
[ enable_http2: <bool> | default: true ]
# The IP protocol of the HTTP probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
[ ip_protocol_fallback: <boolean> | default = true ]
# The body of the HTTP request used in probe.
[ body: <string> ]
# Read the HTTP request body from from a file.
# It is mutually exclusive with `body`.
[ body_file: <filename> ]
```
#### `<http_header_match_spec>`
```yml
header: <string>,
regexp: <regex>,
[ allow_missing: <boolean> | default = false ]
```
### `<tcp_probe>`
```yml
# The IP protocol of the TCP probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
[ ip_protocol_fallback: <boolean | default = true> ]
# 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>`
```yml
# The IP protocol of the DNS probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
[ ip_protocol_fallback: <boolean | default = true> ]
# The source IP address.
[ source_ip_address: <string> ]
[ transport_protocol: <string> | default = "udp" ] # udp, tcp
# Whether to use DNS over TLS. This only works with TCP.
[ dns_over_tls: <boolean | default = false> ]
# Configuration for TLS protocol of DNS over TLS probe.
tls_config:
[ <tls_config> ]
query_name: <string>
[ query_type: <string> | default = "ANY" ]
[ query_class: <string> | default = "IN" ]
# Set the recursion desired (RD) flag in the request.
[ recursion_desired: <boolean> | default = true ]
# List of valid response codes.
valid_rcodes:
[ - <string> ... | default = "NOERROR" ]
validate_answer_rrs:
fail_if_matches_regexp:
[ - <regex>, ... ]
fail_if_all_match_regexp:
[ - <regex>, ... ]
fail_if_not_matches_regexp:
[ - <regex>, ... ]
fail_if_none_matches_regexp:
[ - <regex>, ... ]
validate_authority_rrs:
fail_if_matches_regexp:
[ - <regex>, ... ]
fail_if_all_match_regexp:
[ - <regex>, ... ]
fail_if_not_matches_regexp:
[ - <regex>, ... ]
fail_if_none_matches_regexp:
[ - <regex>, ... ]
validate_additional_rrs:
fail_if_matches_regexp:
[ - <regex>, ... ]
fail_if_all_match_regexp:
[ - <regex>, ... ]
fail_if_not_matches_regexp:
[ - <regex>, ... ]
fail_if_none_matches_regexp:
[ - <regex>, ... ]
```
### `<icmp_probe>`
```yml
# The IP protocol of the ICMP probe (ip4, ip6).
[ preferred_ip_protocol: <string> | default = "ip6" ]
[ ip_protocol_fallback: <boolean | default = true> ]
# The source IP address.
[ source_ip_address: <string> ]
# Set the DF-bit in the IP-header. Only works with ip4, on *nix systems and
# requires raw sockets (i.e. root or CAP_NET_RAW on Linux).
[ dont_fragment: <boolean> | default = false ]
# The size of the payload.
[ payload_size: <int> ]
# TTL of outbound packets. Value must be in the range [0, 255]. Can be used
# to test reachability of a target within a given number of hops, for example,
# to determine when network routing has changed.
[ ttl: <int> ]
```
### `<grpc_probe>`
```yml
# The service name to query for health status.
[ service: <string> ]
# The IP protocol of the gRPC probe (ip4, ip6).
[ preferred_ip_protocol: <string> ]
[ ip_protocol_fallback: <boolean> | default = true ]
# Whether to connect to the endpoint with TLS.
[ tls: <boolean | default = false> ]
# Configuration for TLS protocol of gRPC probe.
tls_config:
[ <tls_config> ]
```
### `<tls_config>`
```yml
# 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> ]
# Minimum acceptable TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS
# 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3).
# If unset, Prometheus will use Go default minimum version, which is TLS 1.2.
# See MinVersion in https://pkg.go.dev/crypto/tls#Config.
[ min_version: <string> ]
```
#### `<oauth2>`
OAuth 2.0 authentication using the client credentials grant type. Blackbox
exporter fetches an access token from the specified endpoint with the given
client access and secret keys.
NOTE: This is *experimental* in the blackbox exporter and might not be
reflected properly in the probe metrics at the moment.
```yml
client_id: <string>
[ client_secret: <secret> ]
# Read the client secret from a file.
# It is mutually exclusive with `client_secret`.
[ client_secret_file: <filename> ]
# Scopes for the token request.
scopes:
[ - <string> ... ]
# The URL to fetch the token from.
token_url: <string>
# Optional parameters to append to the token URL.
endpoint_params:
[ <string>: <string> ... ]
```
0707010000000F000081A400000000000000000000000164636398000001C4000000000000000000000000000000000000002400000000blackbox_exporter-0.24.0/DockerfileARG ARCH="amd64"
ARG OS="linux"
FROM quay.io/prometheus/busybox-${OS}-${ARCH}:latest
LABEL maintainer="The Prometheus Authors <prometheus-developers@googlegroups.com>"
ARG ARCH="amd64"
ARG OS="linux"
COPY .build/${OS}-${ARCH}/blackbox_exporter /bin/blackbox_exporter
COPY blackbox.yml /etc/blackbox_exporter/config.yml
EXPOSE 9115
ENTRYPOINT [ "/bin/blackbox_exporter" ]
CMD [ "--config.file=/etc/blackbox_exporter/config.yml" ]
07070100000010000081A40000000000000000000000016463639800002C5D000000000000000000000000000000000000002100000000blackbox_exporter-0.24.0/LICENSE Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
07070100000011000081A400000000000000000000000164636398000000A8000000000000000000000000000000000000002800000000blackbox_exporter-0.24.0/MAINTAINERS.md* Julien Pivotto <roidelapluie@prometheus.io> @roidelapluie
* Marcelo Magallon <marcelo.magallon@grafana.com> @mem
* Suraj Nath <suraj.sidh@grafana.com> @electron0zero
07070100000012000081A40000000000000000000000016463639800000306000000000000000000000000000000000000002200000000blackbox_exporter-0.24.0/Makefile# Copyright 2016 The Prometheus Authors
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Needs to be defined before including Makefile.common to auto-generate targets
DOCKER_ARCHS ?= amd64 armv7 arm64 ppc64le
include Makefile.common
DOCKER_IMAGE_NAME ?= blackbox-exporter
07070100000013000081A4000000000000000000000001646363980000238B000000000000000000000000000000000000002900000000blackbox_exporter-0.24.0/Makefile.common# Copyright 2018 The Prometheus Authors
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# A common Makefile that includes rules to be reused in different prometheus projects.
# !!! Open PRs only against the prometheus/prometheus/Makefile.common repository!
# Example usage :
# Create the main Makefile in the root project directory.
# include Makefile.common
# customTarget:
# @echo ">> Running customTarget"
#
# Ensure GOBIN is not set during build so that promu is installed to the correct path
unexport GOBIN
GO ?= go
GOFMT ?= $(GO)fmt
FIRST_GOPATH := $(firstword $(subst :, ,$(shell $(GO) env GOPATH)))
GOOPTS ?=
GOHOSTOS ?= $(shell $(GO) env GOHOSTOS)
GOHOSTARCH ?= $(shell $(GO) env GOHOSTARCH)
GO_VERSION ?= $(shell $(GO) version)
GO_VERSION_NUMBER ?= $(word 3, $(GO_VERSION))
PRE_GO_111 ?= $(shell echo $(GO_VERSION_NUMBER) | grep -E 'go1\.(10|[0-9])\.')
PROMU := $(FIRST_GOPATH)/bin/promu
pkgs = ./...
ifeq (arm, $(GOHOSTARCH))
GOHOSTARM ?= $(shell GOARM= $(GO) env GOARM)
GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH)v$(GOHOSTARM)
else
GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH)
endif
GOTEST := $(GO) test
GOTEST_DIR :=
ifneq ($(CIRCLE_JOB),)
ifneq ($(shell which gotestsum),)
GOTEST_DIR := test-results
GOTEST := gotestsum --junitfile $(GOTEST_DIR)/unit-tests.xml --
endif
endif
PROMU_VERSION ?= 0.14.0
PROMU_URL := https://github.com/prometheus/promu/releases/download/v$(PROMU_VERSION)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM).tar.gz
SKIP_GOLANGCI_LINT :=
GOLANGCI_LINT :=
GOLANGCI_LINT_OPTS ?=
GOLANGCI_LINT_VERSION ?= v1.51.2
# golangci-lint only supports linux, darwin and windows platforms on i386/amd64.
# windows isn't included here because of the path separator being different.
ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux darwin))
ifeq ($(GOHOSTARCH),$(filter $(GOHOSTARCH),amd64 i386))
# If we're in CI and there is an Actions file, that means the linter
# is being run in Actions, so we don't need to run it here.
ifneq (,$(SKIP_GOLANGCI_LINT))
GOLANGCI_LINT :=
else ifeq (,$(CIRCLE_JOB))
GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint
else ifeq (,$(wildcard .github/workflows/golangci-lint.yml))
GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint
endif
endif
endif
PREFIX ?= $(shell pwd)
BIN_DIR ?= $(shell pwd)
DOCKER_IMAGE_TAG ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))
DOCKERFILE_PATH ?= ./Dockerfile
DOCKERBUILD_CONTEXT ?= ./
DOCKER_REPO ?= prom
DOCKER_ARCHS ?= amd64
BUILD_DOCKER_ARCHS = $(addprefix common-docker-,$(DOCKER_ARCHS))
PUBLISH_DOCKER_ARCHS = $(addprefix common-docker-publish-,$(DOCKER_ARCHS))
TAG_DOCKER_ARCHS = $(addprefix common-docker-tag-latest-,$(DOCKER_ARCHS))
SANITIZED_DOCKER_IMAGE_TAG := $(subst +,-,$(DOCKER_IMAGE_TAG))
ifeq ($(GOHOSTARCH),amd64)
ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux freebsd darwin windows))
# Only supported on amd64
test-flags := -race
endif
endif
# This rule is used to forward a target like "build" to "common-build". This
# allows a new "build" target to be defined in a Makefile which includes this
# one and override "common-build" without override warnings.
%: common-% ;
.PHONY: common-all
common-all: precheck style check_license lint yamllint unused build test
.PHONY: common-style
common-style:
@echo ">> checking code style"
@fmtRes=$$($(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print)); \
if [ -n "$${fmtRes}" ]; then \
echo "gofmt checking failed!"; echo "$${fmtRes}"; echo; \
echo "Please ensure you are using $$($(GO) version) for formatting code."; \
exit 1; \
fi
.PHONY: common-check_license
common-check_license:
@echo ">> checking license header"
@licRes=$$(for file in $$(find . -type f -iname '*.go' ! -path './vendor/*') ; do \
awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \
done); \
if [ -n "$${licRes}" ]; then \
echo "license header checking failed:"; echo "$${licRes}"; \
exit 1; \
fi
.PHONY: common-deps
common-deps:
@echo ">> getting dependencies"
$(GO) mod download
.PHONY: update-go-deps
update-go-deps:
@echo ">> updating Go dependencies"
@for m in $$($(GO) list -mod=readonly -m -f '{{ if and (not .Indirect) (not .Main)}}{{.Path}}{{end}}' all); do \
$(GO) get -d $$m; \
done
$(GO) mod tidy
.PHONY: common-test-short
common-test-short: $(GOTEST_DIR)
@echo ">> running short tests"
$(GOTEST) -short $(GOOPTS) $(pkgs)
.PHONY: common-test
common-test: $(GOTEST_DIR)
@echo ">> running all tests"
$(GOTEST) $(test-flags) $(GOOPTS) $(pkgs)
$(GOTEST_DIR):
@mkdir -p $@
.PHONY: common-format
common-format:
@echo ">> formatting code"
$(GO) fmt $(pkgs)
.PHONY: common-vet
common-vet:
@echo ">> vetting code"
$(GO) vet $(GOOPTS) $(pkgs)
.PHONY: common-lint
common-lint: $(GOLANGCI_LINT)
ifdef GOLANGCI_LINT
@echo ">> running golangci-lint"
# 'go list' needs to be executed before staticcheck to prepopulate the modules cache.
# Otherwise staticcheck might fail randomly for some reason not yet explained.
$(GO) list -e -compiled -test=true -export=false -deps=true -find=false -tags= -- ./... > /dev/null
$(GOLANGCI_LINT) run $(GOLANGCI_LINT_OPTS) $(pkgs)
endif
.PHONY: common-yamllint
common-yamllint:
@echo ">> running yamllint on all YAML files in the repository"
ifeq (, $(shell which yamllint))
@echo "yamllint not installed so skipping"
else
yamllint .
endif
# For backward-compatibility.
.PHONY: common-staticcheck
common-staticcheck: lint
.PHONY: common-unused
common-unused:
@echo ">> running check for unused/missing packages in go.mod"
$(GO) mod tidy
@git diff --exit-code -- go.sum go.mod
.PHONY: common-build
common-build: promu
@echo ">> building binaries"
$(PROMU) build --prefix $(PREFIX) $(PROMU_BINARIES)
.PHONY: common-tarball
common-tarball: promu
@echo ">> building release tarball"
$(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR)
.PHONY: common-docker $(BUILD_DOCKER_ARCHS)
common-docker: $(BUILD_DOCKER_ARCHS)
$(BUILD_DOCKER_ARCHS): common-docker-%:
docker build -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)" \
-f $(DOCKERFILE_PATH) \
--build-arg ARCH="$*" \
--build-arg OS="linux" \
$(DOCKERBUILD_CONTEXT)
.PHONY: common-docker-publish $(PUBLISH_DOCKER_ARCHS)
common-docker-publish: $(PUBLISH_DOCKER_ARCHS)
$(PUBLISH_DOCKER_ARCHS): common-docker-publish-%:
docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)"
DOCKER_MAJOR_VERSION_TAG = $(firstword $(subst ., ,$(shell cat VERSION)))
.PHONY: common-docker-tag-latest $(TAG_DOCKER_ARCHS)
common-docker-tag-latest: $(TAG_DOCKER_ARCHS)
$(TAG_DOCKER_ARCHS): common-docker-tag-latest-%:
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:latest"
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:v$(DOCKER_MAJOR_VERSION_TAG)"
.PHONY: common-docker-manifest
common-docker-manifest:
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest create -a "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)" $(foreach ARCH,$(DOCKER_ARCHS),$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$(ARCH):$(SANITIZED_DOCKER_IMAGE_TAG))
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)"
.PHONY: promu
promu: $(PROMU)
$(PROMU):
$(eval PROMU_TMP := $(shell mktemp -d))
curl -s -L $(PROMU_URL) | tar -xvzf - -C $(PROMU_TMP)
mkdir -p $(FIRST_GOPATH)/bin
cp $(PROMU_TMP)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM)/promu $(FIRST_GOPATH)/bin/promu
rm -r $(PROMU_TMP)
.PHONY: proto
proto:
@echo ">> generating code from proto files"
@./scripts/genproto.sh
ifdef GOLANGCI_LINT
$(GOLANGCI_LINT):
mkdir -p $(FIRST_GOPATH)/bin
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/$(GOLANGCI_LINT_VERSION)/install.sh \
| sed -e '/install -d/d' \
| sh -s -- -b $(FIRST_GOPATH)/bin $(GOLANGCI_LINT_VERSION)
endif
.PHONY: precheck
precheck::
define PRECHECK_COMMAND_template =
precheck:: $(1)_precheck
PRECHECK_COMMAND_$(1) ?= $(1) $$(strip $$(PRECHECK_OPTIONS_$(1)))
.PHONY: $(1)_precheck
$(1)_precheck:
@if ! $$(PRECHECK_COMMAND_$(1)) 1>/dev/null 2>&1; then \
echo "Execution of '$$(PRECHECK_COMMAND_$(1))' command failed. Is $(1) installed?"; \
exit 1; \
fi
endef
07070100000014000081A4000000000000000000000001646363980000005E000000000000000000000000000000000000002000000000blackbox_exporter-0.24.0/NOTICEThe Blackbox exporter for blackbox probing metrics
Copyright 2012-2016 The Prometheus Authors
07070100000015000081A40000000000000000000000016463639800001976000000000000000000000000000000000000002300000000blackbox_exporter-0.24.0/README.md# Blackbox exporter [][travis]
[][circleci]
[][quay]
[][hub]
The blackbox exporter allows blackbox probing of endpoints over
HTTP, HTTPS, DNS, TCP, ICMP and gRPC.
## Running this software
### From binaries
Download the most suitable binary from [the releases tab](https://github.com/prometheus/blackbox_exporter/releases)
Then:
./blackbox_exporter <flags>
### Using the docker image
*Note: You may want to [enable ipv6 in your docker configuration](https://docs.docker.com/v17.09/engine/userguide/networking/default_network/ipv6/)*
docker run --rm \
-p 9115/tcp \
--name blackbox_exporter \
-v $(pwd):/config \
quay.io/prometheus/blackbox-exporter:latest --config.file=/config/blackbox.yml
### Checking the results
Visiting [http://localhost:9115/probe?target=google.com&module=http_2xx](http://localhost:9115/probe?target=google.com&module=http_2xx)
will return metrics for a HTTP probe against google.com. The `probe_success`
metric indicates if the probe succeeded. Adding a `debug=true` parameter
will return debug information for that probe.
### TLS and basic authentication
The Blackbox Exporter supports TLS and basic authentication. This enables better
control of the various HTTP endpoints.
To use TLS and/or basic authentication, you need to pass a configuration file
using the `--web.config.file` parameter. The format of the file is described
[in the exporter-toolkit repository](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md).
Note that the TLS and basic authentication settings affect all HTTP endpoints:
/metrics for scraping, /probe for probing, and the web UI.
## Building the software
### Local Build
make
### Building with Docker
After a successful local build:
docker build -t blackbox_exporter .
## [Configuration](CONFIGURATION.md)
Blackbox exporter is configured via a [configuration file](CONFIGURATION.md) and command-line flags (such as what configuration file to load, what port to listen on, and the logging format and level).
Blackbox exporter can reload its configuration file at runtime. If the new configuration is not well-formed, the changes will not be applied.
A configuration reload is triggered by sending a `SIGHUP` to the Blackbox exporter process or by sending a HTTP POST request to the `/-/reload` endpoint.
To view all available command-line flags, run `./blackbox_exporter -h`.
To specify which [configuration file](CONFIGURATION.md) to load, use the `--config.file` flag.
Additionally, an [example configuration](example.yml) is also available.
HTTP, HTTPS (via the `http` prober), DNS, TCP socket, ICMP and gRPC (see permissions section) are currently supported.
Additional modules can be defined to meet your needs.
The timeout of each probe is automatically determined from the `scrape_timeout` in the [Prometheus config](https://prometheus.io/docs/operating/configuration/#configuration-file), slightly reduced to allow for network delays.
This can be further limited by the `timeout` in the Blackbox exporter config file. If neither is specified, it defaults to 120 seconds.
## Prometheus Configuration
Blackbox exporter implements the multi-target exporter pattern, so we advice
to read the guide [Understanding and using the multi-target exporter pattern
](https://prometheus.io/docs/guides/multi-target-exporter/) to get the general
idea about the configuration.
The blackbox exporter needs to be passed the target as a parameter, this can be
done with relabelling.
Example config:
```yml
scrape_configs:
- job_name: 'blackbox'
metrics_path: /probe
params:
module: [http_2xx] # Look for a HTTP 200 response.
static_configs:
- targets:
- 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__]
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.
```
HTTP probes can accept an additional `hostname` parameter that will set `Host` header and TLS SNI. This can be especially useful with `dns_sd_config`:
```yaml
scrape_configs:
- job_name: blackbox_all
metrics_path: /probe
params:
module: [ http_2xx ] # Look for a HTTP 200 response.
dns_sd_configs:
- names:
- example.com
- prometheus.io
type: A
port: 443
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
replacement: https://$1/ # Make probe URL be like https://1.2.3.4:443/
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: 127.0.0.1:9115 # The blackbox exporter's real hostname:port.
- source_labels: [__meta_dns_name]
target_label: __param_hostname # Make domain name become 'Host' header for probe requests
- source_labels: [__meta_dns_name]
target_label: vhost # and store it in 'vhost' label
```
## Permissions
The ICMP probe requires elevated privileges to function:
* *Windows*: Administrator privileges are required.
* *Linux*: either a user with a group within `net.ipv4.ping_group_range`, the
`CAP_NET_RAW` capability or the root user is required.
* Your distribution may configure `net.ipv4.ping_group_range` by default in
`/etc/sysctl.conf` or similar. If not you can set
`net.ipv4.ping_group_range = 0 2147483647` to allow any user the ability
to use ping.
* Alternatively the capability can be set by executing `setcap cap_net_raw+ep
blackbox_exporter`
* *BSD*: root user is required.
* *OS X*: No additional privileges are needed.
[circleci]: https://circleci.com/gh/prometheus/blackbox_exporter
[hub]: https://hub.docker.com/r/prom/blackbox-exporter/
[travis]: https://travis-ci.org/prometheus/blackbox_exporter
[quay]: https://quay.io/repository/prometheus/blackbox-exporter
07070100000016000081A400000000000000000000000164636398000000AC000000000000000000000000000000000000002500000000blackbox_exporter-0.24.0/SECURITY.md# Reporting a security issue
The Prometheus security policy, including how to report vulnerabilities, can be
found here:
<https://prometheus.io/docs/operating/security/>
07070100000017000081A40000000000000000000000016463639800000007000000000000000000000000000000000000002100000000blackbox_exporter-0.24.0/VERSION0.24.0
07070100000018000081A400000000000000000000000164636398000003BC000000000000000000000000000000000000002600000000blackbox_exporter-0.24.0/blackbox.ymlmodules:
http_2xx:
prober: http
http:
preferred_ip_protocol: "ip4"
http_post_2xx:
prober: http
http:
method: POST
tcp_connect:
prober: tcp
pop3s_banner:
prober: tcp
tcp:
query_response:
- expect: "^+OK"
tls: true
tls_config:
insecure_skip_verify: false
grpc:
prober: grpc
grpc:
tls: true
preferred_ip_protocol: "ip4"
grpc_plain:
prober: grpc
grpc:
tls: false
service: "service1"
ssh_banner:
prober: tcp
tcp:
query_response:
- expect: "^SSH-2.0-"
- send: "SSH-2.0-blackbox-ssh-check"
irc_banner:
prober: tcp
tcp:
query_response:
- send: "NICK prober"
- send: "USER prober prober prober :prober"
- expect: "PING :([^ ]+)"
send: "PONG ${1}"
- expect: "^:[^ ]+ 001"
icmp:
prober: icmp
icmp_ttl5:
prober: icmp
timeout: 5s
icmp:
ttl: 5
07070100000019000041ED0000000000000000000000036463639800000000000000000000000000000000000000000000002000000000blackbox_exporter-0.24.0/config0707010000001A000081A40000000000000000000000016463639800003FA2000000000000000000000000000000000000002A00000000blackbox_exporter-0.24.0/config/config.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package config
import (
"errors"
"fmt"
"math"
"net/textproto"
"os"
"regexp"
"runtime"
"sort"
"strconv"
"strings"
"sync"
"time"
yaml "gopkg.in/yaml.v3"
"github.com/alecthomas/units"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/miekg/dns"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/prometheus/common/config"
)
var (
configReloadSuccess = promauto.NewGauge(prometheus.GaugeOpts{
Namespace: "blackbox_exporter",
Name: "config_last_reload_successful",
Help: "Blackbox exporter config loaded successfully.",
})
configReloadSeconds = promauto.NewGauge(prometheus.GaugeOpts{
Namespace: "blackbox_exporter",
Name: "config_last_reload_success_timestamp_seconds",
Help: "Timestamp of the last successful configuration reload.",
})
// DefaultModule set default configuration for the Module
DefaultModule = Module{
HTTP: DefaultHTTPProbe,
TCP: DefaultTCPProbe,
ICMP: DefaultICMPProbe,
DNS: DefaultDNSProbe,
}
// DefaultHTTPProbe set default value for HTTPProbe
DefaultHTTPProbe = HTTPProbe{
IPProtocolFallback: true,
HTTPClientConfig: config.DefaultHTTPClientConfig,
}
// DefaultGRPCProbe set default value for HTTPProbe
DefaultGRPCProbe = GRPCProbe{
Service: "",
IPProtocolFallback: true,
}
// DefaultTCPProbe set default value for TCPProbe
DefaultTCPProbe = TCPProbe{
IPProtocolFallback: true,
}
// DefaultICMPProbe set default value for ICMPProbe
DefaultICMPTTL = 64
DefaultICMPProbe = ICMPProbe{
IPProtocolFallback: true,
TTL: DefaultICMPTTL,
}
// DefaultDNSProbe set default value for DNSProbe
DefaultDNSProbe = DNSProbe{
IPProtocolFallback: true,
Recursion: true,
}
)
type Config struct {
Modules map[string]Module `yaml:"modules"`
}
type SafeConfig struct {
sync.RWMutex
C *Config
}
func (sc *SafeConfig) ReloadConfig(confFile string, logger log.Logger) (err error) {
var c = &Config{}
defer func() {
if err != nil {
configReloadSuccess.Set(0)
} else {
configReloadSuccess.Set(1)
configReloadSeconds.SetToCurrentTime()
}
}()
yamlReader, err := os.Open(confFile)
if err != nil {
return fmt.Errorf("error reading config file: %s", err)
}
defer yamlReader.Close()
decoder := yaml.NewDecoder(yamlReader)
decoder.KnownFields(true)
if err = decoder.Decode(c); err != nil {
return fmt.Errorf("error parsing config file: %s", err)
}
for name, module := range c.Modules {
if module.HTTP.NoFollowRedirects != nil {
// Hide the old flag from the /config page.
module.HTTP.NoFollowRedirects = nil
c.Modules[name] = module
if logger != nil {
level.Warn(logger).Log("msg", "no_follow_redirects is deprecated and will be removed in the next release. It is replaced by follow_redirects.", "module", name)
}
}
}
sc.Lock()
sc.C = c
sc.Unlock()
return nil
}
// Regexp encapsulates a regexp.Regexp and makes it YAML marshalable.
type Regexp struct {
*regexp.Regexp
original string
}
// NewRegexp creates a new anchored Regexp and returns an error if the
// passed-in regular expression does not compile.
func NewRegexp(s string) (Regexp, error) {
regex, err := regexp.Compile(s)
return Regexp{
Regexp: regex,
original: s,
}, err
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (re *Regexp) UnmarshalYAML(unmarshal func(interface{}) error) error {
var s string
if err := unmarshal(&s); err != nil {
return err
}
r, err := NewRegexp(s)
if err != nil {
return fmt.Errorf("\"Could not compile regular expression\" regexp=\"%s\"", s)
}
*re = r
return nil
}
// MarshalYAML implements the yaml.Marshaler interface.
func (re Regexp) MarshalYAML() (interface{}, error) {
if re.original != "" {
return re.original, nil
}
return nil, nil
}
// MustNewRegexp works like NewRegexp, but panics if the regular expression does not compile.
func MustNewRegexp(s string) Regexp {
re, err := NewRegexp(s)
if err != nil {
panic(err)
}
return re
}
type Module struct {
Prober string `yaml:"prober,omitempty"`
Timeout time.Duration `yaml:"timeout,omitempty"`
HTTP HTTPProbe `yaml:"http,omitempty"`
TCP TCPProbe `yaml:"tcp,omitempty"`
ICMP ICMPProbe `yaml:"icmp,omitempty"`
DNS DNSProbe `yaml:"dns,omitempty"`
GRPC GRPCProbe `yaml:"grpc,omitempty"`
}
type HTTPProbe struct {
// Defaults to 2xx.
ValidStatusCodes []int `yaml:"valid_status_codes,omitempty"`
ValidHTTPVersions []string `yaml:"valid_http_versions,omitempty"`
IPProtocol string `yaml:"preferred_ip_protocol,omitempty"`
IPProtocolFallback bool `yaml:"ip_protocol_fallback,omitempty"`
SkipResolvePhaseWithProxy bool `yaml:"skip_resolve_phase_with_proxy,omitempty"`
NoFollowRedirects *bool `yaml:"no_follow_redirects,omitempty"`
FailIfSSL bool `yaml:"fail_if_ssl,omitempty"`
FailIfNotSSL bool `yaml:"fail_if_not_ssl,omitempty"`
Method string `yaml:"method,omitempty"`
Headers map[string]string `yaml:"headers,omitempty"`
FailIfBodyMatchesRegexp []Regexp `yaml:"fail_if_body_matches_regexp,omitempty"`
FailIfBodyNotMatchesRegexp []Regexp `yaml:"fail_if_body_not_matches_regexp,omitempty"`
FailIfHeaderMatchesRegexp []HeaderMatch `yaml:"fail_if_header_matches,omitempty"`
FailIfHeaderNotMatchesRegexp []HeaderMatch `yaml:"fail_if_header_not_matches,omitempty"`
Body string `yaml:"body,omitempty"`
BodyFile string `yaml:"body_file,omitempty"`
HTTPClientConfig config.HTTPClientConfig `yaml:"http_client_config,inline"`
Compression string `yaml:"compression,omitempty"`
BodySizeLimit units.Base2Bytes `yaml:"body_size_limit,omitempty"`
}
type GRPCProbe struct {
Service string `yaml:"service,omitempty"`
TLS bool `yaml:"tls,omitempty"`
TLSConfig config.TLSConfig `yaml:"tls_config,omitempty"`
IPProtocolFallback bool `yaml:"ip_protocol_fallback,omitempty"`
PreferredIPProtocol string `yaml:"preferred_ip_protocol,omitempty"`
}
type HeaderMatch struct {
Header string `yaml:"header,omitempty"`
Regexp Regexp `yaml:"regexp,omitempty"`
AllowMissing bool `yaml:"allow_missing,omitempty"`
}
type QueryResponse struct {
Expect Regexp `yaml:"expect,omitempty"`
Send string `yaml:"send,omitempty"`
StartTLS bool `yaml:"starttls,omitempty"`
}
type TCPProbe struct {
IPProtocol string `yaml:"preferred_ip_protocol,omitempty"`
IPProtocolFallback bool `yaml:"ip_protocol_fallback,omitempty"`
SourceIPAddress string `yaml:"source_ip_address,omitempty"`
QueryResponse []QueryResponse `yaml:"query_response,omitempty"`
TLS bool `yaml:"tls,omitempty"`
TLSConfig config.TLSConfig `yaml:"tls_config,omitempty"`
}
type ICMPProbe struct {
IPProtocol string `yaml:"preferred_ip_protocol,omitempty"` // Defaults to "ip6".
IPProtocolFallback bool `yaml:"ip_protocol_fallback,omitempty"`
SourceIPAddress string `yaml:"source_ip_address,omitempty"`
PayloadSize int `yaml:"payload_size,omitempty"`
DontFragment bool `yaml:"dont_fragment,omitempty"`
TTL int `yaml:"ttl,omitempty"`
}
type DNSProbe struct {
IPProtocol string `yaml:"preferred_ip_protocol,omitempty"`
IPProtocolFallback bool `yaml:"ip_protocol_fallback,omitempty"`
DNSOverTLS bool `yaml:"dns_over_tls,omitempty"`
TLSConfig config.TLSConfig `yaml:"tls_config,omitempty"`
SourceIPAddress string `yaml:"source_ip_address,omitempty"`
TransportProtocol string `yaml:"transport_protocol,omitempty"`
QueryClass string `yaml:"query_class,omitempty"` // Defaults to IN.
QueryName string `yaml:"query_name,omitempty"`
QueryType string `yaml:"query_type,omitempty"` // Defaults to ANY.
Recursion bool `yaml:"recursion_desired,omitempty"` // Defaults to true.
ValidRcodes []string `yaml:"valid_rcodes,omitempty"` // Defaults to NOERROR.
ValidateAnswer DNSRRValidator `yaml:"validate_answer_rrs,omitempty"`
ValidateAuthority DNSRRValidator `yaml:"validate_authority_rrs,omitempty"`
ValidateAdditional DNSRRValidator `yaml:"validate_additional_rrs,omitempty"`
}
type DNSRRValidator struct {
FailIfMatchesRegexp []string `yaml:"fail_if_matches_regexp,omitempty"`
FailIfAllMatchRegexp []string `yaml:"fail_if_all_match_regexp,omitempty"`
FailIfNotMatchesRegexp []string `yaml:"fail_if_not_matches_regexp,omitempty"`
FailIfNoneMatchesRegexp []string `yaml:"fail_if_none_matches_regexp,omitempty"`
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *Config) UnmarshalYAML(unmarshal func(interface{}) error) error {
type plain Config
if err := unmarshal((*plain)(s)); err != nil {
return err
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *Module) UnmarshalYAML(unmarshal func(interface{}) error) error {
*s = DefaultModule
type plain Module
if err := unmarshal((*plain)(s)); err != nil {
return err
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *HTTPProbe) UnmarshalYAML(unmarshal func(interface{}) error) error {
*s = DefaultHTTPProbe
type plain HTTPProbe
if err := unmarshal((*plain)(s)); err != nil {
return err
}
// BodySizeLimit == 0 means no limit. By leaving it at 0 we
// avoid setting up the limiter.
if s.BodySizeLimit < 0 || s.BodySizeLimit == math.MaxInt64 {
// The implementation behind http.MaxBytesReader tries
// to add 1 to the specified limit causing it to wrap
// around and become negative, and then it tries to use
// that result to index an slice.
s.BodySizeLimit = math.MaxInt64 - 1
}
if err := s.HTTPClientConfig.Validate(); err != nil {
return err
}
if s.NoFollowRedirects != nil {
s.HTTPClientConfig.FollowRedirects = !*s.NoFollowRedirects
}
if s.Body != "" && s.BodyFile != "" {
return errors.New("setting body and body_file both are not allowed")
}
for key, value := range s.Headers {
switch textproto.CanonicalMIMEHeaderKey(key) {
case "Accept-Encoding":
if !isCompressionAcceptEncodingValid(s.Compression, value) {
return fmt.Errorf(`invalid configuration "%s: %s", "compression: %s"`, key, value, s.Compression)
}
}
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *GRPCProbe) UnmarshalYAML(unmarshal func(interface{}) error) error {
*s = DefaultGRPCProbe
type plain GRPCProbe
if err := unmarshal((*plain)(s)); err != nil {
return err
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *DNSProbe) UnmarshalYAML(unmarshal func(interface{}) error) error {
*s = DefaultDNSProbe
type plain DNSProbe
if err := unmarshal((*plain)(s)); err != nil {
return err
}
if s.QueryName == "" {
return errors.New("query name must be set for DNS module")
}
if s.QueryClass != "" {
if _, ok := dns.StringToClass[s.QueryClass]; !ok {
return fmt.Errorf("query class '%s' is not valid", s.QueryClass)
}
}
if s.QueryType != "" {
if _, ok := dns.StringToType[s.QueryType]; !ok {
return fmt.Errorf("query type '%s' is not valid", s.QueryType)
}
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *TCPProbe) UnmarshalYAML(unmarshal func(interface{}) error) error {
*s = DefaultTCPProbe
type plain TCPProbe
if err := unmarshal((*plain)(s)); err != nil {
return err
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *DNSRRValidator) UnmarshalYAML(unmarshal func(interface{}) error) error {
type plain DNSRRValidator
if err := unmarshal((*plain)(s)); err != nil {
return err
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *ICMPProbe) UnmarshalYAML(unmarshal func(interface{}) error) error {
*s = DefaultICMPProbe
type plain ICMPProbe
if err := unmarshal((*plain)(s)); err != nil {
return err
}
if runtime.GOOS == "windows" && s.DontFragment {
return errors.New("\"dont_fragment\" is not supported on windows platforms")
}
if s.TTL < 0 {
return errors.New("\"ttl\" cannot be negative")
}
if s.TTL > 255 {
return errors.New("\"ttl\" cannot exceed 255")
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *QueryResponse) UnmarshalYAML(unmarshal func(interface{}) error) error {
type plain QueryResponse
if err := unmarshal((*plain)(s)); err != nil {
return err
}
return nil
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
func (s *HeaderMatch) UnmarshalYAML(unmarshal func(interface{}) error) error {
type plain HeaderMatch
if err := unmarshal((*plain)(s)); err != nil {
return err
}
if s.Header == "" {
return errors.New("header name must be set for HTTP header matchers")
}
if s.Regexp.Regexp == nil || s.Regexp.Regexp.String() == "" {
return errors.New("regexp must be set for HTTP header matchers")
}
return nil
}
// isCompressionAcceptEncodingValid validates the compression +
// Accept-Encoding combination.
//
// If there's a compression setting, and there's also an accept-encoding
// header, they MUST match, otherwise we end up requesting something
// that doesn't include the specified compression, and that's likely to
// fail, depending on how the server is configured. Testing that the
// server _ignores_ Accept-Encoding, e.g. by not including a particular
// compression in the header but expecting it in the response falls out
// of the scope of the tests we perform.
//
// With that logic, this function validates that if a compression
// algorithm is specified, it's covered by the specified accept encoding
// header. It doesn't need to be the most prefered encoding, but it MUST
// be included in the prefered encodings.
func isCompressionAcceptEncodingValid(encoding, acceptEncoding string) bool {
// unspecified compression + any encoding value is valid
// any compression + no accept encoding is valid
if encoding == "" || acceptEncoding == "" {
return true
}
type encodingQuality struct {
encoding string
quality float32
}
var encodings []encodingQuality
for _, parts := range strings.Split(acceptEncoding, ",") {
var e encodingQuality
if idx := strings.LastIndexByte(parts, ';'); idx == -1 {
e.encoding = strings.TrimSpace(parts)
e.quality = 1.0
} else {
parseQuality := func(str string) float32 {
q, err := strconv.ParseFloat(str, 32)
if err != nil {
return 0
}
return float32(math.Round(q*1000) / 1000)
}
e.encoding = strings.TrimSpace(parts[:idx])
q := strings.TrimSpace(parts[idx+1:])
q = strings.TrimPrefix(q, "q=")
e.quality = parseQuality(q)
}
encodings = append(encodings, e)
}
sort.SliceStable(encodings, func(i, j int) bool {
return encodings[j].quality < encodings[i].quality
})
for _, e := range encodings {
if encoding == e.encoding || e.encoding == "*" {
return e.quality > 0
}
}
return false
}
0707010000001B000081A400000000000000000000000164636398000018B4000000000000000000000000000000000000002F00000000blackbox_exporter-0.24.0/config/config_test.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package config
import (
"strings"
"testing"
yaml "gopkg.in/yaml.v3"
)
func TestLoadConfig(t *testing.T) {
sc := &SafeConfig{
C: &Config{},
}
err := sc.ReloadConfig("testdata/blackbox-good.yml", nil)
if err != nil {
t.Errorf("Error loading config %v: %v", "blackbox.yml", err)
}
}
func TestLoadBadConfigs(t *testing.T) {
sc := &SafeConfig{
C: &Config{},
}
tests := []struct {
input string
want string
}{
{
input: "testdata/blackbox-bad.yml",
want: "error parsing config file: yaml: unmarshal errors:\n line 50: field invalid_extra_field not found in type config.plain",
},
{
input: "testdata/blackbox-bad2.yml",
want: "error parsing config file: at most one of bearer_token & bearer_token_file must be configured",
},
{
input: "testdata/invalid-dns-module.yml",
want: "error parsing config file: query name must be set for DNS module",
},
{
input: "testdata/invalid-dns-class.yml",
want: "error parsing config file: query class 'X' is not valid",
},
{
input: "testdata/invalid-dns-type.yml",
want: "error parsing config file: query type 'X' is not valid",
},
{
input: "testdata/invalid-http-header-match.yml",
want: "error parsing config file: regexp must be set for HTTP header matchers",
},
{
input: "testdata/invalid-http-body-match-regexp.yml",
want: `error parsing config file: "Could not compile regular expression" regexp=":["`,
},
{
input: "testdata/invalid-http-body-not-match-regexp.yml",
want: `error parsing config file: "Could not compile regular expression" regexp=":["`,
},
{
input: "testdata/invalid-http-header-match-regexp.yml",
want: `error parsing config file: "Could not compile regular expression" regexp=":["`,
},
{
input: "testdata/invalid-http-compression-mismatch.yml",
want: `error parsing config file: invalid configuration "Accept-Encoding: deflate", "compression: gzip"`,
},
{
input: "testdata/invalid-http-compression-mismatch-special-case.yml",
want: `error parsing config file: invalid configuration "accEpt-enCoding: deflate", "compression: gzip"`,
},
{
input: "testdata/invalid-http-request-compression-reject-all-encodings.yml",
want: `error parsing config file: invalid configuration "Accept-Encoding: *;q=0.0", "compression: gzip"`,
},
{
input: "testdata/invalid-icmp-ttl.yml",
want: "error parsing config file: \"ttl\" cannot be negative",
},
{
input: "testdata/invalid-icmp-ttl-overflow.yml",
want: "error parsing config file: \"ttl\" cannot exceed 255",
},
{
input: "testdata/invalid-tcp-query-response-regexp.yml",
want: `error parsing config file: "Could not compile regular expression" regexp=":["`,
},
{
input: "testdata/invalid-http-body-config.yml",
want: `error parsing config file: setting body and body_file both are not allowed`,
},
}
for _, test := range tests {
t.Run(test.input, func(t *testing.T) {
got := sc.ReloadConfig(test.input, nil)
if got == nil || got.Error() != test.want {
t.Fatalf("ReloadConfig(%q) = %v; want %q", test.input, got, test.want)
}
})
}
}
func TestHideConfigSecrets(t *testing.T) {
sc := &SafeConfig{
C: &Config{},
}
err := sc.ReloadConfig("testdata/blackbox-good.yml", nil)
if err != nil {
t.Errorf("Error loading config %v: %v", "testdata/blackbox-good.yml", err)
}
// String method must not reveal authentication credentials.
sc.RLock()
c, err := yaml.Marshal(sc.C)
sc.RUnlock()
if err != nil {
t.Errorf("Error marshalling config: %v", err)
}
if strings.Contains(string(c), "mysecret") {
t.Fatal("config's String method reveals authentication credentials.")
}
}
func TestIsEncodingAcceptable(t *testing.T) {
testcases := map[string]struct {
input string
acceptEncoding string
expected bool
}{
"empty compression": {
input: "",
acceptEncoding: "gzip",
expected: true,
},
"trivial": {
input: "gzip",
acceptEncoding: "gzip",
expected: true,
},
"trivial, quality": {
input: "gzip",
acceptEncoding: "gzip;q=1.0",
expected: true,
},
"first": {
input: "gzip",
acceptEncoding: "gzip, compress",
expected: true,
},
"second": {
input: "gzip",
acceptEncoding: "compress, gzip",
expected: true,
},
"missing": {
input: "br",
acceptEncoding: "gzip, compress",
expected: false,
},
"*": {
input: "br",
acceptEncoding: "gzip, compress, *",
expected: true,
},
"* with quality": {
input: "br",
acceptEncoding: "gzip, compress, *;q=0.1",
expected: true,
},
"rejected": {
input: "br",
acceptEncoding: "gzip, compress, br;q=0.0",
expected: false,
},
"rejected *": {
input: "br",
acceptEncoding: "gzip, compress, *;q=0.0",
expected: false,
},
"complex": {
input: "br",
acceptEncoding: "gzip;q=1.0, compress;q=0.5, br;q=0.1, *;q=0.0",
expected: true,
},
"complex out of order": {
input: "br",
acceptEncoding: "*;q=0.0, compress;q=0.5, br;q=0.1, gzip;q=1.0",
expected: true,
},
"complex with extra blanks": {
input: "br",
acceptEncoding: " gzip;q=1.0, compress; q=0.5, br;q=0.1, *; q=0.0 ",
expected: true,
},
}
for name, tc := range testcases {
t.Run(name, func(t *testing.T) {
actual := isCompressionAcceptEncodingValid(tc.input, tc.acceptEncoding)
if actual != tc.expected {
t.Errorf("Unexpected result: input=%q acceptEncoding=%q expected=%t actual=%t", tc.input, tc.acceptEncoding, tc.expected, actual)
}
})
}
}
0707010000001C000041ED0000000000000000000000026463639800000000000000000000000000000000000000000000002900000000blackbox_exporter-0.24.0/config/testdata0707010000001D000081A400000000000000000000000164636398000003C8000000000000000000000000000000000000003A00000000blackbox_exporter-0.24.0/config/testdata/blackbox-bad.ymlmodules:
http_2xx:
prober: http
timeout: 5s
http:
http_post_2xx:
prober: http
timeout: 5s
http:
method: POST
tcp_connect:
prober: tcp
timeout: 5s
pop3s_banner:
prober: tcp
tcp:
query_response:
- expect: "^+OK"
tls: true
tls_config:
insecure_skip_verify: false
ssh_banner:
prober: tcp
timeout: 5s
tcp:
query_response:
- expect: "^SSH-2.0-"
irc_banner:
prober: tcp
timeout: 5s
tcp:
query_response:
- send: "NICK prober"
- send: "USER prober prober prober :prober"
- expect: "PING :([^ ]+)"
send: "PONG ${1}"
- expect: "^:[^ ]+ 001"
icmp_test:
prober: icmp
timeout: 5s
icmp:
preferred_ip_protocol: ip4
dns_test:
prober: dns
timeout: 5s
dns:
preferred_ip_protocol: ip6
validate_answer_rrs:
fail_if_matches_regexp: [test]
invalid_extra_field: value
0707010000001E000081A400000000000000000000000164636398000000D9000000000000000000000000000000000000003B00000000blackbox_exporter-0.24.0/config/testdata/blackbox-bad2.ymlmodules:
http_post_2xx:
prober: http
timeout: 5s
http:
method: POST
bearer_token: foo
bearer_token_file: foo
basic_auth:
username: "username"
password: "mysecret"
0707010000001F000081A400000000000000000000000164636398000006A1000000000000000000000000000000000000003B00000000blackbox_exporter-0.24.0/config/testdata/blackbox-good.ymlmodules:
http_2xx:
prober: http
timeout: 5s
http:
http_post_2xx:
prober: http
timeout: 5s
http:
method: POST
basic_auth:
username: "username"
password: "mysecret"
body_size_limit: 1MB
tcp_connect:
prober: tcp
timeout: 5s
pop3s_banner:
prober: tcp
tcp:
query_response:
- expect: "^+OK"
tls: true
tls_config:
insecure_skip_verify: false
ssh_banner:
prober: tcp
timeout: 5s
tcp:
query_response:
- expect: "^SSH-2.0-"
smtp_starttls:
prober: tcp
timeout: 5s
tcp:
query_response:
- expect: "^220 "
- send: "EHLO prober\r"
- expect: "^250-STARTTLS"
- send: "STARTTLS\r"
- expect: "^220"
- starttls: true
- send: "EHLO prober\r"
- expect: "^250-AUTH"
- send: "QUIT\r"
irc_banner:
prober: tcp
timeout: 5s
tcp:
query_response:
- send: "NICK prober"
- send: "USER prober prober prober :prober"
- expect: "PING :([^ ]+)"
send: "PONG ${1}"
- expect: "^:[^ ]+ 001"
icmp_test:
prober: icmp
timeout: 5s
icmp:
preferred_ip_protocol: ip4
dns_test:
prober: dns
timeout: 5s
dns:
query_name: example.com
preferred_ip_protocol: ip4
ip_protocol_fallback: false
validate_answer_rrs:
fail_if_matches_regexp: [test]
http_header_match_origin:
prober: http
timeout: 5s
http:
method: GET
headers:
Origin: example.com
fail_if_header_not_matches:
- header: Access-Control-Allow-Origin
regexp: '(\*|example\.com)'
allow_missing: false
07070100000020000081A40000000000000000000000016463639800000085000000000000000000000000000000000000003F00000000blackbox_exporter-0.24.0/config/testdata/invalid-dns-class.ymlmodules:
dns_test:
prober: dns
timeout: 5s
dns:
query_name: example.com
query_class: X
query_type: A
07070100000021000081A400000000000000000000000164636398000000A1000000000000000000000000000000000000004000000000blackbox_exporter-0.24.0/config/testdata/invalid-dns-module.ymlmodules:
dns_test:
prober: dns
timeout: 5s
dns:
preferred_ip_protocol: ip6
validate_answer_rrs:
fail_if_matches_regexp: [test]
07070100000022000081A40000000000000000000000016463639800000086000000000000000000000000000000000000003E00000000blackbox_exporter-0.24.0/config/testdata/invalid-dns-type.ymlmodules:
dns_test:
prober: dns
timeout: 5s
dns:
query_name: example.com
query_class: CH
query_type: X
07070100000023000081A4000000000000000000000001646363980000007A000000000000000000000000000000000000004600000000blackbox_exporter-0.24.0/config/testdata/invalid-http-body-config.ymlmodules:
http_test:
prober: http
timeout: 5s
http:
body: "Test body"
body_file: "test_body.txt"
07070100000024000081A40000000000000000000000016463639800000076000000000000000000000000000000000000004C00000000blackbox_exporter-0.24.0/config/testdata/invalid-http-body-match-regexp.ymlmodules:
http_headers:
prober: http
timeout: 5s
http:
fail_if_body_matches_regexp:
- ':['
07070100000025000081A4000000000000000000000001646363980000007A000000000000000000000000000000000000005000000000blackbox_exporter-0.24.0/config/testdata/invalid-http-body-not-match-regexp.ymlmodules:
http_headers:
prober: http
timeout: 5s
http:
fail_if_body_not_matches_regexp:
- ':['
07070100000026000081A40000000000000000000000016463639800000090000000000000000000000000000000000000005C00000000blackbox_exporter-0.24.0/config/testdata/invalid-http-compression-mismatch-special-case.ymlmodules:
http_headers:
prober: http
timeout: 5s
http:
compression: gzip
headers:
"accEpt-enCoding": "deflate"
07070100000027000081A40000000000000000000000016463639800000090000000000000000000000000000000000000004F00000000blackbox_exporter-0.24.0/config/testdata/invalid-http-compression-mismatch.ymlmodules:
http_headers:
prober: http
timeout: 5s
http:
compression: gzip
headers:
"Accept-Encoding": "deflate"
07070100000028000081A400000000000000000000000164636398000000CA000000000000000000000000000000000000004E00000000blackbox_exporter-0.24.0/config/testdata/invalid-http-header-match-regexp.ymlmodules:
http_headers:
prober: http
timeout: 5s
http:
fail_if_header_not_matches:
- header: Access-Control-Allow-Origin
allow_missing: false
regexp: ':['
07070100000029000081A400000000000000000000000164636398000000B3000000000000000000000000000000000000004700000000blackbox_exporter-0.24.0/config/testdata/invalid-http-header-match.ymlmodules:
http_headers:
prober: http
timeout: 5s
http:
fail_if_header_not_matches:
- header: Access-Control-Allow-Origin
allow_missing: false
0707010000002A000081A40000000000000000000000016463639800000118000000000000000000000000000000000000006300000000blackbox_exporter-0.24.0/config/testdata/invalid-http-request-compression-reject-all-encodings.ymlmodules:
http_headers:
prober: http
timeout: 5s
http:
# this configuration is invalid because it's requesting a
# compressed encoding, but it's rejecting every possible encoding
compression: gzip
headers:
"Accept-Encoding": "*;q=0.0"
0707010000002B000081A40000000000000000000000016463639800000040000000000000000000000000000000000000004700000000blackbox_exporter-0.24.0/config/testdata/invalid-icmp-ttl-overflow.ymlmodules:
icmp_test:
prober: icmp
icmp:
ttl: 256
0707010000002C000081A4000000000000000000000001646363980000003F000000000000000000000000000000000000003E00000000blackbox_exporter-0.24.0/config/testdata/invalid-icmp-ttl.ymlmodules:
icmp_test:
prober: icmp
icmp:
ttl: -1
0707010000002D000081A40000000000000000000000016463639800000088000000000000000000000000000000000000004F00000000blackbox_exporter-0.24.0/config/testdata/invalid-tcp-query-response-regexp.ymlmodules:
tcp_test:
prober: tcp
timeout: 5s
tcp:
query_response:
- expect: ":["
- send: ". STARTTLS"
0707010000002E000081A40000000000000000000000016463639800001214000000000000000000000000000000000000002500000000blackbox_exporter-0.24.0/example.ymlmodules:
http_2xx_example:
prober: http
timeout: 5s
http:
valid_http_versions: ["HTTP/1.1", "HTTP/2.0"]
valid_status_codes: [] # Defaults to 2xx
method: GET
headers:
Host: vhost.example.com
Accept-Language: en-US
Origin: example.com
follow_redirects: true
fail_if_ssl: false
fail_if_not_ssl: false
fail_if_body_matches_regexp:
- "Could not connect to database"
fail_if_body_not_matches_regexp:
- "Download the latest version here"
fail_if_header_matches: # Verifies that no cookies are set
- header: Set-Cookie
allow_missing: true
regexp: '.*'
fail_if_header_not_matches:
- header: Access-Control-Allow-Origin
regexp: '(\*|example\.com)'
tls_config:
insecure_skip_verify: false
preferred_ip_protocol: "ip4" # defaults to "ip6"
ip_protocol_fallback: false # no fallback to "ip6"
http_with_proxy:
prober: http
http:
proxy_url: "http://127.0.0.1:3128"
skip_resolve_phase_with_proxy: true
http_with_proxy_and_headers:
prober: http
http:
proxy_url: "http://127.0.0.1:3128"
proxy_connect_header:
Proxy-Authorization:
- Bearer token
http_post_2xx:
prober: http
timeout: 5s
http:
method: POST
headers:
Content-Type: application/json
body: '{}'
http_post_body_file:
prober: http
timeout: 5s
http:
method: POST
body_file: "/files/body.txt"
http_basic_auth_example:
prober: http
timeout: 5s
http:
method: POST
headers:
Host: "login.example.com"
basic_auth:
username: "username"
password: "mysecret"
http_2xx_oauth_client_credentials:
prober: http
timeout: 5s
http:
valid_http_versions: ["HTTP/1.1", "HTTP/2"]
follow_redirects: true
preferred_ip_protocol: "ip4"
valid_status_codes:
- 200
- 201
oauth2:
client_id: "client_id"
client_secret: "client_secret"
token_url: "https://api.example.com/token"
endpoint_params:
grant_type: "client_credentials"
http_custom_ca_example:
prober: http
http:
method: GET
tls_config:
ca_file: "/certs/my_cert.crt"
http_gzip:
prober: http
http:
method: GET
compression: gzip
http_gzip_with_accept_encoding:
prober: http
http:
method: GET
compression: gzip
headers:
Accept-Encoding: gzip
tls_connect:
prober: tcp
timeout: 5s
tcp:
tls: true
tcp_connect_example:
prober: tcp
timeout: 5s
imap_starttls:
prober: tcp
timeout: 5s
tcp:
query_response:
- expect: "OK.*STARTTLS"
- send: ". STARTTLS"
- expect: "OK"
- starttls: true
- send: ". capability"
- expect: "CAPABILITY IMAP4rev1"
smtp_starttls:
prober: tcp
timeout: 5s
tcp:
query_response:
- expect: "^220 ([^ ]+) ESMTP (.+)$"
- send: "EHLO prober\r"
- expect: "^250-STARTTLS"
- send: "STARTTLS\r"
- expect: "^220"
- starttls: true
- send: "EHLO prober\r"
- expect: "^250-AUTH"
- send: "QUIT\r"
irc_banner_example:
prober: tcp
timeout: 5s
tcp:
query_response:
- send: "NICK prober"
- send: "USER prober prober prober :prober"
- expect: "PING :([^ ]+)"
send: "PONG ${1}"
- expect: "^:[^ ]+ 001"
icmp_example:
prober: icmp
timeout: 5s
icmp:
preferred_ip_protocol: "ip4"
source_ip_address: "127.0.0.1"
dns_udp_example:
prober: dns
timeout: 5s
dns:
query_name: "www.prometheus.io"
query_type: "A"
valid_rcodes:
- NOERROR
validate_answer_rrs:
fail_if_matches_regexp:
- ".*127.0.0.1"
fail_if_all_match_regexp:
- ".*127.0.0.1"
fail_if_not_matches_regexp:
- "www.prometheus.io.\t300\tIN\tA\t127.0.0.1"
fail_if_none_matches_regexp:
- "127.0.0.1"
validate_authority_rrs:
fail_if_matches_regexp:
- ".*127.0.0.1"
validate_additional_rrs:
fail_if_matches_regexp:
- ".*127.0.0.1"
dns_soa:
prober: dns
dns:
query_name: "prometheus.io"
query_type: "SOA"
dns_tcp_example:
prober: dns
dns:
transport_protocol: "tcp" # defaults to "udp"
preferred_ip_protocol: "ip4" # defaults to "ip6"
query_name: "www.prometheus.io"
0707010000002F000081A40000000000000000000000016463639800000652000000000000000000000000000000000000002000000000blackbox_exporter-0.24.0/go.modmodule github.com/prometheus/blackbox_exporter
go 1.19
require (
github.com/alecthomas/kingpin/v2 v2.3.2
github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137
github.com/andybalholm/brotli v1.0.5
github.com/go-kit/log v0.2.1
github.com/miekg/dns v1.1.50
github.com/pkg/errors v0.9.1
github.com/prometheus/client_golang v1.15.1
github.com/prometheus/client_model v0.4.0
github.com/prometheus/common v0.43.0
github.com/prometheus/exporter-toolkit v0.10.0
golang.org/x/net v0.9.0
google.golang.org/grpc v1.55.0
gopkg.in/yaml.v2 v2.4.0
gopkg.in/yaml.v3 v3.0.1
)
require (
github.com/beorn7/perks v1.0.1 // indirect
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/coreos/go-systemd/v22 v22.5.0 // indirect
github.com/go-logfmt/logfmt v0.5.1 // indirect
github.com/golang/protobuf v1.5.3 // indirect
github.com/jpillora/backoff v1.0.0 // indirect
github.com/kr/text v0.2.0 // indirect
github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f // indirect
github.com/prometheus/procfs v0.9.0 // indirect
github.com/xhit/go-str2duration/v2 v2.1.0 // indirect
golang.org/x/crypto v0.8.0 // indirect
golang.org/x/mod v0.8.0 // indirect
golang.org/x/oauth2 v0.7.0 // indirect
golang.org/x/sync v0.1.0 // indirect
golang.org/x/sys v0.7.0 // indirect
golang.org/x/text v0.9.0 // indirect
golang.org/x/tools v0.6.0 // indirect
google.golang.org/appengine v1.6.7 // indirect
google.golang.org/genproto v0.0.0-20230306155012-7f2fa6fef1f4 // indirect
google.golang.org/protobuf v1.30.0 // indirect
)
07070100000030000081A40000000000000000000000016463639800002B8D000000000000000000000000000000000000002000000000blackbox_exporter-0.24.0/go.sumgithub.com/alecthomas/kingpin/v2 v2.3.2 h1:H0aULhgmSzN8xQ3nX1uxtdlTHYoPLu5AhHxWrKI6ocU=
github.com/alecthomas/kingpin/v2 v2.3.2/go.mod h1:0gyi0zQnjuFk8xrkNKamJoyUo382HRL7ATRpFZCw6tE=
github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 h1:s6gZFSlWYmbqAuRjVTiNNhvNRfY2Wxp9nhfyel4rklc=
github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137/go.mod h1:OMCwj8VM1Kc9e19TLln2VL61YJF0x1XFtfdL4JdbSyE=
github.com/andybalholm/brotli v1.0.5 h1:8uQZIdzKmjc/iuPu7O2ioW48L81FgatrcpfFmiq/cCs=
github.com/andybalholm/brotli v1.0.5/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/coreos/go-systemd/v22 v22.5.0 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8iXXhfZs=
github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/go-kit/log v0.2.1 h1:MRVx0/zhvdseW+Gza6N9rVzU/IVzaeE1SFI4raAhmBU=
github.com/go-kit/log v0.2.1/go.mod h1:NwTd00d/i8cPZ3xOwwiv2PO5MOcx78fFErGNcVmBjv0=
github.com/go-logfmt/logfmt v0.5.1 h1:otpy5pqBCBZ1ng9RQ0dPu4PN7ba75Y/aA+UpowDyNVA=
github.com/go-logfmt/logfmt v0.5.1/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs=
github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg=
github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
github.com/jpillora/backoff v1.0.0 h1:uvFg412JmmHBHw7iwprIxkPMI+sGQ4kzOWsMeHnm2EA=
github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4=
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zkfA9PSy5pEvNWRP0ET0TIVo=
github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=
github.com/miekg/dns v1.1.50 h1:DQUfb9uc6smULcREF09Uc+/Gd46YWqJd5DbpPE9xkcA=
github.com/miekg/dns v1.1.50/go.mod h1:e3IlAVfNqAllflbibAZEWOXOQ+Ynzk/dDozDxY7XnME=
github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f h1:KUppIJq7/+SVif2QVs3tOP0zanoHgBEVAwHxUSIzRqU=
github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prometheus/client_golang v1.15.1 h1:8tXpTmJbyH5lydzFPoxSIJ0J46jdh3tylbvM1xCv0LI=
github.com/prometheus/client_golang v1.15.1/go.mod h1:e9yaBhRPU2pPNsZwE+JdQl0KEt1N9XgF6zxWmaC0xOk=
github.com/prometheus/client_model v0.4.0 h1:5lQXD3cAg1OXBf4Wq03gTrXHeaV0TQvGfUooCfx1yqY=
github.com/prometheus/client_model v0.4.0/go.mod h1:oMQmHW1/JoDwqLtg57MGgP/Fb1CJEYF2imWWhWtMkYU=
github.com/prometheus/common v0.43.0 h1:iq+BVjvYLei5f27wiuNiB1DN6DYQkp1c8Bx0Vykh5us=
github.com/prometheus/common v0.43.0/go.mod h1:NCvr5cQIh3Y/gy73/RdVtC9r8xxrxwJnB+2lB3BxrFc=
github.com/prometheus/exporter-toolkit v0.10.0 h1:yOAzZTi4M22ZzVxD+fhy1URTuNRj/36uQJJ5S8IPza8=
github.com/prometheus/exporter-toolkit v0.10.0/go.mod h1:+sVFzuvV5JDyw+Ih6p3zFxZNVnKQa3x5qPmDSiPu4ZY=
github.com/prometheus/procfs v0.9.0 h1:wzCHvIvM5SxWqYvwgVL7yJY8Lz3PKn49KQtpgMYJfhI=
github.com/prometheus/procfs v0.9.0/go.mod h1:+pB4zwohETzFnmlpe6yd2lSc+0/46IYZRB/chUwxUZY=
github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
github.com/xhit/go-str2duration/v2 v2.1.0 h1:lxklc02Drh6ynqX+DdPyp5pCKLUQpRT8bp8Ydu2Bstc=
github.com/xhit/go-str2duration/v2 v2.1.0/go.mod h1:ohY8p+0f07DiV6Em5LKB0s2YpLtXVyJfNt1+BlmyAsU=
github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.8.0 h1:pd9TJtTueMTVQXzk8E2XESSMQDj/U7OUu0PqJqPXQjQ=
golang.org/x/crypto v0.8.0/go.mod h1:mRqEX+O9/h5TFCrQhkgjo2yKi0yYA+9ecGkdQoHrywE=
golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.8.0 h1:LUYupSeNrTNCGzR/hVBk2NHZO4hXcVaW1k4Qx7rjPx8=
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM=
golang.org/x/net v0.0.0-20210726213435-c6fcb2dbf985/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
golang.org/x/net v0.9.0 h1:aWJ/m6xSmxWBx+V0XRHTlrYrPG56jKsLdTFmsSsCzOM=
golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns=
golang.org/x/oauth2 v0.7.0 h1:qe6s0zUXlPX80/dITx3440hWZ7GwMwgDDyrSGTPJG/g=
golang.org/x/oauth2 v0.7.0/go.mod h1:hPLQkd9LyjfXTiRohC/41GhcFqxisoUQ99sCUOHO9x4=
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.7.0 h1:3jlCCIQZPdOYu1h8BkNvLz8Kgwtae2cagcG/VamtZRU=
golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE=
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.6-0.20210726203631-07bc1bf47fb2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
golang.org/x/tools v0.6.0 h1:BOw41kyTf3PuCW1pVQf8+Cyg8pMlkYB1oo9iJ6D/lKM=
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
google.golang.org/genproto v0.0.0-20230306155012-7f2fa6fef1f4 h1:DdoeryqhaXp1LtT/emMP1BRJPHHKFi5akj/nbx/zNTA=
google.golang.org/genproto v0.0.0-20230306155012-7f2fa6fef1f4/go.mod h1:NWraEVixdDnqcqQ30jipen1STv2r/n24Wb7twVTGR4s=
google.golang.org/grpc v1.55.0 h1:3Oj82/tFSCeUrRTg/5E/7d/W5A1tj6Ky1ABAuZuv5ag=
google.golang.org/grpc v1.55.0/go.mod h1:iYEXKGkEBhg1PjZQvoYEVPTDkHo1/bjTnfwTeGONTY8=
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng=
google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
07070100000031000081A40000000000000000000000016463639800002660000000000000000000000000000000000000002100000000blackbox_exporter-0.24.0/main.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package main
import (
"fmt"
"html"
"net"
"net/http"
_ "net/http/pprof"
"net/url"
"os"
"os/signal"
"path"
"strconv"
"strings"
"syscall"
"github.com/alecthomas/kingpin/v2"
"github.com/go-kit/log/level"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/common/promlog"
"github.com/prometheus/common/promlog/flag"
"github.com/prometheus/common/version"
"github.com/prometheus/exporter-toolkit/web"
webflag "github.com/prometheus/exporter-toolkit/web/kingpinflag"
"gopkg.in/yaml.v3"
"github.com/prometheus/blackbox_exporter/config"
"github.com/prometheus/blackbox_exporter/prober"
)
var (
sc = &config.SafeConfig{
C: &config.Config{},
}
configFile = kingpin.Flag("config.file", "Blackbox exporter configuration file.").Default("blackbox.yml").String()
timeoutOffset = kingpin.Flag("timeout-offset", "Offset to subtract from timeout in seconds.").Default("0.5").Float64()
configCheck = kingpin.Flag("config.check", "If true validate the config file and then exit.").Default().Bool()
historyLimit = kingpin.Flag("history.limit", "The maximum amount of items to keep in the history.").Default("100").Uint()
externalURL = kingpin.Flag("web.external-url", "The URL under which Blackbox exporter is externally reachable (for example, if Blackbox exporter is served via a reverse proxy). Used for generating relative and absolute links back to Blackbox exporter itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by Blackbox exporter. If omitted, relevant URL components will be derived automatically.").PlaceHolder("<url>").String()
routePrefix = kingpin.Flag("web.route-prefix", "Prefix for the internal routes of web endpoints. Defaults to path of --web.external-url.").PlaceHolder("<path>").String()
toolkitFlags = webflag.AddFlags(kingpin.CommandLine, ":9115")
)
func init() {
prometheus.MustRegister(version.NewCollector("blackbox_exporter"))
}
func main() {
os.Exit(run())
}
func run() int {
kingpin.CommandLine.UsageWriter(os.Stdout)
promlogConfig := &promlog.Config{}
flag.AddFlags(kingpin.CommandLine, promlogConfig)
kingpin.Version(version.Print("blackbox_exporter"))
kingpin.HelpFlag.Short('h')
kingpin.Parse()
logger := promlog.New(promlogConfig)
rh := &prober.ResultHistory{MaxResults: *historyLimit}
level.Info(logger).Log("msg", "Starting blackbox_exporter", "version", version.Info())
level.Info(logger).Log("build_context", version.BuildContext())
if err := sc.ReloadConfig(*configFile, logger); err != nil {
level.Error(logger).Log("msg", "Error loading config", "err", err)
return 1
}
if *configCheck {
level.Info(logger).Log("msg", "Config file is ok exiting...")
return 0
}
level.Info(logger).Log("msg", "Loaded config file")
// Infer or set Blackbox exporter externalURL
listenAddrs := toolkitFlags.WebListenAddresses
if *externalURL == "" && *toolkitFlags.WebSystemdSocket {
level.Error(logger).Log("msg", "Cannot automatically infer external URL with systemd socket listener. Please provide --web.external-url")
return 1
} else if *externalURL == "" && len(*listenAddrs) > 1 {
level.Info(logger).Log("msg", "Inferring external URL from first provided listen address")
}
beURL, err := computeExternalURL(*externalURL, (*listenAddrs)[0])
if err != nil {
level.Error(logger).Log("msg", "failed to determine external URL", "err", err)
return 1
}
level.Debug(logger).Log("externalURL", beURL.String())
// Default -web.route-prefix to path of -web.external-url.
if *routePrefix == "" {
*routePrefix = beURL.Path
}
// routePrefix must always be at least '/'.
*routePrefix = "/" + strings.Trim(*routePrefix, "/")
// routePrefix requires path to have trailing "/" in order
// for browsers to interpret the path-relative path correctly, instead of stripping it.
if *routePrefix != "/" {
*routePrefix = *routePrefix + "/"
}
level.Debug(logger).Log("routePrefix", *routePrefix)
hup := make(chan os.Signal, 1)
reloadCh := make(chan chan error)
signal.Notify(hup, syscall.SIGHUP)
go func() {
for {
select {
case <-hup:
if err := sc.ReloadConfig(*configFile, logger); err != nil {
level.Error(logger).Log("msg", "Error reloading config", "err", err)
continue
}
level.Info(logger).Log("msg", "Reloaded config file")
case rc := <-reloadCh:
if err := sc.ReloadConfig(*configFile, logger); err != nil {
level.Error(logger).Log("msg", "Error reloading config", "err", err)
rc <- err
} else {
level.Info(logger).Log("msg", "Reloaded config file")
rc <- nil
}
}
}
}()
// Match Prometheus behavior and redirect over externalURL for root path only
// if routePrefix is different than "/"
if *routePrefix != "/" {
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/" {
http.NotFound(w, r)
return
}
http.Redirect(w, r, beURL.String(), http.StatusFound)
})
}
http.HandleFunc(path.Join(*routePrefix, "/-/reload"),
func(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
w.WriteHeader(http.StatusMethodNotAllowed)
fmt.Fprintf(w, "This endpoint requires a POST request.\n")
return
}
rc := make(chan error)
reloadCh <- rc
if err := <-rc; err != nil {
http.Error(w, fmt.Sprintf("failed to reload config: %s", err), http.StatusInternalServerError)
}
})
http.Handle(path.Join(*routePrefix, "/metrics"), promhttp.Handler())
http.HandleFunc(path.Join(*routePrefix, "/-/healthy"), func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("Healthy"))
})
http.HandleFunc(path.Join(*routePrefix, "/probe"), func(w http.ResponseWriter, r *http.Request) {
sc.Lock()
conf := sc.C
sc.Unlock()
prober.Handler(w, r, conf, logger, rh, *timeoutOffset, nil)
})
http.HandleFunc(*routePrefix, func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html")
w.Write([]byte(`<html>
<head><title>Blackbox Exporter</title></head>
<body>
<h1>Blackbox Exporter</h1>
<p><a href="probe?target=prometheus.io&module=http_2xx">Probe prometheus.io for http_2xx</a></p>
<p><a href="probe?target=prometheus.io&module=http_2xx&debug=true">Debug probe prometheus.io for http_2xx</a></p>
<p><a href="metrics">Metrics</a></p>
<p><a href="config">Configuration</a></p>
<h2>Recent Probes</h2>
<table border='1'><tr><th>Module</th><th>Target</th><th>Result</th><th>Debug</th>`))
results := rh.List()
for i := len(results) - 1; i >= 0; i-- {
r := results[i]
success := "Success"
if !r.Success {
success = "<strong>Failure</strong>"
}
fmt.Fprintf(w, "<tr><td>%s</td><td>%s</td><td>%s</td><td><a href='logs?id=%d'>Logs</a></td></td>",
html.EscapeString(r.ModuleName), html.EscapeString(r.Target), success, r.Id)
}
w.Write([]byte(`</table></body>
</html>`))
})
http.HandleFunc(path.Join(*routePrefix, "/logs"), func(w http.ResponseWriter, r *http.Request) {
id, err := strconv.ParseInt(r.URL.Query().Get("id"), 10, 64)
if err != nil {
http.Error(w, "Invalid probe id", 500)
return
}
result := rh.Get(id)
if result == nil {
http.Error(w, "Probe id not found", 404)
return
}
w.Header().Set("Content-Type", "text/plain")
w.Write([]byte(result.DebugOutput))
})
http.HandleFunc(path.Join(*routePrefix, "/config"), func(w http.ResponseWriter, r *http.Request) {
sc.RLock()
c, err := yaml.Marshal(sc.C)
sc.RUnlock()
if err != nil {
level.Warn(logger).Log("msg", "Error marshalling configuration", "err", err)
http.Error(w, err.Error(), 500)
return
}
w.Header().Set("Content-Type", "text/plain")
w.Write(c)
})
srv := &http.Server{}
srvc := make(chan struct{})
term := make(chan os.Signal, 1)
signal.Notify(term, os.Interrupt, syscall.SIGTERM)
go func() {
if err := web.ListenAndServe(srv, toolkitFlags, logger); err != nil {
level.Error(logger).Log("msg", "Error starting HTTP server", "err", err)
close(srvc)
}
}()
for {
select {
case <-term:
level.Info(logger).Log("msg", "Received SIGTERM, exiting gracefully...")
return 0
case <-srvc:
return 1
}
}
}
func startsOrEndsWithQuote(s string) bool {
return strings.HasPrefix(s, "\"") || strings.HasPrefix(s, "'") ||
strings.HasSuffix(s, "\"") || strings.HasSuffix(s, "'")
}
// computeExternalURL computes a sanitized external URL from a raw input. It infers unset
// URL parts from the OS and the given listen address.
func computeExternalURL(u, listenAddr string) (*url.URL, error) {
if u == "" {
hostname, err := os.Hostname()
if err != nil {
return nil, err
}
_, port, err := net.SplitHostPort(listenAddr)
if err != nil {
return nil, err
}
u = fmt.Sprintf("http://%s:%s/", hostname, port)
}
if startsOrEndsWithQuote(u) {
return nil, errors.New("URL must not begin or end with quotes")
}
eu, err := url.Parse(u)
if err != nil {
return nil, err
}
ppref := strings.TrimRight(eu.Path, "/")
if ppref != "" && !strings.HasPrefix(ppref, "/") {
ppref = "/" + ppref
}
eu.Path = ppref
return eu, nil
}
07070100000032000081A400000000000000000000000164636398000005D9000000000000000000000000000000000000002600000000blackbox_exporter-0.24.0/main_test.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package main
import "testing"
func TestComputeExternalURL(t *testing.T) {
tests := []struct {
input string
valid bool
}{
{
input: "",
valid: true,
},
{
input: "http://proxy.com/prometheus",
valid: true,
},
{
input: "'https://url/prometheus'",
valid: false,
},
{
input: "'relative/path/with/quotes'",
valid: false,
},
{
input: "http://alertmanager.company.com",
valid: true,
},
{
input: "https://double--dash.de",
valid: true,
},
{
input: "'http://starts/with/quote",
valid: false,
},
{
input: "ends/with/quote\"",
valid: false,
},
}
for _, test := range tests {
_, err := computeExternalURL(test.input, "0.0.0.0:9090")
if test.valid {
if err != nil {
t.Errorf("unexpected error %v", err)
}
} else {
if err == nil {
t.Errorf("expected error computing %s got none", test.input)
}
}
}
}
07070100000033000041ED0000000000000000000000026463639800000000000000000000000000000000000000000000002000000000blackbox_exporter-0.24.0/prober07070100000034000081A40000000000000000000000016463639800002B31000000000000000000000000000000000000002700000000blackbox_exporter-0.24.0/prober/dns.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"context"
"net"
"regexp"
"time"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/miekg/dns"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"github.com/prometheus/blackbox_exporter/config"
)
// validRRs checks a slice of RRs received from the server against a DNSRRValidator.
func validRRs(rrs *[]dns.RR, v *config.DNSRRValidator, logger log.Logger) bool {
var anyMatch bool = false
var allMatch bool = true
// Fail the probe if there are no RRs of a given type, but a regexp match is required
// (i.e. FailIfNotMatchesRegexp or FailIfNoneMatchesRegexp is set).
if len(*rrs) == 0 && len(v.FailIfNotMatchesRegexp) > 0 {
level.Error(logger).Log("msg", "fail_if_not_matches_regexp specified but no RRs returned")
return false
}
if len(*rrs) == 0 && len(v.FailIfNoneMatchesRegexp) > 0 {
level.Error(logger).Log("msg", "fail_if_none_matches_regexp specified but no RRs returned")
return false
}
for _, rr := range *rrs {
level.Info(logger).Log("msg", "Validating RR", "rr", rr)
for _, re := range v.FailIfMatchesRegexp {
match, err := regexp.MatchString(re, rr.String())
if err != nil {
level.Error(logger).Log("msg", "Error matching regexp", "regexp", re, "err", err)
return false
}
if match {
level.Error(logger).Log("msg", "At least one RR matched regexp", "regexp", re, "rr", rr)
return false
}
}
for _, re := range v.FailIfAllMatchRegexp {
match, err := regexp.MatchString(re, rr.String())
if err != nil {
level.Error(logger).Log("msg", "Error matching regexp", "regexp", re, "err", err)
return false
}
if !match {
allMatch = false
}
}
for _, re := range v.FailIfNotMatchesRegexp {
match, err := regexp.MatchString(re, rr.String())
if err != nil {
level.Error(logger).Log("msg", "Error matching regexp", "regexp", re, "err", err)
return false
}
if !match {
level.Error(logger).Log("msg", "At least one RR did not match regexp", "regexp", re, "rr", rr)
return false
}
}
for _, re := range v.FailIfNoneMatchesRegexp {
match, err := regexp.MatchString(re, rr.String())
if err != nil {
level.Error(logger).Log("msg", "Error matching regexp", "regexp", re, "err", err)
return false
}
if match {
anyMatch = true
}
}
}
if len(v.FailIfAllMatchRegexp) > 0 && !allMatch {
level.Error(logger).Log("msg", "Not all RRs matched regexp")
return false
}
if len(v.FailIfNoneMatchesRegexp) > 0 && !anyMatch {
level.Error(logger).Log("msg", "None of the RRs did matched any regexp")
return false
}
return true
}
// validRcode checks rcode in the response against a list of valid rcodes.
func validRcode(rcode int, valid []string, logger log.Logger) bool {
var validRcodes []int
// If no list of valid rcodes is specified, only NOERROR is considered valid.
if valid == nil {
validRcodes = append(validRcodes, dns.StringToRcode["NOERROR"])
} else {
for _, rcode := range valid {
rc, ok := dns.StringToRcode[rcode]
if !ok {
level.Error(logger).Log("msg", "Invalid rcode", "rcode", rcode, "known_rcode", dns.RcodeToString)
return false
}
validRcodes = append(validRcodes, rc)
}
}
for _, rc := range validRcodes {
if rcode == rc {
level.Info(logger).Log("msg", "Rcode is valid", "rcode", rcode, "string_rcode", dns.RcodeToString[rcode])
return true
}
}
level.Error(logger).Log("msg", "Rcode is not one of the valid rcodes", "rcode", rcode, "string_rcode", dns.RcodeToString[rcode], "valid_rcodes", validRcodes)
return false
}
func ProbeDNS(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) bool {
var dialProtocol string
probeDNSDurationGaugeVec := prometheus.NewGaugeVec(prometheus.GaugeOpts{
Name: "probe_dns_duration_seconds",
Help: "Duration of DNS request by phase",
}, []string{"phase"})
probeDNSAnswerRRSGauge := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_dns_answer_rrs",
Help: "Returns number of entries in the answer resource record list",
})
probeDNSAuthorityRRSGauge := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_dns_authority_rrs",
Help: "Returns number of entries in the authority resource record list",
})
probeDNSAdditionalRRSGauge := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_dns_additional_rrs",
Help: "Returns number of entries in the additional resource record list",
})
probeDNSQuerySucceeded := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_dns_query_succeeded",
Help: "Displays whether or not the query was executed successfully",
})
for _, lv := range []string{"resolve", "connect", "request"} {
probeDNSDurationGaugeVec.WithLabelValues(lv)
}
registry.MustRegister(probeDNSDurationGaugeVec)
registry.MustRegister(probeDNSAnswerRRSGauge)
registry.MustRegister(probeDNSAuthorityRRSGauge)
registry.MustRegister(probeDNSAdditionalRRSGauge)
registry.MustRegister(probeDNSQuerySucceeded)
qc := uint16(dns.ClassINET)
if module.DNS.QueryClass != "" {
var ok bool
qc, ok = dns.StringToClass[module.DNS.QueryClass]
if !ok {
level.Error(logger).Log("msg", "Invalid query class", "Class seen", module.DNS.QueryClass, "Existing classes", dns.ClassToString)
return false
}
}
qt := dns.TypeANY
if module.DNS.QueryType != "" {
var ok bool
qt, ok = dns.StringToType[module.DNS.QueryType]
if !ok {
level.Error(logger).Log("msg", "Invalid query type", "Type seen", module.DNS.QueryType, "Existing types", dns.TypeToString)
return false
}
}
var probeDNSSOAGauge prometheus.Gauge
var ip *net.IPAddr
if module.DNS.TransportProtocol == "" {
module.DNS.TransportProtocol = "udp"
}
if !(module.DNS.TransportProtocol == "udp" || module.DNS.TransportProtocol == "tcp") {
level.Error(logger).Log("msg", "Configuration error: Expected transport protocol udp or tcp", "protocol", module.DNS.TransportProtocol)
return false
}
targetAddr, port, err := net.SplitHostPort(target)
if err != nil {
// Target only contains host so fallback to default port and set targetAddr as target.
if module.DNS.DNSOverTLS {
port = "853"
} else {
port = "53"
}
targetAddr = target
}
ip, lookupTime, err := chooseProtocol(ctx, module.DNS.IPProtocol, module.DNS.IPProtocolFallback, targetAddr, registry, logger)
if err != nil {
level.Error(logger).Log("msg", "Error resolving address", "err", err)
return false
}
probeDNSDurationGaugeVec.WithLabelValues("resolve").Add(lookupTime)
targetIP := net.JoinHostPort(ip.String(), port)
if ip.IP.To4() == nil {
dialProtocol = module.DNS.TransportProtocol + "6"
} else {
dialProtocol = module.DNS.TransportProtocol + "4"
}
if module.DNS.DNSOverTLS {
if module.DNS.TransportProtocol == "tcp" {
dialProtocol += "-tls"
} else {
level.Error(logger).Log("msg", "Configuration error: Expected transport protocol tcp for DoT", "protocol", module.DNS.TransportProtocol)
return false
}
}
client := new(dns.Client)
client.Net = dialProtocol
if module.DNS.DNSOverTLS {
tlsConfig, err := pconfig.NewTLSConfig(&module.DNS.TLSConfig)
if err != nil {
level.Error(logger).Log("msg", "Failed to create TLS configuration", "err", err)
return false
}
if tlsConfig.ServerName == "" {
// Use target-hostname as default for TLS-servername.
tlsConfig.ServerName = targetAddr
}
client.TLSConfig = tlsConfig
}
// Use configured SourceIPAddress.
if len(module.DNS.SourceIPAddress) > 0 {
srcIP := net.ParseIP(module.DNS.SourceIPAddress)
if srcIP == nil {
level.Error(logger).Log("msg", "Error parsing source ip address", "srcIP", module.DNS.SourceIPAddress)
return false
}
level.Info(logger).Log("msg", "Using local address", "srcIP", srcIP)
client.Dialer = &net.Dialer{}
if module.DNS.TransportProtocol == "tcp" {
client.Dialer.LocalAddr = &net.TCPAddr{IP: srcIP}
} else {
client.Dialer.LocalAddr = &net.UDPAddr{IP: srcIP}
}
}
msg := new(dns.Msg)
msg.Id = dns.Id()
msg.RecursionDesired = module.DNS.Recursion
msg.Question = make([]dns.Question, 1)
msg.Question[0] = dns.Question{dns.Fqdn(module.DNS.QueryName), qt, qc}
level.Info(logger).Log("msg", "Making DNS query", "target", targetIP, "dial_protocol", dialProtocol, "query", module.DNS.QueryName, "type", qt, "class", qc)
timeoutDeadline, _ := ctx.Deadline()
client.Timeout = time.Until(timeoutDeadline)
requestStart := time.Now()
response, rtt, err := client.Exchange(msg, targetIP)
// The rtt value returned from client.Exchange includes only the time to
// exchange messages with the server _after_ the connection is created.
// We compute the connection time as the total time for the operation
// minus the time for the actual request rtt.
probeDNSDurationGaugeVec.WithLabelValues("connect").Set((time.Since(requestStart) - rtt).Seconds())
probeDNSDurationGaugeVec.WithLabelValues("request").Set(rtt.Seconds())
if err != nil {
level.Error(logger).Log("msg", "Error while sending a DNS query", "err", err)
return false
}
level.Info(logger).Log("msg", "Got response", "response", response)
probeDNSAnswerRRSGauge.Set(float64(len(response.Answer)))
probeDNSAuthorityRRSGauge.Set(float64(len(response.Ns)))
probeDNSAdditionalRRSGauge.Set(float64(len(response.Extra)))
probeDNSQuerySucceeded.Set(1)
if qt == dns.TypeSOA {
probeDNSSOAGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_dns_serial",
Help: "Returns the serial number of the zone",
})
registry.MustRegister(probeDNSSOAGauge)
for _, a := range response.Answer {
if soa, ok := a.(*dns.SOA); ok {
probeDNSSOAGauge.Set(float64(soa.Serial))
}
}
}
if !validRcode(response.Rcode, module.DNS.ValidRcodes, logger) {
return false
}
level.Info(logger).Log("msg", "Validating Answer RRs")
if !validRRs(&response.Answer, &module.DNS.ValidateAnswer, logger) {
level.Error(logger).Log("msg", "Answer RRs validation failed")
return false
}
level.Info(logger).Log("msg", "Validating Authority RRs")
if !validRRs(&response.Ns, &module.DNS.ValidateAuthority, logger) {
level.Error(logger).Log("msg", "Authority RRs validation failed")
return false
}
level.Info(logger).Log("msg", "Validating Additional RRs")
if !validRRs(&response.Extra, &module.DNS.ValidateAdditional, logger) {
level.Error(logger).Log("msg", "Additional RRs validation failed")
return false
}
return true
}
07070100000035000081A40000000000000000000000016463639800004492000000000000000000000000000000000000002C00000000blackbox_exporter-0.24.0/prober/dns_test.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"context"
"net"
"os"
"runtime"
"testing"
"time"
"github.com/go-kit/log"
"github.com/miekg/dns"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/blackbox_exporter/config"
)
var PROTOCOLS = [...]string{"udp", "tcp"}
// startDNSServer starts a DNS server with a given handler function on a random port.
// Returns the Server object itself as well as the net.Addr corresponding to the server port.
func startDNSServer(protocol string, handler func(dns.ResponseWriter, *dns.Msg)) (*dns.Server, net.Addr) {
h := dns.NewServeMux()
h.HandleFunc(".", handler)
server := &dns.Server{Addr: ":0", Net: protocol, Handler: h}
if protocol == "udp" {
a, err := net.ResolveUDPAddr(server.Net, server.Addr)
if err != nil {
panic(err)
}
l, err := net.ListenUDP(server.Net, a)
if err != nil {
panic(err)
}
server.PacketConn = l
} else {
a, err := net.ResolveTCPAddr(server.Net, server.Addr)
if err != nil {
panic(err)
}
l, err := net.ListenTCP(server.Net, a)
if err != nil {
panic(err)
}
server.Listener = l
}
go server.ActivateAndServe()
if protocol == "tcp" {
return server, server.Listener.Addr()
}
return server, server.PacketConn.LocalAddr()
}
func recursiveDNSHandler(w dns.ResponseWriter, r *dns.Msg) {
m := new(dns.Msg)
m.SetReply(r)
if !r.RecursionDesired {
m.Rcode = dns.RcodeRefused
} else {
answers := []string{
"example.com. 3600 IN A 127.0.0.1",
"example.com. 3600 IN A 127.0.0.2",
}
for _, rr := range answers {
a, err := dns.NewRR(rr)
if err != nil {
panic(err)
}
m.Answer = append(m.Answer, a)
}
}
if err := w.WriteMsg(m); err != nil {
panic(err)
}
}
func TestRecursiveDNSResponse(t *testing.T) {
if os.Getenv("CI") == "true" {
t.Skip("skipping; CI is failing on ipv6 dns requests")
}
tests := []struct {
Probe config.DNSProbe
ShouldSucceed bool
}{
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
Recursion: true,
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
Recursion: true,
ValidRcodes: []string{"SERVFAIL", "NXDOMAIN"},
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
Recursion: true,
ValidateAnswer: config.DNSRRValidator{
FailIfMatchesRegexp: []string{".*7200.*"},
FailIfNotMatchesRegexp: []string{".*3600.*"},
},
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
Recursion: true,
ValidateAuthority: config.DNSRRValidator{
FailIfMatchesRegexp: []string{".*7200.*"},
},
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
Recursion: true,
ValidateAdditional: config.DNSRRValidator{
FailIfNotMatchesRegexp: []string{".*3600.*"},
},
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
Recursion: false,
}, false,
},
}
for _, protocol := range PROTOCOLS {
server, addr := startDNSServer(protocol, recursiveDNSHandler)
defer server.Shutdown()
for i, test := range tests {
test.Probe.TransportProtocol = protocol
registry := prometheus.NewPedanticRegistry()
registry.Gather()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeDNS(testCTX, addr.String(), config.Module{Timeout: time.Second, DNS: test.Probe}, registry, log.NewNopLogger())
if result != test.ShouldSucceed {
t.Fatalf("Test %d had unexpected result: %v", i, result)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_dns_answer_rrs": 2,
"probe_dns_authority_rrs": 0,
"probe_dns_additional_rrs": 0,
"probe_dns_query_succeeded": 1,
}
if !test.Probe.Recursion {
expectedResults["probe_dns_answer_rrs"] = 0
}
checkRegistryResults(expectedResults, mfs, t)
}
}
}
func authoritativeDNSHandler(w dns.ResponseWriter, r *dns.Msg) {
m := new(dns.Msg)
m.SetReply(r)
if r.Question[0].Qtype == dns.TypeSOA {
a, err := dns.NewRR("example.com. 3600 IN SOA ns.example.com. noc.example.com. 1000 7200 3600 1209600 3600")
if err != nil {
panic(err)
}
m.Answer = append(m.Answer, a)
} else if r.Question[0].Qclass == dns.ClassCHAOS && r.Question[0].Qtype == dns.TypeTXT {
txt, err := dns.NewRR("example.com. 3600 CH TXT \"goCHAOS\"")
if err != nil {
panic(err)
}
m.Answer = append(m.Answer, txt)
} else {
a, err := dns.NewRR("example.com. 3600 IN A 127.0.0.1")
if err != nil {
panic(err)
}
m.Answer = append(m.Answer, a)
}
authority := []string{
"example.com. 7200 IN NS ns1.isp.net.",
"example.com. 7200 IN NS ns2.isp.net.",
}
for _, rr := range authority {
a, err := dns.NewRR(rr)
if err != nil {
panic(err)
}
m.Ns = append(m.Ns, a)
}
additional := []string{
"ns1.isp.net. 7200 IN A 127.0.0.1",
"ns1.isp.net. 7200 IN AAAA ::1",
"ns2.isp.net. 7200 IN A 127.0.0.2",
}
for _, rr := range additional {
a, err := dns.NewRR(rr)
if err != nil {
panic(err)
}
m.Extra = append(m.Extra, a)
}
if err := w.WriteMsg(m); err != nil {
panic(err)
}
}
func TestAuthoritativeDNSResponse(t *testing.T) {
if os.Getenv("CI") == "true" {
t.Skip("skipping; CI is failing on ipv6 dns requests")
}
tests := []struct {
Probe config.DNSProbe
ShouldSucceed bool
}{
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
QueryType: "SOA",
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryClass: "CH",
QueryName: "example.com",
QueryType: "TXT",
ValidateAnswer: config.DNSRRValidator{
FailIfMatchesRegexp: []string{".*IN.*"},
FailIfNotMatchesRegexp: []string{".*CH.*"},
},
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidRcodes: []string{"SERVFAIL", "NXDOMAIN"},
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidateAnswer: config.DNSRRValidator{
FailIfMatchesRegexp: []string{".*3600.*"},
FailIfNotMatchesRegexp: []string{".*3600.*"},
},
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidateAnswer: config.DNSRRValidator{
FailIfMatchesRegexp: []string{".*7200.*"},
FailIfNotMatchesRegexp: []string{".*7200.*"},
},
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidateAuthority: config.DNSRRValidator{
FailIfNotMatchesRegexp: []string{"ns.*.isp.net"},
},
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidateAdditional: config.DNSRRValidator{
FailIfNotMatchesRegexp: []string{"^ns.*.isp"},
},
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidateAdditional: config.DNSRRValidator{
FailIfMatchesRegexp: []string{"^ns.*.isp"},
},
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidateAdditional: config.DNSRRValidator{
FailIfAllMatchRegexp: []string{".*127.0.0.*"},
},
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidateAdditional: config.DNSRRValidator{
FailIfNoneMatchesRegexp: []string{".*127.0.0.3.*"},
},
}, false,
},
}
for _, protocol := range PROTOCOLS {
server, addr := startDNSServer(protocol, authoritativeDNSHandler)
defer server.Shutdown()
for i, test := range tests {
test.Probe.TransportProtocol = protocol
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeDNS(testCTX, addr.String(), config.Module{Timeout: time.Second, DNS: test.Probe}, registry, log.NewNopLogger())
if result != test.ShouldSucceed {
t.Fatalf("Test %d had unexpected result: %v", i, result)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_dns_answer_rrs": 1,
"probe_dns_authority_rrs": 2,
"probe_dns_additional_rrs": 3,
"probe_dns_query_succeeded": 1,
}
if test.Probe.QueryType == "SOA" {
expectedResults["probe_dns_serial"] = 1000
}
checkRegistryResults(expectedResults, mfs, t)
}
}
}
func TestServfailDNSResponse(t *testing.T) {
if os.Getenv("CI") == "true" {
t.Skip("skipping; CI is failing on ipv6 dns requests")
}
tests := []struct {
Probe config.DNSProbe
ShouldSucceed bool
}{
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidRcodes: []string{"SERVFAIL", "NXDOMAIN"},
}, true,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
QueryType: "NOT_A_VALID_QUERY_TYPE",
}, false,
},
{
config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
ValidRcodes: []string{"NOT_A_VALID_RCODE"},
}, false,
},
}
for _, protocol := range PROTOCOLS {
// dns.HandleFailed returns SERVFAIL on everything
server, addr := startDNSServer(protocol, dns.HandleFailed)
defer server.Shutdown()
for i, test := range tests {
test.Probe.TransportProtocol = protocol
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeDNS(testCTX, addr.String(), config.Module{Timeout: time.Second, DNS: test.Probe}, registry, log.NewNopLogger())
if result != test.ShouldSucceed {
t.Fatalf("Test %d had unexpected result: %v", i, result)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_dns_answer_rrs": 0,
"probe_dns_authority_rrs": 0,
"probe_dns_additional_rrs": 0,
"probe_dns_query_succeeded": 1,
}
// Handle case where ProbeDNS fails before executing the query because of an invalid query type
if test.Probe.QueryType == "NOT_A_VALID_QUERY_TYPE" {
expectedResults["probe_dns_query_succeeded"] = 0
}
checkRegistryResults(expectedResults, mfs, t)
}
}
}
func TestDNSProtocol(t *testing.T) {
if os.Getenv("CI") == "true" {
t.Skip("skipping; CI is failing on ipv6 dns requests")
}
// This test assumes that listening TCP listens both IPv6 and IPv4 traffic and
// localhost resolves to both 127.0.0.1 and ::1. we must skip the test if either
// of these isn't true. This should be true for modern Linux systems.
if runtime.GOOS == "dragonfly" || runtime.GOOS == "openbsd" {
t.Skip("IPv6 socket isn't able to accept IPv4 traffic in the system.")
}
_, err := net.ResolveIPAddr("ip6", "localhost")
if err != nil {
t.Skip("\"localhost\" doesn't resolve to ::1.")
}
for _, protocol := range PROTOCOLS {
server, addr := startDNSServer(protocol, recursiveDNSHandler)
defer server.Shutdown()
_, port, _ := net.SplitHostPort(addr.String())
// Prefer IPv6
module := config.Module{
Timeout: time.Second,
DNS: config.DNSProbe{
QueryName: "example.com",
TransportProtocol: protocol,
IPProtocol: "ip6",
Recursion: true,
},
}
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeDNS(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if !result {
t.Fatalf("DNS protocol: \"%v\", preferred \"ip6\" connection test failed, expected success.", protocol)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_ip_protocol": 6,
}
checkRegistryResults(expectedResults, mfs, t)
// Prefer IPv4
module = config.Module{
Timeout: time.Second,
DNS: config.DNSProbe{
QueryName: "example.com",
Recursion: true,
TransportProtocol: protocol,
IPProtocol: "ip4",
},
}
registry = prometheus.NewRegistry()
testCTX, cancel = context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result = ProbeDNS(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if !result {
t.Fatalf("DNS protocol: \"%v\", preferred \"ip4\" connection test failed, expected success.", protocol)
}
mfs, err = registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults = map[string]float64{
"probe_ip_protocol": 4,
}
checkRegistryResults(expectedResults, mfs, t)
// Prefer none
module = config.Module{
Timeout: time.Second,
DNS: config.DNSProbe{
QueryName: "example.com",
Recursion: true,
TransportProtocol: protocol,
},
}
registry = prometheus.NewRegistry()
testCTX, cancel = context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result = ProbeDNS(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if !result {
t.Fatalf("DNS protocol: \"%v\" connection test failed, expected success.", protocol)
}
mfs, err = registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults = map[string]float64{
"probe_ip_protocol": 6,
}
checkRegistryResults(expectedResults, mfs, t)
// No protocol
module = config.Module{
Timeout: time.Second,
DNS: config.DNSProbe{
QueryName: "example.com",
Recursion: true,
},
}
registry = prometheus.NewRegistry()
testCTX, cancel = context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result = ProbeDNS(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if protocol == "udp" {
if !result {
t.Fatalf("DNS test connection with protocol %s failed, expected success.", protocol)
}
} else {
if result {
t.Fatalf("DNS test connection with protocol %s succeeded, expected failure.", protocol)
}
}
mfs, err = registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults = map[string]float64{
"probe_ip_protocol": 6,
}
checkRegistryResults(expectedResults, mfs, t)
}
}
// TestDNSMetrics checks that calling ProbeDNS populates the expected
// set of metrics for a DNS probe, but it does not test that those
// metrics contain specific values.
func TestDNSMetrics(t *testing.T) {
server, addr := startDNSServer("udp", recursiveDNSHandler)
defer server.Shutdown()
_, port, _ := net.SplitHostPort(addr.String())
module := config.Module{
Timeout: time.Second,
DNS: config.DNSProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
QueryName: "example.com",
Recursion: true,
},
}
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeDNS(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if !result {
t.Fatalf("DNS test connection failed, expected success.")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedMetrics := map[string]map[string]map[string]struct{}{
"probe_dns_lookup_time_seconds": nil,
"probe_dns_duration_seconds": {
"phase": {
"resolve": {},
"connect": {},
"request": {},
},
},
"probe_dns_answer_rrs": nil,
"probe_dns_authority_rrs": nil,
"probe_dns_additional_rrs": nil,
"probe_dns_query_succeeded": nil,
}
checkMetrics(expectedMetrics, mfs, t)
}
07070100000036000081A40000000000000000000000016463639800001BC6000000000000000000000000000000000000002800000000blackbox_exporter-0.24.0/prober/grpc.go// Copyright 2021 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"context"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/blackbox_exporter/config"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/health/grpc_health_v1"
"google.golang.org/grpc/peer"
"google.golang.org/grpc/status"
"net"
"net/url"
"strings"
"time"
)
type GRPCHealthCheck interface {
Check(c context.Context, service string) (bool, codes.Code, *peer.Peer, string, error)
}
type gRPCHealthCheckClient struct {
client grpc_health_v1.HealthClient
conn *grpc.ClientConn
}
func NewGrpcHealthCheckClient(conn *grpc.ClientConn) GRPCHealthCheck {
client := new(gRPCHealthCheckClient)
client.client = grpc_health_v1.NewHealthClient(conn)
client.conn = conn
return client
}
func (c *gRPCHealthCheckClient) Close() error {
return c.conn.Close()
}
func (c *gRPCHealthCheckClient) Check(ctx context.Context, service string) (bool, codes.Code, *peer.Peer, string, error) {
var res *grpc_health_v1.HealthCheckResponse
var err error
req := grpc_health_v1.HealthCheckRequest{
Service: service,
}
serverPeer := new(peer.Peer)
res, err = c.client.Check(ctx, &req, grpc.Peer(serverPeer))
if err == nil {
if res.GetStatus() == grpc_health_v1.HealthCheckResponse_SERVING {
return true, codes.OK, serverPeer, res.Status.String(), nil
}
return false, codes.OK, serverPeer, res.Status.String(), nil
}
returnStatus, _ := status.FromError(err)
return false, returnStatus.Code(), nil, "", err
}
func ProbeGRPC(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) (success bool) {
var (
durationGaugeVec = prometheus.NewGaugeVec(prometheus.GaugeOpts{
Name: "probe_grpc_duration_seconds",
Help: "Duration of gRPC request by phase",
}, []string{"phase"})
isSSLGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_grpc_ssl",
Help: "Indicates if SSL was used for the connection",
})
statusCodeGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_grpc_status_code",
Help: "Response gRPC status code",
})
healthCheckResponseGaugeVec = prometheus.NewGaugeVec(prometheus.GaugeOpts{
Name: "probe_grpc_healthcheck_response",
Help: "Response HealthCheck response",
}, []string{"serving_status"})
probeSSLEarliestCertExpiryGauge = prometheus.NewGauge(sslEarliestCertExpiryGaugeOpts)
probeTLSVersion = prometheus.NewGaugeVec(
probeTLSInfoGaugeOpts,
[]string{"version"},
)
probeSSLLastInformation = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "probe_ssl_last_chain_info",
Help: "Contains SSL leaf certificate information",
},
[]string{"fingerprint_sha256", "subject", "issuer", "subjectalternative"},
)
)
for _, lv := range []string{"resolve"} {
durationGaugeVec.WithLabelValues(lv)
}
registry.MustRegister(durationGaugeVec)
registry.MustRegister(isSSLGauge)
registry.MustRegister(statusCodeGauge)
registry.MustRegister(healthCheckResponseGaugeVec)
registry.MustRegister(probeSSLEarliestCertExpiryGauge)
registry.MustRegister(probeTLSVersion)
registry.MustRegister(probeSSLLastInformation)
if !strings.HasPrefix(target, "http://") && !strings.HasPrefix(target, "https://") {
target = "http://" + target
}
targetURL, err := url.Parse(target)
if err != nil {
level.Error(logger).Log("msg", "Could not parse target URL", "err", err)
return false
}
targetHost, targetPort, err := net.SplitHostPort(targetURL.Host)
// If split fails, assuming it's a hostname without port part.
if err != nil {
targetHost = targetURL.Host
}
tlsConfig, err := pconfig.NewTLSConfig(&module.GRPC.TLSConfig)
if err != nil {
level.Error(logger).Log("msg", "Error creating TLS configuration", "err", err)
return false
}
ip, lookupTime, err := chooseProtocol(ctx, module.GRPC.PreferredIPProtocol, module.GRPC.IPProtocolFallback, targetHost, registry, logger)
if err != nil {
level.Error(logger).Log("msg", "Error resolving address", "err", err)
return false
}
durationGaugeVec.WithLabelValues("resolve").Add(lookupTime)
checkStart := time.Now()
if len(tlsConfig.ServerName) == 0 {
// If there is no `server_name` in tls_config, use
// the hostname of the target.
tlsConfig.ServerName = targetHost
}
if targetPort == "" {
targetURL.Host = "[" + ip.String() + "]"
} else {
targetURL.Host = net.JoinHostPort(ip.String(), targetPort)
}
var opts []grpc.DialOption
target = targetHost + ":" + targetPort
if !module.GRPC.TLS {
level.Debug(logger).Log("msg", "Dialing GRPC without TLS")
opts = append(opts, grpc.WithTransportCredentials(insecure.NewCredentials()))
if len(targetPort) == 0 {
target = targetHost + ":80"
}
} else {
creds := credentials.NewTLS(tlsConfig)
opts = append(opts, grpc.WithTransportCredentials(creds))
if len(targetPort) == 0 {
target = targetHost + ":443"
}
}
conn, err := grpc.Dial(target, opts...)
if err != nil {
level.Error(logger).Log("did not connect: %v", err)
}
client := NewGrpcHealthCheckClient(conn)
defer conn.Close()
ok, statusCode, serverPeer, servingStatus, err := client.Check(context.Background(), module.GRPC.Service)
durationGaugeVec.WithLabelValues("check").Add(time.Since(checkStart).Seconds())
for servingStatusName, _ := range grpc_health_v1.HealthCheckResponse_ServingStatus_value {
healthCheckResponseGaugeVec.WithLabelValues(servingStatusName).Set(float64(0))
}
if servingStatus != "" {
healthCheckResponseGaugeVec.WithLabelValues(servingStatus).Set(float64(1))
}
if serverPeer != nil {
tlsInfo, tlsOk := serverPeer.AuthInfo.(credentials.TLSInfo)
if tlsOk {
isSSLGauge.Set(float64(1))
probeSSLEarliestCertExpiryGauge.Set(float64(getEarliestCertExpiry(&tlsInfo.State).Unix()))
probeTLSVersion.WithLabelValues(getTLSVersion(&tlsInfo.State)).Set(1)
probeSSLLastInformation.WithLabelValues(getFingerprint(&tlsInfo.State), getSubject(&tlsInfo.State), getIssuer(&tlsInfo.State), getDNSNames(&tlsInfo.State)).Set(1)
} else {
isSSLGauge.Set(float64(0))
}
}
statusCodeGauge.Set(float64(statusCode))
if !ok || err != nil {
level.Error(logger).Log("msg", "can't connect grpc server:", "err", err)
success = false
} else {
level.Debug(logger).Log("connect the grpc server successfully")
success = true
}
return
}
07070100000037000081A40000000000000000000000016463639800002A05000000000000000000000000000000000000002D00000000blackbox_exporter-0.24.0/prober/grpc_test.go// Copyright 2021 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"context"
"crypto/tls"
"crypto/x509"
"encoding/pem"
"fmt"
"net"
"os"
"testing"
"time"
"github.com/go-kit/log"
"github.com/prometheus/blackbox_exporter/config"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/health"
"google.golang.org/grpc/health/grpc_health_v1"
)
func TestGRPCConnection(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, port, err := net.SplitHostPort(ln.Addr().String())
if err != nil {
t.Fatalf("Error retrieving port for socket: %s", err)
}
s := grpc.NewServer()
healthServer := health.NewServer()
healthServer.SetServingStatus("service", grpc_health_v1.HealthCheckResponse_SERVING)
grpc_health_v1.RegisterHealthServer(s, healthServer)
go func() {
if err := s.Serve(ln); err != nil {
t.Errorf("failed to serve: %v", err)
return
}
}()
defer s.GracefulStop()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
result := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
IPProtocolFallback: false,
},
}, registry, log.NewNopLogger())
if !result {
t.Fatalf("GRPC probe failed")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedMetrics := map[string]map[string]map[string]struct{}{
"probe_grpc_healthcheck_response": {
"serving_status": {
"UNKNOWN": {},
"SERVING": {},
"NOT_SERVING": {},
"SERVICE_UNKNOWN": {},
},
},
}
checkMetrics(expectedMetrics, mfs, t)
expectedResults := map[string]float64{
"probe_grpc_ssl": 0,
"probe_grpc_status_code": 0,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestMultipleGRPCservices(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, port, err := net.SplitHostPort(ln.Addr().String())
if err != nil {
t.Fatalf("Error retrieving port for socket: %s", err)
}
s := grpc.NewServer()
healthServer := health.NewServer()
healthServer.SetServingStatus("service1", grpc_health_v1.HealthCheckResponse_SERVING)
healthServer.SetServingStatus("service2", grpc_health_v1.HealthCheckResponse_NOT_SERVING)
grpc_health_v1.RegisterHealthServer(s, healthServer)
go func() {
if err := s.Serve(ln); err != nil {
t.Errorf("failed to serve: %v", err)
return
}
}()
defer s.GracefulStop()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registryService1 := prometheus.NewRegistry()
resultService1 := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
IPProtocolFallback: false,
Service: "service1",
},
}, registryService1, log.NewNopLogger())
if !resultService1 {
t.Fatalf("GRPC probe failed for service1")
}
registryService2 := prometheus.NewRegistry()
resultService2 := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
IPProtocolFallback: false,
Service: "service2",
},
}, registryService2, log.NewNopLogger())
if resultService2 {
t.Fatalf("GRPC probe succeed for service2")
}
registryService3 := prometheus.NewRegistry()
resultService3 := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
IPProtocolFallback: false,
Service: "service3",
},
}, registryService3, log.NewNopLogger())
if resultService3 {
t.Fatalf("GRPC probe succeed for service3")
}
}
func TestGRPCTLSConnection(t *testing.T) {
certExpiry := time.Now().AddDate(0, 0, 1)
testCertTmpl := generateCertificateTemplate(certExpiry, false)
testCertTmpl.IsCA = true
_, testcertPem, testKey := generateSelfSignedCertificate(testCertTmpl)
// CAFile must be passed via filesystem, use a tempfile.
tmpCaFile, err := os.CreateTemp("", "cafile.pem")
if err != nil {
t.Fatalf("Error creating CA tempfile: %s", err)
}
if _, err = tmpCaFile.Write(testcertPem); err != nil {
t.Fatalf("Error writing CA tempfile: %s", err)
}
if err = tmpCaFile.Close(); err != nil {
t.Fatalf("Error closing CA tempfile: %s", err)
}
defer os.Remove(tmpCaFile.Name())
testKeyPem := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(testKey)})
testcert, err := tls.X509KeyPair(testcertPem, testKeyPem)
if err != nil {
panic(fmt.Sprintf("Failed to decode TLS testing keypair: %s\n", err))
}
tlsConfig := &tls.Config{
Certificates: []tls.Certificate{testcert},
MinVersion: tls.VersionTLS12,
MaxVersion: tls.VersionTLS12,
}
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, port, err := net.SplitHostPort(ln.Addr().String())
if err != nil {
t.Fatalf("Error retrieving port for socket: %s", err)
}
s := grpc.NewServer(grpc.Creds(credentials.NewTLS(tlsConfig)))
healthServer := health.NewServer()
healthServer.SetServingStatus("service", grpc_health_v1.HealthCheckResponse_SERVING)
grpc_health_v1.RegisterHealthServer(s, healthServer)
go func() {
if err := s.Serve(ln); err != nil {
t.Errorf("failed to serve: %v", err)
return
}
}()
defer s.GracefulStop()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
result := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
TLS: true,
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: true},
IPProtocolFallback: false,
},
}, registry, log.NewNopLogger())
if !result {
t.Fatalf("GRPC probe failed")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedLabels := map[string]map[string]string{
"probe_tls_version_info": {
"version": "TLS 1.2",
},
}
checkRegistryLabels(expectedLabels, mfs, t)
expectedResults := map[string]float64{
"probe_grpc_ssl": 1,
"probe_grpc_status_code": 0,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestNoTLSConnection(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, port, err := net.SplitHostPort(ln.Addr().String())
if err != nil {
t.Fatalf("Error retrieving port for socket: %s", err)
}
s := grpc.NewServer()
healthServer := health.NewServer()
healthServer.SetServingStatus("service", grpc_health_v1.HealthCheckResponse_SERVING)
grpc_health_v1.RegisterHealthServer(s, healthServer)
go func() {
if err := s.Serve(ln); err != nil {
t.Errorf("failed to serve: %v", err)
return
}
}()
defer s.GracefulStop()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
result := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
TLS: true,
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: true},
IPProtocolFallback: false,
},
}, registry, log.NewNopLogger())
if result {
t.Fatalf("GRPC probe succeed")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_grpc_ssl": 0,
"probe_grpc_status_code": 14, //UNAVAILABLE
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestGRPCServiceNotFound(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, port, err := net.SplitHostPort(ln.Addr().String())
if err != nil {
t.Fatalf("Error retrieving port for socket: %s", err)
}
s := grpc.NewServer()
healthServer := health.NewServer()
healthServer.SetServingStatus("service", grpc_health_v1.HealthCheckResponse_SERVING)
grpc_health_v1.RegisterHealthServer(s, healthServer)
go func() {
if err := s.Serve(ln); err != nil {
t.Errorf("failed to serve: %v", err)
return
}
}()
defer s.GracefulStop()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
result := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
IPProtocolFallback: false,
Service: "NonExistingService",
},
}, registry, log.NewNopLogger())
if result {
t.Fatalf("GRPC probe succeed")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_grpc_ssl": 0,
"probe_grpc_status_code": 5, //NOT_FOUND
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestGRPCHealthCheckUnimplemented(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, port, err := net.SplitHostPort(ln.Addr().String())
if err != nil {
t.Fatalf("Error retrieving port for socket: %s", err)
}
s := grpc.NewServer()
go func() {
if err := s.Serve(ln); err != nil {
t.Errorf("failed to serve: %v", err)
return
}
}()
defer s.GracefulStop()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
result := ProbeGRPC(testCTX, "localhost:"+port,
config.Module{Timeout: time.Second, GRPC: config.GRPCProbe{
IPProtocolFallback: false,
Service: "NonExistingService",
},
}, registry, log.NewNopLogger())
if result {
t.Fatalf("GRPC probe succeed")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_grpc_ssl": 0,
"probe_grpc_status_code": 12, //UNIMPLEMENTED
}
checkRegistryResults(expectedResults, mfs, t)
}
07070100000038000081A40000000000000000000000016463639800001B7F000000000000000000000000000000000000002B00000000blackbox_exporter-0.24.0/prober/handler.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"bytes"
"context"
"fmt"
"net/http"
"net/textproto"
"net/url"
"strconv"
"time"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/blackbox_exporter/config"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/common/expfmt"
"gopkg.in/yaml.v2"
)
var (
Probers = map[string]ProbeFn{
"http": ProbeHTTP,
"tcp": ProbeTCP,
"icmp": ProbeICMP,
"dns": ProbeDNS,
"grpc": ProbeGRPC,
}
moduleUnknownCounter = promauto.NewCounter(prometheus.CounterOpts{
Name: "blackbox_module_unknown_total",
Help: "Count of unknown modules requested by probes",
})
)
func Handler(w http.ResponseWriter, r *http.Request, c *config.Config, logger log.Logger,
rh *ResultHistory, timeoutOffset float64, params url.Values) {
if params == nil {
params = r.URL.Query()
}
moduleName := params.Get("module")
if moduleName == "" {
moduleName = "http_2xx"
}
module, ok := c.Modules[moduleName]
if !ok {
http.Error(w, fmt.Sprintf("Unknown module %q", moduleName), http.StatusBadRequest)
level.Debug(logger).Log("msg", "Unknown module", "module", moduleName)
moduleUnknownCounter.Add(1)
return
}
timeoutSeconds, err := getTimeout(r, module, timeoutOffset)
if err != nil {
http.Error(w, fmt.Sprintf("Failed to parse timeout from Prometheus header: %s", err), http.StatusInternalServerError)
return
}
ctx, cancel := context.WithTimeout(r.Context(), time.Duration(timeoutSeconds*float64(time.Second)))
defer cancel()
r = r.WithContext(ctx)
probeSuccessGauge := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_success",
Help: "Displays whether or not the probe was a success",
})
probeDurationGauge := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_duration_seconds",
Help: "Returns how long the probe took to complete in seconds",
})
target := params.Get("target")
if target == "" {
http.Error(w, "Target parameter is missing", http.StatusBadRequest)
return
}
prober, ok := Probers[module.Prober]
if !ok {
http.Error(w, fmt.Sprintf("Unknown prober %q", module.Prober), http.StatusBadRequest)
return
}
hostname := params.Get("hostname")
if module.Prober == "http" && hostname != "" {
err = setHTTPHost(hostname, &module)
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
}
if module.Prober == "tcp" && hostname != "" {
if module.TCP.TLSConfig.ServerName == "" {
module.TCP.TLSConfig.ServerName = hostname
}
}
sl := newScrapeLogger(logger, moduleName, target)
level.Info(sl).Log("msg", "Beginning probe", "probe", module.Prober, "timeout_seconds", timeoutSeconds)
start := time.Now()
registry := prometheus.NewRegistry()
registry.MustRegister(probeSuccessGauge)
registry.MustRegister(probeDurationGauge)
success := prober(ctx, target, module, registry, sl)
duration := time.Since(start).Seconds()
probeDurationGauge.Set(duration)
if success {
probeSuccessGauge.Set(1)
level.Info(sl).Log("msg", "Probe succeeded", "duration_seconds", duration)
} else {
level.Error(sl).Log("msg", "Probe failed", "duration_seconds", duration)
}
debugOutput := DebugOutput(&module, &sl.buffer, registry)
rh.Add(moduleName, target, debugOutput, success)
if r.URL.Query().Get("debug") == "true" {
w.Header().Set("Content-Type", "text/plain")
w.Write([]byte(debugOutput))
return
}
h := promhttp.HandlerFor(registry, promhttp.HandlerOpts{})
h.ServeHTTP(w, r)
}
func setHTTPHost(hostname string, module *config.Module) error {
// By creating a new hashmap and copying values there we
// ensure that the initial configuration remain intact.
headers := make(map[string]string)
if module.HTTP.Headers != nil {
for name, value := range module.HTTP.Headers {
if textproto.CanonicalMIMEHeaderKey(name) == "Host" && value != hostname {
return fmt.Errorf("host header defined both in module configuration (%s) and with URL-parameter 'hostname' (%s)", value, hostname)
}
headers[name] = value
}
}
headers["Host"] = hostname
module.HTTP.Headers = headers
return nil
}
type scrapeLogger struct {
next log.Logger
buffer bytes.Buffer
bufferLogger log.Logger
}
func newScrapeLogger(logger log.Logger, module string, target string) *scrapeLogger {
logger = log.With(logger, "module", module, "target", target)
sl := &scrapeLogger{
next: logger,
buffer: bytes.Buffer{},
}
bl := log.NewLogfmtLogger(&sl.buffer)
sl.bufferLogger = log.With(bl, "ts", log.DefaultTimestampUTC, "caller", log.Caller(6), "module", module, "target", target)
return sl
}
func (sl scrapeLogger) Log(keyvals ...interface{}) error {
sl.bufferLogger.Log(keyvals...)
kvs := make([]interface{}, len(keyvals))
copy(kvs, keyvals)
// Switch level to debug for application output.
for i := 0; i < len(kvs); i += 2 {
if kvs[i] == level.Key() {
kvs[i+1] = level.DebugValue()
}
}
return sl.next.Log(kvs...)
}
// DebugOutput returns plaintext debug output for a probe.
func DebugOutput(module *config.Module, logBuffer *bytes.Buffer, registry *prometheus.Registry) string {
buf := &bytes.Buffer{}
fmt.Fprintf(buf, "Logs for the probe:\n")
logBuffer.WriteTo(buf)
fmt.Fprintf(buf, "\n\n\nMetrics that would have been returned:\n")
mfs, err := registry.Gather()
if err != nil {
fmt.Fprintf(buf, "Error gathering metrics: %s\n", err)
}
for _, mf := range mfs {
expfmt.MetricFamilyToText(buf, mf)
}
fmt.Fprintf(buf, "\n\n\nModule configuration:\n")
c, err := yaml.Marshal(module)
if err != nil {
fmt.Fprintf(buf, "Error marshalling config: %s\n", err)
}
buf.Write(c)
return buf.String()
}
func getTimeout(r *http.Request, module config.Module, offset float64) (timeoutSeconds float64, err error) {
// If a timeout is configured via the Prometheus header, add it to the request.
if v := r.Header.Get("X-Prometheus-Scrape-Timeout-Seconds"); v != "" {
var err error
timeoutSeconds, err = strconv.ParseFloat(v, 64)
if err != nil {
return 0, err
}
}
if timeoutSeconds == 0 {
timeoutSeconds = 120
}
var maxTimeoutSeconds = timeoutSeconds - offset
if module.Timeout.Seconds() < maxTimeoutSeconds && module.Timeout.Seconds() > 0 || maxTimeoutSeconds < 0 {
timeoutSeconds = module.Timeout.Seconds()
} else {
timeoutSeconds = maxTimeoutSeconds
}
return timeoutSeconds, nil
}
07070100000039000081A40000000000000000000000016463639800001D35000000000000000000000000000000000000003000000000blackbox_exporter-0.24.0/prober/handler_test.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"bytes"
"fmt"
"net"
"net/http"
"net/http/httptest"
"strconv"
"strings"
"testing"
"time"
"github.com/go-kit/log"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"github.com/prometheus/blackbox_exporter/config"
)
var c = &config.Config{
Modules: map[string]config.Module{
"http_2xx": {
Prober: "http",
Timeout: 10 * time.Second,
HTTP: config.HTTPProbe{
HTTPClientConfig: pconfig.HTTPClientConfig{
BearerToken: "mysecret",
},
},
},
},
}
func TestPrometheusTimeoutHTTP(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(2 * time.Second)
}))
defer ts.Close()
req, err := http.NewRequest("GET", "?target="+ts.URL, nil)
if err != nil {
t.Fatal(err)
}
req.Header.Set("X-Prometheus-Scrape-Timeout-Seconds", "1")
rr := httptest.NewRecorder()
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Handler(w, r, c, log.NewNopLogger(), &ResultHistory{}, 0.5, nil)
})
handler.ServeHTTP(rr, req)
if status := rr.Code; status != http.StatusOK {
t.Errorf("probe request handler returned wrong status code: %v, want %v", status, http.StatusOK)
}
}
func TestPrometheusConfigSecretsHidden(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(2 * time.Second)
}))
defer ts.Close()
req, err := http.NewRequest("GET", "?debug=true&target="+ts.URL, nil)
if err != nil {
t.Fatal(err)
}
rr := httptest.NewRecorder()
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Handler(w, r, c, log.NewNopLogger(), &ResultHistory{}, 0.5, nil)
})
handler.ServeHTTP(rr, req)
body := rr.Body.String()
if strings.Contains(body, "mysecret") {
t.Errorf("Secret exposed in debug config output: %v", body)
}
if !strings.Contains(body, "<secret>") {
t.Errorf("Hidden secret missing from debug config output: %v", body)
}
}
func TestDebugOutputSecretsHidden(t *testing.T) {
module := c.Modules["http_2xx"]
out := DebugOutput(&module, &bytes.Buffer{}, prometheus.NewRegistry())
if strings.Contains(out, "mysecret") {
t.Errorf("Secret exposed in debug output: %v", out)
}
if !strings.Contains(out, "<secret>") {
t.Errorf("Hidden secret missing from debug output: %v", out)
}
}
func TestTimeoutIsSetCorrectly(t *testing.T) {
var tests = []struct {
inModuleTimeout time.Duration
inPrometheusTimeout string
inOffset float64
outTimeout float64
}{
{0 * time.Second, "15", 0.5, 14.5},
{0 * time.Second, "15", 0, 15},
{20 * time.Second, "15", 0.5, 14.5},
{20 * time.Second, "15", 0, 15},
{5 * time.Second, "15", 0, 5},
{5 * time.Second, "15", 0.5, 5},
{10 * time.Second, "", 0.5, 10},
{10 * time.Second, "10", 0.5, 9.5},
{9500 * time.Millisecond, "", 0.5, 9.5},
{9500 * time.Millisecond, "", 1, 9.5},
{0 * time.Second, "", 0.5, 119.5},
{0 * time.Second, "", 0, 120},
}
for _, v := range tests {
request, _ := http.NewRequest("GET", "", nil)
request.Header.Set("X-Prometheus-Scrape-Timeout-Seconds", v.inPrometheusTimeout)
module := config.Module{
Timeout: v.inModuleTimeout,
}
timeout, _ := getTimeout(request, module, v.inOffset)
if timeout != v.outTimeout {
t.Errorf("timeout is incorrect: %v, want %v", timeout, v.outTimeout)
}
}
}
func TestHostnameParam(t *testing.T) {
headers := map[string]string{}
c := &config.Config{
Modules: map[string]config.Module{
"http_2xx": {
Prober: "http",
Timeout: 10 * time.Second,
HTTP: config.HTTPProbe{
Headers: headers,
IPProtocolFallback: true,
},
},
},
}
// check that 'hostname' parameter make its way to Host header
hostname := "foo.example.com"
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Host != hostname {
t.Errorf("Unexpected Host: expected %q, got %q.", hostname, r.Host)
}
w.WriteHeader(http.StatusOK)
}))
defer ts.Close()
requrl := fmt.Sprintf("?debug=true&hostname=%s&target=%s", hostname, ts.URL)
req, err := http.NewRequest("GET", requrl, nil)
if err != nil {
t.Fatal(err)
}
rr := httptest.NewRecorder()
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Handler(w, r, c, log.NewNopLogger(), &ResultHistory{}, 0.5, nil)
})
handler.ServeHTTP(rr, req)
if status := rr.Code; status != http.StatusOK {
t.Errorf("probe request handler returned wrong status code: %v, want %v", status, http.StatusOK)
}
// check that ts got the request to perform header check
if !strings.Contains(rr.Body.String(), "probe_success 1") {
t.Errorf("probe failed, response body: %v", rr.Body.String())
}
// check that host header both in config and in parameter will result in 400
c.Modules["http_2xx"].HTTP.Headers["Host"] = hostname + ".something"
handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Handler(w, r, c, log.NewNopLogger(), &ResultHistory{}, 0.5, nil)
})
rr = httptest.NewRecorder()
handler.ServeHTTP(rr, req)
if status := rr.Code; status != http.StatusBadRequest {
t.Errorf("probe request handler returned wrong status code: %v, want %v", status, http.StatusBadRequest)
}
}
func TestTCPHostnameParam(t *testing.T) {
c := &config.Config{
Modules: map[string]config.Module{
"tls_connect": {
Prober: "tcp",
Timeout: 10 * time.Second,
TCP: config.TCPProbe{
TLS: true,
IPProtocol: "ip4",
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: true},
},
},
},
}
// check that 'hostname' parameter make its way to server_name in the tls_config
hostname := "foo.example.com"
ts := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Host != hostname {
t.Errorf("Unexpected Host: expected %q, got %q.", hostname, r.Host)
}
w.WriteHeader(http.StatusOK)
}))
defer ts.Close()
requrl := fmt.Sprintf("?module=tls_connect&debug=true&hostname=%s&target=%s", hostname, ts.Listener.Addr().(*net.TCPAddr).IP.String()+":"+strconv.Itoa(ts.Listener.Addr().(*net.TCPAddr).Port))
req, err := http.NewRequest("GET", requrl, nil)
if err != nil {
t.Fatal(err)
}
rr := httptest.NewRecorder()
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Handler(w, r, c, log.NewNopLogger(), &ResultHistory{}, 0.5, nil)
})
handler.ServeHTTP(rr, req)
if status := rr.Code; status != http.StatusOK {
t.Errorf("probe request handler returned wrong status code: %v, want %v", status, http.StatusOK)
}
// check debug output to confirm the server_name is set in tls_config and matches supplied hostname
if !strings.Contains(rr.Body.String(), "server_name: "+hostname) {
t.Errorf("probe failed, response body: %v", rr.Body.String())
}
}
0707010000003A000081A40000000000000000000000016463639800000B19000000000000000000000000000000000000002B00000000blackbox_exporter-0.24.0/prober/history.go// Copyright 2017 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"sync"
)
// Result contains the result of the execution of a probe
type Result struct {
Id int64
ModuleName string
Target string
DebugOutput string
Success bool
}
// ResultHistory contains two history slices: `results` contains most recent `maxResults` results.
// After they expire out of `results`, failures will be saved in `preservedFailedResults`. This
// ensures that we are always able to see debug information about recent failures.
type ResultHistory struct {
mu sync.Mutex
nextId int64
results []*Result
preservedFailedResults []*Result
MaxResults uint
}
// Add a result to the history.
func (rh *ResultHistory) Add(moduleName, target, debugOutput string, success bool) {
rh.mu.Lock()
defer rh.mu.Unlock()
r := &Result{
Id: rh.nextId,
ModuleName: moduleName,
Target: target,
DebugOutput: debugOutput,
Success: success,
}
rh.nextId++
rh.results = append(rh.results, r)
if uint(len(rh.results)) > rh.MaxResults {
// If we are about to remove a failure, add it to the failed result history, then
// remove the oldest failed result, if needed.
if !rh.results[0].Success {
rh.preservedFailedResults = append(rh.preservedFailedResults, rh.results[0])
if uint(len(rh.preservedFailedResults)) > rh.MaxResults {
preservedFailedResults := make([]*Result, len(rh.preservedFailedResults)-1)
copy(preservedFailedResults, rh.preservedFailedResults[1:])
rh.preservedFailedResults = preservedFailedResults
}
}
results := make([]*Result, len(rh.results)-1)
copy(results, rh.results[1:])
rh.results = results
}
}
// List returns a list of all results.
func (rh *ResultHistory) List() []*Result {
rh.mu.Lock()
defer rh.mu.Unlock()
// Results in each slice are disjoint. We can simply concatenate the results.
return append(rh.preservedFailedResults[:], rh.results...)
}
// Get returns a given result.
func (rh *ResultHistory) Get(id int64) *Result {
rh.mu.Lock()
defer rh.mu.Unlock()
for _, r := range rh.preservedFailedResults {
if r.Id == id {
return r
}
}
for _, r := range rh.results {
if r.Id == id {
return r
}
}
return nil
}
0707010000003B000081A40000000000000000000000016463639800000BA7000000000000000000000000000000000000003000000000blackbox_exporter-0.24.0/prober/history_test.go// Copyright 2017 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"fmt"
"testing"
)
func TestHistoryKeepsLatestResults(t *testing.T) {
history := &ResultHistory{MaxResults: 3}
for i := 0; i < 4; i++ {
history.Add("module", "target", fmt.Sprintf("result %d", i), true)
}
savedResults := history.List()
for i := 0; i < len(savedResults); i++ {
if savedResults[i].DebugOutput != fmt.Sprintf("result %d", i+1) {
t.Errorf("History contained the wrong result at index %d", i)
}
}
}
func FillHistoryWithMaxSuccesses(h *ResultHistory) {
for i := uint(0); i < h.MaxResults; i++ {
h.Add("module", "target", fmt.Sprintf("result %d", h.nextId), true)
}
}
func FillHistoryWithMaxPreservedFailures(h *ResultHistory) {
for i := uint(0); i < h.MaxResults; i++ {
h.Add("module", "target", fmt.Sprintf("result %d", h.nextId), false)
}
}
func TestHistoryPreservesExpiredFailedResults(t *testing.T) {
history := &ResultHistory{MaxResults: 3}
// Success are expired, no failures are expired
FillHistoryWithMaxSuccesses(history)
FillHistoryWithMaxPreservedFailures(history)
savedResults := history.List()
for i := uint(0); i < uint(len(savedResults)); i++ {
expectedDebugOutput := fmt.Sprintf("result %d", i+history.MaxResults)
if savedResults[i].DebugOutput != expectedDebugOutput {
t.Errorf("History contained the wrong result at index %d. Expected: %s, Actual: %s", i, expectedDebugOutput, savedResults[i].DebugOutput)
}
}
// Failures are expired, should all be preserved
FillHistoryWithMaxPreservedFailures(history)
savedResults = history.List()
for i := uint(0); i < uint(len(savedResults)); i++ {
expectedDebugOutput := fmt.Sprintf("result %d", i+history.MaxResults)
if savedResults[i].DebugOutput != expectedDebugOutput {
t.Errorf("History contained the wrong result at index %d. Expected: %s, Actual: %s", i, expectedDebugOutput, savedResults[i].DebugOutput)
}
}
// New expired failures are preserved, new success are not expired
FillHistoryWithMaxPreservedFailures(history)
FillHistoryWithMaxSuccesses(history)
savedResults = history.List()
for i := uint(0); i < uint(len(savedResults)); i++ {
expectedDebugOutput := fmt.Sprintf("result %d", i+history.MaxResults*3)
if savedResults[i].DebugOutput != expectedDebugOutput {
t.Errorf("History contained the wrong result at index %d. Expected: %s, Actual: %s", i, expectedDebugOutput, savedResults[i].DebugOutput)
}
}
}
0707010000003C000081A40000000000000000000000016463639800005692000000000000000000000000000000000000002800000000blackbox_exporter-0.24.0/prober/http.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"compress/flate"
"compress/gzip"
"context"
"crypto/tls"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/http/cookiejar"
"net/http/httptrace"
"net/textproto"
"net/url"
"os"
"strconv"
"strings"
"sync"
"time"
"github.com/andybalholm/brotli"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"github.com/prometheus/common/version"
"golang.org/x/net/publicsuffix"
"github.com/prometheus/blackbox_exporter/config"
)
func matchRegularExpressions(reader io.Reader, httpConfig config.HTTPProbe, logger log.Logger) bool {
body, err := io.ReadAll(reader)
if err != nil {
level.Error(logger).Log("msg", "Error reading HTTP body", "err", err)
return false
}
for _, expression := range httpConfig.FailIfBodyMatchesRegexp {
if expression.Regexp.Match(body) {
level.Error(logger).Log("msg", "Body matched regular expression", "regexp", expression)
return false
}
}
for _, expression := range httpConfig.FailIfBodyNotMatchesRegexp {
if !expression.Regexp.Match(body) {
level.Error(logger).Log("msg", "Body did not match regular expression", "regexp", expression)
return false
}
}
return true
}
func matchRegularExpressionsOnHeaders(header http.Header, httpConfig config.HTTPProbe, logger log.Logger) bool {
for _, headerMatchSpec := range httpConfig.FailIfHeaderMatchesRegexp {
values := header[textproto.CanonicalMIMEHeaderKey(headerMatchSpec.Header)]
if len(values) == 0 {
if !headerMatchSpec.AllowMissing {
level.Error(logger).Log("msg", "Missing required header", "header", headerMatchSpec.Header)
return false
} else {
continue // No need to match any regex on missing headers.
}
}
for _, val := range values {
if headerMatchSpec.Regexp.MatchString(val) {
level.Error(logger).Log("msg", "Header matched regular expression", "header", headerMatchSpec.Header,
"regexp", headerMatchSpec.Regexp, "value_count", len(values))
return false
}
}
}
for _, headerMatchSpec := range httpConfig.FailIfHeaderNotMatchesRegexp {
values := header[textproto.CanonicalMIMEHeaderKey(headerMatchSpec.Header)]
if len(values) == 0 {
if !headerMatchSpec.AllowMissing {
level.Error(logger).Log("msg", "Missing required header", "header", headerMatchSpec.Header)
return false
} else {
continue // No need to match any regex on missing headers.
}
}
anyHeaderValueMatched := false
for _, val := range values {
if headerMatchSpec.Regexp.MatchString(val) {
anyHeaderValueMatched = true
break
}
}
if !anyHeaderValueMatched {
level.Error(logger).Log("msg", "Header did not match regular expression", "header", headerMatchSpec.Header,
"regexp", headerMatchSpec.Regexp, "value_count", len(values))
return false
}
}
return true
}
// roundTripTrace holds timings for a single HTTP roundtrip.
type roundTripTrace struct {
tls bool
start time.Time
dnsDone time.Time
connectDone time.Time
gotConn time.Time
responseStart time.Time
end time.Time
tlsStart time.Time
tlsDone time.Time
}
// transport is a custom transport keeping traces for each HTTP roundtrip.
type transport struct {
Transport http.RoundTripper
NoServerNameTransport http.RoundTripper
firstHost string
logger log.Logger
mu sync.Mutex
traces []*roundTripTrace
current *roundTripTrace
}
func newTransport(rt, noServerName http.RoundTripper, logger log.Logger) *transport {
return &transport{
Transport: rt,
NoServerNameTransport: noServerName,
logger: logger,
traces: []*roundTripTrace{},
}
}
// RoundTrip switches to a new trace, then runs embedded RoundTripper.
func (t *transport) RoundTrip(req *http.Request) (*http.Response, error) {
level.Info(t.logger).Log("msg", "Making HTTP request", "url", req.URL.String(), "host", req.Host)
trace := &roundTripTrace{}
if req.URL.Scheme == "https" {
trace.tls = true
}
t.current = trace
t.traces = append(t.traces, trace)
if t.firstHost == "" {
t.firstHost = req.URL.Host
}
if t.firstHost != req.URL.Host {
// This is a redirect to something other than the initial host,
// so TLS ServerName should not be set.
level.Info(t.logger).Log("msg", "Address does not match first address, not sending TLS ServerName", "first", t.firstHost, "address", req.URL.Host)
return t.NoServerNameTransport.RoundTrip(req)
}
return t.Transport.RoundTrip(req)
}
func (t *transport) DNSStart(_ httptrace.DNSStartInfo) {
t.mu.Lock()
defer t.mu.Unlock()
t.current.start = time.Now()
}
func (t *transport) DNSDone(_ httptrace.DNSDoneInfo) {
t.mu.Lock()
defer t.mu.Unlock()
t.current.dnsDone = time.Now()
}
func (ts *transport) ConnectStart(_, _ string) {
ts.mu.Lock()
defer ts.mu.Unlock()
t := ts.current
// No DNS resolution because we connected to IP directly.
if t.dnsDone.IsZero() {
t.start = time.Now()
t.dnsDone = t.start
}
}
func (t *transport) ConnectDone(net, addr string, err error) {
t.mu.Lock()
defer t.mu.Unlock()
t.current.connectDone = time.Now()
}
func (t *transport) GotConn(_ httptrace.GotConnInfo) {
t.mu.Lock()
defer t.mu.Unlock()
t.current.gotConn = time.Now()
}
func (t *transport) GotFirstResponseByte() {
t.mu.Lock()
defer t.mu.Unlock()
t.current.responseStart = time.Now()
}
func (t *transport) TLSHandshakeStart() {
t.mu.Lock()
defer t.mu.Unlock()
t.current.tlsStart = time.Now()
}
func (t *transport) TLSHandshakeDone(_ tls.ConnectionState, _ error) {
t.mu.Lock()
defer t.mu.Unlock()
t.current.tlsDone = time.Now()
}
// byteCounter implements an io.ReadCloser that keeps track of the total
// number of bytes it has read.
type byteCounter struct {
io.ReadCloser
n int64
}
func (bc *byteCounter) Read(p []byte) (int, error) {
n, err := bc.ReadCloser.Read(p)
bc.n += int64(n)
return n, err
}
var userAgentDefaultHeader = fmt.Sprintf("Blackbox Exporter/%s", version.Version)
func ProbeHTTP(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) (success bool) {
var redirects int
var (
durationGaugeVec = prometheus.NewGaugeVec(prometheus.GaugeOpts{
Name: "probe_http_duration_seconds",
Help: "Duration of http request by phase, summed over all redirects",
}, []string{"phase"})
contentLengthGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_http_content_length",
Help: "Length of http content response",
})
bodyUncompressedLengthGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_http_uncompressed_body_length",
Help: "Length of uncompressed response body",
})
redirectsGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_http_redirects",
Help: "The number of redirects",
})
isSSLGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_http_ssl",
Help: "Indicates if SSL was used for the final redirect",
})
statusCodeGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_http_status_code",
Help: "Response HTTP status code",
})
probeSSLEarliestCertExpiryGauge = prometheus.NewGauge(sslEarliestCertExpiryGaugeOpts)
probeSSLLastChainExpiryTimestampSeconds = prometheus.NewGauge(sslChainExpiryInTimeStampGaugeOpts)
probeSSLLastInformation = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "probe_ssl_last_chain_info",
Help: "Contains SSL leaf certificate information",
},
[]string{"fingerprint_sha256", "subject", "issuer", "subjectalternative"},
)
probeTLSVersion = prometheus.NewGaugeVec(
probeTLSInfoGaugeOpts,
[]string{"version"},
)
probeHTTPVersionGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_http_version",
Help: "Returns the version of HTTP of the probe response",
})
probeFailedDueToRegex = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_failed_due_to_regex",
Help: "Indicates if probe failed due to regex",
})
probeHTTPLastModified = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_http_last_modified_timestamp_seconds",
Help: "Returns the Last-Modified HTTP response header in unixtime",
})
)
registry.MustRegister(durationGaugeVec)
registry.MustRegister(contentLengthGauge)
registry.MustRegister(bodyUncompressedLengthGauge)
registry.MustRegister(redirectsGauge)
registry.MustRegister(isSSLGauge)
registry.MustRegister(statusCodeGauge)
registry.MustRegister(probeHTTPVersionGauge)
registry.MustRegister(probeFailedDueToRegex)
httpConfig := module.HTTP
if !strings.HasPrefix(target, "http://") && !strings.HasPrefix(target, "https://") {
target = "http://" + target
}
targetURL, err := url.Parse(target)
if err != nil {
level.Error(logger).Log("msg", "Could not parse target URL", "err", err)
return false
}
targetHost := targetURL.Hostname()
targetPort := targetURL.Port()
var ip *net.IPAddr
if !module.HTTP.SkipResolvePhaseWithProxy || module.HTTP.HTTPClientConfig.ProxyConfig.ProxyURL.URL == nil || module.HTTP.HTTPClientConfig.ProxyConfig.ProxyFromEnvironment {
var lookupTime float64
ip, lookupTime, err = chooseProtocol(ctx, module.HTTP.IPProtocol, module.HTTP.IPProtocolFallback, targetHost, registry, logger)
durationGaugeVec.WithLabelValues("resolve").Add(lookupTime)
if err != nil {
level.Error(logger).Log("msg", "Error resolving address", "err", err)
return false
}
}
httpClientConfig := module.HTTP.HTTPClientConfig
if len(httpClientConfig.TLSConfig.ServerName) == 0 {
// If there is no `server_name` in tls_config, use
// the hostname of the target.
httpClientConfig.TLSConfig.ServerName = targetHost
// However, if there is a Host header it is better to use
// its value instead. This helps avoid TLS handshake error
// if targetHost is an IP address.
for name, value := range httpConfig.Headers {
if textproto.CanonicalMIMEHeaderKey(name) == "Host" {
httpClientConfig.TLSConfig.ServerName = value
}
}
}
client, err := pconfig.NewClientFromConfig(httpClientConfig, "http_probe", pconfig.WithKeepAlivesDisabled())
if err != nil {
level.Error(logger).Log("msg", "Error generating HTTP client", "err", err)
return false
}
httpClientConfig.TLSConfig.ServerName = ""
noServerName, err := pconfig.NewRoundTripperFromConfig(httpClientConfig, "http_probe", pconfig.WithKeepAlivesDisabled())
if err != nil {
level.Error(logger).Log("msg", "Error generating HTTP client without ServerName", "err", err)
return false
}
jar, err := cookiejar.New(&cookiejar.Options{PublicSuffixList: publicsuffix.List})
if err != nil {
level.Error(logger).Log("msg", "Error generating cookiejar", "err", err)
return false
}
client.Jar = jar
// Inject transport that tracks traces for each redirect,
// and does not set TLS ServerNames on redirect if needed.
tt := newTransport(client.Transport, noServerName, logger)
client.Transport = tt
client.CheckRedirect = func(r *http.Request, via []*http.Request) error {
level.Info(logger).Log("msg", "Received redirect", "location", r.Response.Header.Get("Location"))
redirects = len(via)
if redirects > 10 || !httpConfig.HTTPClientConfig.FollowRedirects {
level.Info(logger).Log("msg", "Not following redirect")
return errors.New("don't follow redirects")
}
return nil
}
if httpConfig.Method == "" {
httpConfig.Method = "GET"
}
origHost := targetURL.Host
if ip != nil {
// Replace the host field in the URL with the IP we resolved.
if targetPort == "" {
if strings.Contains(ip.String(), ":") {
targetURL.Host = "[" + ip.String() + "]"
} else {
targetURL.Host = ip.String()
}
} else {
targetURL.Host = net.JoinHostPort(ip.String(), targetPort)
}
}
var body io.Reader
var respBodyBytes int64
// If a body is configured, add it to the request.
if httpConfig.Body != "" {
body = strings.NewReader(httpConfig.Body)
}
// If a body file is configured, add its content to the request.
if httpConfig.BodyFile != "" {
body_file, err := os.Open(httpConfig.BodyFile)
if err != nil {
level.Error(logger).Log("msg", "Error creating request", "err", err)
return
}
defer body_file.Close()
body = body_file
}
request, err := http.NewRequest(httpConfig.Method, targetURL.String(), body)
if err != nil {
level.Error(logger).Log("msg", "Error creating request", "err", err)
return
}
request.Host = origHost
request = request.WithContext(ctx)
for key, value := range httpConfig.Headers {
if textproto.CanonicalMIMEHeaderKey(key) == "Host" {
request.Host = value
continue
}
request.Header.Set(key, value)
}
_, hasUserAgent := request.Header["User-Agent"]
if !hasUserAgent {
request.Header.Set("User-Agent", userAgentDefaultHeader)
}
trace := &httptrace.ClientTrace{
DNSStart: tt.DNSStart,
DNSDone: tt.DNSDone,
ConnectStart: tt.ConnectStart,
ConnectDone: tt.ConnectDone,
GotConn: tt.GotConn,
GotFirstResponseByte: tt.GotFirstResponseByte,
TLSHandshakeStart: tt.TLSHandshakeStart,
TLSHandshakeDone: tt.TLSHandshakeDone,
}
request = request.WithContext(httptrace.WithClientTrace(request.Context(), trace))
for _, lv := range []string{"connect", "tls", "processing", "transfer"} {
durationGaugeVec.WithLabelValues(lv)
}
resp, err := client.Do(request)
// This is different from the usual err != nil you'd expect here because err won't be nil if redirects were
// turned off. See https://github.com/golang/go/issues/3795
//
// If err == nil there should never be a case where resp is also nil, but better be safe than sorry, so check if
// resp == nil first, and then check if there was an error.
if resp == nil {
resp = &http.Response{}
if err != nil {
level.Error(logger).Log("msg", "Error for HTTP request", "err", err)
}
} else {
requestErrored := (err != nil)
level.Info(logger).Log("msg", "Received HTTP response", "status_code", resp.StatusCode)
if len(httpConfig.ValidStatusCodes) != 0 {
for _, code := range httpConfig.ValidStatusCodes {
if resp.StatusCode == code {
success = true
break
}
}
if !success {
level.Info(logger).Log("msg", "Invalid HTTP response status code", "status_code", resp.StatusCode,
"valid_status_codes", fmt.Sprintf("%v", httpConfig.ValidStatusCodes))
}
} else if 200 <= resp.StatusCode && resp.StatusCode < 300 {
success = true
} else {
level.Info(logger).Log("msg", "Invalid HTTP response status code, wanted 2xx", "status_code", resp.StatusCode)
}
if success && (len(httpConfig.FailIfHeaderMatchesRegexp) > 0 || len(httpConfig.FailIfHeaderNotMatchesRegexp) > 0) {
success = matchRegularExpressionsOnHeaders(resp.Header, httpConfig, logger)
if success {
probeFailedDueToRegex.Set(0)
} else {
probeFailedDueToRegex.Set(1)
}
}
// Since the configuration specifies a compression algorithm, blindly treat the response body as a
// compressed payload; if we cannot decompress it it's a failure because the configuration says we
// should expect the response to be compressed in that way.
if httpConfig.Compression != "" {
dec, err := getDecompressionReader(httpConfig.Compression, resp.Body)
if err != nil {
level.Info(logger).Log("msg", "Failed to get decompressor for HTTP response body", "err", err)
success = false
} else if dec != nil {
// Since we are replacing the original resp.Body with the decoder, we need to make sure
// we close the original body. We cannot close it right away because the decompressor
// might not have read it yet.
defer func(c io.Closer) {
err := c.Close()
if err != nil {
// At this point we cannot really do anything with this error, but log
// it in case it contains useful information as to what's the problem.
level.Info(logger).Log("msg", "Error while closing response from server", "err", err)
}
}(resp.Body)
resp.Body = dec
}
}
// If there's a configured body_size_limit, wrap the body in the response in a http.MaxBytesReader.
// This will read up to BodySizeLimit bytes from the body, and return an error if the response is
// larger. It forwards the Close call to the original resp.Body to make sure the TCP connection is
// correctly shut down. The limit is applied _after decompression_ if applicable.
if httpConfig.BodySizeLimit > 0 {
resp.Body = http.MaxBytesReader(nil, resp.Body, int64(httpConfig.BodySizeLimit))
}
byteCounter := &byteCounter{ReadCloser: resp.Body}
if success && (len(httpConfig.FailIfBodyMatchesRegexp) > 0 || len(httpConfig.FailIfBodyNotMatchesRegexp) > 0) {
success = matchRegularExpressions(byteCounter, httpConfig, logger)
if success {
probeFailedDueToRegex.Set(0)
} else {
probeFailedDueToRegex.Set(1)
}
}
if !requestErrored {
_, err = io.Copy(io.Discard, byteCounter)
if err != nil {
level.Info(logger).Log("msg", "Failed to read HTTP response body", "err", err)
success = false
}
respBodyBytes = byteCounter.n
if err := byteCounter.Close(); err != nil {
// We have already read everything we could from the server, maybe even uncompressed the
// body. The error here might be either a decompression error or a TCP error. Log it in
// case it contains useful information as to what's the problem.
level.Info(logger).Log("msg", "Error while closing response from server", "error", err.Error())
}
}
// At this point body is fully read and we can write end time.
tt.current.end = time.Now()
// Check if there is a Last-Modified HTTP response header.
if t, err := http.ParseTime(resp.Header.Get("Last-Modified")); err == nil {
registry.MustRegister(probeHTTPLastModified)
probeHTTPLastModified.Set(float64(t.Unix()))
}
var httpVersionNumber float64
httpVersionNumber, err = strconv.ParseFloat(strings.TrimPrefix(resp.Proto, "HTTP/"), 64)
if err != nil {
level.Error(logger).Log("msg", "Error parsing version number from HTTP version", "err", err)
}
probeHTTPVersionGauge.Set(httpVersionNumber)
if len(httpConfig.ValidHTTPVersions) != 0 {
found := false
for _, version := range httpConfig.ValidHTTPVersions {
if version == resp.Proto {
found = true
break
}
}
if !found {
level.Error(logger).Log("msg", "Invalid HTTP version number", "version", resp.Proto)
success = false
}
}
}
tt.mu.Lock()
defer tt.mu.Unlock()
for i, trace := range tt.traces {
level.Info(logger).Log(
"msg", "Response timings for roundtrip",
"roundtrip", i,
"start", trace.start,
"dnsDone", trace.dnsDone,
"connectDone", trace.connectDone,
"gotConn", trace.gotConn,
"responseStart", trace.responseStart,
"tlsStart", trace.tlsStart,
"tlsDone", trace.tlsDone,
"end", trace.end,
)
// We get the duration for the first request from chooseProtocol.
if i != 0 {
durationGaugeVec.WithLabelValues("resolve").Add(trace.dnsDone.Sub(trace.start).Seconds())
}
// Continue here if we never got a connection because a request failed.
if trace.gotConn.IsZero() {
continue
}
if trace.tls {
// dnsDone must be set if gotConn was set.
durationGaugeVec.WithLabelValues("connect").Add(trace.connectDone.Sub(trace.dnsDone).Seconds())
durationGaugeVec.WithLabelValues("tls").Add(trace.tlsDone.Sub(trace.tlsStart).Seconds())
} else {
durationGaugeVec.WithLabelValues("connect").Add(trace.gotConn.Sub(trace.dnsDone).Seconds())
}
// Continue here if we never got a response from the server.
if trace.responseStart.IsZero() {
continue
}
durationGaugeVec.WithLabelValues("processing").Add(trace.responseStart.Sub(trace.gotConn).Seconds())
// Continue here if we never read the full response from the server.
// Usually this means that request either failed or was redirected.
if trace.end.IsZero() {
continue
}
durationGaugeVec.WithLabelValues("transfer").Add(trace.end.Sub(trace.responseStart).Seconds())
}
if resp.TLS != nil {
isSSLGauge.Set(float64(1))
registry.MustRegister(probeSSLEarliestCertExpiryGauge, probeTLSVersion, probeSSLLastChainExpiryTimestampSeconds, probeSSLLastInformation)
probeSSLEarliestCertExpiryGauge.Set(float64(getEarliestCertExpiry(resp.TLS).Unix()))
probeTLSVersion.WithLabelValues(getTLSVersion(resp.TLS)).Set(1)
probeSSLLastChainExpiryTimestampSeconds.Set(float64(getLastChainExpiry(resp.TLS).Unix()))
probeSSLLastInformation.WithLabelValues(getFingerprint(resp.TLS), getSubject(resp.TLS), getIssuer(resp.TLS), getDNSNames(resp.TLS)).Set(1)
if httpConfig.FailIfSSL {
level.Error(logger).Log("msg", "Final request was over SSL")
success = false
}
} else if httpConfig.FailIfNotSSL {
level.Error(logger).Log("msg", "Final request was not over SSL")
success = false
}
statusCodeGauge.Set(float64(resp.StatusCode))
contentLengthGauge.Set(float64(resp.ContentLength))
bodyUncompressedLengthGauge.Set(float64(respBodyBytes))
redirectsGauge.Set(float64(redirects))
return
}
func getDecompressionReader(algorithm string, origBody io.ReadCloser) (io.ReadCloser, error) {
switch strings.ToLower(algorithm) {
case "br":
return io.NopCloser(brotli.NewReader(origBody)), nil
case "deflate":
return flate.NewReader(origBody), nil
case "gzip":
return gzip.NewReader(origBody)
case "identity", "":
return origBody, nil
default:
return nil, errors.New("unsupported compression algorithm")
}
}
0707010000003D000081A4000000000000000000000001646363980000B6B9000000000000000000000000000000000000002D00000000blackbox_exporter-0.24.0/prober/http_test.go// Copyright 2015 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"bytes"
"compress/flate"
"compress/gzip"
"context"
"crypto/tls"
"crypto/x509"
"encoding/pem"
"fmt"
"io"
"net/http"
"net/http/httptest"
"net/textproto"
"net/url"
"os"
"strconv"
"strings"
"testing"
"time"
"github.com/andybalholm/brotli"
"github.com/go-kit/log"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"github.com/prometheus/blackbox_exporter/config"
)
func TestHTTPStatusCodes(t *testing.T) {
tests := []struct {
StatusCode int
ValidStatusCodes []int
ShouldSucceed bool
}{
{200, []int{}, true},
{201, []int{}, true},
{299, []int{}, true},
{300, []int{}, false},
{404, []int{}, false},
{404, []int{200, 404}, true},
{200, []int{200, 404}, true},
{201, []int{200, 404}, false},
{404, []int{404}, true},
{200, []int{404}, false},
}
for i, test := range tests {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(test.StatusCode)
}))
defer ts.Close()
registry := prometheus.NewRegistry()
recorder := httptest.NewRecorder()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, ValidStatusCodes: test.ValidStatusCodes}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if result != test.ShouldSucceed {
t.Fatalf("Test %d had unexpected result: %s", i, body)
}
}
}
func TestValidHTTPVersion(t *testing.T) {
tests := []struct {
ValidHTTPVersions []string
ShouldSucceed bool
}{
{[]string{}, true},
{[]string{"HTTP/1.1"}, true},
{[]string{"HTTP/1.1", "HTTP/2.0"}, true},
{[]string{"HTTP/2.0"}, false},
}
for i, test := range tests {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
result := ProbeHTTP(context.Background(), ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
ValidHTTPVersions: test.ValidHTTPVersions,
}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if result != test.ShouldSucceed {
t.Fatalf("Test %v had unexpected result: %s", i, body)
}
}
}
func TestContentLength(t *testing.T) {
type testdata struct {
msg []byte
contentLength int
uncompressedBodyLength int
handler http.HandlerFunc
expectFailure bool
}
testmsg := []byte(strings.Repeat("hello world", 10))
notfoundMsg := []byte("not found")
testcases := map[string]testdata{
"identity": {
msg: testmsg,
contentLength: len(testmsg),
uncompressedBodyLength: len(testmsg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "identity")
w.WriteHeader(http.StatusOK)
w.Write(testmsg)
},
},
"no content-encoding": {
msg: testmsg,
contentLength: len(testmsg),
uncompressedBodyLength: len(testmsg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write(testmsg)
},
},
// Unknown Content-Encoding, we should let this pass thru.
"unknown content-encoding": {
msg: testmsg,
contentLength: len(testmsg),
uncompressedBodyLength: len(testmsg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "xxx")
w.WriteHeader(http.StatusOK)
w.Write(bytes.Repeat([]byte{'x'}, len(testmsg)))
},
},
// 401 response, verify that the content-length is still computed correctly.
"401": {
expectFailure: true,
msg: notfoundMsg,
contentLength: len(notfoundMsg),
uncompressedBodyLength: len(notfoundMsg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusNotFound)
// Send something in the body to make sure that this get reported as the content length.
w.Write(notfoundMsg)
},
},
// Compressed payload _without_ compression setting, it should not be decompressed.
"brotli": func() testdata {
msg := testmsg
var buf bytes.Buffer
fw := brotli.NewWriter(&buf)
fw.Write([]byte(msg))
fw.Close()
return testdata{
msg: msg,
contentLength: len(buf.Bytes()), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(buf.Bytes()), // No decompression.
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "br")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
}
}(),
// Compressed payload _without_ compression setting, it should not be decompressed.
"deflate": func() testdata {
msg := testmsg
var buf bytes.Buffer
// the only error path is an invalid compression level
fw, _ := flate.NewWriter(&buf, flate.DefaultCompression)
fw.Write([]byte(msg))
fw.Close()
return testdata{
msg: msg,
contentLength: len(buf.Bytes()), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(buf.Bytes()), // No decompression.
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "deflate")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
}
}(),
// Compressed payload _without_ compression setting, it should not be decompressed.
"gzip": func() testdata {
msg := testmsg
var buf bytes.Buffer
gw := gzip.NewWriter(&buf)
gw.Write([]byte(msg))
gw.Close()
return testdata{
msg: msg,
contentLength: len(buf.Bytes()), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(buf.Bytes()), // No decompression.
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "gzip")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
}
}(),
}
for name, tc := range testcases {
t.Run(name, func(t *testing.T) {
ts := httptest.NewServer(tc.handler)
defer ts.Close()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
var logbuf bytes.Buffer
result := ProbeHTTP(testCTX,
ts.URL,
config.Module{
Timeout: time.Second,
HTTP: config.HTTPProbe{IPProtocolFallback: true},
},
registry,
log.NewLogfmtLogger(&logbuf))
if !tc.expectFailure && !result {
t.Fatalf("probe failed unexpectedly: %s", logbuf.String())
} else if tc.expectFailure && result {
t.Fatalf("probe succeeded unexpectedly: %s", logbuf.String())
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_content_length": float64(tc.contentLength),
"probe_http_uncompressed_body_length": float64(tc.uncompressedBodyLength),
}
checkRegistryResults(expectedResults, mfs, t)
})
}
}
// TestHandlingOfCompressionSetting verifies that the "compression"
// setting is handled correctly: content is decompressed only if
// compression is specified, and only the specified compression
// algorithm is handled.
func TestHandlingOfCompressionSetting(t *testing.T) {
type testdata struct {
contentLength int
uncompressedBodyLength int
handler http.HandlerFunc
expectFailure bool
httpConfig config.HTTPProbe
}
testmsg := []byte(strings.Repeat("hello world", 10))
testcases := map[string]testdata{
"gzip": func() testdata {
msg := testmsg
var buf bytes.Buffer
enc := gzip.NewWriter(&buf)
enc.Write(msg)
enc.Close()
return testdata{
contentLength: buf.Len(), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(msg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "gzip")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "gzip",
},
}
}(),
"brotli": func() testdata {
msg := testmsg
var buf bytes.Buffer
enc := brotli.NewWriter(&buf)
enc.Write(msg)
enc.Close()
return testdata{
contentLength: len(buf.Bytes()), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(msg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "br")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "br",
},
}
}(),
"deflate": func() testdata {
msg := testmsg
var buf bytes.Buffer
// the only error path is an invalid compression level
enc, _ := flate.NewWriter(&buf, flate.DefaultCompression)
enc.Write(msg)
enc.Close()
return testdata{
contentLength: len(buf.Bytes()), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(msg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "deflate")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "deflate",
},
}
}(),
"identity": {
contentLength: len(testmsg),
uncompressedBodyLength: len(testmsg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "identity")
w.WriteHeader(http.StatusOK)
w.Write(testmsg)
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "identity",
},
},
// We do exactly as told: the server is returning a
// gzip-encoded response, but the module is expecting a
// delfate-encoded response. This should fail.
"compression encoding mismatch": func() testdata {
msg := testmsg
var buf bytes.Buffer
enc := gzip.NewWriter(&buf)
enc.Write(msg)
enc.Close()
return testdata{
expectFailure: true,
contentLength: buf.Len(), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: 0,
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "gzip")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "deflate",
},
}
}(),
"accept gzip": func() testdata {
msg := testmsg
var buf bytes.Buffer
enc := gzip.NewWriter(&buf)
enc.Write(msg)
enc.Close()
return testdata{
expectFailure: false,
contentLength: buf.Len(), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(msg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "gzip")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "gzip",
Headers: map[string]string{
"Accept-Encoding": "gzip",
},
},
}
}(),
"accept br, gzip": func() testdata {
msg := testmsg
var buf bytes.Buffer
enc := gzip.NewWriter(&buf)
enc.Write(msg)
enc.Close()
return testdata{
expectFailure: false,
contentLength: buf.Len(), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(msg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "gzip")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "gzip",
Headers: map[string]string{
"Accept-Encoding": "br, gzip",
},
},
}
}(),
"accept anything": func() testdata {
msg := testmsg
var buf bytes.Buffer
enc := gzip.NewWriter(&buf)
enc.Write(msg)
enc.Close()
return testdata{
expectFailure: false,
contentLength: buf.Len(), // Content lenght is the length of the compressed buffer.
uncompressedBodyLength: len(msg),
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "gzip")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
Compression: "gzip",
Headers: map[string]string{
"Accept-Encoding": "*",
},
},
}
}(),
"compressed content without compression setting": func() testdata {
msg := testmsg
var buf bytes.Buffer
enc := gzip.NewWriter(&buf)
enc.Write(msg)
enc.Close()
return testdata{
expectFailure: false,
contentLength: buf.Len(),
uncompressedBodyLength: buf.Len(), // content won't be uncompressed
handler: func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Encoding", "gzip")
w.WriteHeader(http.StatusOK)
w.Write(buf.Bytes())
},
httpConfig: config.HTTPProbe{
IPProtocolFallback: true,
},
}
}(),
}
for name, tc := range testcases {
t.Run(name, func(t *testing.T) {
ts := httptest.NewServer(tc.handler)
defer ts.Close()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
var logbuf bytes.Buffer
result := ProbeHTTP(testCTX,
ts.URL,
config.Module{
Timeout: time.Second,
HTTP: tc.httpConfig,
},
registry,
log.NewLogfmtLogger(&logbuf))
if !tc.expectFailure && !result {
t.Fatalf("probe failed unexpectedly: %s", logbuf.String())
} else if tc.expectFailure && result {
t.Fatalf("probe succeeded unexpectedly: %s", logbuf.String())
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_content_length": float64(tc.contentLength),
"probe_http_uncompressed_body_length": float64(tc.uncompressedBodyLength),
}
checkRegistryResults(expectedResults, mfs, t)
})
}
}
func TestMaxResponseLength(t *testing.T) {
const max = 128
var shortGzippedPayload bytes.Buffer
enc := gzip.NewWriter(&shortGzippedPayload)
enc.Write(bytes.Repeat([]byte{'A'}, max-1))
enc.Close()
var longGzippedPayload bytes.Buffer
enc = gzip.NewWriter(&longGzippedPayload)
enc.Write(bytes.Repeat([]byte{'A'}, max+1))
enc.Close()
testcases := map[string]struct {
target string
compression string
expectedMetrics map[string]float64
expectFailure bool
}{
"short": {
target: "/short",
expectedMetrics: map[string]float64{
"probe_http_uncompressed_body_length": float64(max - 1),
"probe_http_content_length": float64(max - 1),
},
},
"long": {
target: "/long",
expectFailure: true,
expectedMetrics: map[string]float64{
"probe_http_content_length": float64(max + 1),
},
},
"short compressed": {
target: "/short-compressed",
compression: "gzip",
expectedMetrics: map[string]float64{
"probe_http_content_length": float64(shortGzippedPayload.Len()),
"probe_http_uncompressed_body_length": float64(max - 1),
},
},
"long compressed": {
target: "/long-compressed",
compression: "gzip",
expectFailure: true,
expectedMetrics: map[string]float64{
"probe_http_content_length": float64(longGzippedPayload.Len()),
"probe_http_uncompressed_body_length": max, // it should stop decompressing at max bytes
},
},
}
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var resp []byte
switch r.URL.Path {
case "/short-compressed":
resp = shortGzippedPayload.Bytes()
w.Header().Add("Content-Encoding", "gzip")
case "/long-compressed":
resp = longGzippedPayload.Bytes()
w.Header().Add("Content-Encoding", "gzip")
case "/long":
resp = bytes.Repeat([]byte{'A'}, max+1)
case "/short":
resp = bytes.Repeat([]byte{'A'}, max-1)
default:
w.WriteHeader(http.StatusBadRequest)
return
}
w.Header().Set("Content-Length", strconv.Itoa(len(resp)))
w.WriteHeader(http.StatusOK)
w.Write(resp)
}))
defer ts.Close()
for name, tc := range testcases {
t.Run(name, func(t *testing.T) {
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(
testCTX,
ts.URL+tc.target,
config.Module{
Timeout: time.Second,
HTTP: config.HTTPProbe{
IPProtocolFallback: true,
BodySizeLimit: max,
HTTPClientConfig: pconfig.DefaultHTTPClientConfig,
Compression: tc.compression,
},
},
registry,
log.NewNopLogger(),
)
switch {
case tc.expectFailure && result:
t.Fatalf("test passed unexpectedly")
case !tc.expectFailure && !result:
t.Fatalf("test failed unexpectedly")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
checkRegistryResults(tc.expectedMetrics, mfs, t)
})
}
}
func TestRedirectFollowed(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/" {
http.Redirect(w, r, "/noredirect", http.StatusFound)
}
}))
defer ts.Close()
// Follow redirect, should succeed with 200.
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("Redirect test failed unexpectedly, got %s", body)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_redirects": 1,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestRedirectNotFollowed(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
http.Redirect(w, r, "/noredirect", http.StatusFound)
}))
defer ts.Close()
// Follow redirect, should succeed with 200.
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.HTTPClientConfig{FollowRedirects: false}, ValidStatusCodes: []int{302}}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("Redirect test failed unexpectedly, got %s", body)
}
}
// TestRedirectionLimit verifies that the probe stops following
// redirects after some limit
func TestRedirectionLimit(t *testing.T) {
const redirectLimit = 11
tooManyRedirects := false
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch {
case r.URL.Path == fmt.Sprintf("/redirect-%d", redirectLimit+1):
// the client should never hit this path
// because they should stop at the previous one.
w.WriteHeader(http.StatusTooManyRequests)
tooManyRedirects = true
return
case strings.HasPrefix(r.URL.Path, "/redirect-"):
n, err := strconv.Atoi(strings.TrimPrefix(r.URL.Path, "/redirect-"))
if err != nil {
w.WriteHeader(http.StatusInternalServerError)
fmt.Fprintf(w, "failed to extract redirect number from %s", r.URL.Path)
return
}
http.Redirect(w, r, fmt.Sprintf("/redirect-%d", n+1), http.StatusFound)
default:
http.Redirect(w, r, "/redirect-1", http.StatusFound)
}
}))
defer ts.Close()
// Follow redirect, should eventually fail with 302
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(
testCTX,
ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}},
registry,
log.NewNopLogger())
if result {
t.Fatalf("Probe suceeded unexpectedly")
}
if tooManyRedirects {
t.Fatalf("Probe followed too many redirects")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_redirects": redirectLimit, // should stop here
"probe_http_status_code": http.StatusFound, // final code should be Found
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestPost(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
w.WriteHeader(http.StatusBadRequest)
}
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, Method: "POST"}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("Post test failed unexpectedly, got %s", body)
}
}
func TestBasicAuth(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
HTTPClientConfig: pconfig.HTTPClientConfig{
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: false},
BasicAuth: &pconfig.BasicAuth{Username: "username", Password: "password"},
},
}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("HTTP probe failed, got %s", body)
}
}
func TestBearerToken(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
HTTPClientConfig: pconfig.HTTPClientConfig{
BearerToken: pconfig.Secret("mysecret"),
},
}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("HTTP probe failed, got %s", body)
}
}
func TestFailIfNotSSL(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfNotSSL: true}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if result {
t.Fatalf("Fail if not SSL test suceeded unexpectedly, got %s", body)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_ssl": 0,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestFailIfBodyMatchesRegexp(t *testing.T) {
testcases := map[string]struct {
respBody string
regexps []config.Regexp
expectedResult bool
}{
"one regex, match": {
respBody: "Bad news: could not connect to database server",
regexps: []config.Regexp{config.MustNewRegexp("could not connect to database")},
expectedResult: false,
},
"one regex, no match": {
respBody: "Download the latest version here",
regexps: []config.Regexp{config.MustNewRegexp("could not connect to database")},
expectedResult: true,
},
"multiple regexes, match": {
respBody: "internal error",
regexps: []config.Regexp{config.MustNewRegexp("could not connect to database"), config.MustNewRegexp("internal error")},
expectedResult: false,
},
"multiple regexes, no match": {
respBody: "hello world",
regexps: []config.Regexp{config.MustNewRegexp("could not connect to database"), config.MustNewRegexp("internal error")},
expectedResult: true,
},
}
for name, testcase := range testcases {
t.Run(name, func(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, testcase.respBody)
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfBodyMatchesRegexp: testcase.regexps}}, registry, log.NewNopLogger())
if testcase.expectedResult && !result {
t.Fatalf("Regexp test failed unexpectedly, got %s", recorder.Body.String())
} else if !testcase.expectedResult && result {
t.Fatalf("Regexp test succeeded unexpectedly, got %s", recorder.Body.String())
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
boolToFloat := func(v bool) float64 {
if v {
return 1
}
return 0
}
expectedResults := map[string]float64{
"probe_failed_due_to_regex": boolToFloat(!testcase.expectedResult),
"probe_http_content_length": float64(len(testcase.respBody)), // Issue #673: check that this is correctly populated when using regex validations.
"probe_http_uncompressed_body_length": float64(len(testcase.respBody)), // Issue #673, see above.
}
checkRegistryResults(expectedResults, mfs, t)
})
}
}
func TestFailIfBodyNotMatchesRegexp(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Bad news: could not connect to database server")
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfBodyNotMatchesRegexp: []config.Regexp{config.MustNewRegexp("Download the latest version here")}}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if result {
t.Fatalf("Regexp test succeeded unexpectedly, got %s", body)
}
ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Download the latest version here")
}))
defer ts.Close()
recorder = httptest.NewRecorder()
registry = prometheus.NewRegistry()
result = ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfBodyNotMatchesRegexp: []config.Regexp{config.MustNewRegexp("Download the latest version here")}}}, registry, log.NewNopLogger())
body = recorder.Body.String()
if !result {
t.Fatalf("Regexp test failed unexpectedly, got %s", body)
}
// With multiple regexps configured, verify that any non-matching regexp
// causes the probe to fail, but probes succeed when all regexps match.
ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Download the latest version here")
}))
defer ts.Close()
recorder = httptest.NewRecorder()
registry = prometheus.NewRegistry()
result = ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfBodyNotMatchesRegexp: []config.Regexp{config.MustNewRegexp("Download the latest version here"), config.MustNewRegexp("Copyright 2015")}}}, registry, log.NewNopLogger())
body = recorder.Body.String()
if result {
t.Fatalf("Regexp test succeeded unexpectedly, got %s", body)
}
ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Download the latest version here. Copyright 2015 Test Inc.")
}))
defer ts.Close()
recorder = httptest.NewRecorder()
registry = prometheus.NewRegistry()
result = ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfBodyNotMatchesRegexp: []config.Regexp{config.MustNewRegexp("Download the latest version here"), config.MustNewRegexp("Copyright 2015")}}}, registry, log.NewNopLogger())
body = recorder.Body.String()
if !result {
t.Fatalf("Regexp test failed unexpectedly, got %s", body)
}
}
func TestFailIfHeaderMatchesRegexp(t *testing.T) {
tests := []struct {
Rule config.HeaderMatch
Values []string
ShouldSucceed bool
}{
{config.HeaderMatch{"Content-Type", config.MustNewRegexp("text/javascript"), false}, []string{"text/javascript"}, false},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp("text/javascript"), false}, []string{"application/octet-stream"}, true},
{config.HeaderMatch{"content-type", config.MustNewRegexp("text/javascript"), false}, []string{"application/octet-stream"}, true},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp(".*"), false}, []string{""}, false},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp(".*"), false}, []string{}, false},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp(".*"), true}, []string{""}, false},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp(".*"), true}, []string{}, true},
{config.HeaderMatch{"Set-Cookie", config.MustNewRegexp(".*Domain=\\.example\\.com.*"), false}, []string{"gid=1; Expires=Tue, 19-Mar-2019 20:08:29 GMT; Domain=.example.com; Path=/"}, false},
{config.HeaderMatch{"Set-Cookie", config.MustNewRegexp(".*Domain=\\.example\\.com.*"), false}, []string{"zz=4; expires=Mon, 01-Jan-1990 00:00:00 GMT; Domain=www.example.com; Path=/", "gid=1; Expires=Tue, 19-Mar-2019 20:08:29 GMT; Domain=.example.com; Path=/"}, false},
}
for i, test := range tests {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
for _, val := range test.Values {
w.Header().Add(test.Rule.Header, val)
}
}))
defer ts.Close()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfHeaderMatchesRegexp: []config.HeaderMatch{test.Rule}}}, registry, log.NewNopLogger())
if result != test.ShouldSucceed {
t.Fatalf("Test %d had unexpected result: succeeded: %t, expected: %+v", i, result, test)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_failed_due_to_regex": 1,
}
if test.ShouldSucceed {
expectedResults["probe_failed_due_to_regex"] = 0
}
checkRegistryResults(expectedResults, mfs, t)
}
}
func TestFailIfHeaderNotMatchesRegexp(t *testing.T) {
tests := []struct {
Rule config.HeaderMatch
Values []string
ShouldSucceed bool
}{
{config.HeaderMatch{"Content-Type", config.MustNewRegexp("text/javascript"), false}, []string{"text/javascript"}, true},
{config.HeaderMatch{"content-type", config.MustNewRegexp("text/javascript"), false}, []string{"text/javascript"}, true},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp("text/javascript"), false}, []string{"application/octet-stream"}, false},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp(".*"), false}, []string{""}, true},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp(".*"), false}, []string{}, false},
{config.HeaderMatch{"Content-Type", config.MustNewRegexp(".*"), true}, []string{}, true},
{config.HeaderMatch{"Set-Cookie", config.MustNewRegexp(".*Domain=\\.example\\.com.*"), false}, []string{"zz=4; expires=Mon, 01-Jan-1990 00:00:00 GMT; Domain=www.example.com; Path=/"}, false},
{config.HeaderMatch{"Set-Cookie", config.MustNewRegexp(".*Domain=\\.example\\.com.*"), false}, []string{"zz=4; expires=Mon, 01-Jan-1990 00:00:00 GMT; Domain=www.example.com; Path=/", "gid=1; Expires=Tue, 19-Mar-2019 20:08:29 GMT; Domain=.example.com; Path=/"}, true},
}
for i, test := range tests {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
for _, val := range test.Values {
w.Header().Add(test.Rule.Header, val)
}
}))
defer ts.Close()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, FailIfHeaderNotMatchesRegexp: []config.HeaderMatch{test.Rule}}}, registry, log.NewNopLogger())
if result != test.ShouldSucceed {
t.Fatalf("Test %d had unexpected result: succeeded: %t, expected: %+v", i, result, test)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_failed_due_to_regex": 1,
}
if test.ShouldSucceed {
expectedResults["probe_failed_due_to_regex"] = 0
}
checkRegistryResults(expectedResults, mfs, t)
}
}
func TestHTTPHeaders(t *testing.T) {
headers := map[string]string{
"Host": "my-secret-vhost.com",
"User-Agent": "unsuspicious user",
"Accept-Language": "en-US",
}
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
for key, value := range headers {
if textproto.CanonicalMIMEHeaderKey(key) == "Host" {
if r.Host != value {
t.Errorf("Unexpected host: expected %q, got %q.", value, r.Host)
}
continue
}
if got := r.Header.Get(key); got != value {
t.Errorf("Unexpected value of header %q: expected %q, got %q", key, value, got)
}
}
w.WriteHeader(http.StatusOK)
}))
defer ts.Close()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
Headers: headers,
}}, registry, log.NewNopLogger())
if !result {
t.Fatalf("Probe failed unexpectedly.")
}
}
func TestFailIfSelfSignedCA(t *testing.T) {
ts := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
HTTPClientConfig: pconfig.HTTPClientConfig{
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: false},
},
}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if result {
t.Fatalf("Fail if selfsigned CA test suceeded unexpectedly, got %s", body)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_ssl": 0,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestSucceedIfSelfSignedCA(t *testing.T) {
ts := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
HTTPClientConfig: pconfig.HTTPClientConfig{
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: true},
},
}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("Fail if (not strict) selfsigned CA test fails unexpectedly, got %s", body)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_ssl": 1,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestTLSConfigIsIgnoredForPlainHTTP(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
HTTPClientConfig: pconfig.HTTPClientConfig{
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: false},
},
}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("Fail if InsecureSkipVerify affects simple http fails unexpectedly, got %s", body)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_http_ssl": 0,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestHTTPUsesTargetAsTLSServerName(t *testing.T) {
// Create test certificates valid for 1 day.
certExpiry := time.Now().AddDate(0, 0, 1)
testCertTmpl := generateCertificateTemplate(certExpiry, false)
testCertTmpl.IsCA = true
_, testcertPem, testKey := generateSelfSignedCertificate(testCertTmpl)
// CAFile must be passed via filesystem, use a tempfile.
tmpCaFile, err := os.CreateTemp("", "cafile.pem")
if err != nil {
t.Fatalf("Error creating CA tempfile: %s", err)
}
if _, err = tmpCaFile.Write(testcertPem); err != nil {
t.Fatalf("Error writing CA tempfile: %s", err)
}
if err = tmpCaFile.Close(); err != nil {
t.Fatalf("Error closing CA tempfile: %s", err)
}
defer os.Remove(tmpCaFile.Name())
testKeyPem := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(testKey)})
testcert, err := tls.X509KeyPair(testcertPem, testKeyPem)
if err != nil {
panic(fmt.Sprintf("Failed to decode TLS testing keypair: %s\n", err))
}
ts := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
ts.TLS = &tls.Config{
Certificates: []tls.Certificate{testcert},
}
ts.StartTLS()
defer ts.Close()
registry := prometheus.NewRegistry()
module := config.Module{
Timeout: time.Second,
HTTP: config.HTTPProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
HTTPClientConfig: pconfig.HTTPClientConfig{
TLSConfig: pconfig.TLSConfig{
CAFile: tmpCaFile.Name(),
},
},
},
}
// Replace IP address with hostname.
url := strings.Replace(ts.URL, "127.0.0.1", "localhost", -1)
url = strings.Replace(url, "[::1]", "localhost", -1)
result := ProbeHTTP(context.Background(), url, module, registry, log.NewNopLogger())
if !result {
t.Fatalf("TLS probe failed unexpectedly")
}
}
func TestRedirectToTLSHostWorks(t *testing.T) {
if testing.Short() {
t.Skip("skipping network dependent test")
}
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
http.Redirect(w, r, "https://prometheus.io", http.StatusFound)
}))
defer ts.Close()
// Follow redirect, should succeed with 200.
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}}, registry, log.NewNopLogger())
if !result {
t.Fatalf("Redirect test failed unexpectedly")
}
}
func TestHTTPPhases(t *testing.T) {
ts := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
}))
defer ts.Close()
// Follow redirect, should succeed with 200.
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{
IPProtocolFallback: true,
HTTPClientConfig: pconfig.HTTPClientConfig{
TLSConfig: pconfig.TLSConfig{InsecureSkipVerify: true},
},
}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("HTTP Phases test failed unexpectedly, got %s", body)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedMetrics := map[string]map[string]map[string]struct{}{
"probe_http_duration_seconds": {
"phase": {
"connect": {},
"processing": {},
"resolve": {},
"transfer": {},
"tls": {},
},
},
}
checkMetrics(expectedMetrics, mfs, t)
}
func TestCookieJar(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/" {
expiration := time.Now().Add(365 * 24 * time.Hour)
cookie := http.Cookie{Name: "somecookie", Value: "cookie", Expires: expiration}
http.SetCookie(w, &cookie)
http.Redirect(w, r, "/noredirect", http.StatusFound)
}
if r.URL.Path == "/noredirect" {
cookie, err := r.Cookie("somecookie")
if err != nil {
t.Fatalf("Error retrieving cookie, got %v", err)
}
if cookie.String() != "somecookie=cookie" {
t.Errorf("Error incorrect cookie value received, got %v, wanted %v", cookie.String(), "somecookie=cookie")
}
}
}))
defer ts.Close()
recorder := httptest.NewRecorder()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}}, registry, log.NewNopLogger())
body := recorder.Body.String()
if !result {
t.Fatalf("Redirect test failed unexpectedly, got %s", body)
}
}
func TestSkipResolvePhase(t *testing.T) {
if testing.Short() {
t.Skip("skipping network dependent test")
}
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusNoContent)
}))
defer ts.Close()
t.Run("Without Proxy", func(t *testing.T) {
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig, SkipResolvePhaseWithProxy: true}}, registry, log.NewNopLogger())
if !result {
t.Fatalf("Probe unsuccessful")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedMetrics := map[string]map[string]map[string]struct{}{
"probe_http_duration_seconds": {
"phase": {
"connect": {},
"processing": {},
"resolve": {},
"transfer": {},
"tls": {},
},
},
}
checkMetrics(expectedMetrics, mfs, t)
})
t.Run("With Proxy", func(t *testing.T) {
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
httpCfg := pconfig.DefaultHTTPClientConfig
u, err := url.Parse("http://127.0.0.1:3128")
if err != nil {
t.Fatalf(err.Error())
}
httpCfg.ProxyURL = pconfig.URL{
URL: u,
}
ProbeHTTP(testCTX, ts.URL,
config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: httpCfg, SkipResolvePhaseWithProxy: true}}, registry, log.NewNopLogger())
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedMetrics := map[string]map[string]map[string]struct{}{
"probe_http_duration_seconds": {
"phase": {
"connect": {},
"processing": {},
"transfer": {},
"tls": {},
},
},
}
checkMetrics(expectedMetrics, mfs, t)
})
}
func TestBody(t *testing.T) {
body := "Test Body"
tmpBodyFile, err := os.CreateTemp("", "body.txt")
if err != nil {
t.Fatalf("Error creating body tempfile: %s", err)
}
if _, err := tmpBodyFile.Write([]byte(body)); err != nil {
t.Fatalf("Error writing body tempfile: %s", err)
}
if err := tmpBodyFile.Close(); err != nil {
t.Fatalf("Error closing body tempfie: %s", err)
}
tests := []config.HTTPProbe{
{IPProtocolFallback: true, Body: body},
{IPProtocolFallback: true, BodyFile: tmpBodyFile.Name()},
}
for i, test := range tests {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
b, err := io.ReadAll(r.Body)
if err != nil {
t.Fatalf("Body test %d failed unexpectedly.", i)
}
if string(b) != body {
t.Fatalf("Body test %d failed unexpectedly.", i)
}
}))
defer ts.Close()
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
result := ProbeHTTP(
testCTX,
ts.URL,
config.Module{
Timeout: time.Second,
HTTP: test},
registry,
log.NewNopLogger(),
)
if !result {
t.Fatalf("Body test %d failed unexpectedly.", i)
}
}
}
0707010000003E000081A40000000000000000000000016463639800002A4B000000000000000000000000000000000000002800000000blackbox_exporter-0.24.0/prober/icmp.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"bytes"
"context"
"math/rand"
"net"
"os"
"runtime"
"sync"
"time"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/client_golang/prometheus"
"golang.org/x/net/icmp"
"golang.org/x/net/ipv4"
"golang.org/x/net/ipv6"
"github.com/prometheus/blackbox_exporter/config"
)
var (
icmpID int
icmpSequence uint16
icmpSequenceMutex sync.Mutex
)
func init() {
r := rand.New(rand.NewSource(time.Now().UnixNano()))
// PID is typically 1 when running in a container; in that case, set
// the ICMP echo ID to a random value to avoid potential clashes with
// other blackbox_exporter instances. See #411.
if pid := os.Getpid(); pid == 1 {
icmpID = r.Intn(1 << 16)
} else {
icmpID = pid & 0xffff
}
// Start the ICMP echo sequence at a random offset to prevent them from
// being in sync when several blackbox_exporter instances are restarted
// at the same time. See #411.
icmpSequence = uint16(r.Intn(1 << 16))
}
func getICMPSequence() uint16 {
icmpSequenceMutex.Lock()
defer icmpSequenceMutex.Unlock()
icmpSequence++
return icmpSequence
}
func ProbeICMP(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) (success bool) {
var (
requestType icmp.Type
replyType icmp.Type
icmpConn *icmp.PacketConn
v4RawConn *ipv4.RawConn
hopLimitFlagSet bool = true
durationGaugeVec = prometheus.NewGaugeVec(prometheus.GaugeOpts{
Name: "probe_icmp_duration_seconds",
Help: "Duration of icmp request by phase",
}, []string{"phase"})
hopLimitGauge = prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_icmp_reply_hop_limit",
Help: "Replied packet hop limit (TTL for ipv4)",
})
)
for _, lv := range []string{"resolve", "setup", "rtt"} {
durationGaugeVec.WithLabelValues(lv)
}
registry.MustRegister(durationGaugeVec)
dstIPAddr, lookupTime, err := chooseProtocol(ctx, module.ICMP.IPProtocol, module.ICMP.IPProtocolFallback, target, registry, logger)
if err != nil {
level.Warn(logger).Log("msg", "Error resolving address", "err", err)
return false
}
durationGaugeVec.WithLabelValues("resolve").Add(lookupTime)
var srcIP net.IP
if len(module.ICMP.SourceIPAddress) > 0 {
if srcIP = net.ParseIP(module.ICMP.SourceIPAddress); srcIP == nil {
level.Error(logger).Log("msg", "Error parsing source ip address", "srcIP", module.ICMP.SourceIPAddress)
return false
}
level.Info(logger).Log("msg", "Using source address", "srcIP", srcIP)
}
setupStart := time.Now()
level.Info(logger).Log("msg", "Creating socket")
privileged := true
// Unprivileged sockets are supported on Darwin and Linux only.
tryUnprivileged := runtime.GOOS == "darwin" || runtime.GOOS == "linux"
if dstIPAddr.IP.To4() == nil {
requestType = ipv6.ICMPTypeEchoRequest
replyType = ipv6.ICMPTypeEchoReply
if srcIP == nil {
srcIP = net.ParseIP("::")
}
if tryUnprivileged {
// "udp" here means unprivileged -- not the protocol "udp".
icmpConn, err = icmp.ListenPacket("udp6", srcIP.String())
if err != nil {
level.Debug(logger).Log("msg", "Unable to do unprivileged listen on socket, will attempt privileged", "err", err)
} else {
privileged = false
}
}
if privileged {
icmpConn, err = icmp.ListenPacket("ip6:ipv6-icmp", srcIP.String())
if err != nil {
level.Error(logger).Log("msg", "Error listening to socket", "err", err)
return
}
}
defer icmpConn.Close()
if err := icmpConn.IPv6PacketConn().SetControlMessage(ipv6.FlagHopLimit, true); err != nil {
level.Debug(logger).Log("msg", "Failed to set Control Message for retrieving Hop Limit", "err", err)
hopLimitFlagSet = false
}
} else {
requestType = ipv4.ICMPTypeEcho
replyType = ipv4.ICMPTypeEchoReply
if srcIP == nil {
srcIP = net.ParseIP("0.0.0.0")
}
if module.ICMP.DontFragment {
// If the user has set the don't fragment option we cannot use unprivileged
// sockets as it is not possible to set IP header level options.
netConn, err := net.ListenPacket("ip4:icmp", srcIP.String())
if err != nil {
level.Error(logger).Log("msg", "Error listening to socket", "err", err)
return
}
defer netConn.Close()
v4RawConn, err = ipv4.NewRawConn(netConn)
if err != nil {
level.Error(logger).Log("msg", "Error creating raw connection", "err", err)
return
}
defer v4RawConn.Close()
if err := v4RawConn.SetControlMessage(ipv4.FlagTTL, true); err != nil {
level.Debug(logger).Log("msg", "Failed to set Control Message for retrieving TTL", "err", err)
hopLimitFlagSet = false
}
} else {
if tryUnprivileged {
icmpConn, err = icmp.ListenPacket("udp4", srcIP.String())
if err != nil {
level.Debug(logger).Log("msg", "Unable to do unprivileged listen on socket, will attempt privileged", "err", err)
} else {
privileged = false
}
}
if privileged {
icmpConn, err = icmp.ListenPacket("ip4:icmp", srcIP.String())
if err != nil {
level.Error(logger).Log("msg", "Error listening to socket", "err", err)
return
}
}
defer icmpConn.Close()
if err := icmpConn.IPv4PacketConn().SetControlMessage(ipv4.FlagTTL, true); err != nil {
level.Debug(logger).Log("msg", "Failed to set Control Message for retrieving TTL", "err", err)
hopLimitFlagSet = false
}
}
}
var dst net.Addr = dstIPAddr
if !privileged {
dst = &net.UDPAddr{IP: dstIPAddr.IP, Zone: dstIPAddr.Zone}
}
var data []byte
if module.ICMP.PayloadSize != 0 {
data = make([]byte, module.ICMP.PayloadSize)
copy(data, "Prometheus Blackbox Exporter")
} else {
data = []byte("Prometheus Blackbox Exporter")
}
body := &icmp.Echo{
ID: icmpID,
Seq: int(getICMPSequence()),
Data: data,
}
level.Info(logger).Log("msg", "Creating ICMP packet", "seq", body.Seq, "id", body.ID)
wm := icmp.Message{
Type: requestType,
Code: 0,
Body: body,
}
wb, err := wm.Marshal(nil)
if err != nil {
level.Error(logger).Log("msg", "Error marshalling packet", "err", err)
return
}
durationGaugeVec.WithLabelValues("setup").Add(time.Since(setupStart).Seconds())
level.Info(logger).Log("msg", "Writing out packet")
rttStart := time.Now()
if icmpConn != nil {
ttl := module.ICMP.TTL
if ttl > 0 {
if c4 := icmpConn.IPv4PacketConn(); c4 != nil {
level.Debug(logger).Log("msg", "Setting TTL (IPv4 unprivileged)", "ttl", ttl)
c4.SetTTL(ttl)
}
if c6 := icmpConn.IPv6PacketConn(); c6 != nil {
level.Debug(logger).Log("msg", "Setting TTL (IPv6 unprivileged)", "ttl", ttl)
c6.SetHopLimit(ttl)
}
}
_, err = icmpConn.WriteTo(wb, dst)
} else {
ttl := config.DefaultICMPTTL
if module.ICMP.TTL > 0 {
level.Debug(logger).Log("msg", "Overriding TTL (raw IPv4)", "ttl", ttl)
ttl = module.ICMP.TTL
}
// Only for IPv4 raw. Needed for setting DontFragment flag.
header := &ipv4.Header{
Version: ipv4.Version,
Len: ipv4.HeaderLen,
Protocol: 1,
TotalLen: ipv4.HeaderLen + len(wb),
TTL: ttl,
Dst: dstIPAddr.IP,
Src: srcIP,
}
header.Flags |= ipv4.DontFragment
err = v4RawConn.WriteTo(header, wb, nil)
}
if err != nil {
level.Warn(logger).Log("msg", "Error writing to socket", "err", err)
return
}
// Reply should be the same except for the message type and ID if
// unprivileged sockets were used and the kernel used its own.
wm.Type = replyType
// Unprivileged cannot set IDs on Linux.
idUnknown := !privileged && runtime.GOOS == "linux"
if idUnknown {
body.ID = 0
}
wb, err = wm.Marshal(nil)
if err != nil {
level.Error(logger).Log("msg", "Error marshalling packet", "err", err)
return
}
if idUnknown {
// If the ID is unknown (due to unprivileged sockets) we also cannot know
// the checksum in userspace.
wb[2] = 0
wb[3] = 0
}
rb := make([]byte, 65536)
deadline, _ := ctx.Deadline()
if icmpConn != nil {
err = icmpConn.SetReadDeadline(deadline)
} else {
err = v4RawConn.SetReadDeadline(deadline)
}
if err != nil {
level.Error(logger).Log("msg", "Error setting socket deadline", "err", err)
return
}
level.Info(logger).Log("msg", "Waiting for reply packets")
for {
var n int
var peer net.Addr
var err error
var hopLimit float64 = -1
if dstIPAddr.IP.To4() == nil {
var cm *ipv6.ControlMessage
n, cm, peer, err = icmpConn.IPv6PacketConn().ReadFrom(rb)
// HopLimit == 0 is valid for IPv6, although go initialize it as 0.
if cm != nil && hopLimitFlagSet {
hopLimit = float64(cm.HopLimit)
} else {
level.Debug(logger).Log("msg", "Cannot get Hop Limit from the received packet. 'probe_icmp_reply_hop_limit' will be missing.")
}
} else {
var cm *ipv4.ControlMessage
if icmpConn != nil {
n, cm, peer, err = icmpConn.IPv4PacketConn().ReadFrom(rb)
} else {
var h *ipv4.Header
var p []byte
h, p, cm, err = v4RawConn.ReadFrom(rb)
if err == nil {
copy(rb, p)
n = len(p)
peer = &net.IPAddr{IP: h.Src}
}
}
if cm != nil && hopLimitFlagSet {
// Not really Hop Limit, but it is in practice.
hopLimit = float64(cm.TTL)
} else {
level.Debug(logger).Log("msg", "Cannot get TTL from the received packet. 'probe_icmp_reply_hop_limit' will be missing.")
}
}
if err != nil {
if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
level.Warn(logger).Log("msg", "Timeout reading from socket", "err", err)
return
}
level.Error(logger).Log("msg", "Error reading from socket", "err", err)
continue
}
if peer.String() != dst.String() {
continue
}
if idUnknown {
// Clear the ID from the packet, as the kernel will have replaced it (and
// kept track of our packet for us, hence clearing is safe).
rb[4] = 0
rb[5] = 0
}
if idUnknown || replyType == ipv6.ICMPTypeEchoReply {
// Clear checksum to make comparison succeed.
rb[2] = 0
rb[3] = 0
}
if bytes.Equal(rb[:n], wb) {
durationGaugeVec.WithLabelValues("rtt").Add(time.Since(rttStart).Seconds())
if hopLimit >= 0 {
hopLimitGauge.Set(hopLimit)
registry.MustRegister(hopLimitGauge)
}
level.Info(logger).Log("msg", "Found matching reply packet")
return true
}
}
}
0707010000003F000081A40000000000000000000000016463639800000614000000000000000000000000000000000000002A00000000blackbox_exporter-0.24.0/prober/prober.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"context"
"github.com/go-kit/log"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/blackbox_exporter/config"
)
type ProbeFn func(ctx context.Context, target string, config config.Module, registry *prometheus.Registry, logger log.Logger) bool
const (
helpSSLEarliestCertExpiry = "Returns last SSL chain expiry in unixtime"
helpSSLChainExpiryInTimeStamp = "Returns last SSL chain expiry in timestamp"
helpProbeTLSInfo = "Returns the TLS version used or NaN when unknown"
)
var (
sslEarliestCertExpiryGaugeOpts = prometheus.GaugeOpts{
Name: "probe_ssl_earliest_cert_expiry",
Help: helpSSLEarliestCertExpiry,
}
sslChainExpiryInTimeStampGaugeOpts = prometheus.GaugeOpts{
Name: "probe_ssl_last_chain_expiry_timestamp_seconds",
Help: helpSSLChainExpiryInTimeStamp,
}
probeTLSInfoGaugeOpts = prometheus.GaugeOpts{
Name: "probe_tls_version_info",
Help: helpProbeTLSInfo,
}
)
07070100000040000081A40000000000000000000000016463639800001ED0000000000000000000000000000000000000002700000000blackbox_exporter-0.24.0/prober/tcp.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"bufio"
"context"
"crypto/tls"
"fmt"
"net"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"github.com/prometheus/blackbox_exporter/config"
)
func dialTCP(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) (net.Conn, error) {
var dialProtocol, dialTarget string
dialer := &net.Dialer{}
targetAddress, port, err := net.SplitHostPort(target)
if err != nil {
level.Error(logger).Log("msg", "Error splitting target address and port", "err", err)
return nil, err
}
ip, _, err := chooseProtocol(ctx, module.TCP.IPProtocol, module.TCP.IPProtocolFallback, targetAddress, registry, logger)
if err != nil {
level.Error(logger).Log("msg", "Error resolving address", "err", err)
return nil, err
}
if ip.IP.To4() == nil {
dialProtocol = "tcp6"
} else {
dialProtocol = "tcp4"
}
if len(module.TCP.SourceIPAddress) > 0 {
srcIP := net.ParseIP(module.TCP.SourceIPAddress)
if srcIP == nil {
level.Error(logger).Log("msg", "Error parsing source ip address", "srcIP", module.TCP.SourceIPAddress)
return nil, fmt.Errorf("error parsing source ip address: %s", module.TCP.SourceIPAddress)
}
level.Info(logger).Log("msg", "Using local address", "srcIP", srcIP)
dialer.LocalAddr = &net.TCPAddr{IP: srcIP}
}
dialTarget = net.JoinHostPort(ip.String(), port)
if !module.TCP.TLS {
level.Info(logger).Log("msg", "Dialing TCP without TLS")
return dialer.DialContext(ctx, dialProtocol, dialTarget)
}
tlsConfig, err := pconfig.NewTLSConfig(&module.TCP.TLSConfig)
if err != nil {
level.Error(logger).Log("msg", "Error creating TLS configuration", "err", err)
return nil, err
}
if len(tlsConfig.ServerName) == 0 {
// If there is no `server_name` in tls_config, use
// targetAddress as TLS-servername. Normally tls.DialWithDialer
// would do this for us, but we pre-resolved the name by
// `chooseProtocol` and pass the IP-address for dialing (prevents
// resolving twice).
// For this reason we need to specify the original targetAddress
// via tlsConfig to enable hostname verification.
tlsConfig.ServerName = targetAddress
}
timeoutDeadline, _ := ctx.Deadline()
dialer.Deadline = timeoutDeadline
level.Info(logger).Log("msg", "Dialing TCP with TLS")
return tls.DialWithDialer(dialer, dialProtocol, dialTarget, tlsConfig)
}
func ProbeTCP(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) bool {
probeSSLEarliestCertExpiry := prometheus.NewGauge(sslEarliestCertExpiryGaugeOpts)
probeSSLLastChainExpiryTimestampSeconds := prometheus.NewGauge(sslChainExpiryInTimeStampGaugeOpts)
probeSSLLastInformation := prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "probe_ssl_last_chain_info",
Help: "Contains SSL leaf certificate information",
},
[]string{"fingerprint_sha256", "subject", "issuer", "subjectalternative"},
)
probeTLSVersion := prometheus.NewGaugeVec(
probeTLSInfoGaugeOpts,
[]string{"version"},
)
probeFailedDueToRegex := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_failed_due_to_regex",
Help: "Indicates if probe failed due to regex",
})
registry.MustRegister(probeFailedDueToRegex)
deadline, _ := ctx.Deadline()
conn, err := dialTCP(ctx, target, module, registry, logger)
if err != nil {
level.Error(logger).Log("msg", "Error dialing TCP", "err", err)
return false
}
defer conn.Close()
level.Info(logger).Log("msg", "Successfully dialed")
// Set a deadline to prevent the following code from blocking forever.
// If a deadline cannot be set, better fail the probe by returning an error
// now rather than blocking forever.
if err := conn.SetDeadline(deadline); err != nil {
level.Error(logger).Log("msg", "Error setting deadline", "err", err)
return false
}
if module.TCP.TLS {
state := conn.(*tls.Conn).ConnectionState()
registry.MustRegister(probeSSLEarliestCertExpiry, probeTLSVersion, probeSSLLastChainExpiryTimestampSeconds, probeSSLLastInformation)
probeSSLEarliestCertExpiry.Set(float64(getEarliestCertExpiry(&state).Unix()))
probeTLSVersion.WithLabelValues(getTLSVersion(&state)).Set(1)
probeSSLLastChainExpiryTimestampSeconds.Set(float64(getLastChainExpiry(&state).Unix()))
probeSSLLastInformation.WithLabelValues(getFingerprint(&state), getSubject(&state), getIssuer(&state), getDNSNames(&state)).Set(1)
}
scanner := bufio.NewScanner(conn)
for i, qr := range module.TCP.QueryResponse {
level.Info(logger).Log("msg", "Processing query response entry", "entry_number", i)
send := qr.Send
if qr.Expect.Regexp != nil {
var match []int
// Read lines until one of them matches the configured regexp.
for scanner.Scan() {
level.Debug(logger).Log("msg", "Read line", "line", scanner.Text())
match = qr.Expect.Regexp.FindSubmatchIndex(scanner.Bytes())
if match != nil {
level.Info(logger).Log("msg", "Regexp matched", "regexp", qr.Expect.Regexp, "line", scanner.Text())
break
}
}
if scanner.Err() != nil {
level.Error(logger).Log("msg", "Error reading from connection", "err", scanner.Err().Error())
return false
}
if match == nil {
probeFailedDueToRegex.Set(1)
level.Error(logger).Log("msg", "Regexp did not match", "regexp", qr.Expect.Regexp, "line", scanner.Text())
return false
}
probeFailedDueToRegex.Set(0)
send = string(qr.Expect.Regexp.Expand(nil, []byte(send), scanner.Bytes(), match))
}
if send != "" {
level.Debug(logger).Log("msg", "Sending line", "line", send)
if _, err := fmt.Fprintf(conn, "%s\n", send); err != nil {
level.Error(logger).Log("msg", "Failed to send", "err", err)
return false
}
}
if qr.StartTLS {
// Upgrade TCP connection to TLS.
tlsConfig, err := pconfig.NewTLSConfig(&module.TCP.TLSConfig)
if err != nil {
level.Error(logger).Log("msg", "Failed to create TLS configuration", "err", err)
return false
}
if tlsConfig.ServerName == "" {
// Use target-hostname as default for TLS-servername.
targetAddress, _, _ := net.SplitHostPort(target) // Had succeeded in dialTCP already.
tlsConfig.ServerName = targetAddress
}
tlsConn := tls.Client(conn, tlsConfig)
defer tlsConn.Close()
// Initiate TLS handshake (required here to get TLS state).
if err := tlsConn.Handshake(); err != nil {
level.Error(logger).Log("msg", "TLS Handshake (client) failed", "err", err)
return false
}
level.Info(logger).Log("msg", "TLS Handshake (client) succeeded.")
conn = net.Conn(tlsConn)
scanner = bufio.NewScanner(conn)
// Get certificate expiry.
state := tlsConn.ConnectionState()
registry.MustRegister(probeSSLEarliestCertExpiry, probeTLSVersion, probeSSLLastChainExpiryTimestampSeconds, probeSSLLastInformation)
probeSSLEarliestCertExpiry.Set(float64(getEarliestCertExpiry(&state).Unix()))
probeTLSVersion.WithLabelValues(getTLSVersion(&state)).Set(1)
probeSSLLastChainExpiryTimestampSeconds.Set(float64(getLastChainExpiry(&state).Unix()))
probeSSLLastInformation.WithLabelValues(getFingerprint(&state), getSubject(&state), getIssuer(&state), getDNSNames(&state)).Set(1)
}
}
return true
}
07070100000041000081A40000000000000000000000016463639800005018000000000000000000000000000000000000002C00000000blackbox_exporter-0.24.0/prober/tcp_test.go// Copyright 2015 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"bytes"
"context"
"crypto/rand"
"crypto/rsa"
"crypto/tls"
"crypto/x509"
"encoding/pem"
"fmt"
"net"
"os"
"runtime"
"testing"
"time"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/client_golang/prometheus"
pconfig "github.com/prometheus/common/config"
"github.com/prometheus/blackbox_exporter/config"
)
func TestTCPConnection(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
ch := make(chan (struct{}))
go func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
conn.Close()
ch <- struct{}{}
}()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
if !ProbeTCP(testCTX, ln.Addr().String(), config.Module{TCP: config.TCPProbe{IPProtocolFallback: true}}, registry, log.NewNopLogger()) {
t.Fatalf("TCP module failed, expected success.")
}
<-ch
}
func TestTCPConnectionFails(t *testing.T) {
// Invalid port number.
registry := prometheus.NewRegistry()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
if ProbeTCP(testCTX, ":0", config.Module{TCP: config.TCPProbe{}}, registry, log.NewNopLogger()) {
t.Fatalf("TCP module suceeded, expected failure.")
}
}
func TestTCPConnectionWithTLS(t *testing.T) {
if os.Getenv("CI") == "true" {
t.Skip("skipping; CI is failing on ipv6 dns requests")
}
ln, err := net.Listen("tcp", ":0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, listenPort, _ := net.SplitHostPort(ln.Addr().String())
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
// Create test certificates valid for 1 day.
certExpiry := time.Now().AddDate(0, 0, 1)
rootCertTmpl := generateCertificateTemplate(certExpiry, false)
rootCertTmpl.IsCA = true
_, rootCertPem, rootKey := generateSelfSignedCertificate(rootCertTmpl)
// CAFile must be passed via filesystem, use a tempfile.
tmpCaFile, err := os.CreateTemp("", "cafile.pem")
if err != nil {
t.Fatalf(fmt.Sprintf("Error creating CA tempfile: %s", err))
}
if _, err := tmpCaFile.Write(rootCertPem); err != nil {
t.Fatalf(fmt.Sprintf("Error writing CA tempfile: %s", err))
}
if err := tmpCaFile.Close(); err != nil {
t.Fatalf(fmt.Sprintf("Error closing CA tempfile: %s", err))
}
defer os.Remove(tmpCaFile.Name())
ch := make(chan (struct{}))
logger := log.NewNopLogger()
// Handle server side of this test.
serverFunc := func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
defer conn.Close()
rootKeyPem := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(rootKey)})
testcert, err := tls.X509KeyPair(rootCertPem, rootKeyPem)
if err != nil {
panic(fmt.Sprintf("Failed to decode TLS testing keypair: %s\n", err))
}
// Immediately upgrade to TLS.
tlsConfig := &tls.Config{
ServerName: "localhost",
Certificates: []tls.Certificate{testcert},
MinVersion: tls.VersionTLS12,
MaxVersion: tls.VersionTLS12,
}
tlsConn := tls.Server(conn, tlsConfig)
defer tlsConn.Close()
if err := tlsConn.Handshake(); err != nil {
level.Error(logger).Log("msg", "Error TLS Handshake (server) failed", "err", err)
} else {
// Send some bytes before terminating the connection.
fmt.Fprintf(tlsConn, "Hello World!\n")
}
ch <- struct{}{}
}
// Expect name-verified TLS connection.
module := config.Module{
TCP: config.TCPProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
TLS: true,
TLSConfig: pconfig.TLSConfig{
CAFile: tmpCaFile.Name(),
InsecureSkipVerify: false,
},
},
}
registry := prometheus.NewRegistry()
go serverFunc()
// Test name-verification failure (IP without IPs in cert's SAN).
if ProbeTCP(testCTX, ln.Addr().String(), module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module succeeded, expected failure.")
}
<-ch
registry = prometheus.NewRegistry()
go serverFunc()
// Test name-verification with name from target.
target := net.JoinHostPort("localhost", listenPort)
if !ProbeTCP(testCTX, target, module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module failed, expected success.")
}
<-ch
registry = prometheus.NewRegistry()
go serverFunc()
// Test name-verification against name from tls_config.
module.TCP.TLSConfig.ServerName = "localhost"
if !ProbeTCP(testCTX, ln.Addr().String(), module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module failed, expected success.")
}
<-ch
// Check the resulting metrics.
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
// Check labels
expectedLabels := map[string]map[string]string{
"probe_tls_version_info": {
"version": "TLS 1.2",
},
}
checkRegistryLabels(expectedLabels, mfs, t)
// Check values
expectedResults := map[string]float64{
"probe_ssl_earliest_cert_expiry": float64(certExpiry.Unix()),
"probe_ssl_last_chain_info": 1,
"probe_tls_version_info": 1,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestTCPConnectionWithTLSAndVerifiedCertificateChain(t *testing.T) {
if os.Getenv("CI") == "true" {
t.Skip("skipping; CI is failing on ipv6 dns requests")
}
ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
_, listenPort, _ := net.SplitHostPort(ln.Addr().String())
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
// From here prepare two certificate chains where one expires before the
// other
rootPrivatekey, err := rsa.GenerateKey(rand.Reader, 2048)
if err != nil {
panic(fmt.Sprintf("Error creating rsa key: %s", err))
}
rootCertExpiry := time.Now().AddDate(0, 0, 3)
rootCertTmpl := generateCertificateTemplate(rootCertExpiry, false)
rootCertTmpl.IsCA = true
_, rootCertPem := generateSelfSignedCertificateWithPrivateKey(rootCertTmpl, rootPrivatekey)
olderRootCertExpiry := time.Now().AddDate(0, 0, 1)
olderRootCertTmpl := generateCertificateTemplate(olderRootCertExpiry, false)
olderRootCertTmpl.IsCA = true
olderRootCert, olderRootCertPem := generateSelfSignedCertificateWithPrivateKey(olderRootCertTmpl, rootPrivatekey)
serverCertExpiry := time.Now().AddDate(0, 0, 2)
serverCertTmpl := generateCertificateTemplate(serverCertExpiry, false)
_, serverCertPem, serverKey := generateSignedCertificate(serverCertTmpl, olderRootCert, rootPrivatekey)
// CAFile must be passed via filesystem, use a tempfile.
tmpCaFile, err := os.CreateTemp("", "cafile.pem")
if err != nil {
t.Fatalf(fmt.Sprintf("Error creating CA tempfile: %s", err))
}
if _, err := tmpCaFile.Write(bytes.Join([][]byte{rootCertPem, olderRootCertPem}, []byte("\n"))); err != nil {
t.Fatalf(fmt.Sprintf("Error writing CA tempfile: %s", err))
}
if err := tmpCaFile.Close(); err != nil {
t.Fatalf(fmt.Sprintf("Error closing CA tempfile: %s", err))
}
defer os.Remove(tmpCaFile.Name())
ch := make(chan (struct{}))
logger := log.NewNopLogger()
// Handle server side of this test.
serverFunc := func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
defer conn.Close()
serverKeyPem := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(serverKey)})
// Include the older root cert in the chain
keypair, err := tls.X509KeyPair(append(serverCertPem, olderRootCertPem...), serverKeyPem)
if err != nil {
panic(fmt.Sprintf("Failed to decode TLS testing keypair: %s\n", err))
}
// Immediately upgrade to TLS.
tlsConfig := &tls.Config{
ServerName: "localhost",
Certificates: []tls.Certificate{keypair},
MinVersion: tls.VersionTLS12,
MaxVersion: tls.VersionTLS12,
}
tlsConn := tls.Server(conn, tlsConfig)
defer tlsConn.Close()
if err := tlsConn.Handshake(); err != nil {
level.Error(logger).Log("msg", "Error TLS Handshake (server) failed", "err", err)
} else {
// Send some bytes before terminating the connection.
fmt.Fprintf(tlsConn, "Hello World!\n")
}
ch <- struct{}{}
}
// Expect name-verified TLS connection.
module := config.Module{
TCP: config.TCPProbe{
IPProtocol: "ip4",
IPProtocolFallback: true,
TLS: true,
TLSConfig: pconfig.TLSConfig{
CAFile: tmpCaFile.Name(),
InsecureSkipVerify: false,
},
},
}
registry := prometheus.NewRegistry()
go serverFunc()
// Test name-verification with name from target.
target := net.JoinHostPort("localhost", listenPort)
if !ProbeTCP(testCTX, target, module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module failed, expected success.")
}
<-ch
// Check the resulting metrics.
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
// Check values
expectedResults := map[string]float64{
"probe_ssl_earliest_cert_expiry": float64(olderRootCertExpiry.Unix()),
"probe_ssl_last_chain_expiry_timestamp_seconds": float64(serverCertExpiry.Unix()),
"probe_ssl_last_chain_info": 1,
"probe_tls_version_info": 1,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestTCPConnectionQueryResponseStartTLS(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
// Create test certificates valid for 1 day.
certExpiry := time.Now().AddDate(0, 0, 1)
testCertTmpl := generateCertificateTemplate(certExpiry, true)
testCertTmpl.IsCA = true
_, testCertPem, testKey := generateSelfSignedCertificate(testCertTmpl)
// CAFile must be passed via filesystem, use a tempfile.
tmpCaFile, err := os.CreateTemp("", "cafile.pem")
if err != nil {
t.Fatalf(fmt.Sprintf("Error creating CA tempfile: %s", err))
}
if _, err := tmpCaFile.Write(testCertPem); err != nil {
t.Fatalf(fmt.Sprintf("Error writing CA tempfile: %s", err))
}
if err := tmpCaFile.Close(); err != nil {
t.Fatalf(fmt.Sprintf("Error closing CA tempfile: %s", err))
}
defer os.Remove(tmpCaFile.Name())
// Define some (bogus) example SMTP dialog with STARTTLS.
module := config.Module{
TCP: config.TCPProbe{
IPProtocolFallback: true,
QueryResponse: []config.QueryResponse{
{Expect: config.MustNewRegexp("^220.*ESMTP.*$")},
{Send: "EHLO tls.prober"},
{Expect: config.MustNewRegexp("^250-STARTTLS")},
{Send: "STARTTLS"},
{Expect: config.MustNewRegexp("^220")},
{StartTLS: true},
{Send: "EHLO tls.prober"},
{Expect: config.MustNewRegexp("^250-AUTH")},
{Send: "QUIT"},
},
TLSConfig: pconfig.TLSConfig{
CAFile: tmpCaFile.Name(),
InsecureSkipVerify: false,
},
},
}
// Handle server side of this test.
ch := make(chan (struct{}))
go func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
defer conn.Close()
fmt.Fprintf(conn, "220 ESMTP StartTLS pseudo-server\n")
if _, e := fmt.Fscanf(conn, "EHLO tls.prober\n"); e != nil {
panic("Error in dialog. No EHLO received.")
}
fmt.Fprintf(conn, "250-pseudo-server.example.net\n")
fmt.Fprintf(conn, "250-STARTTLS\n")
fmt.Fprintf(conn, "250 DSN\n")
if _, e := fmt.Fscanf(conn, "STARTTLS\n"); e != nil {
panic("Error in dialog. No (TLS) STARTTLS received.")
}
fmt.Fprintf(conn, "220 2.0.0 Ready to start TLS\n")
testKeyPem := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(testKey)})
testcert, err := tls.X509KeyPair(testCertPem, testKeyPem)
if err != nil {
panic(fmt.Sprintf("Failed to decode TLS testing keypair: %s\n", err))
}
// Do the server-side upgrade to TLS.
tlsConfig := &tls.Config{
ServerName: "localhost",
Certificates: []tls.Certificate{testcert},
}
tlsConn := tls.Server(conn, tlsConfig)
if err := tlsConn.Handshake(); err != nil {
panic(fmt.Sprintf("TLS Handshake (server) failed: %s\n", err))
}
defer tlsConn.Close()
// Continue encrypted.
if _, e := fmt.Fscanf(tlsConn, "EHLO"); e != nil {
panic("Error in dialog. No (TLS) EHLO received.")
}
fmt.Fprintf(tlsConn, "250-AUTH\n")
fmt.Fprintf(tlsConn, "250 DSN\n")
ch <- struct{}{}
}()
// Do the client side of this test.
registry := prometheus.NewRegistry()
if !ProbeTCP(testCTX, ln.Addr().String(), module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module failed, expected success.")
}
<-ch
// Check the probe_ssl_earliest_cert_expiry.
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_ssl_earliest_cert_expiry": float64(certExpiry.Unix()),
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestTCPConnectionQueryResponseIRC(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
module := config.Module{
TCP: config.TCPProbe{
IPProtocolFallback: true,
QueryResponse: []config.QueryResponse{
{Send: "NICK prober"},
{Send: "USER prober prober prober :prober"},
{Expect: config.MustNewRegexp("^:[^ ]+ 001")},
},
},
}
ch := make(chan (struct{}))
go func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
fmt.Fprintf(conn, ":ircd.localhost NOTICE AUTH :*** Looking up your hostname...\n")
var nick, user, mode, unused, realname string
fmt.Fscanf(conn, "NICK %s", &nick)
fmt.Fscanf(conn, "USER %s %s %s :%s", &user, &mode, &unused, &realname)
fmt.Fprintf(conn, ":ircd.localhost 001 %s :Welcome to IRC!\n", nick)
conn.Close()
ch <- struct{}{}
}()
registry := prometheus.NewRegistry()
if !ProbeTCP(testCTX, ln.Addr().String(), module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module failed, expected success.")
}
<-ch
go func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
fmt.Fprintf(conn, ":ircd.localhost NOTICE AUTH :*** Looking up your hostname...\n")
var nick, user, mode, unused, realname string
fmt.Fscanf(conn, "NICK %s", &nick)
fmt.Fscanf(conn, "USER %s %s %s :%s", &user, &mode, &unused, &realname)
fmt.Fprintf(conn, "ERROR: Your IP address has been blacklisted.\n")
conn.Close()
ch <- struct{}{}
}()
registry = prometheus.NewRegistry()
if ProbeTCP(testCTX, ln.Addr().String(), module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module succeeded, expected failure.")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_failed_due_to_regex": 1,
}
checkRegistryResults(expectedResults, mfs, t)
<-ch
}
func TestTCPConnectionQueryResponseMatching(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
time.Sleep(time.Millisecond * 100)
module := config.Module{
TCP: config.TCPProbe{
IPProtocolFallback: true,
QueryResponse: []config.QueryResponse{
{
Expect: config.MustNewRegexp("SSH-2.0-(OpenSSH_6.9p1) Debian-2"),
Send: "CONFIRM ${1}",
},
},
},
}
ch := make(chan string)
go func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
conn.SetDeadline(time.Now().Add(1 * time.Second))
fmt.Fprintf(conn, "SSH-2.0-OpenSSH_6.9p1 Debian-2\n")
var version string
fmt.Fscanf(conn, "CONFIRM %s", &version)
conn.Close()
ch <- version
}()
registry := prometheus.NewRegistry()
if !ProbeTCP(testCTX, ln.Addr().String(), module, registry, log.NewNopLogger()) {
t.Fatalf("TCP module failed, expected success.")
}
if got, want := <-ch, "OpenSSH_6.9p1"; got != want {
t.Fatalf("Read unexpected version: got %q, want %q", got, want)
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_failed_due_to_regex": 0,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestTCPConnectionProtocol(t *testing.T) {
if os.Getenv("CI") == "true" {
t.Skip("skipping; CI is failing on ipv6 dns requests")
}
// This test assumes that listening TCP listens both IPv6 and IPv4 traffic and
// localhost resolves to both 127.0.0.1 and ::1. we must skip the test if either
// of these isn't true. This should be true for modern Linux systems.
if runtime.GOOS == "dragonfly" || runtime.GOOS == "openbsd" {
t.Skip("IPv6 socket isn't able to accept IPv4 traffic in the system.")
}
_, err := net.ResolveIPAddr("ip6", "localhost")
if err != nil {
t.Skip("\"localhost\" doesn't resolve to ::1.")
}
ln, err := net.Listen("tcp", ":0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
_, port, _ := net.SplitHostPort(ln.Addr().String())
// Prefer IPv4
module := config.Module{
TCP: config.TCPProbe{
IPProtocol: "ip4",
},
}
registry := prometheus.NewRegistry()
result := ProbeTCP(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if !result {
t.Fatalf("TCP protocol: \"tcp\", prefer: \"ip4\" connection test failed, expected success.")
}
mfs, err := registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults := map[string]float64{
"probe_ip_protocol": 4,
}
checkRegistryResults(expectedResults, mfs, t)
// Prefer IPv6
module = config.Module{
TCP: config.TCPProbe{
IPProtocol: "ip6",
},
}
registry = prometheus.NewRegistry()
result = ProbeTCP(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if !result {
t.Fatalf("TCP protocol: \"tcp\", prefer: \"ip6\" connection test failed, expected success.")
}
mfs, err = registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults = map[string]float64{
"probe_ip_protocol": 6,
}
checkRegistryResults(expectedResults, mfs, t)
// Prefer nothing
module = config.Module{
TCP: config.TCPProbe{},
}
registry = prometheus.NewRegistry()
result = ProbeTCP(testCTX, net.JoinHostPort("localhost", port), module, registry, log.NewNopLogger())
if !result {
t.Fatalf("TCP protocol: \"tcp\" connection test failed, expected success.")
}
mfs, err = registry.Gather()
if err != nil {
t.Fatal(err)
}
expectedResults = map[string]float64{
"probe_ip_protocol": 6,
}
checkRegistryResults(expectedResults, mfs, t)
}
func TestPrometheusTimeoutTCP(t *testing.T) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("Error listening on socket: %s", err)
}
defer ln.Close()
ch := make(chan (struct{}))
go func() {
conn, err := ln.Accept()
if err != nil {
panic(fmt.Sprintf("Error accepting on socket: %s", err))
}
conn.Close()
ch <- struct{}{}
}()
testCTX, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
registry := prometheus.NewRegistry()
if ProbeTCP(testCTX, ln.Addr().String(), config.Module{TCP: config.TCPProbe{
IPProtocolFallback: true,
QueryResponse: []config.QueryResponse{
{
Expect: config.MustNewRegexp("SSH-2.0-(OpenSSH_6.9p1) Debian-2"),
},
},
}}, registry, log.NewNopLogger()) {
t.Fatalf("TCP module succeeded, expected timeout failure.")
}
<-ch
}
07070100000042000081A40000000000000000000000016463639800000915000000000000000000000000000000000000002700000000blackbox_exporter-0.24.0/prober/tls.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"crypto/sha256"
"crypto/tls"
"encoding/hex"
"strings"
"time"
)
func getEarliestCertExpiry(state *tls.ConnectionState) time.Time {
earliest := time.Time{}
for _, cert := range state.PeerCertificates {
if (earliest.IsZero() || cert.NotAfter.Before(earliest)) && !cert.NotAfter.IsZero() {
earliest = cert.NotAfter
}
}
return earliest
}
func getFingerprint(state *tls.ConnectionState) string {
cert := state.PeerCertificates[0]
fingerprint := sha256.Sum256(cert.Raw)
return hex.EncodeToString(fingerprint[:])
}
func getSubject(state *tls.ConnectionState) string {
cert := state.PeerCertificates[0]
return cert.Subject.String()
}
func getIssuer(state *tls.ConnectionState) string {
cert := state.PeerCertificates[0]
return cert.Issuer.String()
}
func getDNSNames(state *tls.ConnectionState) string {
cert := state.PeerCertificates[0]
return strings.Join(cert.DNSNames, ",")
}
func getLastChainExpiry(state *tls.ConnectionState) time.Time {
lastChainExpiry := time.Time{}
for _, chain := range state.VerifiedChains {
earliestCertExpiry := time.Time{}
for _, cert := range chain {
if (earliestCertExpiry.IsZero() || cert.NotAfter.Before(earliestCertExpiry)) && !cert.NotAfter.IsZero() {
earliestCertExpiry = cert.NotAfter
}
}
if lastChainExpiry.IsZero() || lastChainExpiry.Before(earliestCertExpiry) {
lastChainExpiry = earliestCertExpiry
}
}
return lastChainExpiry
}
func getTLSVersion(state *tls.ConnectionState) string {
switch state.Version {
case tls.VersionTLS10:
return "TLS 1.0"
case tls.VersionTLS11:
return "TLS 1.1"
case tls.VersionTLS12:
return "TLS 1.2"
case tls.VersionTLS13:
return "TLS 1.3"
default:
return "unknown"
}
}
07070100000043000081A400000000000000000000000164636398000010C0000000000000000000000000000000000000002900000000blackbox_exporter-0.24.0/prober/utils.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"context"
"fmt"
"hash/fnv"
"net"
"time"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/client_golang/prometheus"
)
var protocolToGauge = map[string]float64{
"ip4": 4,
"ip6": 6,
}
// Returns the IP for the IPProtocol and lookup time.
func chooseProtocol(ctx context.Context, IPProtocol string, fallbackIPProtocol bool, target string, registry *prometheus.Registry, logger log.Logger) (ip *net.IPAddr, lookupTime float64, err error) {
var fallbackProtocol string
probeDNSLookupTimeSeconds := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_dns_lookup_time_seconds",
Help: "Returns the time taken for probe dns lookup in seconds",
})
probeIPProtocolGauge := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_ip_protocol",
Help: "Specifies whether probe ip protocol is IP4 or IP6",
})
probeIPAddrHash := prometheus.NewGauge(prometheus.GaugeOpts{
Name: "probe_ip_addr_hash",
Help: "Specifies the hash of IP address. It's useful to detect if the IP address changes.",
})
registry.MustRegister(probeIPProtocolGauge)
registry.MustRegister(probeDNSLookupTimeSeconds)
registry.MustRegister(probeIPAddrHash)
if IPProtocol == "ip6" || IPProtocol == "" {
IPProtocol = "ip6"
fallbackProtocol = "ip4"
} else {
IPProtocol = "ip4"
fallbackProtocol = "ip6"
}
level.Info(logger).Log("msg", "Resolving target address", "target", target, "ip_protocol", IPProtocol)
resolveStart := time.Now()
defer func() {
lookupTime = time.Since(resolveStart).Seconds()
probeDNSLookupTimeSeconds.Add(lookupTime)
}()
resolver := &net.Resolver{}
if !fallbackIPProtocol {
ips, err := resolver.LookupIP(ctx, IPProtocol, target)
if err == nil {
for _, ip := range ips {
level.Info(logger).Log("msg", "Resolved target address", "target", target, "ip", ip.String())
probeIPProtocolGauge.Set(protocolToGauge[IPProtocol])
probeIPAddrHash.Set(ipHash(ip))
return &net.IPAddr{IP: ip}, lookupTime, nil
}
}
level.Error(logger).Log("msg", "Resolution with IP protocol failed", "target", target, "ip_protocol", IPProtocol, "err", err)
return nil, 0.0, err
}
ips, err := resolver.LookupIPAddr(ctx, target)
if err != nil {
level.Error(logger).Log("msg", "Resolution with IP protocol failed", "target", target, "err", err)
return nil, 0.0, err
}
// Return the IP in the requested protocol.
var fallback *net.IPAddr
for _, ip := range ips {
switch IPProtocol {
case "ip4":
if ip.IP.To4() != nil {
level.Info(logger).Log("msg", "Resolved target address", "target", target, "ip", ip.String())
probeIPProtocolGauge.Set(4)
probeIPAddrHash.Set(ipHash(ip.IP))
return &ip, lookupTime, nil
}
// ip4 as fallback
fallback = &ip
case "ip6":
if ip.IP.To4() == nil {
level.Info(logger).Log("msg", "Resolved target address", "target", target, "ip", ip.String())
probeIPProtocolGauge.Set(6)
probeIPAddrHash.Set(ipHash(ip.IP))
return &ip, lookupTime, nil
}
// ip6 as fallback
fallback = &ip
}
}
// Unable to find ip and no fallback set.
if fallback == nil || !fallbackIPProtocol {
return nil, 0.0, fmt.Errorf("unable to find ip; no fallback")
}
// Use fallback ip protocol.
if fallbackProtocol == "ip4" {
probeIPProtocolGauge.Set(4)
} else {
probeIPProtocolGauge.Set(6)
}
probeIPAddrHash.Set(ipHash(fallback.IP))
level.Info(logger).Log("msg", "Resolved target address", "target", target, "ip", fallback.String())
return fallback, lookupTime, nil
}
func ipHash(ip net.IP) float64 {
h := fnv.New32a()
if ip.To4() != nil {
h.Write(ip.To4())
} else {
h.Write(ip.To16())
}
return float64(h.Sum32())
}
07070100000044000081A40000000000000000000000016463639800001D31000000000000000000000000000000000000002E00000000blackbox_exporter-0.24.0/prober/utils_test.go// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package prober
import (
"context"
"crypto/rand"
"crypto/rsa"
"crypto/x509"
"crypto/x509/pkix"
"encoding/pem"
"fmt"
"math/big"
"net"
"os"
"testing"
"time"
"github.com/go-kit/log"
"github.com/prometheus/client_golang/prometheus"
dto "github.com/prometheus/client_model/go"
)
// Check if expected results are in the registry
func checkRegistryResults(expRes map[string]float64, mfs []*dto.MetricFamily, t *testing.T) {
res := make(map[string]float64)
for i := range mfs {
res[mfs[i].GetName()] = mfs[i].Metric[0].GetGauge().GetValue()
}
for k, v := range expRes {
val, ok := res[k]
if !ok {
t.Fatalf("Expected metric %v not found in returned metrics", k)
}
if val != v {
t.Fatalf("Expected: %v: %v, got: %v: %v", k, v, k, val)
}
}
}
// Check if expected labels are in the registry
func checkRegistryLabels(expRes map[string]map[string]string, mfs []*dto.MetricFamily, t *testing.T) {
results := make(map[string]map[string]string)
for _, mf := range mfs {
result := make(map[string]string)
for _, metric := range mf.Metric {
for _, l := range metric.GetLabel() {
result[l.GetName()] = l.GetValue()
}
}
results[mf.GetName()] = result
}
for metric, labelValues := range expRes {
if _, ok := results[metric]; !ok {
t.Fatalf("Expected metric %v not found in returned metrics", metric)
}
for name, exp := range labelValues {
val, ok := results[metric][name]
if !ok {
t.Fatalf("Expected label %v for metric %v not found in returned metrics", val, name)
}
if val != exp {
t.Fatalf("Expected: %v{%q=%q}, got: %v{%q=%q}", metric, name, exp, metric, name, val)
}
}
}
}
func generateCertificateTemplate(expiry time.Time, IPAddressSAN bool) *x509.Certificate {
template := &x509.Certificate{
BasicConstraintsValid: true,
SubjectKeyId: []byte{1},
SerialNumber: big.NewInt(1),
Subject: pkix.Name{
CommonName: "Example",
Organization: []string{"Example Org"},
},
NotBefore: time.Now(),
NotAfter: expiry,
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageClientAuth, x509.ExtKeyUsageServerAuth},
KeyUsage: x509.KeyUsageDigitalSignature | x509.KeyUsageCertSign,
}
template.DNSNames = append(template.DNSNames, "localhost")
if IPAddressSAN {
template.IPAddresses = append(template.IPAddresses, net.ParseIP("127.0.0.1"))
template.IPAddresses = append(template.IPAddresses, net.ParseIP("::1"))
}
return template
}
func generateCertificate(template, parent *x509.Certificate, publickey *rsa.PublicKey, privatekey *rsa.PrivateKey) (*x509.Certificate, []byte) {
derCert, err := x509.CreateCertificate(rand.Reader, template, template, publickey, privatekey)
if err != nil {
panic(fmt.Sprintf("Error signing test-certificate: %s", err))
}
cert, err := x509.ParseCertificate(derCert)
if err != nil {
panic(fmt.Sprintf("Error parsing test-certificate: %s", err))
}
pemCert := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: derCert})
return cert, pemCert
}
func generateSignedCertificate(template, parentCert *x509.Certificate, parentKey *rsa.PrivateKey) (*x509.Certificate, []byte, *rsa.PrivateKey) {
privatekey, err := rsa.GenerateKey(rand.Reader, 2048)
if err != nil {
panic(fmt.Sprintf("Error creating rsa key: %s", err))
}
cert, pemCert := generateCertificate(template, parentCert, &privatekey.PublicKey, parentKey)
return cert, pemCert, privatekey
}
func generateSelfSignedCertificate(template *x509.Certificate) (*x509.Certificate, []byte, *rsa.PrivateKey) {
privatekey, err := rsa.GenerateKey(rand.Reader, 2048)
if err != nil {
panic(fmt.Sprintf("Error creating rsa key: %s", err))
}
publickey := &privatekey.PublicKey
cert, pemCert := generateCertificate(template, template, publickey, privatekey)
return cert, pemCert, privatekey
}
func generateSelfSignedCertificateWithPrivateKey(template *x509.Certificate, privatekey *rsa.PrivateKey) (*x509.Certificate, []byte) {
publickey := &privatekey.PublicKey
cert, pemCert := generateCertificate(template, template, publickey, privatekey)
return cert, pemCert
}
func TestChooseProtocol(t *testing.T) {
if testing.Short() {
t.Skip("skipping network dependent test")
}
ctx := context.Background()
registry := prometheus.NewPedanticRegistry()
w := log.NewSyncWriter(os.Stderr)
logger := log.NewLogfmtLogger(w)
ip, _, err := chooseProtocol(ctx, "ip4", true, "ipv6.google.com", registry, logger)
if err != nil {
t.Error(err)
}
if ip == nil || ip.IP.To4() != nil {
t.Error("with fallback it should answer")
}
registry = prometheus.NewPedanticRegistry()
ip, _, err = chooseProtocol(ctx, "ip4", false, "ipv6.google.com", registry, logger)
if err != nil && !err.(*net.DNSError).IsNotFound {
t.Error(err)
} else if err == nil {
t.Error("should set error")
}
if ip != nil {
t.Error("without fallback it should not answer")
}
}
func checkMetrics(expected map[string]map[string]map[string]struct{}, mfs []*dto.MetricFamily, t *testing.T) {
type (
valueValidation struct {
found bool
}
labelValidation struct {
found bool
values map[string]valueValidation
}
metricValidation struct {
found bool
labels map[string]labelValidation
}
)
foundMetrics := map[string]metricValidation{}
for mname, labels := range expected {
var mv metricValidation
if labels != nil {
mv.labels = map[string]labelValidation{}
for lname, values := range labels {
var lv labelValidation
if values != nil {
lv.values = map[string]valueValidation{}
for vname := range values {
lv.values[vname] = valueValidation{}
}
}
mv.labels[lname] = lv
}
}
foundMetrics[mname] = mv
}
for _, mf := range mfs {
info, wanted := foundMetrics[mf.GetName()]
if !wanted {
continue
}
info.found = true
for _, metric := range mf.GetMetric() {
if info.labels == nil {
continue
}
for _, lp := range metric.Label {
if label, labelWanted := info.labels[lp.GetName()]; labelWanted {
label.found = true
if label.values != nil {
if value, wanted := label.values[lp.GetValue()]; !wanted {
t.Fatalf("Unexpected label %s=%s", lp.GetName(), lp.GetValue())
} else if value.found {
t.Fatalf("Label %s=%s duplicated", lp.GetName(), lp.GetValue())
}
label.values[lp.GetValue()] = valueValidation{found: true}
}
info.labels[lp.GetName()] = label
}
}
}
foundMetrics[mf.GetName()] = info
}
for mname, m := range foundMetrics {
if !m.found {
t.Fatalf("metric %s wanted, not found", mname)
}
for lname, label := range m.labels {
if !label.found {
t.Fatalf("metric %s, label %s wanted, not found", mname, lname)
}
for vname, value := range label.values {
if !value.found {
t.Fatalf("metric %s, label %s, value %s wanted, not found", mname, lname, vname)
}
}
}
}
}
07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!600 blocks
