HTTP Endpoints
Plugin: go.d.plugin Module: httpcheck
Overview
This collector monitors HTTP servers availability and response time.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior
Auto-Detection
This integration doesn't support auto-detection.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per target
The metrics refer to the monitored target.
Labels:
Label | Description |
---|---|
url | url value that is set in the configuration file. |
Metrics:
Metric | Dimensions | Unit |
---|---|---|
httpcheck.response_time | time | ms |
httpcheck.response_length | length | characters |
httpcheck.status | success, no_connection, timeout, bad_content, bad_status | boolean |
httpcheck.in_state | time | boolean |
Alerts
There are no alerts configured by default for this integration.
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name for this integration is go.d/httpcheck.conf
.
You can edit the configuration file using the edit-config
script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/httpcheck.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
Config options
Name | Description | Default | Required |
---|---|---|---|
update_every | Data collection frequency. | 1 | no |
autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
url | Server URL. | yes | |
status_accepted | HTTP accepted response statuses. Anything else will result in 'bad status' in the status chart. | [200] | no |
response_match | If the status code is accepted, the content of the response will be matched against this regular expression. | no | |
cookie_file | Path to cookie file. See cookie file format. | no | |
timeout | HTTP request timeout. | 1 | no |
username | Username for basic HTTP authentication. | no | |
password | Password for basic HTTP authentication. | no | |
proxy_url | Proxy URL. | no | |
proxy_username | Username for proxy basic HTTP authentication. | no | |
proxy_password | Password for proxy basic HTTP authentication. | no | |
method | HTTP request method. | GET | no |
body | HTTP request body. | no | |
headers | HTTP request headers. | no | |
not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
tls_ca | Certification authority that the client uses when verifying the server's certificates. | no | |
tls_cert | Client TLS certificate. | no | |
tls_key | Client TLS key. | no |
Examples
Basic
A basic example configuration.
Config
jobs:
- name: local
url: http://127.0.0.1:8080
With status_accepted
A basic example configuration with non-default status_accepted.
Config
jobs:
- name: local
url: http://127.0.0.1:8080
status_accepted:
- 200
- 204
HTTP authentication
Basic HTTP authentication.
Config
jobs:
- name: local
url: http://127.0.0.1:8080
username: username
password: password
HTTPS with self-signed certificate
Do not validate server certificate chain and hostname.
Config
jobs:
- name: local
url: https://127.0.0.1:8080
tls_skip_verify: yes
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
Config
jobs:
- name: local
url: http://127.0.0.1:8080
- name: remote
url: http://192.0.2.1:8080
Troubleshooting
Debug Mode
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.
Navigate to the
plugins.d
directory, usually at/usr/libexec/netdata/plugins.d/
. If that's not the case on your system, opennetdata.conf
and look for theplugins
setting under[directories]
.cd /usr/libexec/netdata/plugins.d/
Switch to the
netdata
user.sudo -u netdata -s
Run the
go.d.plugin
to debug the collector:./go.d.plugin -d -m httpcheck
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.