Back to godoc.org
go.opentelemetry.io/collector/extension/healthcheckextension

package healthcheckextension

v0.4.0
Latest Go to latest
Published: Jun 16, 2020 | License: Apache-2.0 | Module: go.opentelemetry.io/collector

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

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.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
f or F : Jump to identifier