tron

README

Tron

Installation

install tron:

curl -sSfL https://raw.githubusercontent.com/loghole/tron/main/install.sh | sh
tron version

install protoc:

• linux

$ apt install -y protobuf-compiler
$ protoc --version

• mac:

$ brew install protobuf
$ protoc --version

Documentation

Overview

Package tron contains base application object, some options and functions to create base app.

Index

• func AddLogCaller() app.Option
• func AddLogStacktrace(level string) app.Option
• func SetName(name string)
• func WithAdminHTTP(port uint16) app.Option
• func WithAtomicLoggerLevel(level zap.AtomicLevel) app.Option
• func WithConfigMap(cfg map[string]interface{}) app.Option
• func WithExitSignals(sig ...os.Signal) app.Option
• func WithGRPCListener(listener net.Listener) app.Option
• func WithHTTPListener(listener net.Listener) app.Option
• func WithLogField(key string, value interface{}) app.Option
• func WithLoggerLevel(s string) app.Option
• func WithPublicGRPC(port uint16) app.Option
• func WithPublicHTTP(port uint16) app.Option
• func WithStreamInterceptor(interceptor grpc.StreamServerInterceptor) app.RunOption
• func WithTLSConfig(config *tls.Config) app.RunOption
• func WithTLSKeyPair(certFile, keyFile string) app.RunOption
• func WithTracerConfiguration(config *tracing.Configuration) app.Option
• func WithUnaryInterceptor(interceptor grpc.UnaryServerInterceptor) app.RunOption
• type App
  • func New(options ...app.Option) (*App, error)
  • func (a *App) Close()
  • func (a *App) Go(f func() error)
  • func (a *App) Health() healthcheck.Checker
  • func (a *App) Info() *Info
  • func (a *App) Logger() *zap.SugaredLogger
  • func (a *App) Router() chi.Router
  • func (a *App) Run(impl ...transport.Service) error
  • func (a *App) TraceLogger() tracelog.Logger
  • func (a *App) Tracer() *tracing.Tracer
  • func (a *App) Wait() error
  • func (a *App) WithRunOptions(opts ...app.RunOption) *App
• type Info
  • func GetInfo() *Info
• type Option
• type RunOption

Functions

func AddLogCaller

func AddLogCaller() app.Option

AddLogCaller configures the Logger to annotate each message with the filename and line number of zap's caller.

func AddLogStacktrace

func AddLogStacktrace(level string) app.Option

AddLogStacktrace configures the Logger to record a stack trace for all messages at or above a given level.

Example:

tron.New(tron.AddLogStacktrace("error"))

func SetName

func SetName(name string)

SetName overrides default the application name.

func WithAdminHTTP

func WithAdminHTTP(port uint16) app.Option

WithAdminHTTP returns a Option that sets admin http port. Cannot be changed by config or env.

Example:

tron.New(tron.WithAdminHTTP(8081))

func WithAtomicLoggerLevel

func WithAtomicLoggerLevel(level zap.AtomicLevel) app.Option

WithAtomicLoggerLevel sets atomic logger level.

Example:

level := zap.NewAtomicLevelAt(zapcore.InfoLevel)
tron.New(tron.WithLoggerLevel(level))

func WithConfigMap

func WithConfigMap(cfg map[string]interface{}) app.Option

WithConfigMap returns a Option that init app config from map and envs.

Example:

tron.New(tron.WithConfigMap(map[string]interface{}{
	"namespace":         "dev",
	"service_port_grpc": 35900,
	"cockroach_addr":    "db_addr",
	"cockroach_user":    "db_user",
	"cockroach_db":      "db_name",
}))

func WithExitSignals

func WithExitSignals(sig ...os.Signal) app.Option

WithExitSignals returns a Option that sets exit signals for application. Default signals is: syscall.SIGTERM, syscall.SIGINT.

Example:

tron.New(tron.WithExitSignals(syscall.SIGKILL))

func WithGRPCListener

func WithGRPCListener(listener net.Listener) app.Option

WithGRPCListener returns a Option that sets net listener for grpc public server. Can be used for create application tests with memory listener.

Example:

