diagnostics

Documentation

Index

• type Server
  • func NewServer(logger logr.Logger, cfg ServerConfig) Server
  • func (s *Server) ConfigDumps() util.ConfigDumpDiagnostic
  • func (s *Server) Listen(ctx context.Context, port int) error
• type ServerConfig

Types

type Server

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

Server is an HTTP server running exposing the pprof profiling tool, and processing diagnostic dumps of Kong configurations.

func NewServer

func NewServer(logger logr.Logger, cfg ServerConfig) Server

NewServer creates a diagnostics server ready to start listening.

func (*Server) ConfigDumps

func (s *Server) ConfigDumps() util.ConfigDumpDiagnostic

ConfigDumps returns an object allowing dumping succeeded and failed configuration updates. It will return a zero value of the type in case the config dumps are not enabled.

func (*Server) Listen

func (s *Server) Listen(ctx context.Context, port int) error

Listen starts up the HTTP server and blocks until ctx expires.

type ServerConfig

type ServerConfig struct {
	// ProfilingEnabled enables profiling endpoints.
	ProfilingEnabled bool

	// ConfigDumpsEnabled enables config dumps endpoints.
	ConfigDumpsEnabled bool

	// DumpSensitiveConfig makes config dumps to include sensitive information.
	DumpSensitiveConfig bool
}

ServerConfig contains configuration for the diagnostics server.