debugserver

README

debugserver

A helper function for running a pre-configured pprof server in go.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/debugserver.

Docs

• Usage
• Usage

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Diego area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• Constants
• func AddFlags(flags *flag.FlagSet)
• func DebugAddress(flags *flag.FlagSet) string
• func Handler(zapCtrl zapLogLevelController) http.Handler
• func Run(address string, zapCtrl zapLogLevelController) (ifrit.Process, error)
• func Runner(address string, zapCtrl zapLogLevelController) ifrit.Runner
• func ValidateAndNormalize(w http.ResponseWriter, r *http.Request, level []byte) (string, error)
• type DebugServerConfig
• type LagerAdapter
  • func (l *LagerAdapter) SetMinLevel(level lager.LogLevel)
• type ReconfigurableSinkInterface

Constants

const (
	DebugFlag = "debugAddr"
)

Functions

func AddFlags

func AddFlags(flags *flag.FlagSet)

func DebugAddress

func DebugAddress(flags *flag.FlagSet) string

func Handler

func Handler(zapCtrl zapLogLevelController) http.Handler

func Run

func Run(address string, zapCtrl zapLogLevelController) (ifrit.Process, error)

Run starts the debug server with the provided address and log controller. Run() -> runProcess() -> Runner() -> http_server.New() -> Handler()

func Runner

func Runner(address string, zapCtrl zapLogLevelController) ifrit.Runner

Runner creates an ifrit.Runner for the debug server with the provided address and log controller.

func ValidateAndNormalize

func ValidateAndNormalize(w http.ResponseWriter, r *http.Request, level []byte) (string, error)

Exported only for tests

Types

type DebugServerConfig

type DebugServerConfig struct {
	DebugAddress string `json:"debug_address"`
}

type LagerAdapter

type LagerAdapter struct {
	Sink ReconfigurableSinkInterface
}

LagerAdapter is an adapter for the ReconfigurableSinkInterface to work with lager.LogLevel.

func (*LagerAdapter) SetMinLevel

func (l *LagerAdapter) SetMinLevel(level lager.LogLevel)

SetMinLevel sets the minimum log level for the LagerAdapter.

type ReconfigurableSinkInterface

type ReconfigurableSinkInterface interface {
	SetMinLevel(level lager.LogLevel)
}