pproflogging

package

v0.17.0 Latest Latest Go to latest Published: Apr 16, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kopia/kopia

Links

Open Source Insights

Documentation ¶

Overview ¶

Package pproflogging for pproflogging helper functions.

Index ¶

Constants
Variables
func DumpPem(bs []byte, types string, wrt *os.File) error
func LoadProfileConfig(ctx context.Context, ppconfigss string) (map[ProfileName]*ProfileConfig, error)
func StartProfileBuffers(ctx context.Context)
func StopProfileBuffers(ctx context.Context)
type ProfileConfig
- func (p ProfileConfig) GetValue(s string) (string, bool)
type ProfileConfigs
type ProfileName
type Writer

Constants ¶

View Source

const (
	// DefaultDebugProfileRate default sample/data fraction for profile sample collection rates (1/x, where x is the
	// data fraction sample rate).
	DefaultDebugProfileRate = 100
	// DefaultDebugProfileDumpBufferSizeB default size of the pprof output buffer.
	DefaultDebugProfileDumpBufferSizeB = 1 << 17
)

View Source

const (
	// KopiaDebugFlagForceGc force garbage collection before dumping heap data.
	KopiaDebugFlagForceGc = "forcegc"
	// KopiaDebugFlagDebug value of the profiles `debug` parameter.
	KopiaDebugFlagDebug = "debug"
	// KopiaDebugFlagRate rate setting for the named profile (if available). always an integer.
	KopiaDebugFlagRate = "rate"
)

flags used to configure profiling in EnvVarKopiaDebugPprof.

View Source

const (
	// ProfileNameBlock block profile key.
	ProfileNameBlock ProfileName = "block"
	// ProfileNameMutex mutex profile key.
	ProfileNameMutex = "mutex"
	// ProfileNameCPU cpu profile key.
	ProfileNameCPU = "cpu"
)

View Source

const (
	// EnvVarKopiaDebugPprof environment variable that contains the pprof dump configuration.
	EnvVarKopiaDebugPprof = "KOPIA_PPROF_LOGGING_CONFIG"
)

View Source

const (

	// PPROFDumpTimeout when dumping PPROF data, set an upper bound on the time it can take to log.
	PPROFDumpTimeout = 15 * time.Second
)

Variables ¶

View Source

var (
	// ErrEmptyProfileName returned when a profile configuration flag has no argument.
	ErrEmptyProfileName = errors.New("empty profile flag")
)

Functions ¶

func DumpPem ¶

func DumpPem(bs []byte, types string, wrt *os.File) error

DumpPem dump a PEM version of the byte slice, bs, into writer, wrt.

func LoadProfileConfig ¶

func LoadProfileConfig(ctx context.Context, ppconfigss string) (map[ProfileName]*ProfileConfig, error)

LoadProfileConfig configure PPROF profiling from the config in ppconfigss.

func StartProfileBuffers ¶

func StartProfileBuffers(ctx context.Context)

StartProfileBuffers start profile buffers for enabled profiles/trace. Buffers are returned in an slice of buffers: CPU, Heap and trace respectively. class is used to distinguish profiles external to kopia.

func StopProfileBuffers ¶

func StopProfileBuffers(ctx context.Context)

StopProfileBuffers stop and dump the contents of the buffers to the log as PEMs. Buffers supplied here are from StartProfileBuffers.

Types ¶

type ProfileConfig ¶

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

ProfileConfig configuration flags for a profile.

func (ProfileConfig) GetValue ¶

func (p ProfileConfig) GetValue(s string) (string, bool)

GetValue get the value of the named flag, `s`. False will be returned if the flag does not exist. True will be returned if flag exists without a value.

type ProfileConfigs ¶

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

ProfileConfigs configuration flags for all requested profiles.

type ProfileName ¶

type ProfileName string

ProfileName the name of the profile (see: runtime/pprof/Lookup).

type Writer ¶

type Writer interface {
	io.Writer
	io.StringWriter
}

Writer interface supports destination for PEM output.

Source Files ¶

View all Source files

pproflogging.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL