registry

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 26, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package registry provides service registration and lifecycle management.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MigrationStrategy 

type MigrationStrategy string

MigrationStrategy defines how to migrate between services. 

const (
	MigrationBlueGreen MigrationStrategy = "blue-green"
	MigrationCanary    MigrationStrategy = "canary"
	MigrationGradual   MigrationStrategy = "gradual"
	MigrationImmediate MigrationStrategy = "immediate"
)

type ServiceBinding 

type ServiceBinding struct {
	ID        string    `yaml:"id" json:"id"`
	AppID     string    `yaml:"app_id" json:"app_id"`
	ServiceID string    `yaml:"service_id" json:"service_id"`
	Name      string    `yaml:"name" json:"name"`
	Purpose   string    `yaml:"purpose" json:"purpose"` // e.g., "primary", "replica", "analytics"
	Priority  int       `yaml:"priority" json:"priority"`
	CreatedAt time.Time `yaml:"created_at" json:"created_at"`
	UpdatedAt time.Time `yaml:"updated_at" json:"updated_at"`
}

ServiceBinding represents a binding between an application and a service.

type ServiceConfig 

type ServiceConfig struct {
	// Basic identification
	ID       string          `yaml:"id" json:"id"`
	Name     string          `yaml:"name" json:"name"`
	Type     ServiceType     `yaml:"type" json:"type"`
	Provider ServiceProvider `yaml:"provider" json:"provider"`

	// Connection details
	Host     string `yaml:"host,omitempty" json:"host,omitempty"`
	Port     int    `yaml:"port,omitempty" json:"port,omitempty"`
	Database string `yaml:"database,omitempty" json:"database,omitempty"`
	Username string `yaml:"username,omitempty" json:"username,omitempty"`
	Password string `yaml:"password,omitempty" json:"password,omitempty"`

	// Advanced options
	MaxConns   int           `yaml:"max_conns,omitempty" json:"max_conns,omitempty"`
	MinConns   int           `yaml:"min_conns,omitempty" json:"min_conns,omitempty"`
	Timeout    time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty"`
	RetryCount int           `yaml:"retry_count,omitempty" json:"retry_count,omitempty"`
	TLS        bool          `yaml:"tls,omitempty" json:"tls,omitempty"`

	// Provider-specific settings
	Options map[string]interface{} `yaml:"options,omitempty" json:"options,omitempty"`

	// Metadata
	Labels      map[string]string `yaml:"labels,omitempty" json:"labels,omitempty"`
	Annotations map[string]string `yaml:"annotations,omitempty" json:"annotations,omitempty"`
}

ServiceConfig holds the configuration for a service instance.

type ServiceFactory 

type ServiceFactory interface {
	CreateService(config *ServiceConfig) (ServiceInterface, error)
	SupportedProviders() []ServiceProvider
}

ServiceFactory creates service instances based on configuration.

type ServiceHealth 

type ServiceHealth struct {
	ServiceID   string                 `json:"service_id"`
	Status      ServiceStatus          `json:"status"`
	Latency     time.Duration          `json:"latency"`
	LastChecked time.Time              `json:"last_checked"`
	Error       string                 `json:"error,omitempty"`
	Metadata    map[string]interface{} `json:"metadata,omitempty"`
}

ServiceHealth represents the health status of a service.

type ServiceInterface 

type ServiceInterface interface {
	// Lifecycle methods
	Connect(ctx context.Context) error
	Disconnect(ctx context.Context) error
	Ping(ctx context.Context) error

	// Health and monitoring
	Health(ctx context.Context) (*ServiceHealth, error)
	Metrics(ctx context.Context) (*ServiceMetrics, error)

	// Configuration
	GetConfig() *ServiceConfig
	UpdateConfig(config *ServiceConfig) error

	// Type information
	Type() ServiceType
	Provider() ServiceProvider
	ID() string
}

ServiceInterface defines the common interface all services must implement.

type ServiceMetrics 

type ServiceMetrics struct {
	ServiceID     string                 `json:"service_id"`
	Connections   int                    `json:"connections"`
	Requests      int64                  `json:"requests"`
	Errors        int64                  `json:"errors"`
	Latency       time.Duration          `json:"latency"`
	Throughput    float64                `json:"throughput"`
	CustomMetrics map[string]interface{} `json:"custom_metrics,omitempty"`
}

ServiceMetrics represents metrics for a service.

type ServiceMigration 

type ServiceMigration struct {
	ID          string            `json:"id"`
	FromService string            `json:"from_service"`
	ToService   string            `json:"to_service"`
	Strategy    MigrationStrategy `json:"strategy"`
	Progress    float64           `json:"progress"` // 0.0 to 1.0
	StartedAt   time.Time         `json:"started_at"`
	CompletedAt *time.Time        `json:"completed_at,omitempty"`
	Status      string            `json:"status"`
	Error       string            `json:"error,omitempty"`
}

ServiceMigration represents a migration from one service to another.

type ServiceProvider 

type ServiceProvider string

ServiceProvider represents a backend provider (e.g., postgres, mysql, redis). 

