http

Documentation

Index

• type AgentHTTP
• type Server
  • func NewHTTPServer(debug, prom bool, cfg *config.HTTP, log hclog.Logger, agent AgentHTTP) (*Server, error)
  • func TestServer(t *testing.T, enableProm bool) (*Server, func())
  • func (s *Server) Start()
  • func (s *Server) Stop()

Types

type AgentHTTP

type AgentHTTP interface {
	// DisplayMetrics returns a summary of metrics collected by the agent.
	DisplayMetrics(resp http.ResponseWriter, req *http.Request) (interface{}, error)

	// ReloadAgent triggers the agent to reload policies and configuration.
	ReloadAgent(resp http.ResponseWriter, req *http.Request) (interface{}, error)
}

AgentHTTP is the interface that defines the HTTP handlers that an Agent must implement in order to be accessible through the HTTP API.

type Server

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

func NewHTTPServer

func NewHTTPServer(debug, prom bool, cfg *config.HTTP, log hclog.Logger, agent AgentHTTP) (*Server, error)

NewHTTPServer creates a new agent HTTP server.

func TestServer

func TestServer(t *testing.T, enableProm bool) (*Server, func())

func (*Server) Start

func (s *Server) Start()

Run is used to serve the HTTP server. The function will block and should be run via a go-routine. Unless http.Server.Serve panics/fails, the server can be stopped by calling the Stop function.

func (*Server) Stop

func (s *Server) Stop()

Stop attempts to gracefully stop the HTTP server. If the server does not stop before the timeout is reached, it will be ungracefully stopped.