server

Documentation

Overview

Package server exposes the analyzer as a REST API and a web dashboard.

Index

• type Server
  • func New(client *kube.Client, opts analyzer.Options, cacheTTL time.Duration, ...) *Server
  • func (s *Server) EnableFleet(m *fleet.Manager)
  • func (s *Server) Handler() http.Handler
  • func (s *Server) ListenAndServe(addr string) error

Types

type Server

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

Server serves the dashboard and REST API. Reports are cached briefly so a busy dashboard doesn't hammer the API server.

func New

func New(client *kube.Client, opts analyzer.Options, cacheTTL time.Duration, hist *history.Store) *Server

New returns a Server that analyzes via client, caches reports for cacheTTL, and records each fresh analysis in hist (may be nil to disable history).

func (*Server) EnableFleet

func (s *Server) EnableFleet(m *fleet.Manager)

EnableFleet switches the server into fleet mode: the root page becomes the fleet overview and per-cluster routes are served from m. Call before Handler / ListenAndServe.

func (*Server) Handler

func (s *Server) Handler() http.Handler

Handler returns the HTTP routes for the dashboard, REST API and health probe.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe(addr string) error

ListenAndServe blocks serving HTTP on addr.