RIC:1060: Change in PTL

[com/golog.git] / README.md

diff --git a/README.md b/README.md
index 1d5ed40..eb94143 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-Logging library with MDC support
+Logging Library with MDC support

 ================================
 
 A Golang implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.
 ================================
 
 A Golang implementation of a structured logging library with Mapped Diagnostics Context (MDC) support.


@@ -10,12 +10,19 @@ Overview
 
 A new logger instance is created with InitLogger function. Process identity is given as a parameter.
 
 
 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.
 
 
 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
 
 
 Each log entry written the library contains
 


@@ -64,3 +71,12 @@ License
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

+
+ This source code is part of the near-RT RIC (RAN Intelligent Controller)
+ platform project (RICP).
+
+CI
+--
+
+The Dockerfile in the `ci` directory _only_ runs, when build, the unit tests for the repository.
+