pprof

Documentation

Overview

Package pprof defines a utility for integrating pprof with custom configurations.

Index

• type Pprof
  • func New(ctx context.Context, opts options.Pprof) *Pprof
  • func (p *Pprof) GetAddress() string
  • func (p *Pprof) GetName() string
  • func (p *Pprof) IsEnabled() bool
  • func (p *Pprof) Start() error

Types

type Pprof

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

Pprof encapsulates the pprof server configuration.

func New

func New(ctx context.Context, opts options.Pprof) *Pprof

New creates a new Pprof instance with the specified listen address.

func (*Pprof) GetAddress

func (p *Pprof) GetAddress() string

GetAddress returns the address on which pprof server will be listening on

func (*Pprof) GetName

func (p *Pprof) GetName() string

GetName returns options service name associated with pprof server

func (*Pprof) IsEnabled

func (p *Pprof) IsEnabled() bool

IsEnabled returns if pprof server is enabled or not (via configuration)

func (*Pprof) Start

func (p *Pprof) Start() error

Start initializes the pprof HTTP server on the configured address.