Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

baseserver

package

Go to main page

Versions in this module

v1

v1.0.0

Jul 6, 2022

Changes in this version

type BaseServer

+ func (bs *BaseServer) ParseFlags()

type BaseServerConfiguration

+ SkipParseFlags bool

v1.0.0-rc23

Jun 24, 2022

v0

v0.1.2

Sep 15, 2023

v0.1.1

Sep 15, 2023

v0.0.3

Sep 21, 2023

Changes in this version

+ const ENV_CH_NUM_CPU

+ const FAILURE_CODE

+ const MS_LOG_PREFIX

+ var BaseServerConfigurationDefaults = BaseServerConfiguration

+ var ENV_BLACKLIST = []string

+ func GetGlobalFeatureService() features.FeatureService

+ func GetGlobalPropertyService() properties.PropertyService

+ func InitGlobalBaseServerTestingOnly(propertyMap map[string]string, ...)

+ func ResetGlobalBaseServerTestingOnly()

+ type BaseServer struct

+ Logger *logger.Logger

+ func Boilerplate(serviceName string, versionInfo version.VersionInfo, ...) *BaseServer

+ func BoilerplateWithPrefix(serviceName string, versionInfo version.VersionInfo, metricsPrefix string, ...) *BaseServer

+ func GetGlobalBaseServer() *BaseServer

+ func NewBaseServer(serviceName string, version version.VersionInfo, metricsPrefix string, ...) *BaseServer

+ func (bs *BaseServer) Fail(msg string)

+ func (bs *BaseServer) FinishLogger()

+ func (bs *BaseServer) FinishOlly()

+ func (bs *BaseServer) GetFeatureService() features.FeatureService

+ func (bs *BaseServer) GetHealthCheckHandler() func(w http.ResponseWriter, r *http.Request)

+ func (bs *BaseServer) GetPropertyService() properties.PropertyService

+ func (bs *BaseServer) Init(mextra interface{})

+ func (bs *BaseServer) InitLogger(stdout bool, loglevel string)

+ func (bs *BaseServer) InitMaxProcs()

+ func (bs *BaseServer) InitMetrics(extra interface{})

+ func (bs *BaseServer) InitOlly()

+ func (bs *BaseServer) OllyBuilder() *olly.Builder

+ func (bs *BaseServer) Run(service Service)

+ func (bs *BaseServer) SetLogTee(logChan chan string)

+ func (bs *BaseServer) Shutdown(reason string)

+ func (bs *BaseServer) WaitUntilReady(timeout time.Duration)

+ type BaseServerConfiguration struct

+ HealthCheckPeriod time.Duration

+ HealthCheckStartupDelay time.Duration

+ HealthCheckTimeout time.Duration

+ LogLevel string

+ LogPrefix string

+ LogToStdout bool

+ MetaListen string

+ MetricsDestination string

+ MetricsPrefix string

+ OllyDataset string

+ OllyWriteKey string

+ PropsRefreshPeriod time.Duration

+ ServiceName string

+ ShutdownSettleTime time.Duration

+ SkipEnvDump bool

+ VersionInfo version.VersionInfo

+ type HealthCheckExecutor struct

+ func NewHealthCheckExecutor(service Service, startupDelay time.Duration, period time.Duration, ...) *HealthCheckExecutor

+ func (hce *HealthCheckExecutor) GetResult() *HealthCheckResult

+ func (hce *HealthCheckExecutor) Run(ctx context.Context)

+ type HealthCheckResult struct

+ Error string

+ Stamp time.Time

+ Success bool

+ func (hcr *HealthCheckResult) Fail(message string)

+ func (hcr *HealthCheckResult) FailOnError(description string, err error)

+ func (hcr *HealthCheckResult) FailOnSqlDbError(ctx context.Context, description string, db *sql.DB)

+ type MetaServer struct

+ func NewMetaServer(listen string, serviceName string, version version.VersionInfo, ...) *MetaServer

+ func (ms *MetaServer) Run(ctx context.Context) error

+ type Service interface

+ GetStatus func() []byte

+ HttpInfo func(w http.ResponseWriter, req *http.Request)

+ Init func(svc.Environment) error

+ Run func(ctx context.Context) error

+ RunHealthCheck func(ctx context.Context, result *HealthCheckResult)

+ Start func() error

+ Stop func() error