app

package module

v0.0.0-...-828682c Latest Latest Go to latest Published: Jun 21, 2023 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ethereum-optimism/optimism

README ¶

@eth-optimism/endpoint-monitor

The endpoint-monitor runs websocket checks on edge-proxyd endpoints and downstream infra provider endpoints.

Setup

Install go1.18

make build

source .env.example # (or copy to .envrc if using direnv)
./bin/endpoint-monitor

Documentation ¶

Index ¶

Constants
Variables
func CLIFlags(envPrefix string) []cli.Flag
func Main(version string) func(cliCtx *cli.Context) error
type Config
- func NewConfig(ctx *cli.Context) Config
- func (c Config) Check() error
- func (c Config) GetProviderConfigs() []ProviderConfig
type EndpointMonitor
- func NewEndpointMonitor(cfg Config, l log.Logger) EndpointMonitor
- func (e EndpointMonitor) Start()
type ProviderConfig

Constants ¶

View Source

const (
	ProvidersFlagName     = "providers"
	CheckIntervalFlagName = "check-interval"
	CheckDurationFlagName = "check-duration"
)

Variables ¶

View Source

var (
	MetricWsSubscribeStatus = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "ws_subscribe_status",
			Help: "eth_subscribe over websocket check status"},
		[]string{"status", "provider", "error"},
	)
)

Functions ¶

func CLIFlags ¶

func CLIFlags(envPrefix string) []cli.Flag

func Main ¶

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

Types ¶

type Config ¶

type Config struct {
	Providers     []string
	CheckInterval time.Duration
	CheckDuration time.Duration

	LogConfig     oplog.CLIConfig
	MetricsConfig opmetrics.CLIConfig
}

func NewConfig ¶

func NewConfig(ctx *cli.Context) Config

func (Config) Check ¶

func (c Config) Check() error

func (Config) GetProviderConfigs ¶

func (c Config) GetProviderConfigs() []ProviderConfig

GetProviderConfigs fetches endpoint provider configurations from the environment Each provider should have a corresponding env var with the url, ex: PROVIDER1_URL=<provider-url>

type EndpointMonitor ¶

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

func NewEndpointMonitor ¶

func NewEndpointMonitor(cfg Config, l log.Logger) EndpointMonitor

func (EndpointMonitor) Start ¶

func (e EndpointMonitor) Start()

type ProviderConfig ¶

type ProviderConfig struct {
	Name string
	Url  string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL