infra

Documentation

Overview

Package infra provides infrastructure related utils to share among hipster shop services.

Index

• Constants
• Variables
• func AppPort(port int) int
• func InitJaegerTracing(name string) error
• func InitLogrus() *logrus.Logger
• func NewServer(opts ...serverOption) *grpc.Server
• func WithHealth(srv *grpc.Server)
• func WithReflection(srv *grpc.Server)

Constants

const (
	JaegerAddrEnv = "JAEGER_SERVICE_ADDR"
	DebugModeEnv  = "ENABLE_DEBUG_MODE"
	AppPortEnv    = "APP_PORT"
)

environment variables

Variables

var (
	ErrNoEnv = errors.New("missing env variable")
)

exported errors

Functions

func AppPort

func AppPort(port int) int

AppPort gets the port from certain env variable if it is set, or use the provided port otherwise.

func InitJaegerTracing

func InitJaegerTracing(name string) error

InitJaegerTracing init a jaeger exporter and register it. The agent endpoint comes from the env JAEGER_SERVICE_ADDR.

func InitLogrus

func InitLogrus() *logrus.Logger

InitLogrus returns logger that prints to stderr. If ENABLE_DEBUG_MODE is set to "1", it outputs colored plain text for human read; otherwise it outputs JSON-formatted lines for machines parsing.

func NewServer

func NewServer(opts ...serverOption) *grpc.Server

NewServer returns a grpc server with opencensus statHandler.

func WithHealth

func WithHealth(srv *grpc.Server)

WithHealth registers a health server.

func WithReflection

func WithReflection(srv *grpc.Server)

WithReflection turns on the server's reflection protocol.