service

Documentation

Overview

Package service builds on github.com/kardianos/service to run sidecars as OS services/daemons

Index

• Constants
• func AsExitStatus(err error) (int, error)
• func CmdName() string
• func WithService(ctx context.Context, svc *Service) context.Context
• type Config
  • func (cfg *Config) GetBoolOption(name string, defaultValue bool) bool
  • func (cfg *Config) GetEnv(name, defaultValue string) string
  • func (cfg *Config) GetOption(name string) (any, bool)
  • func (cfg *Config) GetStringOption(name, defaultValue string) string
  • func (cfg *Config) SetBoolOption(name string, value bool)
  • func (cfg *Config) SetDefaults()
  • func (cfg *Config) SetEnv(name, value string)
  • func (cfg *Config) SetOption(name string, value any)
  • func (cfg *Config) SetStringOption(name, value string)
• type ErrorExitCode
  • func (e ErrorExitCode) Error() string
  • func (e ErrorExitCode) ExitStatus() int
  • func (e ErrorExitCode) Unwrap() error
• type Service
  • func Build(rootCmd, serveCmd *cobra.Command) (*Service, error)
  • func GetService(ctx context.Context) (*Service, bool)
  • func MustBuild(rootCmd, serveCmd *cobra.Command) *Service
  • func (s *Service) AddCommand(cmd *cobra.Command)
  • func (s *Service) Cancelled() <-chan struct{}
  • func (s *Service) Command() *cobra.Command
  • func (s *Service) Done() <-chan struct{}
  • func (s *Service) Err() error
  • func (s *Service) Execute() error
  • func (s *Service) ExecuteContext(ctx context.Context) error
  • func (s *Service) Interactive() bool
  • func (s *Service) NewContext(ctx context.Context) (context.Context, error)
  • func (s *Service) PersistentFlags() *pflag.FlagSet
  • func (s *Service) Platform() string
  • func (s *Service) SystemLogger() slog.Logger
  • func (s *Service) Wait() error

Constants

const (
	ExitStatusOK    int = iota // ExitStatusOK indicates everything is fine
	ExitStatusMinor            // ExitStatusMinor indicates there was a minor problem
	ExitStatusMajor            // ExitStatusMajor indicates there was a major problem
)

Functions

func AsExitStatus

func AsExitStatus(err error) (int, error)

AsExitStatus looks at an Execute() error and decides how the process should finish

func CmdName

func CmdName() string

CmdName returns the arg[0] of this execution

func WithService

func WithService(ctx context.Context, svc *Service) context.Context

WithService stores the given Service on a sub-context.

Types

type Config

type Config struct {
	service.Config

	// SanityDelay indicates how long we wait for
	// the run command to fail before claiming a
	// successful start
	SanityDelay time.Duration `default:"2s"`
}

Config describes the Service we are assembling

func (*Config) GetBoolOption

func (cfg *Config) GetBoolOption(name string, defaultValue bool) bool

GetBoolOption gets a boolean option from the service.Config's KeyValue store.

func (*Config) GetEnv

func (cfg *Config) GetEnv(name, defaultValue string) string

GetEnv gets an environment variable from the service.Config.

func (*Config) GetOption

func (cfg *Config) GetOption(name string) (any, bool)

GetOption gets an arbitrary option from the service.Config's KeyValue store.

func (*Config) GetStringOption

func (cfg *Config) GetStringOption(name, defaultValue string) string

GetStringOption gets a string option from the service.Config's KeyValue store.

func (*Config) SetBoolOption

func (cfg *Config) SetBoolOption(name string, value bool)

SetBoolOption sets a boolean option to the service.Config's KeyValue store.

func (*Config) SetDefaults

func (cfg *Config) SetDefaults()

SetDefaults fills gaps in the Config

func (*Config) SetEnv

func (cfg *Config) SetEnv(name, value string)

SetEnv sets an environment variable on the service.Config.

func (*Config) SetOption

func (cfg *Config) SetOption(name string, value any)

SetOption sets an arbitrary option on the service.Config's KeyValue store.

func (*Config) SetStringOption

func (cfg *Config) SetStringOption(name, value string)

SetStringOption sets a string option to the service.Config's KeyValue store.

type ErrorExitCode

type ErrorExitCode struct {
	Code int
	Err  error
}

ErrorExitCode is an error wrapper that knows how the application should exit

func (ErrorExitCode) Error

func (e ErrorExitCode) Error() string

func (ErrorExitCode) ExitStatus

func (e ErrorExitCode) ExitStatus() int

ExitStatus tells the code for os.Exit()

func (ErrorExitCode) Unwrap

func (e ErrorExitCode) Unwrap() error

type Service

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

Service is an application that runs supervised by the OS

func Build

func Build(rootCmd, serveCmd *cobra.Command) (*Service, error)

Build creates a new service from a given root and serve cobra.Command. service.Config parameters can be modified until Execute is called or via PersistentPreRunE on the root command.

func GetService

func GetService(ctx context.Context) (*Service, bool)

GetService gets the current Service from the context.

func MustBuild

func MustBuild(rootCmd, serveCmd *cobra.Command) *Service

MustBuild creates a new service from a given root and serve cobra.Command, and panics if there is a problem.

func (*Service) AddCommand

func (s *Service) AddCommand(cmd *cobra.Command)

AddCommand adds an extra interactive command to the tool

func (*Service) Cancelled

func (s *Service) Cancelled() <-chan struct{}

Cancelled returns a channel that is closed when shutdown has been initiated.

func (*Service) Command

func (s *Service) Command() *cobra.Command

Command returns the root cobra.Command

func (*Service) Done

func (s *Service) Done() <-chan struct{}

Done returns a channel that is closed when the worker has finished.

func (*Service) Err

func (s *Service) Err() error

Err returns the recorded cancellation cause.

func (*Service) Execute

func (s *Service) Execute() error

Execute either runs via cobra or the service invoked process

func (*Service) ExecuteContext

func (s *Service) ExecuteContext(ctx context.Context) error

ExecuteContext either runs via cobra or the service invoked process

func (*Service) Interactive

func (s *Service) Interactive() bool

Interactive returns false if running under the OS service manager and true otherwise.

func (*Service) NewContext

func (s *Service) NewContext(ctx context.Context) (context.Context, error)

NewContext prepares a context for cmd.ExecuteContext() or cmd.SetContext()

func (*Service) PersistentFlags

func (s *Service) PersistentFlags() *pflag.FlagSet

PersistentFlags returns the flags also passed to sub-commands

func (*Service) Platform

func (s *Service) Platform() string

Platform returns a description of the system service.

func (*Service) SystemLogger

func (s *Service) SystemLogger() slog.Logger

SystemLogger returns the OS system logger. Entries will be recorded JSON encoded.

func (*Service) Wait

func (s *Service) Wait() error

Wait waits until the worker has finished and returns its error value