diff options
Diffstat (limited to 'doc/development/logging.md')
| -rw-r--r-- | doc/development/logging.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/logging.md b/doc/development/logging.md index 45f5b672365..cb1070b49cc 100644 --- a/doc/development/logging.md +++ b/doc/development/logging.md @@ -58,12 +58,12 @@ Structured logging solves these problems. Consider the example from an API reque In a single line, we've included all the information that a user needs to understand what happened: the timestamp, HTTP method and path, user -ID, etc. +ID, and so on. ### How to use JSON logging Suppose you want to log the events that happen in a project -importer. You want to log issues created, merge requests, etc. as the +importer. You want to log issues created, merge requests, and so on, as the importer progresses. Here's what to do: 1. Look at [the list of GitLab Logs](../administration/logs.md) to see @@ -174,7 +174,7 @@ Resources: Similar to timezones, choosing the right time unit to log can impose avoidable overhead. So, whenever challenged to choose between seconds, milliseconds or any other unit, lean towards _seconds_ as float -(with microseconds precision, i.e. `Gitlab::InstrumentationHelper::DURATION_PRECISION`). +(with microseconds precision, that is, `Gitlab::InstrumentationHelper::DURATION_PRECISION`). In order to make it easier to track timings in the logs, make sure the log key has `_s` as suffix and `duration` within its name (for example, `view_duration_s`). |