discovery

May 5, 2026

Changes in this version

type Extension

+ func (e *Extension) LocalServiceID() string

Apr 13, 2026

Changes in this version

type ConfigOption

+ func WithFARPCollapseServiceTags(collapse bool) ConfigOption

+ func WithFARPExcludeInternalPaths(exclude bool) ConfigOption

+ func WithFARPPathRules(rules ...farp.PathRule) ConfigOption

type Extension

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

+ func (e *Extension) ServiceNode() *farpdiscovery.ServiceNode

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

type FARPConfig

+ CollapseServiceTags bool

+ ExcludeInternalPaths *bool

+ PathRules []farp.PathRule

+ func (c *FARPConfig) ShouldExcludeInternalPaths() bool

Mar 28, 2026

Changes in this version

type Config

+ HTTP HTTPConfig

type ConfigOption

+ func WithFARPGatewayURL(url string) ConfigOption

+ func WithHTTPPollInterval(d time.Duration) ConfigOption

+ func WithHTTPSeeds(seeds ...string) ConfigOption

+ func WithHTTPTimeout(d time.Duration) ConfigOption

type FARPConfig

+ GatewayURL string

+ type HTTPConfig = backends.HTTPConfig

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

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