const (
	// Database providers.
	ProviderPostgres  ServiceProvider = "postgres"
	ProviderMySQL     ServiceProvider = "mysql"
	ProviderSQLite    ServiceProvider = "sqlite"
	ProviderMongoDB   ServiceProvider = "mongodb"
	ProviderCockroach ServiceProvider = "cockroachdb"

	// Cache providers.
	ProviderRedis     ServiceProvider = "redis"
	ProviderValkey    ServiceProvider = "valkey"
	ProviderMemcache  ServiceProvider = "memcache"
	ProviderHazelcast ServiceProvider = "hazelcast"

	// Queue providers.
	ProviderRabbitMQ ServiceProvider = "rabbitmq"
	ProviderKafka    ServiceProvider = "kafka"
	ProviderNATS     ServiceProvider = "nats"
	ProviderSQS      ServiceProvider = "aws-sqs"
	ProviderPubSub   ServiceProvider = "gcp-pubsub"

	// Storage providers.
	ProviderS3        ServiceProvider = "s3"
	ProviderGCS       ServiceProvider = "gcs"
	ProviderAzureBlob ServiceProvider = "azure-blob"
	ProviderMinIO     ServiceProvider = "minio"
	ProviderLocal     ServiceProvider = "local-fs"

	// Search providers.
	ProviderElasticsearch ServiceProvider = "elasticsearch"
	ProviderOpenSearch    ServiceProvider = "opensearch"
	ProviderZinc          ServiceProvider = "zinc"
	ProviderMeilisearch   ServiceProvider = "meilisearch"
	ProviderTypesense     ServiceProvider = "typesense"
)

type ServiceRegistry 

type ServiceRegistry struct {
	// contains filtered or unexported fields
}

ServiceRegistry manages all registered services.

func NewServiceRegistry 

func NewServiceRegistry() *ServiceRegistry

NewServiceRegistry creates a new service registry.

func (*ServiceRegistry) CreateBinding 

func (r *ServiceRegistry) CreateBinding(binding *ServiceBinding) error

CreateBinding creates a binding between an application and a service.

func (*ServiceRegistry) ErrorEvents 

func (r *ServiceRegistry) ErrorEvents() <-chan error

ErrorEvents returns a channel for receiving error events.

func (*ServiceRegistry) GetBindings 

func (r *ServiceRegistry) GetBindings(appID string) []*ServiceBinding

GetBindings retrieves all bindings for an application.

func (*ServiceRegistry) GetBoundService 

func (r *ServiceRegistry) GetBoundService(appID string, purpose string) (ServiceInterface, error)

GetBoundService retrieves a service bound to an application by purpose.

func (*ServiceRegistry) GetMigration 

func (r *ServiceRegistry) GetMigration(migrationID string) (*ServiceMigration, error)

GetMigration retrieves a migration by ID.

func (*ServiceRegistry) GetService 

func (r *ServiceRegistry) GetService(serviceID string) (ServiceInterface, error)

GetService retrieves a service by ID.

func (*ServiceRegistry) GetServicesByType 

func (r *ServiceRegistry) GetServicesByType(serviceType ServiceType) []ServiceInterface

GetServicesByType retrieves all services of a specific type.

func (*ServiceRegistry) HealthEvents 

func (r *ServiceRegistry) HealthEvents() <-chan ServiceHealth

HealthEvents returns a channel for receiving health events.

func (*ServiceRegistry) RegisterFactory 

func (r *ServiceRegistry) RegisterFactory(serviceType ServiceType, factory ServiceFactory) error

RegisterFactory registers a service factory for a specific service type.

func (*ServiceRegistry) RegisterService 

func (r *ServiceRegistry) RegisterService(config *ServiceConfig) error

RegisterService registers a service instance.

func (*ServiceRegistry) Shutdown 

func (r *ServiceRegistry) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the registry.

func (*ServiceRegistry) StartMigration 

func (r *ServiceRegistry) StartMigration(fromServiceID, toServiceID string, strategy MigrationStrategy) (*ServiceMigration, error)

StartMigration initiates a migration from one service to another.

func (*ServiceRegistry) UnregisterService 

func (r *ServiceRegistry) UnregisterService(serviceID string) error

UnregisterService removes a service from the registry.

type ServiceStatus 

type ServiceStatus string

ServiceStatus represents the current status of a service. 

const (
	StatusHealthy      ServiceStatus = "healthy"
	StatusDegraded     ServiceStatus = "degraded"
	StatusUnhealthy    ServiceStatus = "unhealthy"
	StatusInitializing ServiceStatus = "initializing"
	StatusUnknown      ServiceStatus = "unknown"
)

type ServiceType 

type ServiceType string

ServiceType represents the type of service. 

const (
	ServiceTypeDatabase   ServiceType = "database"
	ServiceTypeCache      ServiceType = "cache"
	ServiceTypeQueue      ServiceType = "queue"
	ServiceTypeStorage    ServiceType = "storage"
	ServiceTypeSearch     ServiceType = "search"
	ServiceTypeAuth       ServiceType = "auth"
	ServiceTypeEmail      ServiceType = "email"
	ServiceTypeMonitoring ServiceType = "monitoring"
	ServiceTypeWorkflow   ServiceType = "workflow"
	ServiceTypeSecrets    ServiceType = "secrets"
	ServiceTypeRouter     ServiceType = "router"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.