summaryrefslogtreecommitdiffstats
path: root/docs/sections/logging.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sections/logging.rst')
-rw-r--r--docs/sections/logging.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/sections/logging.rst b/docs/sections/logging.rst
new file mode 100644
index 0000000..eb2739f
--- /dev/null
+++ b/docs/sections/logging.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Logging
+=============================================
+
+OSDF uses a single logger, oslo, across all the components. The logging format is compliant with the EELF recommendations,
+including having the following logs:
+error, audit, metric, application.
+
+The log statements follow the following format (values default to preset values when missing):
+
+Timestamp|RequestId|ServiceInstanceId|ThreadId|Virtual Server Name|ServiceName|InstanceUUID|Log Level|Alarm Severity Level|Server IP Address|HOST NAME|Remote IP Address|Class name|Timer|Detailed Message
+
+The logger util module can be found at:
+
+<>/has/conductor/conductor/common/utils/conductor_logging_util.py \ No newline at end of file