diff options
Diffstat (limited to '')
-rw-r--r-- | src/go/plugin/go.d/modules/httpcheck/integrations/http_endpoints.md (renamed from src/go/collectors/go.d.plugin/modules/httpcheck/integrations/http_endpoints.md) | 57 |
1 files changed, 52 insertions, 5 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/httpcheck/integrations/http_endpoints.md b/src/go/plugin/go.d/modules/httpcheck/integrations/http_endpoints.md index feb3133cd..b94735dee 100644 --- a/src/go/collectors/go.d.plugin/modules/httpcheck/integrations/http_endpoints.md +++ b/src/go/plugin/go.d/modules/httpcheck/integrations/http_endpoints.md @@ -1,6 +1,6 @@ <!--startmeta -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/httpcheck/README.md" -meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/httpcheck/metadata.yaml" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/httpcheck/README.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/httpcheck/metadata.yaml" sidebar_label: "HTTP Endpoints" learn_status: "Published" learn_rel_path: "Collecting Metrics/Synthetic Checks" @@ -21,7 +21,19 @@ Module: httpcheck ## Overview -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`). | @@ -117,7 +129,7 @@ The following options can be defined globally: update_every, autodetection_retry | headers_match | This option defines a set of rules that check for specific key-value pairs in the HTTP headers of the response. | [] | no | | headers_match.exclude | This option determines whether the rule should check for the presence of the specified key-value pair or the absence of it. | no | no | | headers_match.key | The exact name of the HTTP header to check for. | | yes | -| headers_match.value | 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. | | no | +| headers_match.value | 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. | | no | | cookie_file | Path to cookie file. See [cookie file format](https://everything.curl.dev/http/cookies/fileformat). | | no | | timeout | HTTP request timeout. | 1 | no | | username | Username for basic HTTP authentication. | | no | @@ -189,7 +201,7 @@ jobs: ##### With `header_match` -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. +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. <details open><summary>Config</summary> @@ -292,6 +304,8 @@ jobs: ### Debug Mode +**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature. + To troubleshoot issues with the `httpcheck` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. @@ -314,4 +328,37 @@ should give you clues as to why the collector isn't working. ./go.d.plugin -d -m httpcheck ``` +### Getting Logs + +If you're encountering problems with the `httpcheck` collector, follow these steps to retrieve logs and identify potential issues: + +- **Run the command** specific to your system (systemd, non-systemd, or Docker container). +- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem. + +#### System with systemd + +Use the following command to view logs generated since the last Netdata service restart: + +```bash +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep httpcheck +``` + +#### System without systemd + +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name: + +```bash +grep httpcheck /var/log/netdata/collector.log +``` + +**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues. + +#### Docker Container + +If your Netdata runs in a Docker container named "netdata" (replace if different), use this command: + +```bash +docker logs netdata 2>&1 | grep httpcheck +``` + |