profilers

Documentation

Overview

+kubebuilder:validation:Optional

Index

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

Functions

func Module

func Module() fx.Option

Module is a fx module that provides the profilers.

Types

type Constructor

type Constructor struct {
	ConfigKey     string
	DefaultConfig ProfilersConfig
}

Constructor holds fields to create an instance of profilers.

type ProfilersConfig

type ProfilersConfig struct {
	// Path to save performance profiles. "default" path is `/var/log/aperture/<service>/profiles`.
	ProfilesPath string `json:"profiles_path" default:"default"`
	// 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"`
	// Flag to enable CPU profiling on process start and save it to a file. The Browser (HTTP) interface won't work if this is enabled, as the 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.