svc

Documentation

Index

• Variables
• func CLICmd(name string, opts ...OptFunc) *cli.Command
• func FlagsAndAction(optsargs ...OptFunc) ([]cli.Flag, func(c *cli.Context) error, *cliopts)
• func MustStart(opts ...OptFunc) <-chan error
• func Run(opts ...OptFunc)
• func RunCLI(name string, opts ...OptFunc)
• func SetVersion(v *Version)
• func Start(opts ...OptFunc) (<-chan error, error)
• type CLIOptFunc
  • func WithCLIApp(f func(*cli.App)) CLIOptFunc
  • func WithCLICommand(cmd *cli.Command) CLIOptFunc
  • func WithCLIFlags(flags []cli.Flag) CLIOptFunc
  • func WithCLIPreaction(f func(c *cli.Context) error) CLIOptFunc
• type Component
• type Flags
• type GRPCAddr
• type GRPCOptions
  • func (g *GRPCOptions) Add(opts ...grpc.ServerOption)
• type OptFunc
  • func Provide(p interface{}) OptFunc
  • func WithCLIOptions(fs ...CLIOptFunc) OptFunc
  • func WithComponent(comps ...Component) OptFunc
  • func WithConfig(cfg interface{}) OptFunc
  • func WithDefaultDisable(ns ...string) OptFunc
  • func WithFlags(f *Flags) OptFunc
  • func WithGRPC(enabled bool) OptFunc
  • func WithHTTP(enabled bool) OptFunc
  • func WithInit(n string, f interface{}) OptFunc
  • func WithLogger(l func() L.L) OptFunc
  • func WithName(name string) OptFunc
  • func WithReady(n string, f interface{}) OptFunc
  • func WithSetup(n string, f interface{}) OptFunc
  • func WithStart(n string, f interface{}) OptFunc
• type Providers
  • func (p *Providers) Add(v ...interface{})
  • func (p *Providers) Get(dst interface{}) bool
• type SvcCfg
• type Version
  • func GetVersion() *Version
  • func (v Version) Any() bool
  • func (v Version) String() string

Variables

var DefaultServiceName = filepath.Base(os.Args[0])

Functions

func CLICmd

func CLICmd(name string, opts ...OptFunc) *cli.Command

func FlagsAndAction

func FlagsAndAction(optsargs ...OptFunc) ([]cli.Flag, func(c *cli.Context) error, *cliopts)

func MustStart

func MustStart(opts ...OptFunc) <-chan error

func Run

func Run(opts ...OptFunc)

func RunCLI

func RunCLI(name string, opts ...OptFunc)

func SetVersion

func SetVersion(v *Version)

func Start

func Start(opts ...OptFunc) (<-chan error, error)

Start the service. Returns a channel for asynchronous error handling, for example in case of a failure of the GRPC server itself.

The startup is done in the following order: 1. Configuration loading (both user specified and service); 2. Log initializations. 3. Call user Init functions. 4. If -setup is specified, call user Setup functions. 5. If -exit-before-start is not specified, call user Start functions.

Types

type CLIOptFunc

type CLIOptFunc func(*cliopts)

func WithCLIApp

func WithCLIApp(f func(*cli.App)) CLIOptFunc

func WithCLICommand

func WithCLICommand(cmd *cli.Command) CLIOptFunc

func WithCLIFlags

func WithCLIFlags(flags []cli.Flag) CLIOptFunc

func WithCLIPreaction

func WithCLIPreaction(f func(c *cli.Context) error) CLIOptFunc

type Component

type Component struct {
	Name                      string
	Init, Setup, Start, Ready interface{}
	Disabled                  bool
}

A component is a grouping of init/setup/start record that conceptually belong to a specific component with a name.

type Flags

type Flags struct {
	ConfigPath                                      string
	Enables, Disables, Onlys, Excepts               []string
	Setup, HelpConfig, PrintConfig, ExitBeforeStart bool
}

type GRPCAddr

type GRPCAddr net.Addr

type GRPCOptions

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

Specified GRPC Server Options for the server. Can only be used by the Init phase. Can be used, for example, to add interceptors by components.

func (*GRPCOptions) Add

func (g *GRPCOptions) Add(opts ...grpc.ServerOption)

type OptFunc

type OptFunc func(*opts)

func Provide

func Provide(p interface{}) OptFunc

Explicitly provide a new provider before initialization.

func WithCLIOptions

func WithCLIOptions(fs ...CLIOptFunc) OptFunc

func WithComponent

func WithComponent(comps ...Component) OptFunc

func WithConfig

func WithConfig(cfg interface{}) OptFunc

Load cfg from environment using envconfig before anything else.

func WithDefaultDisable

func WithDefaultDisable(ns ...string) OptFunc

Disable components by default unless enabled from cmdline.

func WithFlags

func WithFlags(f *Flags) OptFunc

Replace command line flags with Flags.

func WithGRPC

func WithGRPC(enabled bool) OptFunc

func WithHTTP

func WithHTTP(enabled bool) OptFunc

func WithInit

func WithInit(n string, f interface{}) OptFunc

Call the init function f after log is initialized and config is loaded.

func WithLogger

func WithLogger(l func() L.L) OptFunc

func WithName

func WithName(name string) OptFunc

Set service name, the executable name by default.

func WithReady

func WithReady(n string, f interface{}) OptFunc

Call the ready function f after everything else.

func WithSetup

func WithSetup(n string, f interface{}) OptFunc

Call the setup function f after init but before start. This is done only if -setup is specified.

func WithStart

func WithStart(n string, f interface{}) OptFunc

Call the start function f to start things up after init and setup. Additional providers available for start functions: *mux.Router, *grpc.Server.

type Providers

type Providers struct{ Vs []interface{} }

func (*Providers) Add

func (p *Providers) Add(v ...interface{})

func (*Providers) Get

func (p *Providers) Get(dst interface{}) bool

type SvcCfg

type SvcCfg struct {
	Log       Z.Config `envconfig:"LOG" json:"log"`
	HTTP      httpCfg  `envconfig:"HTTP" json:"http"`
	GRPC      grpcCfg  `envconfig:"GRPC" json:"grpc"`
	PprofPort int      `envconfig:"PPROF_PORT" json:"pprof_port"`
}

type Version

type Version struct{ Version, Commit, Date string }

func GetVersion

func GetVersion() *Version

func (Version) Any

func (v Version) Any() bool

func (Version) String

func (v Version) String() string