sherlock

Documentation

Index

• Variables
• type Application
  • func New() *Application
  • func (a *Application) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (a *Application) ShutdownStackdriver()

Variables

var (
	Config = viper.New()
)

package level variable holding a viper instance that will manage sherlock's config

Types

type Application

type Application struct {
	AllocationPools *allocationpools.AllocationPoolController
	Services        *services.ServiceController
	Clusters        *controllers.Cluster
	Builds          *builds.BuildController
	Environments    *environments.EnvironmentController
	Deploys         *deploys.DeployController
	Handler         http.Handler
	// Used to pass the dbConn to testing setup helpers
	// without needing to instantiate a full model instance
	DB          *gorm.DB
	Stackdriver *stackdriver.Exporter
}

Application is the core application type containing a router and db connection repository is a wrapper type so we can define our own methods on the type holding the DB connection pool

func New

func New() *Application

New returns a new instance of the core sherlock application

func (*Application) ServeHTTP

func (a *Application) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implments the http.Handler interface for a Sherlock application instance

func (*Application) ShutdownStackdriver

func (a *Application) ShutdownStackdriver()

ShutdownStackdriver is used to flush the metrics buffer and shutdown the exporter before sherlock itself closes