registry

Documentation

Index

• func IsDisabled(srv BackgroundService) bool
• type BackgroundService
• type BackgroundServiceRegistry
• type CanBeDisabled
• type DatabaseMigrator
• type ProvidesUsageStats
• type UsageStatsProvidersRegistry

Functions

func IsDisabled

func IsDisabled(srv BackgroundService) bool

IsDisabled returns whether a background service is disabled.

Types

type BackgroundService

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
}

BackgroundService should be implemented for services that have long running tasks in the background.

type BackgroundServiceRegistry

type BackgroundServiceRegistry interface {
	GetServices() []BackgroundService
}

BackgroundServiceRegistry provides background services.

type CanBeDisabled

type CanBeDisabled interface {
	// IsDisabled should return a bool saying if it can be started or not.
	IsDisabled() bool
}

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 DatabaseMigrator

type DatabaseMigrator interface {
	// AddMigrations allows the service to add migrations to
	// the database migrator.
	AddMigration(mg *migrator.Migrator)
}

DatabaseMigrator allows the caller to add migrations to the migrator passed as argument

type ProvidesUsageStats

type ProvidesUsageStats interface {
	// GetUsageStats is called on a schedule by the UsageStatsService
	// Any errors occurring during usage stats collection should be collected and logged within the provider.
	GetUsageStats(ctx context.Context) map[string]any
}

ProvidesUsageStats is an interface for services that share their usage stats

type UsageStatsProvidersRegistry

type UsageStatsProvidersRegistry interface {
	GetServices() []ProvidesUsageStats
}

UsageStatsProvidersRegistry provides services sharing their usage stats