summaryrefslogtreecommitdiffstats
path: root/docs/platform/log-and-diagnostic-info.rst
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2021-10-21 17:58:01 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2021-10-27 02:34:14 +0200
commit3c0ce0f85b34392dd50608e7440f10a20b0279cd (patch)
tree92521c605d2880a2a0dfabad5cdcaa7c48e89c4b /docs/platform/log-and-diagnostic-info.rst
parent6a35d99de3143d80f1fec13e310bb6fc156fe8cc (diff)
Leverage upper-constraints files to pin all dependencies
It leverages the latest change from lfdocs-conf and the upper-constraints.txt now centralized in ONAP docs. In a long run, upperconstraints.os.txt should be removed once ONAP is synced with OpenStack. It removes tox and setuptools from requirements as nothing depends on them (most requirements should be removed except lfdocsconf) Issue-ID: DOC-765 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I893490b8dfe244e49912d599b8b40745e546862c
Diffstat (limited to 'docs/platform/log-and-diagnostic-info.rst')
-rw-r--r--docs/platform/log-and-diagnostic-info.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst
new file mode 100644
index 0000000..607ecbc
--- /dev/null
+++ b/docs/platform/log-and-diagnostic-info.rst
@@ -0,0 +1,33 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging & Diagnostic Information
+---------------------------------
+
+In the Istanbul release, the logs are kept inside the docker containers, which means that you can get the log information only when the docker is still running.
+
+Where to Access Information
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There are two ways for a user to get the logs.
+
+
+* Assume that the name of a running docker is *holmes-rule-mgmt*, the way to get the log is to run the command ``docker logs ${docker-name}`` in the command window:
+
+ ``sudo docker logs holmes-rule-mgmt``
+
+ Then the logs will be displayed in the command window.
+
+* Get into the docker containers by running ``sudo docker exec -it ${docker-name} sh``. Go to the path ``/var/log/ONAP/holmes/`` and find the logs there.
+
+Error / Warning Messages
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+* Failed to initialize the SSL builder.: Could not create the SSL information for HTTPS calls.
+* Failed to fetch the DCAE configurations.: Could not get the configurations coded in the component specification files.
+* Failed to add rules.: Failed to deploy the rules distributed by CLAMP into Holmes.
+* Failed to publish the control loop message to DMaaP.: Errors occur while publishing messages to DMaaP.
+* Failed to read the API description file.: Could not find the swagger.json file.
+* An error occurrred while reading swagger.json.: An I/O Exception occurs while reading the swagger.json file.
+
+