helper

Documentation

Index

• Constants
• Variables
• func CopiedBytes(source []byte) (destination []byte)
• func FileExists(path string) bool
• func Filter(xs []string, f func(string) bool) []string
• func GenerateRandomId() []byte
• func HasBucketInDomain(host string, prefix string, domains []string) (ok bool, bucket string)
• func Keys(v interface{}) []string
• func Map(xs []string, f func(string) string) []string
• func MarshalTOMLConfig() error
• func MsgPackMarshal(v interface{}) ([]byte, error)
• func MsgPackUnMarshal(data []byte, v interface{}) error
• func PanicOnError(err error, message string)
• func ReadJsonBody(body io.ReadCloser, out interface{}) (err error)
• func SetupConfig()
• func StringInSlice(s string, ss []string) bool
• func SubString(str string, begin, length int) (substr string)
• func Ternary(IF bool, THEN interface{}, ELSE interface{}) interface{}
• func UnicodeIndex(str, substr string) int
• type Config
• type KMSConfig
• type MsgBusConfig
• type PluginConfig

Constants

const (
	YIG_CONF_PATH   = "/etc/yig/yig.toml"
	MIN_BUFFER_SIZE = 512 << 10 // 512k
	MAX_BUFEER_SIZE = 8 << 20   // 8M
)

Variables

var AccessLogger log.Logger

var Logger log.Logger

Global singleton loggers

Functions

func CopiedBytes

func CopiedBytes(source []byte) (destination []byte)

func FileExists

func FileExists(path string) bool

func Filter

func Filter(xs []string, f func(string) bool) []string

func GenerateRandomId

func GenerateRandomId() []byte

func HasBucketInDomain

func HasBucketInDomain(host string, prefix string, domains []string) (ok bool, bucket string)

func Keys

func Keys(v interface{}) []string

Get keys of a map, i.e. map[string]interface{} -> []string Note that some type checks are omitted for efficiency, you need to ensure them yourself, otherwise your program should panic

func Map

func Map(xs []string, f func(string) string) []string

func MarshalTOMLConfig

func MarshalTOMLConfig() error

func MsgPackMarshal

func MsgPackMarshal(v interface{}) ([]byte, error)

func MsgPackUnMarshal

func MsgPackUnMarshal(data []byte, v interface{}) error

func PanicOnError

func PanicOnError(err error, message string)

func ReadJsonBody

func ReadJsonBody(body io.ReadCloser, out interface{}) (err error)

read from ReadCloser and unmarshal to out; `out` should be of POINTER type

func SetupConfig

func SetupConfig()

func StringInSlice

func StringInSlice(s string, ss []string) bool

func SubString

func SubString(str string, begin, length int) (substr string)

func Ternary

func Ternary(IF bool, THEN interface{}, ELSE interface{}) interface{}

mimic `?:` operator Need type assertion to convert output to expected type

func UnicodeIndex

func UnicodeIndex(str, substr string) int

Types

type Config

