health

package

v1.15.5 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 7 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

This section is empty.

This section is empty.

func ConfigAdd(path string)

func Register(ctx context.Context, client *elasticsearch.Client) error

type Checker struct {
	// contains filtered or unexported fields
}

Checker represents elasticsearch health check.

func NewChecker(client *elasticsearch.Client) *Checker

NewChecker creates the elasticsearch health check.

func (c *Checker) Check(ctx context.Context) error

Check checks if elasticsearch is responding.

type Health struct {
	// contains filtered or unexported fields
}

Health represents elasticsearch health.

func NewHealth() *Health

NewHealth returns a health with default options.

func NewHealthWithConfigPath(path string) (*Health, error)

NewHealthWithConfigPath returns a health with options from config path.

func NewHealthWithOptions(options *Options) *Health

NewHealthWithOptions returns a health with the options provided.

func (i *Health) Register(ctx context.Context, client *elasticsearch.Client) error

Register registers a new checker in the health package.

type Options struct {
	Name        string
	Enabled     bool
	Description string
	Required    bool
}

Options represents health options.

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.