app

Documentation

Index

• Variables
• func RunFunc(cCtx *cli.Context) error
• type HTTPMuxOption
  • func WithLiveProbe(probe Probe) HTTPMuxOption
  • func WithMetrics(registry *prometheus.Registry) HTTPMuxOption
  • func WithReadyProbe(probe Probe) HTTPMuxOption
• type HTTPServer
  • func NewHTTPServer(addr string, options ...HTTPMuxOption) *HTTPServer
  • func (s *HTTPServer) Run() error
  • func (s *HTTPServer) Shutdown(ctx context.Context) error
• type Probe

Variables

var Flags = []cli.Flag{
	&cli.StringFlag{
		Name:  "chain-id",
		Usage: "to ensure all nodes matches the specific network (dismiss to auto-detected)",
	},
	&cli.StringFlag{
		Name:  "http-addr",
		Usage: "http server address",
		Value: ":8080",
	},
	&cli.StringFlag{
		Name:  "log-level",
		Usage: "log level (debug, info, warn, error)",
		Value: "info",
	},
	&cli.StringFlag{
		Name:  "namespace",
		Usage: "namespace for Prometheus metrics",
		Value: "cosmos_validator_watcher",
	},
	&cli.BoolFlag{
		Name:  "no-color",
		Usage: "disable colored output",
	},
	&cli.StringSliceFlag{
		Name:  "node",
		Usage: "rpc node endpoint to connect to (specify multiple for high availability)",
		Value: cli.NewStringSlice("http://localhost:26657"),
	},
	&cli.BoolFlag{
		Name:  "no-gov",
		Usage: "disable calls to gov module (useful for consumer chains)",
	},
	&cli.BoolFlag{
		Name:  "no-staking",
		Usage: "disable calls to staking module (useful for consumer chains)",
	},
	&cli.StringSliceFlag{
		Name:  "validator",
		Usage: "validator address(es) to track (use :my-label to add a custom label in metrics & ouput)",
	},
	&cli.StringFlag{
		Name:  "x-gov",
		Usage: "version of the gov module to use (v1|v1beta1)",
		Value: "v1beta1",
	},
}

Functions

func RunFunc

func RunFunc(cCtx *cli.Context) error

Types

type HTTPMuxOption

type HTTPMuxOption func(*http.ServeMux)

func WithLiveProbe

func WithLiveProbe(probe Probe) HTTPMuxOption

func WithMetrics

func WithMetrics(registry *prometheus.Registry) HTTPMuxOption

func WithReadyProbe

func WithReadyProbe(probe Probe) HTTPMuxOption

type HTTPServer

type HTTPServer struct {
	*http.Server
}

func NewHTTPServer

func NewHTTPServer(addr string, options ...HTTPMuxOption) *HTTPServer

func (*HTTPServer) Run

func (s *HTTPServer) Run() error

func (*HTTPServer) Shutdown

func (s *HTTPServer) Shutdown(ctx context.Context) error

type Probe

type Probe func() bool