diff options
| author | Henrik Edin <henrik.edin@mongodb.com> | 2020-05-26 14:26:53 -0400 |
|---|---|---|
| committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2020-05-26 19:59:12 +0000 |
| commit | 859b070a60308b61c7b338bbff8c687f0fd23db2 (patch) | |
| tree | d837f885aefcbf45a5d31be4f3f3cfea65678183 /src/mongo/logv2 | |
| parent | 9618b190e396cfdbf920ac1e7a4177a3c973b46c (diff) | |
| download | mongo-859b070a60308b61c7b338bbff8c687f0fd23db2.tar.gz | |
SERVER-48277 Add text in logv2/README.md about using JIRA ticket for selecting logging ID
Diffstat (limited to 'src/mongo/logv2')
| -rw-r--r-- | src/mongo/logv2/README.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/mongo/logv2/README.md b/src/mongo/logv2/README.md index 42cd65969cc..6de91a458e8 100644 --- a/src/mongo/logv2/README.md +++ b/src/mongo/logv2/README.md @@ -107,7 +107,7 @@ Logging is performed using function style macros: `LOGV2(ID, format-string, message-string, "name0"_attr = var0, ..., "nameN"_attr = varN);` -The ID is a signed 32bit integer in the same number space as the error code numbers. It is used to uniquely identify a log statement. If changing existing code, using a new ID is strongly advised to avoid any parsing ambiguity. +The ID is a signed 32bit integer in the same number space as the error code numbers. It is used to uniquely identify a log statement. If changing existing code, using a new ID is strongly advised to avoid any parsing ambiguity. When selecting ID during work on JIRA ticket `SERVER-ABCDE` you can use the JIRA ticket number to avoid ID collisions with other engineers by taking ID from the range `ABCDE00` - `ABCDE99`. The format string contains the description of the log event with libfmt style replacement fields optionally embedded within it. The format string must comply with the [format syntax](https://fmt.dev/6.1.1/syntax.html#formatspec) from libfmt. The purpose of embedding the replacement fields is to be able to create a human readable message used by the text output format or a tool that converts JSON logs to a human readable format. |