integration-docs
HTTP Check Integration for Elastic
Serverless Observability Serverless Security Stack
| Version | 0.1.0 (View all) |
| Subscription level What's this? |
Basic |
| Developed by What's this? |
Elastic |
To use beta integrations, go to the Integrations page in Kibana, scroll down, and toggle on the Display beta integrations option.
The HTTP Check integration for Elastic performs HTTP checks using the HTTP check receiver of the OTel Collector.
This integration can be used to monitor the availability of HTTP endpoints.
This integration performs periodic HTTP checks to the configured endpoints.
Apart from the endpoints, it is also possible to select the HTTP method and headers to use in the requests.
This integration collects metrics with information about the availability of the HTTP endpoints, and the status codes returned by requests.
Key metrics are stored under the metrics object, and they include:
| Metric Name | Description | Type |
|---|---|---|
| httpcheck.status | For each status class (1xx, 2xx, 3xx, 4xx or 5xx), it is set to 1 if the check returned an status of this class, to 0 otherwise. | Gauge |
| httpcheck.duration | Total duration of the request in milliseconds. | Gauge |
Documents for these metrics include attributes that follow Semantic Conventions for HTTP data.
This integration can be used to monitor the availability of HTTP endpoints. In a more general sense, it can be used to perform requests to specific endpoints.
Elastic Agent must be installed. For more details, check the Elastic Agent installation instructions. You can install only one Elastic Agent per host.
Elastic Agent is required to have network connectivity with the monitored endpoints.
This integration needs to be configured with the list of endpoints to monitor, and the HTTP method and headers that should be used on the requests.
With each policy you can monitor multiple endpoints that require the same method
and headers. For example you can use a single policy to monitor multiple
endpoints if you only need to check its availability with the GET method.
In cases where different headers or methods are required, multiple policies must be created, one for each combination of configurations.
Once configured, you can find documents with information about the status code of the requests done to the configured endpoints.
For help with Elastic ingest tools, check Common problems.
For more information on architectures that can be used for scaling this integration, check the Ingest Architectures documentation.
This package uses the HTTP Check Receiver of the OTel collector.
Changelog
| Version | Details | Kibana version(s) |
|---|---|---|
| 0.1.0 | Enhancement (View pull request) Initial version of the package |
— |