pprofutils

README

pprofutils

Internal fork of https://github.com/felixge/pprofutils stripped to only include essential code and tests. It's used for delta profiles as well as testing.

It'd be nice to keep this in sync with upstream, but no worries if not. We just need the delta profile stuff to work.

Documentation

Overview

Package pprofutils is a fork of github.com/felixge/pprofutils, see README.

Index

• type Delta
  • func (d Delta) Convert(a, b *profile.Profile, extra ...*profile.Profile) (*profile.Profile, error)
• type Protobuf
  • func (p Protobuf) Convert(protobuf *profile.Profile, text io.Writer) error
• type Text
  • func (c Text) Convert(text io.Reader) (*profile.Profile, error)
• type ValueType

Types

type Delta

type Delta struct {
	// SampleTypes limits the delta calcultion to the given sample types. Other
	// sample types will retain the values of profile b. The defined sample types
	// must exist in the profile, otherwise derivation will fail with an error.
	// If the slice is empty, all sample types are subject to delta profile
	// derivation.
	//
	// The use case for this for this is to deal with the heap profile which
	// contains alloc and inuse sample types, but delta profiling makes no sense
	// for the latter.
	SampleTypes []ValueType
}

Delta describes how to compute the delta between two profiles and implements the conversion.

func (Delta) Convert

func (d Delta) Convert(a, b *profile.Profile, extra ...*profile.Profile) (*profile.Profile, error)

Convert computes the delta between all values b-a and returns them as a new profile. Samples that end up with a delta of 0 are dropped. WARNING: Profile a will be mutated by this function. You should pass a copy if that's undesirable.

Other profiles that should be merged into the resulting profile can be passed through the extra parameter.

type Protobuf

type Protobuf struct {
	// SampleTypes causes the text output to begin with a header line listing
	// the sample types found in the profile. This is a custom extension to the
	// folded text format.
	SampleTypes bool
}

Protobuf converts from pprof's protobuf to folded text format.

func (Protobuf) Convert

func (p Protobuf) Convert(protobuf *profile.Profile, text io.Writer) error

Convert marshals the given protobuf profile into folded text format.

type Text

type Text struct{}

Text converts from folded text to protobuf format.

func (Text) Convert

func (c Text) Convert(text io.Reader) (*profile.Profile, error)

Convert parses the given text and returns it as protobuf profile.

type ValueType

type ValueType struct {
	Type string
	Unit string
}

ValueType describes the type and unit of a value.