documentation.md

httpcheck

Default Metrics

The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

metrics:
  <metric_name>:
    enabled: false

httpcheck.duration

Measures the duration of the HTTP check.

Unit	Metric Type	Value Type	Stability
ms	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-

httpcheck.error

Records errors occurring during HTTP check.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic	Stability
{error}	Sum	Int	Cumulative	false	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-
error.message	Error message recorded during check	Any Str	Recommended	-

httpcheck.status

1 if the check resulted in status_code matching the status_class, otherwise 0.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic	Stability
1	Sum	Int	Cumulative	false	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-
http.status_code	HTTP response status code	Any Int	Recommended	-
http.method	HTTP request method	Any Str	Recommended	-
http.status_class	HTTP response status class	Any Str	Recommended	-

Optional Metrics

The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:

metrics:
  <metric_name>:
    enabled: true

httpcheck.client.connection.duration

Time spent establishing TCP connection to the endpoint.

Unit	Metric Type	Value Type	Stability
ms	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-
network.transport	OSI transport layer or inter-process communication method.	Any Str	Recommended	-

httpcheck.client.request.duration

Time spent sending the HTTP request to the endpoint.

Unit	Metric Type	Value Type	Stability
ms	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-

httpcheck.dns.lookup.duration

Time spent performing DNS lookup for the endpoint.

Unit	Metric Type	Value Type	Stability
ms	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-

httpcheck.response.duration

Time spent receiving the HTTP response from the endpoint.

Unit	Metric Type	Value Type	Stability
ms	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-

httpcheck.response.size

Size of response body in bytes.

Unit	Metric Type	Value Type	Stability
By	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-

httpcheck.tls.cert_remaining

Time in seconds until certificate expiry, as specified by NotAfter field in the x.509 certificate. Negative values represent time in seconds since expiration.

Unit	Metric Type	Value Type	Stability
s	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-
http.tls.issuer	The entity that issued the certificate.	Any Str	Recommended	-
http.tls.cn	The commonName in the subject of the certificate.	Any Str	Recommended	-
http.tls.san	The Subject Alternative Name of the certificate.	Any Slice	Recommended	-

httpcheck.tls.handshake.duration

Time spent performing TLS handshake with the endpoint.

Unit	Metric Type	Value Type	Stability
ms	Gauge	Int	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-

httpcheck.validation.failed

Number of response validations that failed.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic	Stability
{validation}	Sum	Int	Cumulative	false	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-
validation.type	Type of validation performed (contains, json_path, size, regex)	Any Str	Recommended	-

httpcheck.validation.passed

Number of response validations that passed.

Unit	Metric Type	Value Type	Aggregation Temporality	Monotonic	Stability
{validation}	Sum	Int	Cumulative	false	Development

Attributes

Name	Description	Values	Requirement Level	Semantic Convention
http.url	Full HTTP request URL.	Any Str	Recommended	-
validation.type	Type of validation performed (contains, json_path, size, regex)	Any Str	Recommended	-