Stat Manuals

About

golang application local business monitor
application can integrate stat module by follow directions

Stat Log Style

Statistic in 60s, CTime: 2017-09-07 06:57:23
  ---------------------
Head Information
---------------------
| MsgIn| MsgOut
total: | 0| 0
count /1s: | 0| 0
---------------------
Operation Information
---------------------
Op | tcount|avg_de_ms|de_max_ms| max_ip|> 20(ms)|> 50(ms)|>100(ms)| 180(ms)|
---------------------
Error Information
---------------------
Op | Err1 | Err2 | Err3 | Err4 | Err5 | total count
---------------------
TOTAL | 0/0 | 0/0 | 0/0 | 0/0 | 0/0 | 0
---------------------
IP Information
---------------------
retcode | ip1 | ip2 | ip3
---------------------
Tail Information
---------------------
INDEGREE_Recive(B)# | 0
INDEGREE_Send(B)# | 0

Dependences

github.com/astaxie/beego/logs
original beego still need to modify to support stat module

First Change

add blankprefix support
modify logs/file.go as show below

Json Config Support

    type fileLogWriter struct {
        sync.RWMutex
        Filename         string `json:"filename"`
        BlankPrefix      bool   `json:"blankprefix"`
    }

FileWriter Default BlankPrefix Support

    func newFileWriter() Logger {
        w := &fileLogWriter{
                Daily:      true,
                MaxDays:    7,
                Rotate:     true,
                BlankPrefix: false,
                RotatePerm: "0440",
                Level:      LevelTrace,
                Perm:       "0660",
        }
        return w
    }

Real Write Support

       func (w *fileLogWriter) WriteMsg(when time.Time, msg string, level int)  error {
             if level > w.Level {
                return nil
            }
            h, d := formatTimeHeader(when)
           if !w.BlankPrefix {
             msg = string(h) + msg + "\n"
           }else{
             msg = msg + "\n"
           }
	   ....
       }

Second Change

Remove the logger level prefix in log line,such as [I],[D],...

BeeLogger Add Member attribute

attribute blankPrefix

    type BeeLogger struct {
        lock                sync.Mutex
        level               int
        init                bool
        enableFuncCallDepth bool
        loggerFuncCallDepth int
        asynchronous        bool
        blankPrefix         bool
        msgChanLen          int64
        msgChan             chan *logMsg
        signalChan          chan string
        wg                  sync.WaitGroup
        outputs             []*nameLogger
    }

BeeLogger Member Default Value

blankPrefix set default value

    func NewLogger(channelLens ...int64) *BeeLogger {
         bl := new(BeeLogger)
         bl.level = LevelDebug
         bl.loggerFuncCallDepth = 2
        bl.blankPrefix = false
        bl.msgChanLen = append(channelLens, 0)[0]
        if bl.msgChanLen <= 0 {
                bl.msgChanLen = defaultAsyncMsgLen
        }
        bl.signalChan = make(chan string, 1)
        bl.setLogger(AdapterConsole)
        return bl
    }

BeeLogger Add Interface

    func (bl *BeeLogger) BlankPrefix() {
        bl.blankPrefix = true
    }

BeeLogger WriteMsg Modify

clause msg = levelPrefix[logLevel] + msg add condition

    func (bl *BeeLogger) writeMsg(logLevel int, msg string, v ...interface{})         error {
        if !bl.init {
                bl.lock.Lock()
                bl.setLogger(AdapterConsole)
                bl.lock.Unlock()
        }

        if len(v) > 0 {
                msg = fmt.Sprintf(msg, v...)
        }
        when := time.Now()
        if bl.enableFuncCallDepth {
                _, file, line, ok := runtime.Caller(bl.loggerFuncCallDepth)
                if !ok {
                        file = "???"
                        line = 0
                }
                _, filename := path.Split(file)
                msg = "[" + filename + ":" + strconv.Itoa(line) + "] " + msg
        }
        //set level info in front of filename info
        if logLevel == levelLoggerImpl {
                logLevel = LevelEmergency
        } else {
             if !bl.blankPrefix {
                     msg = levelPrefix[logLevel] + msg
             }
        }
        ....
     }

Using Help

Base Initialize

	logconfig := make(stat.LoggerParm)
	logconfig.level = "info"
	logconfig.path = "./stat"
	logconfig.namePrefix = "test"
	logconfig.filename = "stat.log"
	logconfig.maxfilesize = 10000
	logconfig.maxdays = 7
	logconfig.maxlines = 10000
	logconfig.chanlen = 10000
	stat.Init(logconfig, 60)
	stat.StatProc()

Application Initialize

    stat.SetDelayUp(20,50,100)

Add Stat Record Data

    type StatItem struct {
	  Name      string //统计的接口名
	  Delay     uint   //接口执行的延时,单位ms
	  Errcode   int    //当次接口请求的错误码,0--成功
	  Ipsrc     net.IP //请求的来源ip
	  Payload   uint   //请求的载荷
	  Direction int    //上行or下行          1 --- 上行   0 ----下行
	  InOrOut   int    //入度请求还是出度请求  1 ---- in  0 ----out
    }

    stat.Push(elem)

Exit Must Call

    stat.Exit()

Already Include Stat Options

    const (
       STAT_IN			        = "MsgIn"
       STAT_OUT				    = "MsgOut"
       INDEGREE_Recive 		    = "InDegree_Recive(B)"
       INDEGREE_Send			= "InDegree_Send(B)"
       OUTDEGREE_Recive 		= "OutDegree_Recive(B)"
       OUTDEGREE_Send			= "OutDegree_Send(B)"
    )

User How to Add Stat Options

user can add user define option and call interface below to tag itemName to Stat Module

   AddReportHeadItem(itemName string)
   AddReportBodyRowItem(itemName string)
   AddReportBodyColItem(itemName string)
   AddReportTailItem(itemName string)
   AddReportErrorItem(itemName string)