debug

Documentation

Overview

Package debug implements debug server for satellite, storage node, and edge services.

Index

• Variables
• func ApplyNewTransformers(r *monkit.Registry) *monkit.Registry
• func ServeTop(w http.ResponseWriter, r *http.Request)
• type Button
• type ButtonGroup
  • func Cycle(name string, cycle *sync2.Cycle) *ButtonGroup
• type Config
• type Endpoint
  • func NewEndpoint(auth func(ctx context.Context) error) *Endpoint
  • func (f *Endpoint) CollectRuntimeTraces(_ *pb.CollectRuntimeTracesRequest, ...) error
  • func (f *Endpoint) CollectRuntimeTraces2(stream pb.DRPCDebug_CollectRuntimeTraces2Stream) error
• type Extension
• type Panel
  • func NewPanel(log *zap.Logger, url, name string) *Panel
  • func (panel *Panel) Add(cats ...*ButtonGroup)
  • func (panel *Panel) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type PrometheusEndpoint
  • func NewPrometheusEndpoint(registry *monkit.Registry) *PrometheusEndpoint
  • func (server *PrometheusEndpoint) PrometheusMetrics(w http.ResponseWriter, r *http.Request)
• type Server
  • func NewServer(log *zap.Logger, listener net.Listener, registry *monkit.Registry, ...) *Server
  • func NewServerWithAtomicLevel(log *zap.Logger, listener net.Listener, registry *monkit.Registry, ...) *Server
  • func (server *Server) Close() error
  • func (server *Server) Run(ctx context.Context) error

Variables

var Error = errs.Class("debug")

Error is default error class for debug package.

var Top eventstat.Registry

Top is a specific registry exposed over the /top endpoint. can be used to publish any high-cardinality event on local HTTP.

Functions

func ApplyNewTransformers

func ApplyNewTransformers(r *monkit.Registry) *monkit.Registry

ApplyNewTransformers adds the default set of monkit.CallbackTransformers. This needs to happen individually for each output type and endpoint.

func ServeTop

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

ServeTop returns all the counters from memory since the last (global) request.

Types

type Button

type Button struct {
	Slug string
	Name string
	Call func(progress io.Writer) error
}

Button defines a clickable button.

type ButtonGroup

type ButtonGroup struct {
	Slug    string
	Name    string
	Buttons []*Button
}

ButtonGroup contains description of a collection of buttons.

func Cycle

func Cycle(name string, cycle *sync2.Cycle) *ButtonGroup

Cycle returns button group for a cycle.

type Config

type Config struct {
	Addr string `help:"address to listen on for debug endpoints" default:"127.0.0.1:0"`

	ControlTitle string `hidden:"true"`
	Control      bool   `releaseDefault:"false" devDefault:"true" hidden:"true"`

	Crawlspace bool `help:"if true, enable crawlspace on debug port" default:"false" hidden:"true"`
}

Config defines configuration for debug server.

type Endpoint

type Endpoint struct {
	pb.DRPCDebugUnimplementedServer

	Auth func(ctx context.Context) error
	// contains filtered or unexported fields
}

Endpoint implements a remote debug server.

func NewEndpoint

func NewEndpoint(auth func(ctx context.Context) error) *Endpoint

NewEndpoint constructs a RemoteDebugEndpoint that will consult the given auth function with the request context to determine if the request is authorized.

func (*Endpoint) CollectRuntimeTraces

func (f *Endpoint) CollectRuntimeTraces(_ *pb.CollectRuntimeTracesRequest, stream pb.DRPCDebug_CollectRuntimeTracesStream) error

CollectRuntimeTraces will stream trace data to the client until the client cancels the request either explicitly or some error happens in sending.

func (*Endpoint) CollectRuntimeTraces2

func (f *Endpoint) CollectRuntimeTraces2(stream pb.DRPCDebug_CollectRuntimeTraces2Stream) error

CollectRuntimeTraces2 will stream trace data to the client until the client sends a done message some error happens, and it then flushes the trace data and captured packet data.

type Extension

type Extension interface {

	// Description is a display name for the UI.
	Description() string

	// Path is the unique HTTP path fragment.
	Path() string

	// Handler is the HTTP handler for the path.
	Handler(http.ResponseWriter, *http.Request)
}

Extension is a custom endpoint, added to the debug endpoint.

type Panel

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

Panel implements a serving of customized callbacks.

func NewPanel

func NewPanel(log *zap.Logger, url, name string) *Panel

NewPanel creates a new panel.

func (*Panel) Add

func (panel *Panel) Add(cats ...*ButtonGroup)

Add adds a button group to the panel.

func (*Panel) ServeHTTP

func (panel *Panel) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves buttons on the prefix and on other endpoints calls the specified call.

type PrometheusEndpoint

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

PrometheusEndpoint includes all the information to server Prometheus compatible HTTP pages.

func NewPrometheusEndpoint

func NewPrometheusEndpoint(registry *monkit.Registry) *PrometheusEndpoint

NewPrometheusEndpoint creates an initialized PrometheusEndpoint.

func (*PrometheusEndpoint) PrometheusMetrics

func (server *PrometheusEndpoint) PrometheusMetrics(w http.ResponseWriter, r *http.Request)

PrometheusMetrics writes monkit data in https://prometheus.io/docs/instrumenting/exposition_formats/.

type Server

type Server struct {
	Panel *Panel

	PrometheusEndpoint *PrometheusEndpoint
	// contains filtered or unexported fields
}

Server provides endpoints for debugging.

func NewServer

func NewServer(log *zap.Logger, listener net.Listener, registry *monkit.Registry, config Config, extensions ...Extension) *Server

NewServer returns a new debug.Server.

func NewServerWithAtomicLevel

func NewServerWithAtomicLevel(log *zap.Logger, listener net.Listener, registry *monkit.Registry, config Config, atomicLevel *zap.AtomicLevel, extensions ...Extension) *Server

NewServerWithAtomicLevel returns a new debug.Server with logging endpoint enabled.

func (*Server) Close

func (server *Server) Close() error

Close closes server and underlying listener.

func (*Server) Run

func (server *Server) Run(ctx context.Context) error

Run starts the debug endpoint.