debug

Documentation

Index

• Variables
• func AddOutputJsonYamlTextFlag(cmd *cobra.Command)
• func DefineDebugCommands(rootCmd *cobra.Command)
• func DefineDebugCommandsSelf(rootCmd *cobra.Command)
• func DefineSocketFlag(cmd *cobra.Command)
• func FormatFromRequest(request *http.Request) string
• type BadRequestError
  • func (be *BadRequestError) Error() string
• type Client
  • func DefaultClient() (*Client, error)
  • func NewClient(socketPath string) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) Get(url string) ([]byte, error)
  • func (c *Client) Post(targetUrl string, data map[string][]string) ([]byte, error)
• type ConfigRequest
  • func Config(client *Client) *ConfigRequest
  • func (cr *ConfigRequest) List(format string) ([]byte, error)
  • func (cr *ConfigRequest) Set(name string, value string, duration time.Duration) ([]byte, error)
• type HookRequest
  • func Hook(client *Client) *HookRequest
  • func (r *HookRequest) List(format string) ([]byte, error)
  • func (r *HookRequest) Name(name string) *HookRequest
  • func (r *HookRequest) Snapshots(format string) ([]byte, error)
• type NotFoundError
  • func (nf *NotFoundError) Error() string
• type QueueRequest
  • func Queue(client *Client) *QueueRequest
  • func (qr *QueueRequest) List(format string, showEmpty bool) ([]byte, error)
  • func (qr *QueueRequest) Main(format string) ([]byte, error)
• type Server
  • func NewServer(prefix, socketPath, httpAddr string, logger *log.Logger) *Server
  • func (s *Server) Init() error
  • func (s *Server) RegisterHandler(method, pattern string, ...)
  • func (s *Server) Shutdown(ctx context.Context) error

Variables

var DefaultSocketPath = "/var/run/shell-operator/debug.socket"

DefaultSocketPath is the path the debug CLI client (DefaultClient) connects to when no explicit socket has been configured. It is a CLI concern only — library consumers should build a debug.Client with NewClient(path) directly.

Functions

func AddOutputJsonYamlTextFlag

func AddOutputJsonYamlTextFlag(cmd *cobra.Command)

func DefineDebugCommands

func DefineDebugCommands(rootCmd *cobra.Command)

func DefineDebugCommandsSelf

func DefineDebugCommandsSelf(rootCmd *cobra.Command)

func DefineSocketFlag

func DefineSocketFlag(cmd *cobra.Command)

DefineSocketFlag binds the --debug-unix-socket flag on cmd to the process-level DefaultSocketPath used by DefaultClient(). Called by debug sub-commands (queue, hook, config, raw).

func FormatFromRequest

func FormatFromRequest(request *http.Request) string

Types

type BadRequestError

type BadRequestError struct {
	Msg string
}

func (*BadRequestError) Error

func (be *BadRequestError) Error() string

type Client

type Client struct {
	SocketPath string
	// contains filtered or unexported fields
}

func DefaultClient

func DefaultClient() (*Client, error)

DefaultClient connects to the unix socket pointed at by DefaultSocketPath. CLI commands bind --debug-unix-socket against DefaultSocketPath via DefineSocketFlag so that this function picks up any flag-supplied override.

func NewClient

func NewClient(socketPath string) (*Client, error)

func (*Client) Close

func (c *Client) Close()

func (*Client) Get

func (c *Client) Get(url string) ([]byte, error)

func (*Client) Post

func (c *Client) Post(targetUrl string, data map[string][]string) ([]byte, error)

type ConfigRequest

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

func Config

func Config(client *Client) *ConfigRequest

func (*ConfigRequest) List

func (cr *ConfigRequest) List(format string) ([]byte, error)

func (*ConfigRequest) Set

func (cr *ConfigRequest) Set(name string, value string, duration time.Duration) ([]byte, error)

type HookRequest

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

func Hook

func Hook(client *Client) *HookRequest

func (*HookRequest) List

func (r *HookRequest) List(format string) ([]byte, error)

func (*HookRequest) Name

func (r *HookRequest) Name(name string) *HookRequest

func (*HookRequest) Snapshots

func (r *HookRequest) Snapshots(format string) ([]byte, error)

type NotFoundError

type NotFoundError struct {
	Msg string
}

func (*NotFoundError) Error

func (nf *NotFoundError) Error() string

type QueueRequest

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

func Queue

func Queue(client *Client) *QueueRequest

func (*QueueRequest) List

func (qr *QueueRequest) List(format string, showEmpty bool) ([]byte, error)

func (*QueueRequest) Main

func (qr *QueueRequest) Main(format string) ([]byte, error)

type Server

type Server struct {
	Prefix     string
	SocketPath string
	HttpAddr   string

	Router chi.Router
	// contains filtered or unexported fields
}

func NewServer

func NewServer(prefix, socketPath, httpAddr string, logger *log.Logger) *Server

func (*Server) Init

func (s *Server) Init() error

func (*Server) RegisterHandler

func (s *Server) RegisterHandler(method, pattern string, handler func(request *http.Request) (interface{}, error))

RegisterHandler registers http handler for unix/http debug server

func (*Server) Shutdown

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

Shutdown gracefully stops both the unix-socket server and the optional HTTP server. The unix socket file is removed on the way out. Safe to call when Init was never run or after a previous Shutdown.