debugapi

Documentation

Overview

Package debugapi exposes the debug API used to control and analyze low-level and runtime features and functionalities of Bee.

Index

• type Service
  • func New(overlay swarm.Address, publicKey, pssPublicKey ecdsa.PublicKey, ...) *Service
  • func (s *Service) Configure(p2p p2p.DebugService, pingpong pingpong.Interface, ...)
  • func (s *Service) MustRegisterMetrics(cs ...prometheus.Collector)
  • func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

Types

type Service

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

Service implements http.Handler interface to be used in HTTP server.

func New

func New(overlay swarm.Address, publicKey, pssPublicKey ecdsa.PublicKey, ethereumAddress common.Address, logger logging.Logger, tracer *tracing.Tracer, corsAllowedOrigins []string) *Service

New creates a new Debug API Service with only basic routers enabled in order to expose /addresses, /health endpoints, Go metrics and pprof. It is useful to expose these endpoints before all dependencies are configured and injected to have access to basic debugging tools and /health endpoint.

func (*Service) Configure

func (s *Service) Configure(p2p p2p.DebugService, pingpong pingpong.Interface, topologyDriver topology.Driver, lightNodes *lightnode.Container, storer storage.Storer, tags *tags.Tags, accounting accounting.Interface, pseudosettle settlement.Interface, chequebookEnabled bool, swap swap.Interface, chequebook chequebook.Service, batchStore postage.Storer)

Configure injects required dependencies and configuration parameters and constructs HTTP routes that depend on them. It is intended and safe to call this method only once.

func (*Service) MustRegisterMetrics

func (s *Service) MustRegisterMetrics(cs ...prometheus.Collector)

func (*Service) ServeHTTP

func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler interface.