Developer Guide¶

Clone the pylog git repository¶

git clone "https://gerrit.o-ran-sc.org/r/com/pylog"

Mapped Diagnostics Context¶

The MDCs are logger instance specific key-value pairs, which are included to all log entries written via the logger instance.

By default, the library implements a root logger instance. MDCs added to the root logger instance are added only to the log entries written via the root logger instance.

Log entry format¶

Each log entry written with mdclog_write() function contains

Timestamp
Logger identity
Log entry severity
All existing MDC pairs
Log message text

Currently the library only supports JSON formatted output written to standard out of the process.

Example log output

{“ts”: 1603103945651, “crit”: “ERROR”, “id”: “test.py”, “mdc”: {“PID”:101,”SYSTEM_NAME”: “Cloud-Space”, “HOST_NAME”: “master”, “SERVICE_NAME”: “TestApp”, “CONTAINER_NAME”: “Container-101”, “POD_NAME”: “POD-101”}, “msg”: “Hello World!”}

Install¶

Install from PyPi

python3 -m pip install mdclogpy

Install using the source

python3 setup.py install

Usage¶

The library can be used in two ways shown below.

Use the root logger

```python
  import mdclogpy
  mdclogpy.mdclog_format_init(configmap_monitor=True)
  mdclogpy.error("This is an error log")
```

Create a logger instance

```python
  from mdclogpy import Logger
  my_logger = Logger()
  my_logger.mdclog_format_init(configmap_monitor=True)
  my_logger.error("This is an error log")
```

A program can create several logger instances.

mdclog_format_init() Adds the MDC log format with HostName, PodName, ContainerName, ServiceName,PID,CallbackNotifyforLogFieldChange

Pass configmap_monitor = False in mdclog_format_init() function to stop dynamic log level change based on configmap.

Logging Levels¶

"""Severity levels of the log messages."""
    DEBUG = 10
    INFO = 20
    WARNING = 30
    ERROR = 40

Pylog API’s¶

Set current logging level

def set_level(self, level: Level):

       Keyword arguments:
       level -- logging level. Log messages with lower severity will be filtered.

Return the current logging level

def get_level(self) -> Level:

Add a logger specific MDC

def add_mdc(self, key: str, value: Value):

       Keyword arguments:
       key -- MDC key
       value -- MDC value

Return logger’s MDC value with the given key or None

def get_mdc(self, key: str) -> Value:

Remove logger’s MDC with the given key

def remove_mdc(self, key: str):

Remove all MDCs of the logger instance.

def clean_mdc(self):

Initialise Logging format:

This api Initialzes mdclog print format using MDC Dictionary by extracting the environment variables in the calling process for “SYSTEM_NAME”, “HOST_NAME”, “SERVICE_NAME”, “CONTAINER_NAME”, “POD_NAME” & “CONFIG_MAP_NAME” mapped to HostName, ServiceName, ContainerName, Podname and Configuration-file-name of the services respectively.

def mdclog_format_init(configmap_monitor=False):

       Keyword arguments:
       configmap_monitor -- Enables/Disables Dynamic log level change based on configmap
                         -- Boolean values True/False can be passed as per requirement.

License¶

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, 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).

Unit testing¶

To run the unit tests run the following command in the package directory

python3 -m unittest discover