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

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(sink ReconfigurableSinkInterface) http.Handler
• func Run(address string, sink ReconfigurableSinkInterface) (ifrit.Process, error)
• func Runner(address string, sink ReconfigurableSinkInterface) ifrit.Runner
• type DebugServerConfig
• 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(sink ReconfigurableSinkInterface) http.Handler

func Run

func Run(address string, sink ReconfigurableSinkInterface) (ifrit.Process, error)

func Runner

func Runner(address string, sink ReconfigurableSinkInterface) ifrit.Runner

Types

type DebugServerConfig

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

type ReconfigurableSinkInterface

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