Skip to content
This repository was archived by the owner on May 6, 2020. It is now read-only.

Commit a761e8c

Browse files
author
James O. D. Hunt
committed
doc: Improve debug and logging details
Explain how to enable full debug and view log output for the various system components. Fixes #845. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
1 parent 4564f9c commit a761e8c

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,30 @@ $ sudo journalctl -t cc-runtime
9494

9595
### Enabling debug for various components
9696

97-
The runtime, the shim (`cc-shim`), and the hypervisor all have separate debug
98-
options in the [configuration file](#Configuration).
97+
The runtime, the shim (`cc-shim`), the hypervisor and the proxy all have separate `enable_debug=` debug
98+
options in the [configuration file](#Configuration). Look at the comments in
99+
the installed configuration file for further details.
99100

100-
The proxy (`cc-proxy`) has a command-line option to enable debug output. See
101-
the [proxy documentation](https://github.com/clearcontainers/proxy#debugging) for further details.
101+
If you wish to enable debug for all components, assuming a standard configuration file path, run:
102+
103+
```bash
104+
$ sudo sed -i -e 's/^#\(enable_debug\).*=.*$/\1 = true/g' /usr/share/defaults/clear-containers/configuration.toml
105+
```
106+
107+
To view shim log output:
108+
109+
```bash
110+
$ sudo journalctl -t cc-shim
111+
```
112+
113+
To view proxy log output:
114+
115+
```bash
116+
$ sudo journalctl -t cc-proxy
117+
```
118+
119+
Note that the proxy log entries also include output from `cc-agent` and the
120+
hypervisor (which includes the guest kernel boot-time messages).
102121

103122
## Limitations
104123

0 commit comments

Comments
 (0)