debug

Documentation

Overview

Package debug exposes an opt-in local HTTP debug server for agent runs.

Index

• type Config
• type Server
  • func NewServer(cfg Config) (*Server, error)
  • func (s *Server) Addr() string
  • func (s *Server) Handler() http.Handler
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start() error

Types

type Config

type Config struct {
	Runtime *agentsruntime.Runtime
	Addr    string
}

Config configures an explicit local debug server.

type Server

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

Server serves development-only run/debug endpoints.

func NewServer

func NewServer(cfg Config) (*Server, error)

NewServer constructs a disabled-by-default debug server. Call Start to bind.

func (*Server) Addr

func (s *Server) Addr() string

Addr returns the configured or bound address.

func (*Server) Handler

func (s *Server) Handler() http.Handler

Handler returns the HTTP handler without starting a listener.

func (*Server) Shutdown

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

Shutdown gracefully stops a started server.

func (*Server) Start

func (s *Server) Start() error

Start binds the debug server. The default address is loopback-only.