diff options
| author |   Lusheng Ji <lji@research.att.com> | 2017-11-05 19:24:05 -0500 |
|---|---|---|
| committer | Lusheng Ji <lji@research.att.com> | 2017-11-05 19:24:17 -0500 |
| commit | a73548f4eb6ba4bdb2b2064c7e24a4b74b467f5a (patch) | |
| tree | 38fa662d90000f88df368d53ced9333a5e36428b /docs/sections/logging.rst | |
| parent | 20cb0239275b2c1c6276507943ca341d932b0378 (diff) | |
Add documentation
Issue-Id: DCAEGEN2-194
Change-Id: Ic70d210e91a0d964861e287d6c2affd4e098b919
Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/sections/logging.rst')
| -rw-r--r-- | docs/sections/logging.rst | 32 |
1 files changed, 20 insertions, 12 deletions
diff --git a/docs/sections/logging.rst b/docs/sections/logging.rst index 39eabfba..a6da9518 100644 --- a/docs/sections/logging.rst +++ b/docs/sections/logging.rst @@ -4,19 +4,27 @@ Logging ======= -.. note:: - * This section is used to describe the informational or diagnostic messages emitted from - a software component and the methods or collecting them. - - * This section is typically: provided for a platform-component and sdk; and - referenced in developer and user guides - - * This note must be removed after content has been added. +DCAE logging is available in several levels. +Platform VM Logging +------------------- +1. DCAE bootstrap VM: + * /var/log directory containing various system logs including cloud init logs. + * /tmp/dcae2_install.log file provided installation logs. + * **docker logs** command for DCAE bootstrap container logs. +2. Cloudify Manager VM: + * /var/log directory containing various system logs including cloud init logs. + * Cloudify Manager GUI provides viewing access to Cloudify's operation logs. +3. Consul cluster: + * /var/log directory containing various system logs including cloud init logs. + * Consul GUI provides viewing access to Consul registered platform and service components healthcheck logs. +4. Docker hosts + * /var/log directory containing various system logs including cloud init logs. + * **docker logs** command for Docker container logs. -Where to Access Information ---------------------------- +Component Logging +----------------- + +In general the logs of service component can be accessed under the /opt/log directory of the container, either the Docker container or the VM. Their deployment logs can be found at the deployment engine and deployment location, e.g. Cloudify Manager, CDAP, and Docker hosts. -Error / Warning Messages ------------------------- |