config.go

package conf

import "time"

// Titan configuration center
type Titan struct {
	Server      Server     `cfg:"server"`
	Status      Status     `cfg:"status"`
	Tikv        Tikv       `cfg:"tikv"`
	TikvLog     TikvLogger `cfg:"tikv-logger"`
	Logger      Logger     `cfg:"logger"`
	PIDFileName string     `cfg:"pid-filename; titan.pid; ; the file name to record connd PID"`
}

// DB config is the config of titan data struct
type DB struct {
	Hash Hash `cfg:"hash"`
}

// Hash config is the config of titan hash data struct
type Hash struct {
	MetaSlot int64 `cfg:"meta-slot;0;numeric;hashes slot key count"`
}

// Server config is the config of titan server
type Server struct {
	Auth          string `cfg:"auth;;;client connetion auth"`
	Listen        string `cfg:"listen; 0.0.0.0:7369; netaddr; address to listen"`
	MaxConnection int64  `cfg:"max-connection;1000;numeric;client connection count"`
}

// Tikv config is the config of tikv sdk
type Tikv struct {
	PdAddrs string `cfg:"pd-addrs;required; ;pd address in tidb"`
	DB      DB     `cfg:"db"`
	GC      GC     `cfg:"gc"`
	Expire  Expire `cfg:"expire"`
	ZT      ZT     `cfg:"zt"`
	TikvGC  TikvGC `cfg:"tikv-gc"`
}

// TikvGC config is the config of implement tikv sdk gcwork
type TikvGC struct {
	Enable            bool          `cfg:"enable; true; boolean; true for enabling tikv gc"`
	Interval          time.Duration `cfg:"interval;20m;;gc work tick interval"`
	LeaderLifeTime    time.Duration `cfg:"leader-life-time;30m;;lease flush leader interval"`
	SafePointLifeTime time.Duration `cfg:"safe-point-life-time;10m;;safe point life time "`
	Concurrency       int           `cfg:"concurrency;2;;gc work concurrency"`
}

// GC config is the config of Titan GC work
type GC struct {
	Enable         bool          `cfg:"enable; true; boolean; true for enabling gc"`
	Interval       time.Duration `cfg:"interval;1s;;gc work tick interval"`
	LeaderLifeTime time.Duration `cfg:"leader-life-time;3m;;lease flush leader interval"`
	BatchLimit     int           `cfg:"batch-limit;256;numeric;key count limitation per-transection"`
}

// Expire config is the config of Titan expire work
type Expire struct {
	Enable         bool          `cfg:"enable; true; boolean; true for enabling expire"`
	Interval       time.Duration `cfg:"interval;1s;;expire work tick interval"`
	LeaderLifeTime time.Duration `cfg:"leader-life-time;3m;;lease flush leader interval"`
	BatchLimit     int           `cfg:"batch-limit;256;numeric;key count limitation per-transection"`
}

// ZT config is the config of zlist
type ZT struct {
	Enable     bool          `cfg:"enable; true; boolean; true for enabling zt"`
	Workers    int           `cfg:"workers;5;numeric;parallel workers count"`
	BatchCount int           `cfg:"batch;10;numeric;object transfer limitation per-transection"`
	QueueDepth int           `cfg:"depth;100;numeric;ZT Worker queue depth"`
	Interval   time.Duration `cfg:"interval;1000ms; ;Queue fill interval in milsecond"`
}

// Logger config is the config of default zap log
type Logger struct {
	Name       string `cfg:"name; titan; ; the default logger name"`
	Path       string `cfg:"path; logs/titan; ; the default log path"`
	Level      string `cfg:"level; info; ; log level(debug, info, warn, error, panic, fatal)"`
	Compress   bool   `cfg:"compress; false; boolean; true for enabling log compress"`
	TimeRotate string `cfg:"time-rotate; 0 0 0 * * *; ; log time rotate pattern(s m h D M W)"`
}

// TikvLogger config is the config of tikv log
type TikvLogger struct {
	Path       string `cfg:"path; logs/tikv;nonempty ; the default log path"`
	Level      string `cfg:"level; info; ; log level(debug, info, warn, error, panic, fatal)"`
	Compress   bool   `cfg:"compress; false; boolean; true for enabling log compress"`
	TimeRotate string `cfg:"time-rotate; 0 0 0 * * *; ; log time rotate pattern(s m h D M W)"`
}

// Status config is the config of exported server
type Status struct {
	Listen string `cfg:"listen;0.0.0.0:7345;nonempty; listen address of http server"`
}