README
¶
Health Check
Health Check extension enables an HTTP url that can be probed to check the status of the the OpenTelemetry Collector. This extension can be used as a liveness and/or readiness probe on Kubernetes.
The following settings are required:
port(default = 13133): What port to expose HTTP health information.
Example:
extensions:
health_check:
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 ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
configmodels.ExtensionSettings `mapstructure:",squash"`
// Port is the port used to publish the health check status.
// The default value is 13133.
Port uint16 `mapstructure:"port"`
}
Config has the configuration for the extension enabling the health check extension, used to report the health status of the service.
type Factory ¶
type Factory struct {
}
ExtensionFactory is the factory for the extension.
func (*Factory) CreateDefaultConfig ¶
func (f *Factory) CreateDefaultConfig() configmodels.Extension
CreateDefaultConfig creates the default configuration for the extension.
func (*Factory) CreateExtension ¶
func (f *Factory) CreateExtension(_ context.Context, params component.ExtensionCreateParams, cfg configmodels.Extension) (component.ServiceExtension, error)
CreateExtension creates the extension based on this config.
func (*Factory) Type ¶
func (f *Factory) Type() configmodels.Type
Type gets the type of the config created by this factory.
Source Files