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 confighttp.HTTPServerSettings `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.
Click to show internal directories.
Click to hide internal directories.