listener := bufconn.Listen(1024*1024)

tron.New(tron.WithGRPCListener(listener))

func WithHTTPListener

func WithHTTPListener(listener net.Listener) app.Option

WithHTTPListener returns a Option that sets net listener for http public server. Can be used for create application tests with memory listener.

Example:

listener = bufconn.Listen(1024*1024)

tron.New(tron.WithHTTPListener(listener))

func WithLogField

func WithLogField(key string, value interface{}) app.Option

WithLogField adds field to the Logger.

Example:

tron.New(tron.WithLogField("my_field_key", "my_field_value"))

func WithLoggerLevel

func WithLoggerLevel(s string) app.Option

WithLoggerLevel sets logger level.

Example:

tron.New(tron.WithLoggerLevel("info"))

func WithPublicGRPC

func WithPublicGRPC(port uint16) app.Option

WithPublicGRPC returns a Option that sets public grpc port. Cannot be changed by config or env.

Example:

tron.New(tron.WithPublicGRPC(8082))

func WithPublicHTTP

func WithPublicHTTP(port uint16) app.Option

WithPublicHTTP returns a Option that sets public http port. Cannot be changed by config or env.

Example:

tron.New(tron.WithPublicGRPC(8080))

func WithStreamInterceptor

func WithStreamInterceptor(interceptor grpc.StreamServerInterceptor) app.RunOption

WithStreamInterceptor returns a RunOption that specifies the chained interceptor for streaming RPCs. The first interceptor will be the outer most, while the last interceptor will be the inner most wrapper around the real call. All stream interceptors added by this method will be chained.

func WithTLSConfig

func WithTLSConfig(config *tls.Config) app.RunOption

WithTLSConfig returns a RunOption that set tls configuration for grpc and http servers.

func WithTLSKeyPair

func WithTLSKeyPair(certFile, keyFile string) app.RunOption

WithTLSKeyPair returns a RunOption that set tls configuration for grpc and http servers from files.

func WithTracerConfiguration

func WithTracerConfiguration(config *tracing.Configuration) app.Option

WithTracerConfiguration sets tracer config.

func WithUnaryInterceptor

func WithUnaryInterceptor(interceptor grpc.UnaryServerInterceptor) app.RunOption

WithUnaryInterceptor returns a RunOption that specifies the chained interceptor for unary RPCs. The first interceptor will be the outer most, while the last interceptor will be the inner most wrapper around the real call. All unary interceptors added by this method will be chained.

Types

type App

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

App is base application object with grpc and http servers, logger and tracer.

func New

func New(options ...app.Option) (*App, error)

New init viper config, logger and tracer.

func (*App) Close

func (a *App) Close()

Close closes tracer and logger.

func (*App) Go

func (a *App) Go(f func() error)

Go calls the given function in a new goroutine.

The first call to return a non-nil error cancels the group; its error will be returned by Wait.

func (*App) Health

func (a *App) Health() healthcheck.Checker

Health returns application health checker.

func (*App) Info

func (a *App) Info() *Info

Info returns application info.

func (*App) Logger

func (a *App) Logger() *zap.SugaredLogger

Logger returns default zap logger.

func (*App) Router

func (a *App) Router() chi.Router

Router returns http router that runs on public port.

func (*App) Run

func (a *App) Run(impl ...transport.Service) error

Run apply run options if exists and starts servers.

func (*App) TraceLogger

func (a *App) TraceLogger() tracelog.Logger

TraceLogger returns wrapped zap logger with opentracing metadata injection to log records.

func (*App) Tracer

func (a *App) Tracer() *tracing.Tracer

Tracer returns wrapped jaeger tracer.

func (*App) Wait

func (a *App) Wait() error

Wait blocks until all function calls from the Go method have returned, then returns the first non-nil error (if any) from them.

func (*App) WithRunOptions

func (a *App) WithRunOptions(opts ...app.RunOption) *App

WithRunOptions appends some run options.

type Info

type Info = app.Info

Info contains service information.

func GetInfo

func GetInfo() *Info

GetInfo returns base service information.

type Option

type Option = app.Option

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

type RunOption

type RunOption = app.RunOption

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