pprof

Documentation

Index

• Constants
• func CompareSampleLabels(a, b []*profilev1.Label) int
• func FilterLabelsInPlace(labels []*profilev1.Label, keys []int64) int
• func FromBytes(input []byte, fn func(*profilev1.Profile, int) error) error
• func FromProfile(p *profile.Profile) (*profilev1.Profile, error)
• func LabelKeysByString(p *profilev1.Profile, keys ...string) []int64
• func LabelKeysMapByString(p *profilev1.Profile, keys ...string) map[string]int64
• func LabelsWithout(labels []*profilev1.Label, keys []int64) []*profilev1.Label
• func RenameLabel(p *profilev1.Profile, oldName, newName string)
• type LabelsByKeyValue
  • func (l LabelsByKeyValue) Len() int
  • func (l LabelsByKeyValue) Less(i, j int) bool
  • func (l LabelsByKeyValue) Swap(i, j int)
• type Profile
  • func NewProfile() *Profile
  • func OpenFile(path string) (*Profile, error)
  • func RawFromBytes(input []byte) (_ *Profile, err error)
  • func RawFromProto(pbp *profilev1.Profile) *Profile
  • func (p *Profile) Close()
  • func (p *Profile) Normalize()
  • func (p *Profile) SizeBytes() int
  • func (p *Profile) WriteTo(w io.Writer) (int64, error)
• type SampleExporter
  • func NewSampleExporter(p *profilev1.Profile) *SampleExporter
  • func (e *SampleExporter) ExportSamples(dst *profilev1.Profile, samples []*profilev1.Sample) *profilev1.Profile
• type SampleGroup
  • func GroupSamplesByLabels(p *profilev1.Profile) []SampleGroup
  • func GroupSamplesWithoutLabels(p *profilev1.Profile, labels ...string) []SampleGroup
  • func GroupSamplesWithoutLabelsByKey(p *profilev1.Profile, keys []int64) []SampleGroup
• type SampleHasher
  • func (h SampleHasher) Hashes(samples []*profilev1.Sample) []uint64
• type SamplesByLabels
  • func (s SamplesByLabels) Len() int
  • func (s SamplesByLabels) Less(i, j int) bool
  • func (s SamplesByLabels) Swap(i, j int)

Constants

const (
	ProfileIDLabelName = "profile_id" // For compatibility with the existing clients.
	SpanIDLabelName    = "span_id"    // Will be supported in the future.
)

Functions

func CompareSampleLabels

func CompareSampleLabels(a, b []*profilev1.Label) int

CompareSampleLabels compares sample label pairs. It's expected that sample labels are sorted. The result will be 0 if a == b, < 0 if a < b, and > 0 if a > b.

func FilterLabelsInPlace

func FilterLabelsInPlace(labels []*profilev1.Label, keys []int64) int

func FromBytes

func FromBytes(input []byte, fn func(*profilev1.Profile, int) error) error

Read Profile from Bytes

func FromProfile

func FromProfile(p *profile.Profile) (*profilev1.Profile, error)

func LabelKeysByString

func LabelKeysByString(p *profilev1.Profile, keys ...string) []int64

func LabelKeysMapByString

func LabelKeysMapByString(p *profilev1.Profile, keys ...string) map[string]int64

func LabelsWithout

func LabelsWithout(labels []*profilev1.Label, keys []int64) []*profilev1.Label

func RenameLabel

func RenameLabel(p *profilev1.Profile, oldName, newName string)

Types

type LabelsByKeyValue

type LabelsByKeyValue []*profilev1.Label

func (LabelsByKeyValue) Len

func (l LabelsByKeyValue) Len() int

func (LabelsByKeyValue) Less

func (l LabelsByKeyValue) Less(i, j int) bool

func (LabelsByKeyValue) Swap

func (l LabelsByKeyValue) Swap(i, j int)

type Profile

type Profile struct {
	*profilev1.Profile
	// contains filtered or unexported fields
}

func NewProfile

func NewProfile() *Profile

func OpenFile

func OpenFile(path string) (*Profile, error)

func RawFromBytes

func RawFromBytes(input []byte) (_ *Profile, err error)

Read RawProfile from bytes

func RawFromProto

func RawFromProto(pbp *profilev1.Profile) *Profile

func (*Profile) Close

func (p *Profile) Close()

func (*Profile) Normalize

func (p *Profile) Normalize()

Normalize normalizes the profile by:

• Removing all duplicate samples (summing their values).
• Removing redundant profile labels (byte => unique of an allocation site) todo: We should reassess if this was a good choice because by merging duplicate stacktrace samples we cannot recompute the allocation per site ("bytes") profile label.
• Removing empty samples.
• Then remove unused references.
• Ensure that the profile has a time_nanos set
• Removes addresses from symbolized profiles.

func (*Profile) SizeBytes

func (p *Profile) SizeBytes() int

func (*Profile) WriteTo

func (p *Profile) WriteTo(w io.Writer) (int64, error)

WriteTo writes the profile to the given writer.

type SampleExporter

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

func NewSampleExporter

func NewSampleExporter(p *profilev1.Profile) *SampleExporter

func (*SampleExporter) ExportSamples

func (e *SampleExporter) ExportSamples(dst *profilev1.Profile, samples []*profilev1.Sample) *profilev1.Profile

ExportSamples creates a new complete profile with the subset of samples provided. It is assumed that those are part of the source profile. Provided samples are modified in place.

The same exporter instance can be used to export non-overlapping sample sets from a single profile.

type SampleGroup

type SampleGroup struct {
	Labels  []*profilev1.Label
	Samples []*profilev1.Sample
}

func GroupSamplesByLabels

func GroupSamplesByLabels(p *profilev1.Profile) []SampleGroup

GroupSamplesByLabels splits samples into groups by labels. It's expected that sample labels are sorted.

func GroupSamplesWithoutLabels

func GroupSamplesWithoutLabels(p *profilev1.Profile, labels ...string) []SampleGroup

GroupSamplesWithoutLabels splits samples into groups by labels ignoring ones from the list: those are preserved as sample labels. It's expected that sample labels are sorted.

func GroupSamplesWithoutLabelsByKey

func GroupSamplesWithoutLabelsByKey(p *profilev1.Profile, keys []int64) []SampleGroup

type SampleHasher

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

func (SampleHasher) Hashes

func (h SampleHasher) Hashes(samples []*profilev1.Sample) []uint64

type SamplesByLabels

type SamplesByLabels []*profilev1.Sample

func (SamplesByLabels) Len

func (s SamplesByLabels) Len() int

func (SamplesByLabels) Less

func (s SamplesByLabels) Less(i, j int) bool

func (SamplesByLabels) Swap

func (s SamplesByLabels) Swap(i, j int)