util

Documentation

Index

• Constants
• func CheckErr(err error)
• func InitCmd(cmd *cobra.Command, logCfg *logutil.Config) context.CancelFunc
• func InitSignalHandling(shutdown shutdownNotify, cancel context.CancelFunc)
• func JSONPrint(cmd *cobra.Command, v interface{}) error
• func LogHTTPProxies()
• func StrictDecodeFile(path, component string, cfg interface{}, ignoreCheckItems ...string) error
• func VerifyPdEndpoint(pdEndpoint string, useTLS bool) error

Constants

const (
	HTTP  = "http"
	HTTPS = "https"
)

Endpoint schemes.

Functions

func CheckErr

func CheckErr(err error)

CheckErr is used to cmd err.

func InitCmd

func InitCmd(cmd *cobra.Command, logCfg *logutil.Config) context.CancelFunc

InitCmd initializes the logger, the default context and returns its cancel function.

func InitSignalHandling

func InitSignalHandling(shutdown shutdownNotify, cancel context.CancelFunc)

InitSignalHandling initializes signal handling. It must be called after InitCmd.

func JSONPrint

func JSONPrint(cmd *cobra.Command, v interface{}) error

JSONPrint will output the data in JSON format.

func LogHTTPProxies

func LogHTTPProxies()

LogHTTPProxies logs HTTP proxy relative environment variables.

func StrictDecodeFile

func StrictDecodeFile(path, component string, cfg interface{}, ignoreCheckItems ...string) error

StrictDecodeFile decodes the toml file strictly. If any item in confFile file is not mapped into the Config struct, issue an error and stop the server from starting.

func VerifyPdEndpoint

func VerifyPdEndpoint(pdEndpoint string, useTLS bool) error

VerifyPdEndpoint verifies whether the pd endpoint is a valid http or https URL. The certificate is required when using https.