Go Web编程添加服务器错误和访问日志
前言
错误日志和访问日志是一个服务器必须支持的功能,我们教程里使用的服务器到目前为止还没有这两个功能。正好前两天也写了篇介绍logrus
日志库的文章,那么今天的文章里就给我们自己写的服务器加上错误日志和访问日志的功能。在介绍添加访问日志的时候会介绍一种通过编写中间件获取HTTP
响应的StausCode
和Body
的方法。
Go Web 编程系列的每篇文章的源代码都打了对应版本的软件包,供大家参考。公众号中回复gohttp11
获取本文源代码
初始化日志记录器
我们先来做一下初始化工作,在项目里初始化记录错误日志和访问日志的记录器Logger
。
// ./utils/vlog package vlog import ( "github.com/sirupsen/logrus" "os" ) var ErrorLog *logrus.Logger var AccessLog *logrus.Logger var errorLogFile = "./tmp/log/error.log" var accessLogFile = "./tmp/log/access.log" func init () { initErrorLog() initAccessLog() } func initErrorLog() { ErrorLog = logrus.New() ErrorLog.SetFormatter(&logrus.JSONFormatter{}) file , err := os.OpenFile(errorLogFile, os.O_RDWR | os.O_CREATE | os.O_APPEND, 0755) if err != nil { panic(err) } ErrorLog.SetOutput(file) } func initAccessLog() { AccessLog = logrus.New() AccessLog.SetFormatter(&logrus.JSONFormatter{}) file , err := os.OpenFile(accessLogFile, os.O_RDWR | os.O_CREATE | os.O_APPEND, 0755) if err != nil { panic(err) } AccessLog.SetOutput(file) }
- 我们新定义一个
package
在init
函数中来初始化记录器,这样服务器成功启动前就会初始化好记录器。 /tmp/log
这个目录要提前创建好,执行init
函数时会自动创建好access.log
和error.log
。
添加错误日志
我们创建服务器使用的net/http
包的Server
类型中,有一个ErrorLog
字段供开发者设置记录错误日志用的记录器Logger
,默认使用的是log
包默认的记录器(应该是系统的标准错误):
type Server struct { Addr string // TCP address to listen on, ":http" if empty Handler Handler // handler to invoke, http.DefaultServeMux if nil ... // ErrorLog specifies an optional logger for errors accepting // connections, unexpected behavior from handlers, and // underlying FileSystem errors. // If nil, logging is done via the log package's standard logger. ErrorLog *log.Logger ... }
我们之前在创建服务器的时候自己实现了Server
类型的对象,那么现在要做的就是将上面初始化好的错误日志的记录器指定给Server
的ErrorLog
字段。
func main() { ... // 将logrus的Logger转换为io.Writer errorWriter := vlog.ErrorLog.Writer() // 记得关闭io.Writer defer errorWriter.Close() server := &http.Server{ Addr: ":8080", Handler: muxRouter, // 用记录器转换成的io.Writer创建log.Logger ErrorLog: log.New(vlog.ErrorLog.Writer(), "", 0), } ... }
添加好错误日志的记录器后,我们找个路由处理函数,在里面故意制造运行时错误验证一下是否能记录到错误。
func (*HelloHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { ints := []int{0, 1, 2} fmt.Fprintf(w, "%v", ints[0:5]) }
在上面处理函数中,通过切片表达式越界故意制造了一个运行时错误,打开error.log
后能看到文件里已经记录到这个运行时错误及其Stack trace
添加访问日志
和Server
对象可以设置错误日志的记录器不一样,访问日志只能是我们通过自己编写中间件的方式来实现了。在记录访问日志的中间件里我们会记录ip
,method
,path
,query
,request_body
,status
和response_body
这些个字段的内容。
status
和response_body
两个字段来自请求对应的响应。响应在net/http
包里是用http.ResponseWriter
接口表示的
type ResponseWriter interface { Header() Header Write([]byte) (int, error) WriteHeader(statusCode int) }
接口本身以及net/http
提供的实现都没有让我们进行读取的方法,所以在编写的用于记录访问日志的中间件里需要对net/http
库本身实现的ResponseWriter
做一层包装。
利用Go
语言结构体类型嵌套匿名类型后,结构体拥有了被嵌套类型的所有导出字段和方法的特性,我们可以很方便地对原来的ResponseWriter
做一层包装,然后只重新实现需要更改的方法即可:
type ResponseWithRecorder struct { http.ResponseWriter statusCode int body bytes.Buffer } func (rec *ResponseWithRecorder) WriteHeader(statusCode int) { rec.ResponseWriter.WriteHeader(statusCode) rec.statusCode = statusCode } func (rec *ResponseWithRecorder) Write(d []byte) (n int, err error) { n, err = rec.ResponseWriter.Write(d) if err != nil { return } rec.body.Write(d) return }
定义好新的类型后我们重新实现了WriteHeader
和Write
方法,在向原来的ReponseWriter
中写入后也会向ResponseWriteRecoder.statusCode和ResponseWriteRecoder.body写入对应的数据。这样我们就可以在中间件里通过这两个字段访问响应码和响应数据了。
记录访问日志的中间件定义如下:
func AccessLogging (f http.Handler) http.Handler { // 创建一个新的handler包装http.HandlerFunc return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { buf := new(bytes.Buffer) buf.ReadFrom(r.Body) logEntry := vlog.AccessLog.WithFields(logrus.Fields{ "ip": r.RemoteAddr, "method": r.Method, "path": r.RequestURI, "query": r.URL.RawQuery, "request_body": buf.String(), }) wc := &ResponseWithRecorder{ ResponseWriter: w, statusCode: http.StatusOK, body: bytes.Buffer{}, } // 调用下一个中间件或者最终的handler处理程序 f.ServeHTTP(wc, r) defer logEntry.WithFields(logrus.Fields{ "status": wc.statusCode, "response_body": wc.body.String(), }).Info() }) }
在Router
上应用创建好的AccessLogging
中间件后,就可以正常的记录服务器的访问日志了。
// router/router.go func RegisterRoutes(r *mux.Router) { ... // apply Logging middleware r.Use(middleware.Logging(), middleware.AccessLogging) ... }
不过有两点需要注意一下
- 这里为了演示获取响应数据记录了
response_body
字段,如果是接口响应内容记录下还可以,但是如果是HTML
还是不记录的为好。 - 初始化
ResponseWithRecorder
时默认设置了statusCode
是因为,服务器正确返回响应时不会显式调用WriteHeader
方法,只有在返回NOT_FOUND
之类的错误的时候才会调用WriteHeader
方法,针对这种情况需要在初始化的时候把statusCode
的默认值设置为200
。
现在再访问服务器后打开access.log
会看到刚刚的访问日志,就能看到刚刚请求的url
,method
,客户端IP等信息了。
{"ip":"......","level":"info","method":"GET","msg":"","path":"/index/","query":"","request_body":"","response_body":"Hello World1","status":200,"time":"2020-03-26T04:21:46Z"}
注意:文章只为说明演示方便,获取IP的方法无法获取代理后的真实IP,请悉知。
以上就是Go Web编程添加服务器错误和访问日志的详细内容,更多关于Go Web服务器错误访问日志的资料请关注猪先飞其它相关文章!
原文出处:http://170e.cn/864o
相关文章
- 在程序员中,尤其是go新手,经常听到的一个讨论话题是:如何处理错误,这篇文章主要给大家介绍了关于Go应用中优雅处理Error的一些相关技巧,需要的朋友可以参考下...2021-09-08
Springboot如何实现Web系统License授权认证
这篇文章主要介绍了Springboot如何实现Web系统License授权认证,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-05-28C#使用Http Post方式传递Json数据字符串调用Web Service
这篇文章主要为大家详细介绍了C#使用Http Post方式传递Json数据字符串调用Web Service,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2020-06-25Django def clean()函数对表单中的数据进行验证操作
这篇文章主要介绍了Django def clean()函数对表单中的数据进行验证操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-09- 简单的php获取linux服务器状态的代码,不多说-直接上函数:复制代码 代码如下:function get_used_status(){ $fp = popen('top -b -n 2 | grep -E "^(Cpu|Mem|Tasks)"',"r");//获取某一时刻系统cpu和内存使用情况 $rs =...2014-05-31
InterlliJ IDEA2020新建java web项目找不到Static Web的解决
这篇文章主要介绍了InterlliJ IDEA2020新建java web项目找不到Static Web的解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-02- 这篇文章主要介绍了Springboot+TCP监听服务器搭建过程,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-10-28
- 前一段时间使用NetStat命令查看服务器端口时,发现服务器udp端口开放了好多,最少在1000个以上,当时事情比较多,没有管它,今天终于有点时间,仔细检查了一下,排除了这个问题. ...2016-01-27
详解在IDEA中将Echarts引入web两种方式(使用js文件和maven的依赖导入)
这篇文章主要介绍了在IDEA中将Echarts引入web两种方式(使用js文件和maven的依赖导入),本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-07-11- “主机,用户名,密码”得到连接、“数据库,sql,连接”得到结果,最后是结果的处理显示。当然,数据库连接是扩展库为我们完成的,我们能做的仅仅是处理结果而已。...2013-09-29
- 这篇文章主要介绍了jQuery mobile 移动web(6)的相关资料,需要的朋友可以参考下...2015-12-21
解决HttpPost+json请求---服务器中文乱码及其他问题
这篇文章主要介绍了解决HttpPost+json请求---服务器中文乱码及其他问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-01-22- 这篇文章主要介绍了golang官方嵌入文件到可执行程序,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-02-20
- 这篇文章主要介绍了go浮点数转字符串保留小数点后N位解决办法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-05-11
- 这篇文章主要介绍了Go语言使用读写OPC详解,图文讲解的很清晰,有感兴趣的同学可以学习下...2021-03-05
- string与[]byte经常需要互相转化,普通转化会发生底层数据的复制,下面这篇文章主要给大家介绍了关于Go中string与[]byte高效互转的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下...2021-09-20
- 这篇文章主要介绍了Hyper-V尝试连接到服务器出错无效类的解决方法,需要的朋友可以参考下...2016-09-28
- 这篇文章主要介绍了Go项目的目录结构,对基础目录做了讲解,对项目开发中的其它目录也一并做了介绍,需要的朋友可以参考下...2020-05-01
- 这篇文章主要介绍了mac使用Shell(终端)SSH连接远程服务器的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-07-11
- 这篇文章主要为大家详细介绍了js实现上传图片到服务器,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-04-11