From 64a088b2222a9d745857ba4726f9ebff11de5956 Mon Sep 17 00:00:00 2001 From: Roni Riska Date: Mon, 25 Nov 2019 09:35:48 +0200 Subject: [PATCH] Update README.md Added more description of the MDC usage. Change-Id: I45490c50396d5297171374b05d4a5e041611f996 Signed-off-by: Roni Riska --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e84607..9f94a07 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,19 @@ Overview A new logger instance is created with InitLogger function. Process identity is given as a parameter. -### Mapped Diagnostics Context +### Mapped Diagnostics Context The MDCs are key-value pairs, which are included to all log entries by the library. The MDC pairs are logger instance specific. -### Log entry format +The idea of the MDC is to define values, which stay the same over multiple log writings. +An MDC value set once will appear in all the subsequent logs written with the logger instance. + +A logger instance can be shared by several goroutines. +Respectively, also the MDC values of the logger instance are then shared by them. +When sharing of the MDCs is not desired, separate logger instances should be used. + +### Log entry format Each log entry written the library contains -- 2.16.6