healthcheckextension

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:

• endpoint (default = 0.0.0.0:13133): Address to publish the health check status to
• port (default = 13133): [deprecated] 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

• func NewFactory() component.ExtensionFactory
• type Config
  • func (cfg *Config) Validate() error

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"`
}

Config has the configuration for the extension enabling the health check extension, used to report the health status of the service.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the extension configuration is valid