health

package

v0.3.1 Latest Latest Go to latest Published: Feb 21, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/caas-team/sparrow

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewCheck() checks.Check
type Config
- func (c *Config) For() string
- func (c *Config) Validate() error
type Health

Constants ¶

View Source

const CheckName = "health"

Variables ¶

This section is empty.

Functions ¶

func NewCheck ¶

func NewCheck() checks.Check

NewCheck creates a new instance of the health check

Types ¶

type Config ¶ added in v0.3.1

type Config struct {
	Targets  []string           `json:"targets,omitempty" yaml:"targets,omitempty"`
	Interval time.Duration      `json:"interval" yaml:"interval"`
	Timeout  time.Duration      `json:"timeout" yaml:"timeout"`
	Retry    helper.RetryConfig `json:"retry" yaml:"retry"`
}

Config defines the configuration parameters for a health check

func (*Config) For ¶ added in v0.3.1

func (c *Config) For() string

For returns the name of the check

func (*Config) Validate ¶ added in v0.3.1

func (c *Config) Validate() error

Validate checks if the configuration is valid

type Health ¶

type Health struct {
	checks.CheckBase
	// contains filtered or unexported fields
}

Health is a check that measures the availability of an endpoint

func (*Health) GetConfig ¶ added in v0.3.1

func (h *Health) GetConfig() checks.Runtime

GetConfig returns the current configuration of the check

func (*Health) GetMetricCollectors ¶

func (h *Health) GetMetricCollectors() []prometheus.Collector

GetMetricCollectors returns all metric collectors of check

func (*Health) Name ¶ added in v0.3.1

func (h *Health) Name() string

Name returns the name of the check

func (*Health) Run ¶

func (h *Health) Run(ctx context.Context, cResult chan checks.ResultDTO) error

Run starts the health check

func (*Health) Schema ¶

func (h *Health) Schema() (*openapi3.SchemaRef, error)

Schema provides the schema of the data that will be provided by the health check

func (*Health) SetConfig ¶

func (h *Health) SetConfig(cfg checks.Runtime) error

SetConfig sets the configuration for the health check

func (*Health) Shutdown ¶

func (h *Health) Shutdown(_ context.Context) error

Shutdown is called once when the check is unregistered or sparrow shuts down

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL