metrics

Documentation

Index

• Variables
• type Collector
  • func NewCollector(logger zerolog.Logger) Collector
• type DefaultCollector
  • func (c *DefaultCollector) ApiErrorOccurred()
  • func (c *DefaultCollector) EVMAccountInteraction(address string)
  • func (c *DefaultCollector) EVMHeightIndexed(height uint64)
  • func (c *DefaultCollector) MeasureRequestDuration(start time.Time, method string)
  • func (c *DefaultCollector) OperatorBalance(account *flow.Account)
  • func (c *DefaultCollector) ServerPanicked(reason string)
  • func (c *DefaultCollector) TraceDownloadFailed()
• type HttpHandler
  • func NewMetricsHandler(handler http.Handler, collector Collector, log zerolog.Logger) *HttpHandler
  • func (h *HttpHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Server
  • func NewServer(log zerolog.Logger, port int) *Server
  • func (s *Server) Start() (<-chan struct{}, error)
  • func (s *Server) Stop()

Variables

var NopCollector = &nopCollector{}

Types

type Collector

type Collector interface {
	ApiErrorOccurred()
	TraceDownloadFailed()
	ServerPanicked(reason string)
	EVMHeightIndexed(height uint64)
	EVMAccountInteraction(address string)
	MeasureRequestDuration(start time.Time, method string)
	OperatorBalance(account *flow.Account)
}

func NewCollector

func NewCollector(logger zerolog.Logger) Collector

type DefaultCollector

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

func (*DefaultCollector) ApiErrorOccurred

func (c *DefaultCollector) ApiErrorOccurred()

func (*DefaultCollector) EVMAccountInteraction

func (c *DefaultCollector) EVMAccountInteraction(address string)

func (*DefaultCollector) EVMHeightIndexed

func (c *DefaultCollector) EVMHeightIndexed(height uint64)

func (*DefaultCollector) MeasureRequestDuration

func (c *DefaultCollector) MeasureRequestDuration(start time.Time, method string)

func (*DefaultCollector) OperatorBalance

func (c *DefaultCollector) OperatorBalance(account *flow.Account)

func (*DefaultCollector) ServerPanicked

func (c *DefaultCollector) ServerPanicked(reason string)

func (*DefaultCollector) TraceDownloadFailed

func (c *DefaultCollector) TraceDownloadFailed()

type HttpHandler

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

HttpHandler is a thin middleware for gathering metrics about http request. It makes no decision about error handling. If one occurred, we log it and pass request on to the underlying handler to make a decision

func NewMetricsHandler

func NewMetricsHandler(handler http.Handler, collector Collector, log zerolog.Logger) *HttpHandler

func (*HttpHandler) ServeHTTP

func (h *HttpHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Server

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

Server is the http server that will be serving metrics requests

func NewServer

func NewServer(log zerolog.Logger, port int) *Server

NewServer creates a new server that will start on the specified port, and responds to only the `/metrics` endpoint

func (*Server) Start

func (s *Server) Start() (<-chan struct{}, error)

Start starts the server and returns a channel which is closed when the server is ready to serve requests.

func (*Server) Stop

func (s *Server) Stop()