commit 7dc291e222f23a4df997b20c3988a8d8034d8de2 Author: Artёm Mishin Date: Fri Apr 25 15:25:07 2025 +0300 add health module with component probing and controller implementation diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..10be536 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +/vendor +/.bench +*.mem +*.cpu +*.test +*.log +*.out +*.html +*.coverprofile +coverage.txt +*.pprof +/.bin +/.cache +/bin +.vscode +.mdoxcache +.idea \ No newline at end of file diff --git a/component.go b/component.go new file mode 100644 index 0000000..47804b5 --- /dev/null +++ b/component.go @@ -0,0 +1,81 @@ +package health + +import ( + "context" + "go.uber.org/fx" + "universe.mrlokop.dev/core/app" + "universe.mrlokop.dev/core/modules" +) + +var ( + DefaultComponentGroup = "universe:health:component" + DefaultComponentTag = app.Group(DefaultComponentGroup) +) + +type ProbableComponent interface { + modules.Component + Probe(ctx context.Context) (*ComponentStatus, error) +} + +type ComponentStatus struct { + IsHealthy bool + IsReady bool + + Message string + URL string + Additional map[string]string + Error error +} + +type ComponentConfiguration struct { + IsDisabled bool `mapstructure:"disabled"` + Group string `mapstructure:"group"` +} + +type simpleProbableComponent struct { + kind string + id string + + prober func(context.Context) (*ComponentStatus, error) +} + +func (s *simpleProbableComponent) ComponentKind() string { + return s.kind +} + +func (s *simpleProbableComponent) ComponentId() string { + return s.id +} + +func (s *simpleProbableComponent) Probe(ctx context.Context) (*ComponentStatus, error) { + return s.prober(ctx) +} + +func SimpleComponent(kind, id string, prober func(context.Context) (*ComponentStatus, error)) ProbableComponent { + return &simpleProbableComponent{kind: kind, id: id, prober: prober} +} + +func SimpleComponentProvider(kind, id string, prober func(context.Context) (*ComponentStatus, error)) any { + return SimpleComponentProviderTagged(kind, id, DefaultComponentTag, prober) +} + +func SimpleComponentProviderTagged(kind, id, tag string, prober func(context.Context) (*ComponentStatus, error)) any { + return fx.Annotate( + func() ProbableComponent { + return SimpleComponent(kind, id, prober) + }, + fx.ResultTags(tag), + ) +} + +func SimpleComponentConfigured(ctx modules.ModuleFactoryContext, config ComponentConfiguration, prober func(context.Context) (*ComponentStatus, error)) any { + if config.IsDisabled { + return fx.Options() + } + + if config.Group == "" { + config.Group = DefaultComponentGroup + } + + return fx.Provide(SimpleComponentProviderTagged(ctx.Kind(), ctx.Id(), app.Group(config.Group), prober)) +} diff --git a/controller.go b/controller.go new file mode 100644 index 0000000..771bdae --- /dev/null +++ b/controller.go @@ -0,0 +1,51 @@ +package health + +import "context" + +type Controller interface { + ProbeAll(ctx context.Context) ([]*ControllerComponentStatus, error) +} + +type ControllerComponentStatus struct { + IsHealthy bool `json:"is_healthy"` + IsReady bool `json:"is_ready"` + + Message string `json:"message"` + URL string `json:"url"` + Additional map[string]string `json:"additional"` + Error error +} + +type controllerImpl struct { + components []ProbableComponent +} + +func (c *controllerImpl) ProbeAll(ctx context.Context) ([]*ControllerComponentStatus, error) { + result := make([]*ControllerComponentStatus, len(c.components)) + for i, p := range c.components { + status, err := p.Probe(ctx) + if err != nil { + result[i] = &ControllerComponentStatus{ + IsHealthy: false, + IsReady: false, + + Message: err.Error(), + Error: err, + } + } else { + result[i] = &ControllerComponentStatus{ + IsHealthy: status.IsHealthy, + IsReady: status.IsReady, + Message: status.Message, + URL: status.URL, + Additional: status.Additional, + Error: status.Error, + } + } + } + return result, nil +} + +func NewControllerFor(components ...ProbableComponent) Controller { + return &controllerImpl{components: components} +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..3ff08e2 --- /dev/null +++ b/go.mod @@ -0,0 +1,31 @@ +module universe.mrlokop.dev/health + +go 1.24 + +require ( + github.com/dgraph-io/badger/v4 v4.7.0 + go.uber.org/fx v1.23.0 + go.uber.org/zap v1.27.0 + universe.mrlokop.dev/core v0.0.0-20250425120025-e03e3e15149c + universe.mrlokop.dev/key_value v0.0.0-20250425095422-3bc81641894a +) + +require ( + github.com/cespare/xxhash/v2 v2.3.0 // indirect + github.com/dgraph-io/ristretto/v2 v2.2.0 // indirect + github.com/dustin/go-humanize v1.0.1 // indirect + github.com/go-logr/logr v1.4.2 // indirect + github.com/go-logr/stdr v1.2.2 // indirect + github.com/google/flatbuffers v25.2.10+incompatible // indirect + github.com/klauspost/compress v1.18.0 // indirect + github.com/mitchellh/mapstructure v1.5.0 // indirect + go.opentelemetry.io/auto/sdk v1.1.0 // indirect + go.opentelemetry.io/otel v1.35.0 // indirect + go.opentelemetry.io/otel/metric v1.35.0 // indirect + go.opentelemetry.io/otel/trace v1.35.0 // indirect + go.uber.org/dig v1.18.1 // indirect + go.uber.org/multierr v1.11.0 // indirect + golang.org/x/net v0.39.0 // indirect + golang.org/x/sys v0.32.0 // indirect + google.golang.org/protobuf v1.36.6 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..4c5d7ab --- /dev/null +++ b/go.sum @@ -0,0 +1,69 @@ +github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= +github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgraph-io/badger/v4 v4.7.0 h1:Q+J8HApYAY7UMpL8d9owqiB+odzEc0zn/aqOD9jhc6Y= +github.com/dgraph-io/badger/v4 v4.7.0/go.mod h1:He7TzG3YBy3j4f5baj5B7Zl2XyfNe5bl4Udl0aPemVA= +github.com/dgraph-io/ristretto/v2 v2.2.0 h1:bkY3XzJcXoMuELV8F+vS8kzNgicwQFAaGINAEJdWGOM= +github.com/dgraph-io/ristretto/v2 v2.2.0/go.mod h1:RZrm63UmcBAaYWC1DotLYBmTvgkrs0+XhBd7Npn7/zI= +github.com/dgryski/go-farm v0.0.0-20240924180020-3414d57e47da h1:aIftn67I1fkbMa512G+w+Pxci9hJPB8oMnkcP3iZF38= +github.com/dgryski/go-farm v0.0.0-20240924180020-3414d57e47da/go.mod h1:SqUrOPUnsFjfmXRMNPybcSiG0BgUW2AuFH8PAnS2iTw= +github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY= +github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= +github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= +github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= +github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= +github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= +github.com/google/flatbuffers v25.2.10+incompatible h1:F3vclr7C3HpB1k9mxCGRMXq6FdUalZ6H/pNX4FP1v0Q= +github.com/google/flatbuffers v25.2.10+incompatible/go.mod h1:1AeVuKshWv4vARoZatz6mlQ0JxURH0Kv5+zNeJKJCa8= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zttxdo= +github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ= +github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= +github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= +go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= +go.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ= +go.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y= +go.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M= +go.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE= +go.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs= +go.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc= +go.uber.org/dig v1.18.0 h1:imUL1UiY0Mg4bqbFfsRQO5G4CGRBec/ZujWTvSVp3pw= +go.uber.org/dig v1.18.0/go.mod h1:Us0rSJiThwCv2GteUN0Q7OKvU7n5J4dxZ9JKUXozFdE= +go.uber.org/dig v1.18.1 h1:rLww6NuajVjeQn+49u5NcezUJEGwd5uXmyoCKW2g5Es= +go.uber.org/dig v1.18.1/go.mod h1:Us0rSJiThwCv2GteUN0Q7OKvU7n5J4dxZ9JKUXozFdE= +go.uber.org/fx v1.23.0 h1:lIr/gYWQGfTwGcSXWXu4vP5Ws6iqnNEIY+F/aFzCKTg= +go.uber.org/fx v1.23.0/go.mod h1:o/D9n+2mLP6v1EG+qsdT1O8wKopYAsqZasju97SDFCU= +go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= +go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= +go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ= +go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= +go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8= +go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= +golang.org/x/net v0.38.0 h1:vRMAPTMaeGqVhG5QyLJHqNDwecKTomGeqbnfZyKlBI8= +golang.org/x/net v0.38.0/go.mod h1:ivrbrMbzFq5J41QOQh0siUuly180yBYtLp+CKbEaFx8= +golang.org/x/net v0.39.0 h1:ZCu7HMWDxpXpaiKdhzIfaltL9Lp31x/3fCP11bc6/fY= +golang.org/x/net v0.39.0/go.mod h1:X7NRbYVEA+ewNkCNyJ513WmMdQ3BineSwVtN2zD/d+E= +golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik= +golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20= +golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY= +google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +universe.mrlokop.dev/core v0.0.0-20250425095444-a3ab13975a72 h1:ZghU34DrFkSFl++UOc1DL8A9DQ8zObdf4xJIyzq76xM= +universe.mrlokop.dev/core v0.0.0-20250425095444-a3ab13975a72/go.mod h1:1xEErU5FKve38at9zd2RZDDbojuebd9rGpWzeUD4zu4= +universe.mrlokop.dev/core v0.0.0-20250425120025-e03e3e15149c h1:WqlSZM2ZPB/OpagR1chJ5uI8Y9scH0sdS4Nqvx31FLc= +universe.mrlokop.dev/core v0.0.0-20250425120025-e03e3e15149c/go.mod h1:1xEErU5FKve38at9zd2RZDDbojuebd9rGpWzeUD4zu4= +universe.mrlokop.dev/key_value v0.0.0-20250425095422-3bc81641894a h1:hVjSMyianC6TB0baoIbJ0IIONsvEx6USPAg2+6+/kHA= +universe.mrlokop.dev/key_value v0.0.0-20250425095422-3bc81641894a/go.mod h1:WNqaFQruy5ich5wzhivNQf6PljJ9QxiBJ8gmvJMemG4= diff --git a/health.go b/health.go new file mode 100644 index 0000000..ed0adf4 --- /dev/null +++ b/health.go @@ -0,0 +1,40 @@ +package health + +import ( + "go.uber.org/fx" + "universe.mrlokop.dev/core/app" + um "universe.mrlokop.dev/core/modules" +) + +type moduleConfig struct { + Group string `mapstructure:"group"` +} + +const ( + kind = "universe:health:controller" +) + +var ( + Module = um.SimpleModule(kind, func(ctx um.ModuleFactoryContext) error { + cfg := &moduleConfig{} + err := ctx.ExtractConfig(cfg) + if err != nil { + return err + } + + if cfg.Group == "" { + cfg.Group = DefaultComponentGroup + } + + ctx.Provide(fx.Annotate( + func(components []ProbableComponent) Controller { + return &controllerImpl{ + components: components, + } + }, + fx.ParamTags(app.Group(cfg.Group)), + )) + + return nil + }) +)