diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-08-26 08:15:20 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-08-26 08:15:20 +0000 |
| commit | 87d772a7d708fec12f48cd8adc0dedff6e1025da (patch) | |
| tree | 1fee344c64cc3f43074a01981e21126c8482a522 /src/go/collectors/go.d.plugin/modules/httpcheck/metadata.yaml | |
| parent | Adding upstream version 1.46.3. (diff) | |
| download | netdata-upstream.tar.xz netdata-upstream.zip | |
Adding upstream version 1.47.0.upstream/1.47.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
| -rw-r--r-- | src/go/plugin/go.d/modules/httpcheck/metadata.yaml (renamed from src/go/collectors/go.d.plugin/modules/httpcheck/metadata.yaml) | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/httpcheck/metadata.yaml b/src/go/plugin/go.d/modules/httpcheck/metadata.yaml index 6b6b7d51c..f34993b5e 100644 --- a/src/go/collectors/go.d.plugin/modules/httpcheck/metadata.yaml +++ b/src/go/plugin/go.d/modules/httpcheck/metadata.yaml @@ -21,7 +21,19 @@ modules: overview: data_collection: metrics_description: | - This collector monitors HTTP servers availability and response time. + This collector monitors HTTP servers availability status and response time. + + Possible statuses: + + | Status | Description | + |---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | success | HTTP request completed successfully with a status code matching the configured `status_accepted` range (default: 200), and the response body and headers (if configured) match expectations. | + | timeout | HTTP request timed out before receiving a response (default: 1 second). | + | no_connection | Failed to establish a connection to the target. | + | redirect | Received a redirect response (3xx status code) while `not_follow_redirects` is configured. | + | bad_status | HTTP request completed with a status code outside the configured `status_accepted` range (default: non-200). | + | bad_content | HTTP request completed successfully but the response body does not match the expected content (when using `response_match`). | + | bad_header | HTTP request completed successfully but response headers do not match the expected values (when using `headers_match`). | method_description: "" supported_platforms: include: [] @@ -82,7 +94,7 @@ modules: default_value: "" required: true - name: headers_match.value - description: "The [pattern](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#supported-format) to match against the value of the specified header." + description: "The [pattern](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#supported-format) to match against the value of the specified header." default_value: "" required: false - name: cookie_file @@ -176,7 +188,7 @@ modules: - 200 - 204 - name: With `header_match` - description: Example configurations with `header_match`. See the value [pattern](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#supported-format) syntax. + description: Example configurations with `header_match`. See the value [pattern](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#supported-format) syntax. config: | jobs: # The "X-Robots-Tag" header must be present in the HTTP response header, |