README
¶
Health Check
| Status | |
|---|---|
| Stability | beta |
| Distributions | contrib |
Health Check extension enables an HTTP url that can be probed to check the status of the OpenTelemetry Collector. This extension can be used as a liveness and/or readiness probe on Kubernetes.
There is an optional configuration check_collector_pipeline which allows
users to enable health check for the collector pipeline. This feature can
monitor the number of times that components failed send data to the destinations.
It only supports monitoring exporter failures and will support receivers and
processors in the future.
The following settings are required:
endpoint(default = 0.0.0.0:13133): Address to publish the health check status toport(default = 13133): [deprecated] What port to expose HTTP health information.path(default = "/"): Specifies the path to be configured for the health check server.check_collector_pipeline:(optional): Settings of collector pipeline health checkenabled(default = false): Whether enable collector pipeline check or notinterval(default = "5m"): Time interval to check the number of failuresexporter_failure_threshold(default = 5): The failure number threshold to mark containers as healthy.
Example:
extensions:
health_check:
health_check/1:
endpoint: "localhost:13"
path: "/health/status"
check_collector_pipeline:
enabled: true
interval: "5m"
exporter_failure_threshold: 5
The full list of settings exposed for this exporter is documented here with detailed sample configurations here.
Documentation
¶
Overview ¶
Package healthcheckextension implements an extension that enables an HTTP endpoint that can be used to check the overall health and status of the service.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewFactory ¶
func NewFactory() component.ExtensionFactory
NewFactory creates a factory for HealthCheck extension.
Types ¶
type Config ¶
type Config struct {
config.ExtensionSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
// Port is the port used to publish the health check status.
// The default value is 13133.
// Deprecated: use Endpoint instead.
Port uint16 `mapstructure:"port"`
// TCPAddr represents a tcp endpoint address that is to publish the health
// check status.
// The default endpoint is "0.0.0.0:13133".
TCPAddr confignet.TCPAddr `mapstructure:",squash"`
// Path represents the path the health check service will serve.
// The default path is "/".
Path string `mapstructure:"path"`
// CheckCollectorPipeline contains the list of settings of collector pipeline health check
CheckCollectorPipeline checkCollectorPipelineSettings `mapstructure:"check_collector_pipeline"`
}
Config has the configuration for the extension enabling the health check extension, used to report the health status of the service.
Source Files