service

Documentation

Index

• type CantabularClient
• type Closer
• type ExternalServiceList
  • func NewServiceList(initialiser Initialiser) *ExternalServiceList
  • func (e *ExternalServiceList) GetCantabularClient(ctx context.Context, cfg *config.Config) CantabularClient
  • func (e *ExternalServiceList) GetGraphDB(ctx context.Context) (api.IGraph, Closer, error)
  • func (e *ExternalServiceList) GetHTTPServer(bindAddr string, httpWriteTimeout time.Duration, router http.Handler) IServer
  • func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (IHealthCheck, error)
• type IHealthCheck
• type IServer
• type Init
  • func (e *Init) DoGetGraphDB(ctx context.Context) (api.IGraph, Closer, error)
  • func (e *Init) DoGetHTTPServer(bindAddr string, httpWriteTimeout time.Duration, router http.Handler) IServer
  • func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (IHealthCheck, error)
• type Initialiser
• type Service
  • func Run(ctx context.Context, cfg *config.Config, serviceList *ExternalServiceList, ...) (*Service, error)
  • func (svc *Service) Close(ctx context.Context) error

Types

type CantabularClient

type CantabularClient interface {
	Checker(context.Context, *healthcheck.CheckState) error
}

type Closer

type Closer interface {
	Close(ctx context.Context) error
}

type ExternalServiceList

type ExternalServiceList struct {
	Graph       bool
	HealthCheck bool
	HTTPServer  bool
	Init        Initialiser
}

ExternalServiceList holds the initialiser and initialisation state of external services.

func NewServiceList

func NewServiceList(initialiser Initialiser) *ExternalServiceList

NewServiceList creates a new service list with the provided initialiser

func (*ExternalServiceList) GetCantabularClient

func (e *ExternalServiceList) GetCantabularClient(ctx context.Context, cfg *config.Config) CantabularClient

func (*ExternalServiceList) GetGraphDB

func (e *ExternalServiceList) GetGraphDB(ctx context.Context) (api.IGraph, Closer, error)

GetGraphDB creates a graphDB client and sets the Graph flag to true

func (*ExternalServiceList) GetHTTPServer

func (e *ExternalServiceList) GetHTTPServer(bindAddr string, httpWriteTimeout time.Duration, router http.Handler) IServer

GetHTTPServer creates an http server and sets the Server flag to true

func (*ExternalServiceList) GetHealthCheck

func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (IHealthCheck, error)

GetHealthCheck creates a healthcheck with versionInfo and sets teh HealthCheck flag to true

type IHealthCheck

type IHealthCheck interface {
	Handler(w http.ResponseWriter, req *http.Request)
	Start(ctx context.Context)
	Stop()
	AddCheck(name string, checker healthcheck.Checker) (err error)
}

IHealthCheck defines the required methods from Healthcheck

type IServer

type IServer interface {
	ListenAndServe() error
	Shutdown(ctx context.Context) error
}

IServer defines the required methods from the HTTP server

type Init

type Init struct{}

Init implements the Initialiser interface to initialise dependencies

func (*Init) DoGetGraphDB

func (e *Init) DoGetGraphDB(ctx context.Context) (api.IGraph, Closer, error)

DoGetGraphDB returns a graphDB

func (*Init) DoGetHTTPServer

func (e *Init) DoGetHTTPServer(bindAddr string, httpWriteTimeout time.Duration, router http.Handler) IServer

DoGetHTTPServer creates an HTTP Server with the provided bind address and router

func (*Init) DoGetHealthCheck

func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (IHealthCheck, error)

DoGetHealthCheck creates a healthcheck with versionInfo

type Initialiser

type Initialiser interface {
	DoGetHTTPServer(bindAddr string, httpWriteTimeout time.Duration, router http.Handler) IServer
	DoGetGraphDB(ctx context.Context) (api.IGraph, Closer, error)
	DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (IHealthCheck, error)
}

Initialiser defines the methods to initialise external services

type Service

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

Service contains all the configs, server and clients to run the observation API

func Run

func Run(ctx context.Context, cfg *config.Config, serviceList *ExternalServiceList, buildTime, gitCommit, version string, svcErrors chan error) (*Service, error)

Run the service with its dependencies

func (*Service) Close

func (svc *Service) Close(ctx context.Context) error

Close gracefully shuts the service down in the required order, with timeout