type Config struct {
	S3Domain             []string                `toml:"s3domain"` // Domain name of YIG
	Region               string                  `toml:"region"`   // Region name this instance belongs to, e.g cn-bj-1
	Plugins              map[string]PluginConfig `toml:"plugins"`
	PiggybackUpdateUsage bool                    `toml:"piggyback_update_usage"`
	LogPath              string                  `toml:"log_path"`
	AccessLogPath        string                  `toml:"access_log_path"`
	AccessLogFormat      string                  `toml:"access_log_format"`
	PanicLogPath         string                  `toml:"panic_log_path"`
	PidFile              string                  `toml:"pid_file"`
	BindApiAddress       string                  `toml:"api_listener"`
	BindAdminAddress     string                  `toml:"admin_listener"`
	SSLKeyPath           string                  `toml:"ssl_key_path"`
	SSLCertPath          string                  `toml:"ssl_cert_path"`
	ZookeeperAddress     string                  `toml:"zk_address"`

	InstanceId             string // if empty, generated one at server startup
	ConcurrentRequestLimit int
	DebugMode              bool   `toml:"debug_mode"`
	EnablePProf            bool   `toml:"enable_pprof"`
	BindPProfAddress       string `toml:"pprof_listener"`
	AdminKey               string `toml:"admin_key"` //used for tools/admin to communicate with yig
	GcThread               int    `toml:"gc_thread"`
	LcThread               int    //used for tools/lc only, set worker numbers to do lc
	LogLevel               string `toml:"log_level"` // "info", "warn", "error"
	CephConfigPattern      string `toml:"ceph_config_pattern"`
	ReservedOrigins        string `toml:"reserved_origins"` // www.ccc.com,www.bbb.com,127.0.0.1
	MetaStore              string `toml:"meta_store"`
	TidbInfo               string `toml:"tidb_info"`
	KeepAlive              bool   `toml:"keepalive"`

	//About cache
	RedisAddress          string `toml:"redis_address"`           // redis connection string, e.g localhost:1234
	RedisConnectionNumber int    `toml:"redis_connection_number"` // number of connections to redis(i.e max concurrent request number)
	RedisPassword         string `toml:"redis_password"`          // redis auth password
	MetaCacheType         int    `toml:"meta_cache_type"`
	EnableDataCache       bool   `toml:"enable_data_cache"`
	RedisConnectTimeout   int    `toml:"redis_connect_timeout"`
	RedisReadTimeout      int    `toml:"redis_read_timeout"`
	RedisWriteTimeout     int    `toml:"redis_write_timeout"`
	RedisKeepAlive        int    `toml:"redis_keepalive"`
	RedisPoolMaxIdle      int    `toml:"redis_pool_max_idle"`
	RedisPoolIdleTimeout  int    `toml:"redis_pool_idle_timeout"`

	// DB Connection parameters
	DbMaxOpenConns       int `toml:"db_max_open_conns"`
	DbMaxIdleConns       int `toml:"db_max_idle_conns"`
	DbConnMaxLifeSeconds int `toml:"db_conn_max_life_seconds"`

	// If the value is not 0, the cached ping detection will be turned on, and the interval is the number of seconds.
	CacheCircuitCheckInterval int `toml:"cache_circuit_check_interval"`
	// This property sets the amount of seconds, after tripping the circuit,
	// to reject requests before allowing attempts again to determine if the circuit should again be closed.
	CacheCircuitCloseSleepWindow int `toml:"cache_circuit_close_sleep_window"`
	// This value is how may consecutive passing requests are required before the circuit is closed
	CacheCircuitCloseRequiredCount int `toml:"cache_circuit_close_required_count"`
	// This property sets the minimum number of requests in a rolling window that will trip the circuit.
	CacheCircuitOpenThreshold     int   `toml:"cache_circuit_open_threshold"`
	CacheCircuitExecTimeout       uint  `toml:"cache_circuit_exec_timeout"`
	CacheCircuitExecMaxConcurrent int64 `toml:"cache_circuit_exec_max_concurrent"`

	DownloadBufPoolSize int64 `toml:"download_buf_pool_size"`
	UploadMinChunkSize  int64 `toml:"upload_min_chunk_size"`
	UploadMaxChunkSize  int64 `toml:"upload_max_chunk_size"`

	KMS KMSConfig `toml:"kms"`

	// Message Bus
	MsgBus MsgBusConfig `toml:"msg_bus"`
}

var CONFIG Config

type KMSConfig

type KMSConfig struct {
	Type     string
	Endpoint string
	Id       string `toml:"kms_id"`
	Secret   string `toml:"kms_secret"`
	Version  int
	Keyname  string
}

type MsgBusConfig

type MsgBusConfig struct {
	// Controls whether to enable message bus when receive the request.
	Enabled bool `toml:"msg_bus_enable"`
	// Controls the under implementation of message bus: 1 for kafka.
	Type int `toml:"msg_bus_type"`
	// Controls the message topic used by message bus.
	Topic string `toml:"msg_bus_topic"`
	// Controls the request timeout for sending a req through message bus.
	RequestTimeoutMs int `toml:"msg_bus_request_timeout_ms"`
	// Controls the total timeout for sending a req through message bus.
	// It will timeout if min(MessageTimeoutMs, SendMaxRetries * RequestTimeoutMs) meets.
	MessageTimeoutMs int `toml:"msg_bus_message_timeout_ms"`
	// Controls the retry time used by message bus if it fails to send a req.
	SendMaxRetries int `toml:"msg_bus_send_max_retries"`
	// Controls the settings for the implementation of message bus.
	// For kafka, the 'broker_list' must be set, like 'broker_list = "kafka:29092"'
	Server map[string]interface{} `toml:"msg_bus_server"`
}

type PluginConfig

type PluginConfig struct {
	Path   string                 `toml:"path"`
	Enable bool                   `toml:"enable"`
	Args   map[string]interface{} `toml:"args"`
}