sentry

Documentation

Index

• type AttestationDataConfig
  • func (f *AttestationDataConfig) Validate() error
• type BeaconCommitteesConfig
• type Config
  • func (c *Config) CreateSinks(log logrus.FieldLogger) ([]output.Sink, error)
  • func (c *Config) Validate() error
• type ForkChoiceConfig
  • func (f *ForkChoiceConfig) Validate() error
• type Metrics
  • func NewMetrics(namespace string) *Metrics
  • func (m *Metrics) AddDecoratedEvent(count int, eventType, networkID string)
• type ProposerDutyConfig
• type Sentry
  • func New(ctx context.Context, log logrus.FieldLogger, config *Config) (*Sentry, error)
  • func (s *Sentry) ServeMetrics(ctx context.Context) error
  • func (s *Sentry) ServePProf(ctx context.Context) error
  • func (s *Sentry) Start(ctx context.Context) error

Types

type AttestationDataConfig

type AttestationDataConfig struct {
	Enabled bool `yaml:"enabled" default:"false"`

	AllCommittees bool `yaml:"allCommittees" default:"false"`

	Interval struct {
		Enabled bool           `yaml:"enabled" default:"false"`
		Every   human.Duration `yaml:"every" default:"12s"`
	} `yaml:"interval"`

	At struct {
		Enabled   bool             `yaml:"enabled" default:"false"`
		SlotTimes []human.Duration `yaml:"slotTimes"`
	} `yaml:"at"`
}

func (*AttestationDataConfig) Validate

func (f *AttestationDataConfig) Validate() error

type BeaconCommitteesConfig

type BeaconCommitteesConfig struct {
	Enabled bool `yaml:"enabled" default:"false"`
}

type Config

type Config struct {
	LoggingLevel string  `yaml:"logging" default:"info"`
	MetricsAddr  string  `yaml:"metricsAddr" default:":9090"`
	PProfAddr    *string `yaml:"pprofAddr"`

	// The name of the sentry
	Name string `yaml:"name"`

	// Ethereum configuration
	Ethereum ethereum.Config `yaml:"ethereum"`

	// Outputs configuration
	Outputs []output.Config `yaml:"outputs"`

	// Labels configures the sentry with labels
	Labels map[string]string `yaml:"labels"`

	// NTP Server to use for clock drift correction
	NTPServer string `yaml:"ntpServer" default:"time.google.com"`

	// ForkChoice configuration
	ForkChoice *ForkChoiceConfig `yaml:"forkChoice" default:"{'enabled': false}"`

	// BeaconCommittees configuration
	BeaconCommittees *BeaconCommitteesConfig `yaml:"beaconCommittees" default:"{'enabled': false}"`

	// AttestationData configuration
	AttestationData *AttestationDataConfig `yaml:"attestationData" default:"{'enabled': false}"`

	// ProposerDuty configuration
	ProposerDuty *ProposerDutyConfig `yaml:"proposerDuty" default:"{'enabled': true}"`

	// Tracing configuration
	Tracing observability.TracingConfig `yaml:"tracing"`
}

func (*Config) CreateSinks

func (c *Config) CreateSinks(log logrus.FieldLogger) ([]output.Sink, error)

func (*Config) Validate

func (c *Config) Validate() error

type ForkChoiceConfig

type ForkChoiceConfig struct {
	Enabled bool `yaml:"enabled" default:"false"`

	OnReOrgEvent struct {
		Enabled bool `yaml:"enabled" default:"false"`
	} `yaml:"onReOrgEvent"`

	Interval struct {
		Enabled bool           `yaml:"enabled" default:"false"`
		Every   human.Duration `yaml:"every" default:"12s"`
	} `yaml:"interval"`

	At struct {
		Enabled   bool             `yaml:"enabled" default:"false"`
		SlotTimes []human.Duration `yaml:"slotTimes"`
	} `yaml:"at"`
}

func (*ForkChoiceConfig) Validate

func (f *ForkChoiceConfig) Validate() error

type Metrics

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

func NewMetrics

func NewMetrics(namespace string) *Metrics

func (*Metrics) AddDecoratedEvent

func (m *Metrics) AddDecoratedEvent(count int, eventType, networkID string)

type ProposerDutyConfig

type ProposerDutyConfig struct {
	Enabled bool `yaml:"enabled" default:"true"`
}

type Sentry

type Sentry struct {
	Config *Config
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, log logrus.FieldLogger, config *Config) (*Sentry, error)

func (*Sentry) ServeMetrics

func (s *Sentry) ServeMetrics(ctx context.Context) error

func (*Sentry) ServePProf

func (s *Sentry) ServePProf(ctx context.Context) error

func (*Sentry) Start

func (s *Sentry) Start(ctx context.Context) error