go.d httpcheck: add status description to docs (#18351)
Ilya Mashchenko committed
Aug 16, 2024 at 18:28 UTC
78d7acee87a9f143be4b4d78c60eb3d658ed8f80
1 file changed
+13
-1
src/go/plugin/go.d/modules/httpcheck/metadata.yaml
+13
-1
@@ -21,7 +21,19 @@ modules:
21
overview:
22
data_collection:
23
metrics_description: |
24
- This collector monitors HTTP servers availability and response time.
24
+ This collector monitors HTTP servers availability status and response time.
25
+
26
+ Possible statuses:
27
+
28
+ | Status | Description |
29
+ |---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
30
+ | 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. |
31
+ | timeout | HTTP request timed out before receiving a response (default: 1 second). |
32
+ | no_connection | Failed to establish a connection to the target. |
33
+ | redirect | Received a redirect response (3xx status code) while `not_follow_redirects` is configured. |
34
+ | bad_status | HTTP request completed with a status code outside the configured `status_accepted` range (default: non-200). |
35
+ | bad_content | HTTP request completed successfully but the response body does not match the expected content (when using `response_match`). |
36
+ | bad_header | HTTP request completed successfully but response headers do not match the expected values (when using `headers_match`). |
37
method_description: ""
38
supported_platforms:
39
include: []