supervisor

Documentation

Index

• func Main(version string, fn MainFn) cliapp.LifecycleAction
• type Backend
• type MainFn
• type SupervisorService
  • func SupervisorFromConfig(ctx context.Context, cfg *config.Config, logger log.Logger) (*SupervisorService, error)
  • func (su *SupervisorService) RPC() string
  • func (su *SupervisorService) Start(ctx context.Context) error
  • func (su *SupervisorService) Stop(ctx context.Context) error
  • func (su *SupervisorService) Stopped() bool

Functions

func Main

func Main(version string, fn MainFn) cliapp.LifecycleAction

Main is the entrypoint into the Supervisor. This method returns a cliapp.LifecycleAction, to create an op-service CLI-lifecycle-managed supervisor with.

Types

type Backend

type Backend interface {
	frontend.Backend
}

type MainFn

type MainFn func(ctx context.Context, cfg *config.Config, logger log.Logger) (cliapp.Lifecycle, error)

type SupervisorService

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

SupervisorService implements the full-environment bells and whistles around the Supervisor. This includes the setup and teardown of metrics, pprof, admin RPC, regular RPC etc.

func SupervisorFromConfig

func SupervisorFromConfig(ctx context.Context, cfg *config.Config, logger log.Logger) (*SupervisorService, error)

func (*SupervisorService) RPC

func (su *SupervisorService) RPC() string

func (*SupervisorService) Start

func (su *SupervisorService) Start(ctx context.Context) error

func (*SupervisorService) Stop

func (su *SupervisorService) Stop(ctx context.Context) error

func (*SupervisorService) Stopped

func (su *SupervisorService) Stopped() bool