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
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

discovery

package module

Go to main page

Versions in this module

v1

v1.3.1

Mar 14, 2026

v1.3.0

Mar 12, 2026

v1.2.0

Mar 7, 2026

v1.0.0

Mar 1, 2026

v0

v0.10.0

Feb 24, 2026

v0.9.12

Feb 18, 2026

v0.9.11

Feb 17, 2026

v0.9.10

Feb 16, 2026

v0.9.9

Feb 15, 2026

Changes in this version

type ConfigOption

+ func WithAutoDeregister(enabled bool) ConfigOption

+ func WithFARP(farp FARPConfig) ConfigOption

+ func WithFARPAutoRegister(autoRegister bool) ConfigOption

+ func WithFARPCapabilities(capabilities ...string) ConfigOption

+ func WithFARPEnabled(enabled bool) ConfigOption

+ func WithFARPEndpoints(endpoints FARPEndpointsConfig) ConfigOption

+ func WithFARPSchemas(schemas ...FARPSchemaConfig) ConfigOption

+ func WithFARPStrategy(strategy string) ConfigOption

+ func WithMDNSBrowseTimeout(d time.Duration) ConfigOption

+ func WithMDNSIPv6(enabled bool) ConfigOption

+ func WithMDNSInterface(iface string) ConfigOption

+ func WithMDNSServiceType(serviceType string) ConfigOption

+ func WithMDNSServiceTypes(types ...string) ConfigOption

+ func WithMDNSTTL(ttl uint32) ConfigOption

+ func WithMDNSWatchInterval(d time.Duration) ConfigOption

+ func WithServiceID(id string) ConfigOption

+ func WithServiceVersion(version string) ConfigOption

v0.9.7

Feb 11, 2026

v0.9.6

Feb 11, 2026

v0.9.5

Feb 10, 2026

v0.9.4

Feb 10, 2026

v0.9.3

Feb 10, 2026

v0.9.2

Feb 10, 2026

v0.9.1

Feb 8, 2026

v0.9.0

Feb 8, 2026

Changes in this version

+ const HealthStatusCritical

+ const HealthStatusPassing

+ const HealthStatusUnknown

+ const HealthStatusWarning

+ const ServiceKey

+ const ServiceKeyLegacy

+ func NewExtension(opts ...ConfigOption) forge.Extension

+ func NewExtensionWithConfig(config Config) forge.Extension

+ type Backend = backends.Backend

+ type Config struct

+ Backend string

+ Consul ConsulConfig

+ Enabled bool

+ Etcd EtcdConfig

+ Eureka EurekaConfig

+ FARP FARPConfig

+ HealthCheck HealthCheckConfig

+ Kubernetes KubernetesConfig

+ MDNS MDNSConfig

+ Service ServiceConfig

+ Watch WatchConfig

+ func DefaultConfig() Config

+ type ConfigOption func(*Config)

+ func WithAppConfig(appConfig forge.AppConfig) ConfigOption

+ func WithBackend(backend string) ConfigOption

+ func WithConfig(config Config) ConfigOption

+ func WithConsul(address, token string) ConfigOption

+ func WithEnabled(enabled bool) ConfigOption

+ func WithEtcd(endpoints []string) ConfigOption

+ func WithEureka(urls []string) ConfigOption

+ func WithHTTPHealthCheck(endpoint string, interval time.Duration) ConfigOption

+ func WithHealthCheck(config HealthCheckConfig) ConfigOption

+ func WithKubernetes(namespace string, inCluster bool) ConfigOption

+ func WithMDNS(domain string) ConfigOption

+ func WithService(service ServiceConfig) ConfigOption

+ func WithServiceAddress(address string, port int) ConfigOption

+ func WithServiceMetadata(metadata map[string]string) ConfigOption

+ func WithServiceName(name string) ConfigOption

+ func WithServiceTags(tags ...string) ConfigOption

+ func WithWatch(services []string, onChange func([]*ServiceInstance)) ConfigOption

+ type ConsulConfig = backends.ConsulConfig

+ type EtcdConfig = backends.EtcdConfig

+ type EurekaConfig = backends.EurekaConfig

+ type Extension struct

+ func (e *Extension) Dependencies() []string

+ func (e *Extension) Health(ctx context.Context) error

+ func (e *Extension) Register(app forge.App) error

