Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

health

package

Go to main page

Versions in this module

v1

v1.1.1

Feb 18, 2025

v1.1.0

Feb 17, 2025

Changes in this version

+ type CognitoChecker struct

+ CheckerName string

+ CognitoAPI cognitoidentityprovideriface.CognitoIdentityProviderAPI

+ CognitoClientID string

+ Timeout time.Duration

+ UserPoolId string

+ func (c *CognitoChecker) Check(ctx context.Context) error

+ func (c *CognitoChecker) GetTimeOut() time.Duration

+ func (c *CognitoChecker) Name() string

+ func (c *CognitoChecker) Type() string

v1.0.0

Feb 13, 2025

Changes in this version

+ func Handler(h *health.Health) http.Handler

+ func New(options ...health.Option) (*health.Health, error)

+ func NewComponent(config ComponentConfig) health.Component

+ func NewHealthOptions(config HealthOptionsConfig) []health.Option

+ func RegisterKafkaHealthChecks(h *health.Health, configs []SyncKafkaChecker, isAsync bool) error

+ func SetupHealthChecks(componentName, componentVersion string, enableSystemInfo bool, ...) (*health.Health, error)

+ func StartHealthCheckServer(h *health.Health, port string)

+ type AsyncChecker struct

+ func NewAsyncChecker(checker HealthChecker, interval time.Duration) *AsyncChecker

+ func (ac *AsyncChecker) HealthCheck() health.Component

+ func (ac *AsyncChecker) Start(ctx context.Context)

+ type AsyncCheckerComponent struct

+ func (ac *AsyncCheckerComponent) Check(ctx context.Context) error

+ func (ac *AsyncCheckerComponent) Name() string

+ func (ac *AsyncCheckerComponent) Type() string

+ type AsyncHealthStore struct

+ func NewAsyncHealthStore() *AsyncHealthStore

+ func (s *AsyncHealthStore) GetStatus(name string) error

+ func (s *AsyncHealthStore) UpdateStatus(name string, err error)

+ type AsyncKafkaChecker struct

+ func NewAsyncKafkaChecker(checker *KafkaChecker) *AsyncKafkaChecker

+ func (akc *AsyncKafkaChecker) Check(ctx context.Context) error

+ func (akc *AsyncKafkaChecker) Name() string

+ func (akc *AsyncKafkaChecker) Start(ctx context.Context)

+ func (akc *AsyncKafkaChecker) Type() string

+ func (k *AsyncKafkaChecker) GetTimeOut() time.Duration

+ type ComponentConfig struct

+ Name string

+ Version string

+ type ConsumerClient interface

+ Assignment func() ([]kafka.TopicPartition, error)

+ Committed func(partitions []kafka.TopicPartition, timeoutMs int) (offsets []kafka.TopicPartition, err error)

+ Position func(partitions []kafka.TopicPartition) (offsets []kafka.TopicPartition, err error)

+ type ConsumerOffsetStore struct

+ func NewConsumerOffsetStore() *ConsumerOffsetStore

+ func (s *ConsumerOffsetStore) GetOffsets(topic string, partition int32) (position kafka.Offset, commit kafka.Offset, exists bool)

+ func (s *ConsumerOffsetStore) SetOffsets(topic string, partition int32, position kafka.Offset, commit kafka.Offset)

+ type HTTPChecker struct

+ func NewHTTPChecker(config HTTPCheckerConfig) *HTTPChecker

+ func (c *HTTPChecker) Check(ctx context.Context) error

+ func (c *HTTPChecker) GetTimeOut() time.Duration

+ func (c *HTTPChecker) Name() string

+ func (c *HTTPChecker) Type() string

+ type HTTPCheckerConfig struct

+ ExpectedStatus int

+ Name string

+ Timeout time.Duration

+ URL string

+ type HealthChecker interface

+ Check func(ctx context.Context) error

+ GetTimeOut func() time.Duration

+ Name func() string

+ Type func() string

+ type HealthOptionsConfig struct

+ ComponentConfig ComponentConfig

+ SystemInfoEnabled bool

+ type KafkaChecker struct

+ func NewSyncKafkaChecker(checker SyncKafkaChecker, store *ConsumerOffsetStore) *KafkaChecker

+ func (k *KafkaChecker) Check(ctx context.Context) error

+ func (k *KafkaChecker) GetTimeOut() time.Duration

+ func (k *KafkaChecker) Name() string

+ func (k *KafkaChecker) Shutdown()

+ func (k *KafkaChecker) Type() string

+ type ProducerClient interface

+ GetMetadata func(topic *string, allTopics bool, timeoutMs int) (*kafka.Metadata, error)

+ type S3Checker struct

+ func NewS3Checker(config S3CheckerConfig) (*S3Checker, error)

+ func (c *S3Checker) Check(ctx context.Context) error

+ func (c *S3Checker) GetTimeOut() time.Duration

+ func (c *S3Checker) Name() string

+ func (c *S3Checker) Type() string

+ type S3CheckerConfig struct

+ BucketName string

+ Name string

+ Region string

+ S3Client s3iface.S3API

+ Timeout time.Duration

+ type SyncKafkaChecker struct

+ Consumer ConsumerClient

+ Interval time.Duration

+ MaxLag int64

+ Name string

+ Producer ProducerClient

+ RequiredTopics []string

+ Timeout time.Duration