profilers

Documentation

Index

• Variables
• func Module() fx.Option
• type Constructor
• type 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 {
	// Path to save performance profiles. This can be set via command line arguments as well.
	ProfilesPath string `json:"profiles_path"`
	// Flag to enable cpu profiling
	CPUProfile bool `json:"cpu_profiler" default:"false"`
}

ProfilersConfig holds configuration for profilers. swagger:model