+ func (e *Extension) Service() *Service

+ func (e *Extension) Start(ctx context.Context) error

+ func (e *Extension) Stop(ctx context.Context) error

+ type FARPConfig struct

+ AutoRegister bool

+ Capabilities []string

+ Enabled bool

+ Endpoints FARPEndpointsConfig

+ Schemas []FARPSchemaConfig

+ Strategy string

+ type FARPEndpointsConfig struct

+ AsyncAPI string

+ GRPCReflection bool

+ GraphQL string

+ Health string

+ Metrics string

+ OpenAPI string

+ type FARPLocationConfig struct

+ Headers map[string]string

+ RegistryPath string

+ Type string

+ URL string

+ type FARPSchemaConfig struct

+ ContentType string

+ Location FARPLocationConfig

+ SpecVersion string

+ Type string

+ type HealthCheckConfig struct

+ DeregisterCriticalServiceAfter time.Duration

+ Enabled bool

+ GRPC string

+ HTTP string

+ Interval time.Duration

+ TCP string

+ Timeout time.Duration

+ type HealthStatus = backends.HealthStatus

+ type KubernetesConfig = backends.KubernetesConfig

+ type LoadBalanceStrategy string

+ const LoadBalanceLeastConnections

+ const LoadBalanceRandom

+ const LoadBalanceRoundRobin

+ const LoadBalanceWeightedRoundRobin

+ type MDNSConfig = backends.MDNSConfig

+ type SchemaPublisher struct

+ func NewSchemaPublisher(config FARPConfig, app forge.App) *SchemaPublisher

+ func (p *SchemaPublisher) Close() error

+ func (p *SchemaPublisher) GetManifest(ctx context.Context, instanceID string) (*farp.SchemaManifest, error)

+ func (p *SchemaPublisher) GetMetadataForDiscovery(baseURL string) map[string]string

+ func (p *SchemaPublisher) Publish(ctx context.Context, instanceID string) error

+ type Service struct

+ func NewService(config Config, backend Backend, logger forge.Logger) *Service

+ func (s *Service) Backend() Backend

+ func (s *Service) Deregister(ctx context.Context, serviceID string) error

+ func (s *Service) Discover(ctx context.Context, serviceName string) ([]*ServiceInstance, error)

+ func (s *Service) DiscoverHealthy(ctx context.Context, serviceName string) ([]*ServiceInstance, error)

+ func (s *Service) DiscoverWithTags(ctx context.Context, serviceName string, tags []string) ([]*ServiceInstance, error)

+ func (s *Service) GetServiceURL(ctx context.Context, serviceName string, scheme string, ...) (string, error)

+ func (s *Service) Health(ctx context.Context) error

+ func (s *Service) ListServices(ctx context.Context) ([]string, error)

+ func (s *Service) Name() string

+ func (s *Service) Register(ctx context.Context, instance *ServiceInstance) error

+ func (s *Service) SelectInstance(ctx context.Context, serviceName string, strategy LoadBalanceStrategy) (*ServiceInstance, error)

+ func (s *Service) Start(ctx context.Context) error

+ func (s *Service) Stop(ctx context.Context) error

+ func (s *Service) Watch(ctx context.Context, serviceName string, onChange func([]*ServiceInstance)) error

+ type ServiceConfig struct

+ Address string

+ EnableAutoDeregister bool

+ ID string

+ Metadata map[string]string

+ Name string

+ Port int

+ Tags []string

+ Version string

+ type ServiceEvent struct

+ Service *ServiceInstance

+ Timestamp int64

+ Type ServiceEventType

+ type ServiceEventType string

+ const ServiceEventDeregistered

+ const ServiceEventHealthChanged

+ const ServiceEventMetadataChanged

+ const ServiceEventRegistered

+ type ServiceInstance = backends.ServiceInstance

+ type ServiceQuery struct

+ LoadBalanceStrategy LoadBalanceStrategy

+ Name string

+ OnlyHealthy bool

+ Tags []string

+ type ServiceRegistration struct

+ HealthCheck HealthCheckConfig

+ Service ServiceConfig

+ type WatchConfig struct

+ Enabled bool

+ OnChange func(services []*ServiceInstance)

+ Services []string

+ Tags []string

Other modules containing this package

github.com/xraph/forge