extensions

Documentation

Overview

Package extensions provides an interface for using optional features.

Features such as C allocation profiling might require cgo, unsafe code, and external non-Go dependencies which might not be desirable for typical users. The main profiler package should not import any package implementing such features directly as doing so may have undesired side effects. This package provides a bridge between the implementation of such optional features and the main profiler package.

Index

• Constants
• func SetCAllocationProfiler(c CAllocationProfiler)
• type CAllocationProfiler
  • func GetCAllocationProfiler() (impl CAllocationProfiler, registered bool)

Constants

const DefaultCAllocationSamplingRate = 2 * 1024 * 1024 // 2 MB

DefaultCAllocationSamplingRate is the sampling rate, in bytes allocated, which will be used if a profile is started with sample rate 0

Functions

func SetCAllocationProfiler

func SetCAllocationProfiler(c CAllocationProfiler)

SetCAllocationProfiler registers a C allocation profiler implementation.

Types

type CAllocationProfiler

type CAllocationProfiler interface {
	// Start begins sampling C allocations at the given rate, in bytes.
	// There will be an average of one sample for every rate bytes
	// allocated.
	Start(rate int)
	// Stop cancels ongoing C allocation profiling and returns the resulting
	// profile. The profile will have the correct sample types such that it
	// can be merged with the Go heap profile. Returns a non-nil error if
	// any part of the profiling failed.
	Stop() (*profile.Profile, error)
}

CAllocationProfiler is the interface for profiling allocations done through the standard malloc/calloc/realloc APIs.

A CAllocationProfiler implementation is not necessarily safe to use from multiple goroutines concurrently.

func GetCAllocationProfiler

func GetCAllocationProfiler() (impl CAllocationProfiler, registered bool)

GetCAllocationProfiler returns the currently registered C allocation profiler, if one is registered.