Documentation
¶
Index ¶
- Constants
- Variables
- func FormatBytes(bytes uint64) string
- type Client
- type Config
- type ConfigGenerator
- func (g *ConfigGenerator) GenerateConfig(data ConfigTemplateData) ([]byte, error)
- func (g *ConfigGenerator) GetDefaultConfigData() ConfigTemplateData
- func (g *ConfigGenerator) GetDefaultTemplate() string
- func (g *ConfigGenerator) ValidateConfigData(data ConfigTemplateData) error
- func (g *ConfigGenerator) WriteConfigFile(configDir string, data ConfigTemplateData) (string, error)
- type ConfigTemplateData
- type DiscoveredServices
- type Manager
- func (m *Manager) GetConfigDirectory() string
- func (m *Manager) GetContainerID() string
- func (m *Manager) GetContainerInfo(ctx context.Context) (*docker.ContainerInfo, error)
- func (m *Manager) GetDefaultConfig() Config
- func (m *Manager) GetMetricsEndpoint() string
- func (m *Manager) IsRunning(ctx context.Context) bool
- func (m *Manager) Restart(ctx context.Context, enclaveName string, config Config) error
- func (m *Manager) Start(ctx context.Context, enclaveName string, config Config) error
- func (m *Manager) Stop(ctx context.Context) error
- func (m *Manager) UpdateConfiguration(ctx context.Context, enclaveName string, config Config) error
- type ParsedMetrics
- type ServiceDiscovery
- func (s *ServiceDiscovery) BuildConsensusURL(services *DiscoveredServices) string
- func (s *ServiceDiscovery) BuildExecutionURL(services *DiscoveredServices) string
- func (s *ServiceDiscovery) DiscoverServices(ctx context.Context, enclaveName string) (*DiscoveredServices, error)
- func (s *ServiceDiscovery) DiscoverServicesWithNames(ctx context.Context, enclaveName, elServiceName, clServiceName string) (*DiscoveredServices, error)
- func (s *ServiceDiscovery) GetClientServiceNames(services *DiscoveredServices) []string
- func (s *ServiceDiscovery) GetMonitoredDirectories(ctx context.Context, services *DiscoveredServices) ([]string, error)
- func (s *ServiceDiscovery) IsEthereumDataDirectory(path string) bool
- func (s *ServiceDiscovery) MonitorServiceChanges(ctx context.Context, enclaveName string) (<-chan *DiscoveredServices, error)
- func (s *ServiceDiscovery) ValidateEndpoints(ctx context.Context, services *DiscoveredServices) error
Constants ¶
const (
// ProtocolHTTP is the HTTP protocol identifier
ProtocolHTTP = "http"
)
Variables ¶
var ( ErrMetricsExporterNotRunning = errors.New("metrics exporter is not running") ErrMetricsEndpointStatusCode = errors.New("metrics endpoint returned non-200 status code") ErrFailedToFetchMetrics = errors.New("failed to fetch metrics") ErrFailedToReadResponseBody = errors.New("failed to read response body") )
Static errors for better error handling
var ( ErrInvalidMetricsPort = errors.New("invalid metrics port") ErrConsensusURLEmpty = errors.New("consensus URL cannot be empty") ErrExecutionURLEmpty = errors.New("execution URL cannot be empty") ErrLogLevelEmpty = errors.New("log level cannot be empty") ErrInvalidLogLevel = errors.New("invalid log level") )
Static errors for better error handling
var ( ErrEnclaveNotFound = errors.New("enclave does not exist") ErrEndpointNil = errors.New("endpoint is nil") ErrEndpointEmptyServiceName = errors.New("endpoint has empty service name") ErrEndpointEmptyInternalIP = errors.New("endpoint has empty internal IP") ErrEndpointInvalidPort = errors.New("endpoint has invalid internal port") ErrEndpointEmptyContainerID = errors.New("endpoint has empty container ID") ErrContainerNotRunning = errors.New("container is not running") ErrServiceNotFound = errors.New("service not found in enclave") )
Static errors for better error handling
var ( ErrNoContainerRunning = errors.New("no container is currently running") ErrNoConfigDirectory = errors.New("no configuration directory available") )
Static errors for better error handling
Functions ¶
func FormatBytes ¶
FormatBytes formats bytes into human readable format
Types ¶
type Config ¶ added in v0.2.0
type Config struct {
Image string // Default: "ethpandaops/ethereum-metrics-exporter:debian-latest"
MetricsPort int // Default: 9090
LogLevel string // Default: "info"
ConfigDir string // Temporary config directory
ELServiceName string // Execution layer service name (optional, for specific discovery)
CLServiceName string // Consensus layer service name (optional, for specific discovery)
}
Config contains configuration for metrics exporter deployment
type ConfigGenerator ¶ added in v0.2.0
type ConfigGenerator struct {
// contains filtered or unexported fields
}
ConfigGenerator handles generation of ethereum-metrics-exporter configuration files
func NewConfigGenerator ¶ added in v0.2.0
func NewConfigGenerator(logger logrus.FieldLogger) *ConfigGenerator
NewConfigGenerator creates a new ConfigGenerator instance
func (*ConfigGenerator) GenerateConfig ¶ added in v0.2.0
func (g *ConfigGenerator) GenerateConfig(data ConfigTemplateData) ([]byte, error)
GenerateConfig generates the metrics exporter configuration as bytes
func (*ConfigGenerator) GetDefaultConfigData ¶ added in v0.2.0
func (g *ConfigGenerator) GetDefaultConfigData() ConfigTemplateData
GetDefaultConfigData returns default configuration data for the metrics exporter
func (*ConfigGenerator) GetDefaultTemplate ¶ added in v0.2.0
func (g *ConfigGenerator) GetDefaultTemplate() string
GetDefaultTemplate returns the default configuration template for ethereum-metrics-exporter
func (*ConfigGenerator) ValidateConfigData ¶ added in v0.2.0
func (g *ConfigGenerator) ValidateConfigData(data ConfigTemplateData) error
ValidateConfigData validates the configuration data before template generation
func (*ConfigGenerator) WriteConfigFile ¶ added in v0.2.0
func (g *ConfigGenerator) WriteConfigFile(configDir string, data ConfigTemplateData) (string, error)
WriteConfigFile generates and writes the configuration file to the specified directory
type ConfigTemplateData ¶ added in v0.2.0
type ConfigTemplateData struct {
MetricsPort int
ConsensusURL string
ExecutionURL string
MonitoredDirs []string
LogLevel string
ELContainerName string // Execution layer container name
CLContainerName string // Consensus layer container name
}
ConfigTemplateData contains the data required for generating the metrics exporter configuration
type DiscoveredServices ¶ added in v0.2.0
type DiscoveredServices struct {
ELEndpoint *kurtosis.ServiceEndpointInfo
CLEndpoint *kurtosis.ServiceEndpointInfo
DataVolumes map[string][]docker.VolumeMount
NetworkName string
EnclaveName string
}
DiscoveredServices contains all discovered service information needed for metrics exporter
type Manager ¶ added in v0.2.0
type Manager struct {
// contains filtered or unexported fields
}
Manager handles lifecycle management of the ethereum-metrics-exporter container
func NewManager ¶ added in v0.2.0
func NewManager( dockerManager *docker.ContainerManager, configGenerator *ConfigGenerator, serviceDiscovery *ServiceDiscovery, logger logrus.FieldLogger, ) *Manager
NewManager creates a new Manager instance
func (*Manager) GetConfigDirectory ¶ added in v0.2.0
GetConfigDirectory returns the current configuration directory path
func (*Manager) GetContainerID ¶ added in v0.2.0
GetContainerID returns the current container ID
func (*Manager) GetContainerInfo ¶ added in v0.2.0
GetContainerInfo returns information about the running container
func (*Manager) GetDefaultConfig ¶ added in v0.2.0
GetDefaultConfig returns default configuration for metrics exporter
func (*Manager) GetMetricsEndpoint ¶ added in v0.2.0
GetMetricsEndpoint returns the metrics endpoint URL
func (*Manager) IsRunning ¶ added in v0.2.0
IsRunning checks if the metrics exporter container is currently running
func (*Manager) Restart ¶ added in v0.2.0
Restart restarts the metrics exporter with new configuration
func (*Manager) UpdateConfiguration ¶ added in v0.2.0
UpdateConfiguration updates the configuration without restarting the container Note: This requires the metrics exporter to support configuration reloading
type ParsedMetrics ¶
type ParsedMetrics struct {
// Execution
ExeVersion string
ExePeers uint64
ExeChainID uint64
ExeSyncCurrentBlock uint64
ExeSyncHighestBlock uint64
ExeIsSyncing bool
ExeSyncPercentage float64
// Execution Docker metrics
ExeDiskUsage uint64
ExeMemoryUsage uint64
ExeBlockIORead uint64
ExeBlockIOWrite uint64
ExeCPUUsagePercent float64
// Consensus
ConVersion string
ConPeers uint64
ConSyncHeadSlot uint64
ConSyncEstimatedHighestSlot uint64
ConIsSyncing bool
ConSyncPercentage float64
// Consensus Docker metrics
ConDiskUsage uint64
ConMemoryUsage uint64
ConBlockIORead uint64
ConBlockIOWrite uint64
ConCPUUsagePercent float64
}
ParsedMetrics contains the parsed metrics we're interested in
type ServiceDiscovery ¶ added in v0.2.0
type ServiceDiscovery struct {
// contains filtered or unexported fields
}
ServiceDiscovery handles discovery of EL/CL services and their connection details
func NewServiceDiscovery ¶ added in v0.2.0
func NewServiceDiscovery( kurtosisClient kurtosis.Client, dockerManager *docker.ContainerManager, volumeHandler *docker.VolumeHandler, logger logrus.FieldLogger, ) *ServiceDiscovery
NewServiceDiscovery creates a new ServiceDiscovery instance
func (*ServiceDiscovery) BuildConsensusURL ¶ added in v0.2.0
func (s *ServiceDiscovery) BuildConsensusURL(services *DiscoveredServices) string
BuildConsensusURL builds the consensus client URL for metrics exporter configuration
func (*ServiceDiscovery) BuildExecutionURL ¶ added in v0.2.0
func (s *ServiceDiscovery) BuildExecutionURL(services *DiscoveredServices) string
BuildExecutionURL builds the execution client URL for metrics exporter configuration
func (*ServiceDiscovery) DiscoverServices ¶ added in v0.2.0
func (s *ServiceDiscovery) DiscoverServices(ctx context.Context, enclaveName string) (*DiscoveredServices, error)
DiscoverServices discovers all services and their configuration for the metrics exporter
func (*ServiceDiscovery) DiscoverServicesWithNames ¶ added in v0.2.0
func (s *ServiceDiscovery) DiscoverServicesWithNames( ctx context.Context, enclaveName, elServiceName, clServiceName string, ) (*DiscoveredServices, error)
DiscoverServicesWithNames discovers services using specific service names
func (*ServiceDiscovery) GetClientServiceNames ¶ added in v0.2.0
func (s *ServiceDiscovery) GetClientServiceNames(services *DiscoveredServices) []string
GetClientServiceNames returns the names of discovered client services
func (*ServiceDiscovery) GetMonitoredDirectories ¶ added in v0.2.0
func (s *ServiceDiscovery) GetMonitoredDirectories(ctx context.Context, services *DiscoveredServices) ([]string, error)
GetMonitoredDirectories returns a list of directories that should be monitored for disk usage
func (*ServiceDiscovery) IsEthereumDataDirectory ¶ added in v0.2.0
func (s *ServiceDiscovery) IsEthereumDataDirectory(path string) bool
IsEthereumDataDirectory checks if a directory path is likely an Ethereum client data directory
func (*ServiceDiscovery) MonitorServiceChanges ¶ added in v0.2.0
func (s *ServiceDiscovery) MonitorServiceChanges(ctx context.Context, enclaveName string) (<-chan *DiscoveredServices, error)
MonitorServiceChanges monitors for changes in service configuration
func (*ServiceDiscovery) ValidateEndpoints ¶ added in v0.2.0
func (s *ServiceDiscovery) ValidateEndpoints(ctx context.Context, services *DiscoveredServices) error
ValidateEndpoints validates that the discovered endpoints are accessible