skeleton

Documentation

Overview

skeleton package contains a framework to develop micro service.

Index

• Constants
• func AddFlags(flags *flag.FlagSet)
• type Logging
• type Service
  • func NewService(serviceName string, adminPort int) *Service
  • func (s *Service) AddFlags(flagSet *flag.FlagSet)
  • func (s *Service) HC() hc.HealthCheck
  • func (s *Service) RunAndThen(shutdown func())
  • func (s *Service) SetHCStatus(status hc.Status)
  • func (s *Service) Start(v *viper.Viper) error
• type SharedFlags
  • func (aOpts *SharedFlags) InitFromViper(v *viper.Viper) *SharedFlags
  • func (aOpts *SharedFlags) NewLogger(conf zap.Config, options ...zap.Option) (*zap.Logger, error)

Constants

const (
	DefaultLogLevel = "info"
)

Functions

func AddFlags

func AddFlags(flags *flag.FlagSet)

Types

type Logging

type Logging struct {
	LogLevel string
}

type Service

type Service struct {
	ServiceName string

	Logger *zap.Logger

	AdminServer *server.AdminServer

	MetricsFactory metrics.Factory
	// contains filtered or unexported fields
}

func NewService

func NewService(serviceName string, adminPort int) *Service

func (*Service) AddFlags

func (s *Service) AddFlags(flagSet *flag.FlagSet)

func (*Service) HC

func (s *Service) HC() hc.HealthCheck

func (*Service) RunAndThen

func (s *Service) RunAndThen(shutdown func())

func (*Service) SetHCStatus

func (s *Service) SetHCStatus(status hc.Status)

func (*Service) Start

func (s *Service) Start(v *viper.Viper) error

type SharedFlags

type SharedFlags struct {
	Logging
}

func (*SharedFlags) InitFromViper

func (aOpts *SharedFlags) InitFromViper(v *viper.Viper) *SharedFlags

func (*SharedFlags) NewLogger

func (aOpts *SharedFlags) NewLogger(conf zap.Config, options ...zap.Option) (*zap.Logger, error)