diffd

Documentation

Index

• type Runtime
  • func (r *Runtime) Run() error
• type Server
• type Service
  • func (s *Service) BindRoutes(router chi.Router) error

Types

type Runtime

type Runtime struct {
	Server      Server
	ExitSignals []domain.ExitSignal
}

Runtime is the app configuration and execution point

func (*Runtime) Run

func (r *Runtime) Run() error

Run runs the application

type Server

type Server interface {
	// ListenAndServe starts the HTTP server in a blocking call.
	ListenAndServe() error
	// Shutdown stops the server from accepting new connections.
	// If the given context expires before shutdown is complete then
	// the context error is returned.
	Shutdown(ctx context.Context) error
}

Server is an interface for starting/stopping an HTTP server

type Service

type Service struct {
	// QueuerHTTPClient is the client to be used with the default Queuer module.
	// If no client is provided, the default client will be used.
	QueuerHTTPClient *http.Client

	// GrapherHTTPClient is the client to be used with the default Grapher module.
	// If no client is provided, the default client will be used.
	GrapherHTTPClient *http.Client

	// Middleware is a list of service middleware to install on the router.
	// The set of prepackaged middleware can be found in pkg/plugins.
	Middleware []func(http.Handler) http.Handler

	// Queuer is responsible for queuing graphing jobs which will eventually be consumed
	// by the Produce handler. The built in Queuer POSTs to an HTTP endpoint.
	Queuer domain.Queuer

	// Storage provides a mechanism to hook into a persistent store for the graphs. The
	// built in Storage uses S3 as the persistent storage for graph content.
	Storage domain.Storage

	// Marker is responsible for marking which graph jobs are inprogress. The built in
	// Marker uses S3 to hold this state.
	Marker domain.Marker

	// Grapher is responsible for creating a graph of VPC logs for a given time range.
	// The built in grapher calls out to a grapher service.
	Grapher domain.Grapher
}

Service is a container for all of the pluggable modules used by the service

func (*Service) BindRoutes

func (s *Service) BindRoutes(router chi.Router) error

BindRoutes binds the service handlers to the provided router