Adding Documentation to pylog

Signed-off-by: wahidw <abdulwahid.w@nokia.com>
Change-Id: Ifc8d61e919d1f722bb9802e32f623777d68f5170

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 33f9735..df208f2 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -66,7 +66,7 @@ out of the process.
 
 *Example log output*
 
-`{"ts": 1603103945651, "crit": "ERROR", "id": "test.py", "mdc": {"SYSTEM_NAME": "Cloud-Space", "HOST_NAME": "master", "SERVICE_NAME": "TestApp", "CONTAINER_NAME": "Container-101", "POD_NAME": "POD-101"}, "msg": "Hello World!"}`
+`{"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
 -------
@@ -171,7 +171,7 @@ Pylog API's
  def clean_mdc(self):
 
 
-7. Initialise Sep Logging format: 
+7. 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.
 

diff --git a/mdclogpy/README.md b/mdclogpy/README.md
index 41ea5b1..c2ce6af 100644 (file)
--- a/mdclogpy/README.md
+++ b/mdclogpy/README.md
@@ -25,7 +25,7 @@ out of the process.
 
 *Example log output*
 
-`{"ts": 1603103945651, "crit": "ERROR", "id": "test.py", "mdc": {"SYSTEM_NAME": "Cloud-Space", "HOST_NAME": "master", "SERVICE_NAME": "TestApp", "CONTAINER_NAME": "", "POD_NAME": ""}, "msg": "Hello World!"}`
+`{"ts": 1603103945651, "crit": "ERROR", "id": "test.py", "mdc": {"PID":101,"SYSTEM_NAME": "Cloud-Space", "HOST_NAME": "master", "SERVICE_NAME": "TestApp", "CONTAINER_NAME": "", "POD_NAME": ""}, "msg": "Hello World!"}`
 
 
 Install

diff --git a/mdclogpy/setup.py b/mdclogpy/setup.py
index 896242d..c4e49bc 100644 (file)
--- a/mdclogpy/setup.py
+++ b/mdclogpy/setup.py
@@ -40,4 +40,5 @@ setup(name='mdclogpy',
       author='kturunen',
       license='Apache Software License',
       packages=['mdclogpy'],
+      install_requires=['inotify'],
       zip_safe=False)