Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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
- API
  
  Reference documentation for the pkg.go.dev API
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

clientkit

package module

Go to main page

Versions in this module

v0

v0.3.0

Aug 16, 2026

v0.2.0

Aug 13, 2026

v0.1.0

Aug 13, 2026

Changes in this version

+ const DefaultMaxConcurrentChecks

+ const DefaultMaxHealthMessageBytes

+ const MaxClientNameBytes

+ const MaxClientProtocolBytes

+ func ValidateClientName(name string) error

+ func ValidateClientProtocol(protocol string) error

+ type AttemptEvent struct

+ Attributes []opskit.Attribute

+ Client string

+ Duration time.Duration

+ EndedAt time.Time

+ Err error

+ FailureClass FailureClass

+ Number int

+ Operation string

+ Outcome string

+ Protocol string

+ StartedAt time.Time

+ Succeeded bool

+ type Client struct

+ func New(cfg Config) (*Client, error)

+ func (c *Client) Health() Health

+ func (c *Client) Name() string

+ func (c *Client) Observer() Observer

+ func (c *Client) ReadinessPolicy() ReadinessPolicy

+ func (c *Client) UpdateHealth(health Health) Health

+ type ClientSnapshot struct

+ Health Health

+ Name string

+ Protocol string

+ ReadinessPolicy ReadinessPolicy

+ type Config struct

+ DisableHealthSanitizer bool

+ HealthSanitizer HealthSanitizer

+ Name string

+ Observer Observer

+ ReadinessPolicy ReadinessPolicy

+ func (cfg Config) Validate() error

+ type FailureClass string

+ const FailureCanceled

+ const FailureConfiguration

+ const FailureConnectionClosed

+ const FailureConnectionRefused

+ const FailureConnectionReset

+ const FailureNameResolution

+ const FailureNone

+ const FailurePolicy

+ const FailureRemoteResponse

+ const FailureRequest

+ const FailureTLS

+ const FailureTimeout

+ const FailureTransport

+ type Health struct

+ CheckedAt time.Time

+ Duration time.Duration

+ FailureClass FailureClass

+ Message string

+ State HealthState

+ func DefaultHealthSanitizer(_ string, health Health) Health

+ func (h Health) IsHealthy() bool

+ func (h Health) IsReady(policy ReadinessPolicy) bool

+ type HealthAssessment struct

+ FailureClass FailureClass

+ Message string

+ State HealthState

+ type HealthCheckConfigurable interface

+ HealthCheckEnabled func() bool

+ type HealthChecker interface

+ Check func(context.Context) Health

+ type HealthEvent struct

+ Attributes []opskit.Attribute

+ CheckedAt time.Time

+ Client string

+ Duration time.Duration

+ FailureClass FailureClass

+ Message string

+ Protocol string

+ State HealthState

+ type HealthSanitizer func(clientName string, health Health) Health

+ type HealthState string

+ const HealthDegraded

+ const HealthHealthy

+ const HealthUnhealthy

+ const HealthUnknown

+ type IdleConnectionCloser interface

+ CloseIdleConnections func()

+ type NopObserver struct

+ func (NopObserver) ObserveAttempt(context.Context, AttemptEvent)

+ func (NopObserver) ObserveHealth(context.Context, HealthEvent)

+ func (NopObserver) ObserveRetry(context.Context, RetryEvent)

+ func (NopObserver) StartOperation(ctx context.Context, _ OperationStartEvent) (context.Context, OperationObservation)

+ type NopOperationObservation struct

+ func (NopOperationObservation) End(context.Context, OperationEndEvent)

+ type Observer interface

+ ObserveAttempt func(context.Context, AttemptEvent)

+ ObserveHealth func(context.Context, HealthEvent)

+ ObserveRetry func(context.Context, RetryEvent)

+ StartOperation func(context.Context, OperationStartEvent) (context.Context, OperationObservation)

+ func MultiObserver(observers ...Observer) Observer

+ func SafeObserver(observer Observer) Observer

+ type OperationEndEvent struct

+ Attempts int

+ Attributes []opskit.Attribute

+ Client string

+ Duration time.Duration

+ EndedAt time.Time

+ Err error

+ FailureClass FailureClass

+ Operation string

+ Outcome string

+ Protocol string

+ StartedAt time.Time

+ Succeeded bool

+ type OperationKind uint8

+ const OperationKindLogical

+ const OperationKindRemote

+ type OperationObservation interface

+ End func(context.Context, OperationEndEvent)

+ type OperationObservationFunc func(context.Context, OperationEndEvent)

+ func (fn OperationObservationFunc) End(ctx context.Context, event OperationEndEvent)

+ type OperationStartEvent struct

+ Attributes []opskit.Attribute

+ Client string

+ Kind OperationKind

+ Operation string

+ Protocol string

+ StartedAt time.Time

+ type ReadinessPolicy string

+ const ReadinessDegradedAllowed

+ const ReadinessInformational

+ const ReadinessOptional

+ const ReadinessRequired

+ func (policy ReadinessPolicy) BlocksReadiness() bool

+ type RegisteredClient interface

+ Health func() Health

+ Name func() string

+ Protocol func() string

+ ReadinessPolicy func() ReadinessPolicy

+ type Registry struct

+ func NewRegistry() *Registry

+ func NewRegistryWithConfig(cfg RegistryConfig) (*Registry, error)

+ func (r *Registry) CheckAll(ctx context.Context) opskit.CheckSummary

+ func (r *Registry) CloseIdleConnections()

+ func (r *Registry) ComponentInfo() opskit.ComponentInfo

+ func (r *Registry) Get(name string) (RegisteredClient, bool)

+ func (r *Registry) Inspect(ctx context.Context) (opskit.Inspection, error)

+ func (r *Registry) MustRegister(client RegisteredClient)

+ func (r *Registry) MustRegisterAll(clients ...RegisteredClient)

+ func (r *Registry) Readiness(context.Context) opskit.Readiness

+ func (r *Registry) Register(client RegisteredClient) error

+ func (r *Registry) RegisterAll(clients ...RegisteredClient) error

+ func (r *Registry) Snapshot() RegistrySnapshot

+ func (r *Registry) Status(context.Context) opskit.Status

+ type RegistryConfig struct

+ ComponentInfo opskit.ComponentInfo

+ DisableHealthSanitizer bool

+ HealthSanitizer HealthSanitizer

+ MaxConcurrentChecks int

+ func DefaultRegistryConfig() RegistryConfig

+ type RegistrySnapshot struct

+ Clients []ClientSnapshot

+ type RetryEvent struct

+ AfterAttempt int

+ At time.Time

+ Attributes []opskit.Attribute

+ Cause string

+ Client string

+ Delay time.Duration

+ FailureClass FailureClass

+ Operation string

+ Protocol string