github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-05 21:53:20 +00:00
Code Issues Projects Releases Wiki Activity

log-parser: fix some of the documentation

Browse Source 
minor fixes of links and text

Signed-off-by: Snir Sheriber <ssheribe@redhat.com>
This commit is contained in:
Snir Sheriber 2022-04-28 17:33:23 +03:00
parent c7dacb1211
commit 271933fec0
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/tools/log-parser/README.md
View File

@ -50,25 +50,25 @@ Additional to the fields above, the tool also expects the following field:
The primary logfiles the tool reads are: The primary logfiles the tool reads are:
- The [runtime](https://github.com/kata-containers/kata-containers/tree/main/src/runtime) log. - The [runtime](../../runtime) log.
This log also includes This log also includes
[virtcontainers](https://github.com/containers/virtcontainers) log entries and [virtcontainers](../../runtime/virtcontainers) log entries and
[agent](https://github.com/kata-containers/kata-containers/tree/main/src/agent) best effort logs unpacking (unless `--no-agent-unpack` is specified) [agent](../../agent) best effort logs unpacking (unless `--no-agent-unpack` is specified).
## Usage ## Usage
To merge all logs: To merge all logs:
1. [Enable full debug](https://github.com/kata-containers/kata-containers/blob/main/docs/Developer-Guide.md#enable-full-debug). 1. [Enable full debug](../../../docs/Developer-Guide.md#enable-full-debug).
1. Clear the systemd journal (optional): 1. Clear the systemd journal (optional):
``` ```
$ sudo systemctl stop systemd-journald $ sudo systemctl stop systemd-journald
$ sudo rm -f /var/log/journal/*/* /run/log/journal/*/* $ sudo rm -f /var/log/journal/*/* /run/log/journal/*/*
$ sudo systemctl start systemd-journald $ sudo systemctl start systemd-journald
``` ```
1. Create a container. 1. Create a Kata container.
1. Collect the logs. 1. Collect the logs (alternatively to journal clearing you may consider constraining collected logs by adding `--since=<container creation time>`).
``` ```
$ sudo journalctl -q -o cat -a -t kata > ./kata.log $ sudo journalctl -q -o cat -a -t kata > ./kata.log
``` ```
@ -78,8 +78,8 @@ To merge all logs:
``` ```
1. To install the program: 1. To install the program:
``` ```
$ go get -d github.com/kata-containers/tests $ go get -d github.com/kata-containers/kata-containers
$ pushd $GOPATH/src/github.com/kata-containers/tests/cmd/log-parser && make install && popd $ pushd $GOPATH/src/github.com/kata-containers/kata-containers/src/tools/log-parser && make install && popd
``` ```
1. To run the program: 1. To run the program:
``` ```
@ -88,7 +88,7 @@ To merge all logs:
### Advanced processing using jq ### Advanced processing using jq
[jq](https://stedolan.github.io/jq/) is a command-line JSON processor which can be combined with `kata-log-parser` [jq](https://stedolan.github.io/jq) is a command-line JSON processor which can be combined with `kata-log-parser`
to filter and fetch specific log entries. to filter and fetch specific log entries.
#### Examples #### Examples