mimicry

Documentation

Index

• type Config
  • func (c *Config) ApplyOverrides(o *Override, log logrus.FieldLogger) error
  • func (c *Config) CreateSinks(log logrus.FieldLogger) ([]output.Sink, error)
  • func (c *Config) Validate() error
• type Metrics
  • func NewMetrics(namespace string) *Metrics
  • func (m *Metrics) AddDecoratedEvent(count int, eventType, networkID string)
• type Mimicry
  • func New(ctx context.Context, log logrus.FieldLogger, config *Config, ...) (*Mimicry, error)
  • func (m *Mimicry) ServeMetrics(ctx context.Context) error
  • func (m *Mimicry) ServePProf(ctx context.Context) error
  • func (m *Mimicry) ServeProbe(ctx context.Context) error
  • func (m *Mimicry) Start(ctx context.Context) error
• type Override

Types

type Config

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

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

	// Ethereum configuration
	Coordinator coordinator.Config `yaml:"coordinator"`

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

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

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

	// CaptureDelay is the Delay before capturing transactions from a peer
	CaptureDelay time.Duration `yaml:"captureDelay" default:"3m"`
}

func (*Config) ApplyOverrides

func (c *Config) ApplyOverrides(o *Override, log logrus.FieldLogger) error

ApplyOverrides applies any overrides to the config.

func (*Config) CreateSinks

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

func (*Config) Validate

func (c *Config) 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 Mimicry

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

func New

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

func (*Mimicry) ServeMetrics

func (m *Mimicry) ServeMetrics(ctx context.Context) error

func (*Mimicry) ServePProf

func (m *Mimicry) ServePProf(ctx context.Context) error

func (*Mimicry) ServeProbe

func (m *Mimicry) ServeProbe(ctx context.Context) error

func (*Mimicry) Start

func (m *Mimicry) Start(ctx context.Context) error

type Override

type Override struct {
	MetricsAddr struct {
		Enabled bool
		Value   string
	}
}

Override is the set of overrides for the mimicry command.