app

Documentation

Overview

Package app contains base application constants, flags and options.

Index

• Variables
• type Info
• type Option
• type Options
  • func NewOptions(info *Info, options ...Option) (*Options, error)
  • func (o *Options) AddRunOptions(options ...RunOption)
  • func (o *Options) ApplyRunOptions() error
• type RunOption

Variables

var (
	InstanceUUID = uuid.New()
	StartTime    = time.Now()
	ServiceName  = "-"
	AppName      = "-"
	GitHash      = "-"
	Version      = "-"
	BuildAt      = "0001-01-01T00:00:00"
)

Types

type Info

type Info struct {
	InstanceUUID string
	ServiceName  string
	AppName      string
	GitHash      string
	Version      string
	BuildAt      string
	StartTime    time.Time
}

Info contains service information.

type Option

type Option func(opts *Options) error

Option sets tron options such as ports, config, etc.

type Options

type Options struct {
	// New options.
	Hostname      string
	PortAdmin     uint16
	PortHTTP      uint16
	PortGRPC      uint16
	LoggerLevel   zap.AtomicLevel
	LoggerOptions []zap.Option
	LoggerConfig  zap.Config
	TracerConfig  *tracing.Configuration
	ExitSignals   []os.Signal
	ConfigMap     map[string]interface{}
	GRPCListener  net.Listener
	HTTPListener  net.Listener

	// Run options.
	TLSConfig   *tls.Config
	GRPCOptions []grpc.ServerOption
	// contains filtered or unexported fields
}

Options is base tron options.

func NewOptions

func NewOptions(info *Info, options ...Option) (*Options, error)

NewOptions returns Options with applied Option list.

func (*Options) AddRunOptions

func (o *Options) AddRunOptions(options ...RunOption)

AddRunOptions append run options to others options.

func (*Options) ApplyRunOptions

func (o *Options) ApplyRunOptions() error

ApplyRunOptions sets run options.

type RunOption

type RunOption func(opts *Options) error

RunOption sets tron run options such as grpc unary interceptors, tls config.