op_heartbeat

Documentation

Index

• Constants
• Variables
• func Handler(l log.Logger, metrics Metrics) http.HandlerFunc
• func HealthzHandler(w http.ResponseWriter, r *http.Request)
• func Main(version string) func(ctx *cli.Context) error
• type Config
  • func NewConfig(ctx *cli.Context) Config
  • func (c Config) Check() error
• type HeartbeatService
  • func Start(ctx context.Context, l log.Logger, cfg Config, version string) (*HeartbeatService, error)
  • func (hs *HeartbeatService) Stop(ctx context.Context) error
• type Metrics
  • func NewMetrics(r *prometheus.Registry) Metrics

Constants

const (
	MetricsNamespace     = "op_heartbeat"
	MinHeartbeatInterval = 10*time.Minute - 10*time.Second
	UsersCacheSize       = 10_000
)

const (
	HTTPMaxHeaderSize = 10 * 1024
	HTTPMaxBodySize   = 1024 * 1024
)

Variables

var AllowedChainIDs = map[uint64]bool{
	420: true,
	902: true,
	10:  true,
}

var AllowedVersions = map[string]bool{
	"":                          true,
	"v0.1.0-beta.1":             true,
	"v0.1.0-goerli-rehearsal.1": true,
	"v0.10.9":                   true,
	"v0.10.10":                  true,
	"v0.10.11":                  true,
	"v0.10.12":                  true,
	"v0.10.13":                  true,
	"v0.10.14":                  true,
	"v0.11.0":                   true,
}

Functions

func Handler

func Handler(l log.Logger, metrics Metrics) http.HandlerFunc

func HealthzHandler

func HealthzHandler(w http.ResponseWriter, r *http.Request)

func Main

func Main(version string) func(ctx *cli.Context) error

Types

type Config

type Config struct {
	HTTPAddr string
	HTTPPort int

	Log oplog.CLIConfig

	Metrics opmetrics.CLIConfig

	Pprof oppprof.CLIConfig
}

func NewConfig

func NewConfig(ctx *cli.Context) Config

func (Config) Check

func (c Config) Check() error

type HeartbeatService

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

func Start

func Start(ctx context.Context, l log.Logger, cfg Config, version string) (*HeartbeatService, error)

func (*HeartbeatService) Stop

func (hs *HeartbeatService) Stop(ctx context.Context) error

type Metrics

type Metrics interface {
	RecordHeartbeat(payload heartbeat.Payload, ip string)
	RecordVersion(version string)
}

func NewMetrics

func NewMetrics(r *prometheus.Registry) Metrics