-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #84 for v0.7 Release
- Loading branch information
Showing
34 changed files
with
1,663 additions
and
382 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| # aah web framework for Go | ||
| [](https://travis-ci.org/go-aah/aah) [](https://codecov.io/gh/go-aah/aah/branch/master) [](https://goreportcard.com/report/aahframework.org/aah.v0) | ||
| [](https://golang.org) | ||
| [](https://github.com/go-aah/aah/releases/latest) [](https://godoc.org/aahframework.org/aah.v0) | ||
| [](LICENSE) | ||
| [](https://github.com/go-aah/aah/releases/latest) [](https://godoc.org/aahframework.org/aah.v0) | ||
| [](LICENSE) [](https://twitter.com/aahframework) | ||
|
|
||
| ***Release [v0.6](https://github.com/go-aah/aah/releases/latest) tagged on Jun 07, 2017*** | ||
| ***Release [v0.7](https://github.com/go-aah/aah/releases/latest) tagged on Aug 01, 2017*** | ||
|
|
||
| aah framework - A scalable, performant, rapid development Web framework for Go. | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,240 @@ | ||
| // Copyright (c) Jeevanandam M. (https://github.com/jeevatkm) | ||
| // go-aah/aah source code and usage is governed by a MIT style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package aah | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "path/filepath" | ||
| "strings" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "aahframework.org/ahttp.v0" | ||
| "aahframework.org/config.v0" | ||
| "aahframework.org/essentials.v0" | ||
| "aahframework.org/log.v0" | ||
| ) | ||
|
|
||
| const ( | ||
| fmtFlagClientIP ess.FmtFlag = iota | ||
| fmtFlagRequestTime | ||
| fmtFlagRequestURL | ||
| fmtFlagRequestMethod | ||
| fmtFlagRequestProto | ||
| fmtFlagRequestID | ||
| fmtFlagRequestHeader | ||
| fmtFlagQueryString | ||
| fmtFlagResponseStatus | ||
| fmtFlagResponseSize | ||
| fmtFlagResponseHeader | ||
| fmtFlagResponseTime | ||
| fmtFlagCustom | ||
| ) | ||
|
|
||
| var ( | ||
| accessLogFmtFlags = map[string]ess.FmtFlag{ | ||
| "clientip": fmtFlagClientIP, | ||
| "reqtime": fmtFlagRequestTime, | ||
| "requrl": fmtFlagRequestURL, | ||
| "reqmethod": fmtFlagRequestMethod, | ||
| "reqproto": fmtFlagRequestProto, | ||
| "reqid": fmtFlagRequestID, | ||
| "reqhdr": fmtFlagRequestHeader, | ||
| "querystr": fmtFlagQueryString, | ||
| "resstatus": fmtFlagResponseStatus, | ||
| "ressize": fmtFlagResponseSize, | ||
| "reshdr": fmtFlagResponseHeader, | ||
| "restime": fmtFlagResponseTime, | ||
| "custom": fmtFlagCustom, | ||
| } | ||
|
|
||
| appDefaultAccessLogPattern = "%clientip %custom:- %reqtime %reqmethod %requrl %reqproto %resstatus %ressize %restime %reqhdr:referer" | ||
| appReqStartTimeKey = "_appReqStartTimeKey" | ||
| appReqIDHdrKey = ahttp.HeaderXRequestID | ||
| appAccessLog *log.Logger | ||
| appAccessLogFmtFlags []ess.FmtFlagPart | ||
| appAccessLogChan chan *accessLog | ||
| accessLogPool = &sync.Pool{New: func() interface{} { return &accessLog{} }} | ||
| ) | ||
|
|
||
| type ( | ||
| //accessLog contains data about the current request | ||
| accessLog struct { | ||
| StartTime time.Time | ||
| ElapsedDuration time.Duration | ||
| Request *ahttp.Request | ||
| ResStatus int | ||
| ResBytes int | ||
| ResHdr http.Header | ||
| } | ||
| ) | ||
|
|
||
| //‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾ | ||
| // accessLog methods | ||
| //___________________________________ | ||
|
|
||
| // FmtRequestTime method returns the formatted request time. There are three | ||
| // possibilities to handle, `%reqtime`, `%reqtime:` and `%reqtime:<format>`. | ||
| func (al *accessLog) FmtRequestTime(format string) string { | ||
| if format == "%v" || ess.IsStrEmpty(format) { | ||
| return al.StartTime.Format(time.RFC3339) | ||
| } | ||
| return al.StartTime.Format(format) | ||
| } | ||
|
|
||
| func (al *accessLog) GetRequestHdr(hdrKey string) string { | ||
| hdrValues := al.Request.Header[http.CanonicalHeaderKey(hdrKey)] | ||
| if len(hdrValues) == 0 { | ||
| return "-" | ||
| } | ||
| return `"` + strings.Join(hdrValues, ", ") + `"` | ||
| } | ||
|
|
||
| func (al *accessLog) GetResponseHdr(hdrKey string) string { | ||
| hdrValues := al.ResHdr[http.CanonicalHeaderKey(hdrKey)] | ||
| if len(hdrValues) == 0 { | ||
| return "-" | ||
| } | ||
| return `"` + strings.Join(hdrValues, ", ") + `"` | ||
| } | ||
|
|
||
| func (al *accessLog) GetQueryString() string { | ||
| queryStr := al.Request.Raw.URL.Query().Encode() | ||
| if ess.IsStrEmpty(queryStr) { | ||
| return "-" | ||
| } | ||
| return `"` + queryStr + `"` | ||
| } | ||
|
|
||
| func (al *accessLog) Reset() { | ||
| al.StartTime = time.Time{} | ||
| al.ElapsedDuration = 0 | ||
| al.Request = nil | ||
| al.ResStatus = 0 | ||
| al.ResBytes = 0 | ||
| al.ResHdr = nil | ||
| } | ||
|
|
||
| //‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾ | ||
| // Unexported methods | ||
| //___________________________________ | ||
|
|
||
| func initAccessLog(logsDir string, appCfg *config.Config) error { | ||
| // log file configuration | ||
| cfg, _ := config.ParseString("") | ||
| file := appCfg.StringDefault("server.access_log.file", "") | ||
|
|
||
| cfg.SetString("log.receiver", "file") | ||
| if ess.IsStrEmpty(file) { | ||
| cfg.SetString("log.file", filepath.Join(logsDir, getBinaryFileName()+"-access.log")) | ||
| } else { | ||
| abspath, err := filepath.Abs(file) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| cfg.SetString("log.file", abspath) | ||
| } | ||
|
|
||
| cfg.SetString("log.pattern", "%message") | ||
|
|
||
| var err error | ||
|
|
||
| // initialize request access log file | ||
| appAccessLog, err = log.New(cfg) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // parse request access log pattern | ||
| pattern := appCfg.StringDefault("server.access_log.pattern", appDefaultAccessLogPattern) | ||
| appAccessLogFmtFlags, err = ess.ParseFmtFlag(pattern, accessLogFmtFlags) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // initialize request access log channel | ||
| if appAccessLogChan == nil { | ||
| appAccessLogChan = make(chan *accessLog, cfg.IntDefault("server.access_log.channel_buffer_size", 500)) | ||
| go listenForAccessLog() | ||
| } | ||
|
|
||
| appReqIDHdrKey = cfg.StringDefault("request.id.header", ahttp.HeaderXRequestID) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func listenForAccessLog() { | ||
| for { | ||
| appAccessLog.Print(accessLogFormatter(<-appAccessLogChan)) | ||
| } | ||
| } | ||
|
|
||
| func sendToAccessLog(ctx *Context) { | ||
| al := acquireAccessLog() | ||
| al.StartTime = ctx.values[appReqStartTimeKey].(time.Time) | ||
|
|
||
| // All the bytes have been written on the wire | ||
| // so calculate elapsed time | ||
| al.ElapsedDuration = time.Since(al.StartTime) | ||
|
|
||
| req := *ctx.Req | ||
| al.Request = &req | ||
| al.ResStatus = ctx.Res.Status() | ||
| al.ResBytes = ctx.Res.BytesWritten() | ||
| al.ResHdr = ctx.Res.Header() | ||
|
|
||
| appAccessLogChan <- al | ||
| } | ||
|
|
||
| func accessLogFormatter(al *accessLog) string { | ||
| defer releaseAccessLog(al) | ||
| buf := acquireBuffer() | ||
| defer releaseBuffer(buf) | ||
|
|
||
| for _, part := range appAccessLogFmtFlags { | ||
| switch part.Flag { | ||
| case fmtFlagClientIP: | ||
| buf.WriteString(al.Request.ClientIP) | ||
| case fmtFlagRequestTime: | ||
| buf.WriteString(al.FmtRequestTime(part.Format)) | ||
| case fmtFlagRequestURL: | ||
| buf.WriteString(al.Request.Path) | ||
| case fmtFlagRequestMethod: | ||
| buf.WriteString(al.Request.Method) | ||
| case fmtFlagRequestProto: | ||
| buf.WriteString(al.Request.Unwrap().Proto) | ||
| case fmtFlagRequestID: | ||
| buf.WriteString(al.GetRequestHdr(appReqIDHdrKey)) | ||
| case fmtFlagRequestHeader: | ||
| buf.WriteString(al.GetRequestHdr(part.Format)) | ||
| case fmtFlagQueryString: | ||
| buf.WriteString(al.GetQueryString()) | ||
| case fmtFlagResponseStatus: | ||
| buf.WriteString(fmt.Sprintf(part.Format, al.ResStatus)) | ||
| case fmtFlagResponseSize: | ||
| buf.WriteString(fmt.Sprintf(part.Format, al.ResBytes)) | ||
| case fmtFlagResponseHeader: | ||
| buf.WriteString(al.GetResponseHdr(part.Format)) | ||
| case fmtFlagResponseTime: | ||
| buf.WriteString(fmt.Sprintf("%.4f", al.ElapsedDuration.Seconds()*1e3)) | ||
| case fmtFlagCustom: | ||
| buf.WriteString(part.Format) | ||
| } | ||
| buf.WriteByte(' ') | ||
| } | ||
| return strings.TrimSpace(buf.String()) | ||
| } | ||
|
|
||
| func acquireAccessLog() *accessLog { | ||
| return accessLogPool.Get().(*accessLog) | ||
| } | ||
|
|
||
| func releaseAccessLog(al *accessLog) { | ||
| if al != nil { | ||
| al.Reset() | ||
| accessLogPool.Put(al) | ||
| } | ||
| } |
Oops, something went wrong.