profilerservice

Documentation

Index

• type HostOptions
  • func NewHostOptionsFromEnvironment(options hostoptions.ProviderConfig) HostOptions
• type Service
  • func NewService(options HostOptions) *Service
  • func (s *Service) Name() string
  • func (s *Service) Run(ctx context.Context) error

Types

type HostOptions

type HostOptions struct {
	// Config is the bootstrap profiler configuration loaded from config file.
	Config *provider.ProfilerProviderOptions
}

func NewHostOptionsFromEnvironment

func NewHostOptionsFromEnvironment(options hostoptions.ProviderConfig) HostOptions

NewHostOptionsFromEnvironment of profiler/hostoptions package returns the HostOptions for profiler service.

type Service

type Service struct {
	Options HostOptions
}

func NewService

func NewService(options HostOptions) *Service

NewService of profiler package returns a new Service with the configs needed

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.