profilerservice

Documentation

Index

• type Options
• type Service
  • func (s *Service) Name() string
  • func (s *Service) Run(ctx context.Context) error

Types

type Options

type Options struct {
	// Enabled is a flag to enable the profiler.
	Enabled bool `yaml:"enabled,omitempty"`

	// Port is the port on which the profiler server listens.
	Port int `yaml:"port,omitempty"`
}

Options represents the options for enabling pprof profiler.

type Service

type Service struct {
	Options *Options
}

Service is the profiler service.

func (*Service) Name

func (s *Service) Name() string

Name returns the name of the profiler service.

func (*Service) Run

func (s *Service) Run(ctx context.Context) error

Run starts the profiler server that exposes an endpoint to collect profiler from. It handles shutdown based on the context, and returns an error if the server fails to start.