phosphor-debug-collector - OpenGrok cross reference for /openbmc/phosphor-debug-collector/

# phosphor-debug-collector

Phosphor Debug Collector provides mechanisms to collect various log files and
system parameters. Used to troubleshoot problems in OpenBMC based systems.

One such mechanism is [dreport](tools/dreport.d/README.md), a script that
collects debug data and packages it into an archive file.

## To Build

To build this package with meson, do the following steps:

```bash
    1. meson builddir
    2. ninja -C builddir
```

To clean the built files run `ninja -C builddir clean`.

## To run unit tests

Tests can be run in the CI docker container, refer
[local-ci-build](https://github.com/openbmc/docs/blob/master/testing/local-ci-build.md)

or with an OpenBMC x86 sdk(see below for x86 steps).

```bash
meson -Dtests=enabled build
ninja -C build test
```
Name		Date	Size	#Lines	LOC
..		Today	-
dump-extensions/	H	30-Nov-2023	-	1,235	878
host-transport-extensions/	H	07-Mar-2021	-	482	311
subprojects/	H	20-Jun-2024	-	45	33
test/	H	28-Feb-2024	-	114	98
tools/dreport.d/	H	07-Mar-2021	-	1,977	1,158
.clang-format	H A D	20-Aug-2024	3.7 KiB	137	135
.gitignore	H A D	05-Oct-2021	42	4	3
.shellcheck-ignore	H A D	27-Jun-2023	1.3 KiB	37	36
LICENSE	H A D	07-Mar-2021	11.1 KiB	202	169
OWNERS	H A D	01-Dec-2023	1.8 KiB	57	52
README.md	H A D	23-Jun-2023	780	31	20
bmc_dump_entry.cpp	H A D	20-Jun-2024	1.7 KiB	71	54
bmc_dump_entry.hpp	H A D	20-Jun-2024	5.8 KiB	170	93
core_manager.cpp	H A D	11-Sep-2023	3.2 KiB	107	83
core_manager.hpp	H A D	11-Sep-2023	2 KiB	78	43
core_manager_main.cpp	H A D	14-Jun-2023	1.2 KiB	51	42
dump-extensions.hpp	H A D	26-Jul-2022	444	22	11
dump_entry.cpp	H A D	20-Jun-2024	5.2 KiB	176	139
dump_entry.hpp	H A D	20-Jun-2024	5.6 KiB	186	96
dump_manager.cpp	H A D	07-Mar-2021	371	26	21
dump_manager.hpp	H A D	20-Aug-2024	2.2 KiB	83	40
dump_manager_bmc.cpp	H A D	20-Aug-2024	11.1 KiB	364	287
dump_manager_bmc.hpp	H A D	20-Jun-2024	4.2 KiB	135	62
dump_manager_faultlog.cpp	H A D	20-Aug-2024	3.6 KiB	123	94
dump_manager_faultlog.hpp	H A D	15-Jun-2023	2.4 KiB	86	56
dump_manager_main.cpp	H A D	11-Sep-2023	3.2 KiB	112	86
dump_offload.cpp	H A D	20-Aug-2024	7.8 KiB	233	189
dump_offload.hpp	H A D	14-Apr-2021	528	27	13
dump_serialize.cpp	H A D	15-Jun-2023	1,022	47	40
dump_serialize.hpp	H A D	14-Apr-2021	893	36	19
dump_types.mako.cpp	H A D	01-Sep-2023	3.3 KiB	131	113
dump_types.mako.hpp	H A D	01-Sep-2023	3.8 KiB	124	48
dump_utils.cpp	H A D	20-Jun-2024	2.3 KiB	83	66
dump_utils.hpp	H A D	20-Aug-2024	12.3 KiB	394	257
elog_watch.cpp	H A D	11-Sep-2023	5 KiB	187	150
elog_watch.hpp	H A D	11-Sep-2023	2.8 KiB	104	50
example_dump_types.yaml	H A D	01-Sep-2023	347	13	12
example_errors_watch.yaml	H A D	09-Dec-2022	61	3	2
faultlog_dump_entry.cpp	H A D	15-Jun-2023	658	34	24
faultlog_dump_entry.hpp	H A D	22-Jun-2023	2 KiB	67	39
ffdc	H A D	27-Jun-2023	2.5 KiB	97	75
host_transport_exts.hpp	H A D	07-Mar-2021	472	29	11
map_gen.py	H A D	01-Sep-2023	1.5 KiB	66	50
meson.build	H A D	20-Jun-2024	11 KiB	314	273
meson.options	H A D	11-Sep-2023	4 KiB	130	100
ramoops_manager.cpp	H A D	14-Nov-2023	4.1 KiB	137	113
ramoops_manager.hpp	H A D	14-Nov-2023	1 KiB	52	29
ramoops_manager_main.cpp	H A D	14-Jun-2023	479	22	16
watch.cpp	H A D	20-Aug-2024	3.1 KiB	131	101
watch.hpp	H A D	14-Apr-2021	2.6 KiB	100	40