platform

Documentation

Index

• func Serve(ctx context.Context, srv Server) error
• type InstrumentationConfig
• type Server
  • func (s Server) Validate() error

Functions

func Serve

func Serve(ctx context.Context, srv Server) error

Serve starts the server listening process

Types

type InstrumentationConfig

type InstrumentationConfig struct {
	Network string `toml:"network" default:"tcp" comment:"Network class used for listen (tcp, tcp4, tcp6, unixsocket)"`
	Listen  string `toml:"listen" default:":5556" comment:"Listen address for instrumentation server"`
	Log     struct {
		Level     string `toml:"level" default:"warn" comment:"Log level: debug, info, warn, error, dpanic, panic, and fatal"`
		SentryDSN string `toml:"sentryDSN" comment:"Sentry DSN"`
	} `toml:"Log" comment:"###############################\n Log Settings \n##############################"`
	Telemetry telemetry.Configuration `toml:"Telemetry" comment:"###############################\n Telemetry Settings \n##############################"`
}

InstrumentationConfig holds all platform instrumentation settings

type Server

type Server struct {
	Debug           bool
	Name            string
	Version         string
	Revision        string
	Network         string
	Address         string
	Instrumentation InstrumentationConfig
	Builder         func(ln net.Listener, group run.Group)
}

Server represents platform server

func (Server) Validate

func (s Server) Validate() error

Validate server settings