Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

Commit

Permalink
README: logging: add shimv2 information
Browse files Browse the repository at this point in the history
The shimv2 runtime logs slightly differently - let's clarify
that in the existing OCI/CRI-O only runtime section.

Fixes: #2520

Signed-off-by: Graham Whaley <[email protected]>
  • Loading branch information
Graham Whaley committed Mar 10, 2020
1 parent a543662 commit 2cd0c88
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ For details of the other Kata Containers repositories, see the
* [Architecture overview](#architecture-overview)
* [Configuration](#configuration)
* [Logging](#logging)
* [Kata OCI](#kata-oci)
* [Kata containerd shimv2](#kata-containerd-shimv2)
* [Debugging](#debugging)
* [Limitations](#limitations)
* [Community](#community)
Expand Down Expand Up @@ -138,19 +140,36 @@ $ kata-runtime kata-env

## Logging

The runtime provides `--log=` and `--log-format=` options. However, the
runtime also always logs to the system log (`syslog` or `journald`).
For detailed information and analysis on obtaining logs for other system
components, see the documentation for the
[`kata-log-parser`](https://github.com/kata-containers/tests/tree/master/cmd/log-parser)
tool.

For runtime logs, see the following sections for the CRI-O and containerd shimv2 based runtimes.

### Kata OCI

The Kata OCI runtime (including when used with CRI-O), provides `--log=` and `--log-format=` options.
However, the runtime also always logs to the system log (`syslog` or `journald`).

To view runtime log output:

```bash
$ sudo journalctl -t kata-runtime
```

For detailed information and analysis on obtaining logs for other system
components, see the documentation for the
[`kata-log-parser`](https://github.com/kata-containers/tests/tree/master/cmd/log-parser)
tool.
### Kata containerd shimv2

The Kata containerd shimv2 runtime logs through `containerd`, and its logs will be sent
to wherever the `containerd` logs are directed. However, the
shimv2 runtime also always logs to the system log (`syslog` or `journald`) under the
identifier name of `kata`.

To view the `shimv2` runtime log output:

```bash
$ sudo journalctl -t kata
```

## Debugging

Expand Down

0 comments on commit 2cd0c88

Please sign in to comment.