mirror of
https://github.com/grafana/grafana.git
synced 2024-11-26 19:00:54 -06:00
120 lines
2.9 KiB
Go
120 lines
2.9 KiB
Go
package registry
|
|
|
|
import (
|
|
"context"
|
|
"reflect"
|
|
"sort"
|
|
|
|
"github.com/grafana/grafana/pkg/services/sqlstore/migrator"
|
|
)
|
|
|
|
type Descriptor struct {
|
|
Name string
|
|
Instance Service
|
|
InitPriority Priority
|
|
}
|
|
|
|
var services []*Descriptor
|
|
|
|
func RegisterService(instance Service) {
|
|
services = append(services, &Descriptor{
|
|
Name: reflect.TypeOf(instance).Elem().Name(),
|
|
Instance: instance,
|
|
InitPriority: Low,
|
|
})
|
|
}
|
|
|
|
func Register(descriptor *Descriptor) {
|
|
services = append(services, descriptor)
|
|
}
|
|
|
|
func GetServices() []*Descriptor {
|
|
slice := getServicesWithOverrides()
|
|
|
|
sort.Slice(slice, func(i, j int) bool {
|
|
return slice[i].InitPriority > slice[j].InitPriority
|
|
})
|
|
|
|
return slice
|
|
}
|
|
|
|
type OverrideServiceFunc func(descriptor Descriptor) (*Descriptor, bool)
|
|
|
|
var overrides []OverrideServiceFunc
|
|
|
|
func RegisterOverride(fn OverrideServiceFunc) {
|
|
overrides = append(overrides, fn)
|
|
}
|
|
|
|
func getServicesWithOverrides() []*Descriptor {
|
|
slice := []*Descriptor{}
|
|
for _, s := range services {
|
|
var descriptor *Descriptor
|
|
for _, fn := range overrides {
|
|
if newDescriptor, override := fn(*s); override {
|
|
descriptor = newDescriptor
|
|
break
|
|
}
|
|
}
|
|
|
|
if descriptor != nil {
|
|
slice = append(slice, descriptor)
|
|
} else {
|
|
slice = append(slice, s)
|
|
}
|
|
}
|
|
|
|
return slice
|
|
}
|
|
|
|
// Service interface is the lowest common shape that services
|
|
// are expected to fulfill to be started within Grafana.
|
|
type Service interface {
|
|
|
|
// Init is called by Grafana main process which gives the service
|
|
// the possibility do some initial work before its started. Things
|
|
// like adding routes, bus handlers should be done in the Init function
|
|
Init() error
|
|
}
|
|
|
|
// CanBeDisabled allows the services to decide if it should
|
|
// be started or not by itself. This is useful for services
|
|
// that might not always be started, ex alerting.
|
|
// This will be called after `Init()`.
|
|
type CanBeDisabled interface {
|
|
|
|
// IsDisabled should return a bool saying if it can be started or not.
|
|
IsDisabled() bool
|
|
}
|
|
|
|
// BackgroundService should be implemented for services that have
|
|
// long running tasks in the background.
|
|
type BackgroundService interface {
|
|
// Run starts the background process of the service after `Init` have been called
|
|
// on all services. The `context.Context` passed into the function should be used
|
|
// to subscribe to ctx.Done() so the service can be notified when Grafana shuts down.
|
|
Run(ctx context.Context) error
|
|
}
|
|
|
|
// DatabaseMigrator allows the caller to add migrations to
|
|
// the migrator passed as argument
|
|
type DatabaseMigrator interface {
|
|
|
|
// AddMigrations allows the service to add migrations to
|
|
// the database migrator.
|
|
AddMigration(mg *migrator.Migrator)
|
|
}
|
|
|
|
// IsDisabled takes an service and return true if its disabled
|
|
func IsDisabled(srv Service) bool {
|
|
canBeDisabled, ok := srv.(CanBeDisabled)
|
|
return ok && canBeDisabled.IsDisabled()
|
|
}
|
|
|
|
type Priority int
|
|
|
|
const (
|
|
High Priority = 100
|
|
Low Priority = 0
|
|
)
|