profilers

Documentation

Overview

+kubebuilder:validation:Optional

Index

• Variables
• func Module() fx.Option
• type Constructor
• type ProfilersConfig
  • func (in *ProfilersConfig) DeepCopy() *ProfilersConfig
  • func (in *ProfilersConfig) DeepCopyInto(out *ProfilersConfig)

Variables

var (
	// DefaultPath is the default path that is used to store profiles.
	DefaultPath = path.Join(config.DefaultLogDirectory, "profiles")
	// DefaultPathFlag is the default path flag for the profiler.
	DefaultPathFlag = defaultKey + ".profiles_path"
)

Functions

func Module

func Module() fx.Option

Module is a fx module that provides the profilers.

Types

type Constructor

type Constructor struct {
	Key           string
	PathKey       string
	DefaultConfig ProfilersConfig
}

Constructor holds fields to create an instance of profilers.

type ProfilersConfig

type ProfilersConfig struct {
	// Register routes. Profile types profile, symbol and cmdline will be registered at /debug/pprof/{profile,symbol,cmdline}.
	RegisterHTTPRoutes bool `json:"register_http_routes" default:"true"`
	// Path to save performance profiles. This can be set via command line arguments as well. E.g. default path for aperture-agent is /var/log/aperture/aperture-agent/profiles.
	ProfilesPath string `json:"profiles_path"`
	// Flag to enable cpu profiling on process start and save it to a file. HTTP interface will not work if this is enabled as CPU profile will always be running.
	CPUProfile bool `json:"cpu_profiler" default:"false"`
}

ProfilersConfig holds configuration for profilers. swagger:model +kubebuilder:object:generate=true

func (*ProfilersConfig) DeepCopy

func (in *ProfilersConfig) DeepCopy() *ProfilersConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProfilersConfig.

func (*ProfilersConfig) DeepCopyInto

func (in *ProfilersConfig) DeepCopyInto(out *ProfilersConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.