From bf571ae4412198e568a31887fc4a8d0f95393993 Mon Sep 17 00:00:00 2001 From: Alexander Mikhalitsyn Date: Mon, 10 Jun 2024 14:22:34 +0200 Subject: [PATCH 1/2] README.md: add info about how to collect a core dump Signed-off-by: Alexander Mikhalitsyn --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2db345b4..5be5aaa1 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ lxc.kmsg = 0 lxc.include = /usr/share/lxc/config/common.conf.d/00-lxcfs.conf ``` -## Using with Docker +### Using with Docker ``` docker run -it -m 256m --memory-swap 256m \ @@ -163,3 +163,29 @@ As a result, LXCFS had to make some compromise which go as follow: usage (100% full) is reported. This provides adequate reporting of the memory consumption while preventing applications from assuming more SWAP is available. + +## Issue reporting + +### Core dump + +In case of LXCFS crash, it can be extremely useful for us to have a core dump of the LXCFS process memory. + +1. Please, check `/var/crash` and `coredumpctl list` just in case if you already have an LXCFS core dump file +2. If not, you can use the following way to collect it from your system: + +On the machine where you run LXCFS, execute as root: +``` +# save an old core_pattern setting value: +cat /proc/sys/kernel/core_pattern > /root/core_pattern.old_value.bak + +# set a new one to collect all core dumps: +echo '|/bin/sh -c $@ -- eval exec gzip --fast > /var/crash/core-%e.%p.gz' > /proc/sys/kernel/core_pattern + +# wait for the next LXCFS crash and check +ls -lah /var/crash + +# there should be a file with a name like "core-lxcfs.80581.gz". Please, upload it somewhere and share with us. + +# restore the old "core_pattern" value: +cat /root/core_pattern.old_value.bak > /proc/sys/kernel/core_pattern +``` From 8c88d4e171dc696a773223f8db5cb846314e702a Mon Sep 17 00:00:00 2001 From: Alexander Mikhalitsyn Date: Mon, 10 Jun 2024 14:27:26 +0200 Subject: [PATCH 2/2] github: add ISSUE_TEMPLATE.md Signed-off-by: Alexander Mikhalitsyn --- .github/ISSUE_TEMPLATE.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..2de18a87 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,32 @@ +The template below is mostly useful for bug reports and support questions. +Feel free to remove anything which doesn't apply to you and add more information where it makes sense. + +# Required information + + * Distribution: + * `cat /etc/os-release` or `cat /etc/lsb-release` + * LXCFS version: + * The output of + * `uname -a` + * `cat /proc/1/mounts` + * `ps aux | grep lxcfs` + * LXCFS logs + +# Issue description + +A brief description of what failed or what could be improved. + +If you have LXCFS crashing, please, collect a crash dump. + +# Steps to reproduce + + 1. Step one + 2. Step two + 3. Step three + +# Information to attach + + - [ ] any relevant kernel output (`dmesg`) + - [ ] LXCFS daemon output / logs + - [ ] LXCFS configuration (Which options were used to start a LXCFS daemon? `ps aux | grep lxcfs`) + - [ ] in case of crash, a core dump (please, read [how to collect a core dump](https://github.com/lxc/lxcfs?tab=readme-ov-file#core-dump))