Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
李少辉-开发者
gitlab-foss
提交
5665ecee
G
gitlab-foss
项目概览
李少辉-开发者
/
gitlab-foss
通知
15
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
G
gitlab-foss
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
5665ecee
编写于
3月 02, 2019
作者:
S
Steve Azzopardi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add logging info to Go guide
closes
https://gitlab.com/gitlab-org/gitlab-ce/issues/57298
上级
e4b2c3b0
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
30 addition
and
3 deletion
+30
-3
doc/development/go_guide/index.md
doc/development/go_guide/index.md
+30
-3
未找到文件。
doc/development/go_guide/index.md
浏览文件 @
5665ecee
...
...
@@ -161,12 +161,39 @@ in the code.
### Logging
The usage of a logging library is strongly recommended for daemons. Even
though
there is a
`log`
package in the standard library, we generally use
[
l
ogrus
](
https://github.com/sirupsen/logrus
)
. Its plugin ("hooks") system
The usage of a logging library is strongly recommended for daemons. Even
th
ough th
ere is a
`log`
package in the standard library, we generally use
[
L
ogrus
](
https://github.com/sirupsen/logrus
)
. Its plugin ("hooks") system
makes it a powerful logging library, with the ability to add notifiers and
formatters at the logger level directly.
#### Structured (JSON) logging
Every binary ideally must have structured (JSON) logging in place as it helps
with searching and filtering the logs. At GitLab we use structured logging in
JSON format, as all our infrastructure assumes that. When using
[
Logrus
](
https://github.com/sirupsen/logrus
)
you can turn on structured
logging simply by using the build in
[
JSON
formatter
](
https://github.com/sirupsen/logrus#formatters
)
. This follows the
same logging type we use in our
[
Ruby
applications
](
../logging.md#use-structured-json-logging
)
.
#### How to use Logrus
There are a few guidelines one should follow when using the
[
Logrus
](
https://github.com/sirupsen/logrus
)
package:
-
When printing an error use
[
WithError
](
https://godoc.org/github.com/sirupsen/logrus#WithError
)
. For
exmaple,
`logrus.WithError(err).Error("Failed to do something")`
.
-
Since we use
[
structured logging
](
#structured-json-logging
)
we can log
fields in the context of that code path, such as the URI of the request using
[
`WithField`
](
https://godoc.org/github.com/sirupsen/logrus#WithField
)
or
[
`WithFields`
](
https://godoc.org/github.com/sirupsen/logrus#WithFields
)
. For
example,
`logrus.WithField("file", "/app/go).Info("Opening dir")`
. If you
have to log multiple keys, always use
`WithFields`
instead of calling
`WithField`
more than once.
### Tracing and Correlation
[
LabKit
](
https://gitlab.com/gitlab-org/labkit
)
is a place to keep common
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录