mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-12 09:23:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

Code Style: Prefer WithFields over Infof

Browse source
This commit is contained in:
Erik Johnston 2017-11-21 18:05:53 +00:00
parent e5f5bb5961
commit ad23cb1024
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CODE_STYLE.md
View file

@ -52,6 +52,25 @@ github. These can be added just before merging of the PR to master, and the
issue number should be added to the comment, e.g. `// TODO(#324): ...`
## Logging
We prefer to log with static log messages and include any dynamic information
in fields.
```golang
logger := util.GetLogger(ctx)
// Not recommended
logger.Infof("Finished processing keys for %s, number of keys %d", name, numKeys)
// Recommended
logger.WithFields(logrus.Fields{
"numberOfKeys": numKeys,
"entityName": name,
}).Info("Finished processing keys")
```
## Visual Studio Code
If you use VSCode then the following is an example of a workspace setting that