# README
Service
Service is basic service package used to build your own service.
Services List
- Logger logrus, ELK
- HTTP go built-in http using gorilla mux
- MQ RabbitMQ
- MySQL go-mysql
- Redis go-redis
ServiceConfig.json
{
"Version":"1.0",
"Environment": "local",
"Service": "what-server",
"Logger":{
"Enable":true, // enable logger
"FullPath":false, // log with full path or not
"FileName":"lottery", //logger file name
"Level":"info" //default level:"debug", "info", "warning", "error", "panic"
"Address": "10.32.10.175:8100" //elk address
},
"Mysql":{
"Enable":true, //true=enable, false=disable
"MainDB":{
"DriverName":"mysql",
"User":"user", //account
"Password":"pass", //password
"Net":"tcp", //net string
"Address":"localhost:3306", //ip:port
"DBName":"", //db name
"Timeout":"1m", //Timeout for establishing connections, aka dial timeout.
"ReadTimeout":"1m5s", //io write timeout
"WriteTimeout":"1m5s" //io read timeout
"SetMaxOpenConns":0, //maximum number of open connections to the database
//If n <= 0, then there is no limit
//golang default is 0
"SetMaxIdleConns":200, //maximum number of connections in the idle connection pool
//If n <= 0, no idle connections are retained.
//golang defaut is 2
//If MaxOpenConns is greater than 0 but less than the new MaxIdleConns,
//then the new MaxIdleConns will be reduced to match the MaxOpenConns limit.
"SetConnMaxIdleTime":180, //maximum amount of time a connection may be idle
//Expired connections may be closed lazily before reuse.
//If d <= 0, connections are not closed due to a connection's idle time.
//單位秒
"SetConnMaxLifetime":2000, //maximum amount of time a connection may be reused
//Expired connections may be closed lazily before reuse
//If d <= 0, connections are not closed due to a connection's age
//連線建立後多久會過期，之後不能重用。
//如果這個連線從建立開始後一直使用，是可以超過maxLifeTime。只是不能被重用。
//超過maxLifeTime會被關閉。
//單位秒
},
"ReadWriteSplitting":false,
"ReadOnlyDB":{
"DriverName":"mysql",
"User":"user",
"Password":"pass",
"Net":"tcp",
"Address":"localhost:3306",
"DBName":"",
"Timeout":"1m",
"ReadTimeout":"1m2s",
"WriteTimeout":"1m2s"
"SetMaxOpenConns":0,
"SetMaxIdleConns":200,
"SetConnMaxIdleTime":180,
"SetConnMaxLifetime":2000,
}
},
"MQ":{
"Enable":true,
"Url":"amqp://account:password@localhost:5672/", //account:password@ip:port
"ResponseTimeoutSecond":10,
"Qos":{
"PrefetchCount":100, //comsumer 一次取幾個 message
"PrefetchSize":0, //message 的 size, 0=無限制
"Global":false
},
//目前架構至少要有兩個queue
//一個收 command, 一個收 response
"QueueDefinition": [
{
"Name": "command", //queue name
"Durable": true, //durable
"AutoDelete": false, //if auto delete queue
"Exclusive": false, //if exclusive
"NoWaite": false, //if no wait
"Args": { //queue args a map[string]interface{}
"A": 10,
"B": 20
}
},
{
"Name": "response",
"Durable": true,
"AutoDelete": false,
"Exclusive": false,
"NoWaite": false,
"Args": {}
}
],
// command consumer param, 收 command 的 command consumer 參數
"CommandConsumerParam": {
"Queue": "command",
"Consumer": "",
"AutoAck": false,
"Exclusive": false,
"NoLocal": false,
"NoWaite": false,
"Args": {}
},
// 收 response 的 consumer 參數
"ResponseConsumerParam": {
"Queue": "response",
"Consumer": "",
"AutoAck": false,
"Exclusive": false,
"NoLocal": false,
"NoWaite": false,
"Args": {}
}
},
"HTTP":{
"Enable":true,
"Address":"",
"Port":"20000",
"ReadTimeoutSecond":10,
"WriteTimeoutSecond":10,
"IdleTimeoutSecond":10,
"MaxHeaderBytes":1048576,
"IsTLS":false,
"CertificateFile":"lc8168.com.crt",
"KeyFile":"lc8168.com.key"
},
"Redis":{
"Enable":true, //true=enable, false=disable
"Network":"tcp", //net default "tcp"
"Address":"localhost:6379", //ip:port
"Password":"", //password
"DB":0, //db index, 0-15
"DialTimeoutSecond":5,
"ReadTimeoutSecond":3,
"WriteTimeoutSecond":3,
"PoolSize":10
},
"Others": {
"str": "abc",
"int": 123123,
"float": 123123.45,
"arr": [1, 2, 3, 4, 5],
"map": {"test": "1787"}
},
"Websocket": {
"Enable": true,
"Address": "",
"Port": "9000",
"ConnPoolSize": 10000,
"ChanPoolSize": 1000,
"AcceptTimeout": "3s",
"AliveTimeout": "3s",
"ReadBufferSize": 10240,
"WriteBufferSize": 10240
}
}
Others Example
go
testString, err := cfg.GetString("str")
if err != nil {
panic("unknown key")
}
fmt.Printf("%s\n", testString)
i, err := cfg.GetInt64("int")
if err != nil {
panic("unknown key")
}
fmt.Printf("%v\n", i)
f, err := cfg.GetFloat64("float")
if err != nil {
panic("unknown key")
}
fmt.Printf("%v\n", f)
var arr []int
err = cfg.GetArray("arr", &arr)
if err != nil {
panic(err)
}
fmt.Printf("%v\n", arr)
s := struct{
Test string
}{}
err = cfg.GetMap("map", &s)
if err != nil {
panic("unknown key")
}
fmt.Printf("%v\n", s)
output
abc123123
123123.45
[1 2 3 4 5]
Using ELK log system (Elasticsearch、Logstash、Kibana)
1. Before handle request
logger, err := svc.GetLogger()
if err != nil {
...
}
// Record service-wide information
logger.WithFields(logrus.Fields{
"service": "api-server",
"host": "...",
"port": "...",
})
2. Declare a log entry in the beginning of a http request handler function.
func (h *handler) handleFunc() {
// Do not use logger directly in http requests
entry := h.logger.NewEntry()
...
}
3. Passing entry into functions whenever logging is needed.
...
doSomethingNeedLog(entry, anotherParameters...)
...
4. Using WithField() and WithFields() to record common informations within a request.
func doSomethingNeedLog(entry, param1, param2, ...) {
// Record common informations
entry.WithFields(logrus.Fields{
"key1": param1,
"key2": param2,
})
// Record common information
info := getSomeInfomation()
entry.WithField("info": info)
5. Fire logs with Info(), Warn(), Error()
if err := doSomethingMayError(); err != nil {
entry.WithField("err", err).Error("doSomethingNeedLog failed at doSomthingMayError")
return
}
}
Recommended log keys
- service
- address
- host
- port
- ip
- func
- agentID
- userID
- command
- path
- method
- error
- requestID