profiling

Documentation

Overview

Package profiling provides profiling server.

Index

• Variables
• type Config
  • func (c *Config) Validate() error
• type Server
  • func NewServer(conf *Config, metrics *prometheus.Metrics) *Server
  • func (s *Server) Handle(pattern string, handler http.Handler)
  • func (s *Server) Shutdown(graceful bool)
  • func (s *Server) Start() error

Variables

var (
	// ErrInvalidProfilingPort occurs when the port in the config is invalid.
	ErrInvalidProfilingPort = errors.New("invalid port number for profiling server")
)

Types

type Config

type Config struct {
	Port        int  `yaml:"Port"`
	EnablePprof bool `yaml:"EnablePprof"`
}

Config is the configuration for creating a Server instance.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the port number.

type Server

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

Server serves information for profiling, such as metrics and pprof information.

func NewServer

func NewServer(conf *Config, metrics *prometheus.Metrics) *Server

NewServer creates an instance of Server.

func (*Server) Handle

func (s *Server) Handle(pattern string, handler http.Handler)

Handle handles the given handler.

func (*Server) Shutdown

func (s *Server) Shutdown(graceful bool)

Shutdown shut down the server.

func (*Server) Start

func (s *Server) Start() error

Start starts the server.