From 1a966503e56fbd5e343535a88836844c5793bf2f Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 14 May 2018 10:54:36 +0100 Subject: [PATCH 1/2] docs: More log-parser detail in dev guide Add brief details to the developer guide explaining that the log parser can convert the format of the logs. Signed-off-by: James O. D. Hunt --- Developer-Guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Developer-Guide.md b/Developer-Guide.md index c646058e35..836cd7b31a 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -275,7 +275,7 @@ script and paste its output directly into a To perform analysis on Kata logs, use the [`kata-log-parser`](https://github.com/kata-containers/tests/tree/master/cmd/log-parser) -tool. +tool, which can convert the logs into formats (e.g. JSON, TOML, XML, and YAML). # Appendices From 317b701499fbb1fadde64fe91460c5cbab4cfe3b Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Mon, 14 May 2018 10:57:34 +0100 Subject: [PATCH 2/2] docs: Explain SIGUSR1 usage in dev guide Add details to the developer guide of how to obtain a backtrace by sending a `SIGUSR1` signal to the component. Fixes #70. Signed-off-by: James O. D. Hunt --- Developer-Guide.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Developer-Guide.md b/Developer-Guide.md index 836cd7b31a..87e7254840 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -277,6 +277,18 @@ To perform analysis on Kata logs, use the [`kata-log-parser`](https://github.com/kata-containers/tests/tree/master/cmd/log-parser) tool, which can convert the logs into formats (e.g. JSON, TOML, XML, and YAML). +To obtain a full backtrace for the agent, proxy, runtime, or shim send the +`SIGUSR1` signal to the process ID of the component. The component will send a +backtrace to the system log on the host system and continue to run without +interruption. + +For example, to obtain a backtrace for `kata-proxy`: + +``` +$ sudo kill -USR1 $kata_proxy_pid +$ sudo journalctl -t kata-proxy +``` + # Appendices ## Checking Docker default runtime