Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-debug-collector / 90a80d16271bbcfa7df11948dcb3faadbf8b09d3
commit90a80d16271bbcfa7df11948dcb3faadbf8b09d3[log] [tgz]
authorMatt Spinler <spinler@us.ibm.com>Tue Oct 18 11:30:08 2022 -0500
committerJayanth Othayoth <ojayanth@gmail.com>Wed Oct 26 08:56:46 2022 +0000
tree10f318105ad9ae2858af93b0c0a4b638e82a43b0
parentc0ab9d43d5e19123cca1a1592ee07fc064b84199 [diff]
Add README for dreport

Document how dreport works, especially the 'config' comment line in
plugins that specifies when the plugins run.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I2063bd8ba8397139f38396752dfbb85eea570455
2 files changed
tree: 10f318105ad9ae2858af93b0c0a4b638e82a43b0
  1. dump-extensions/
  2. host-transport-extensions/
  3. subprojects/
  4. test/
  5. tools/
  6. xyz/
  7. .clang-format
  8. .gitignore
  9. bmc_dump_entry.cpp
  10. bmc_dump_entry.hpp
  11. core_manager.cpp
  12. core_manager.hpp
  13. core_manager_main.cpp
  14. dump-extensions.hpp
  15. dump_entry.cpp
  16. dump_entry.hpp
  17. dump_internal.hpp
  18. dump_manager.cpp
  19. dump_manager.hpp
  20. dump_manager_bmc.cpp
  21. dump_manager_bmc.hpp
  22. dump_manager_faultlog.cpp
  23. dump_manager_faultlog.hpp
  24. dump_manager_main.cpp
  25. dump_offload.cpp
  26. dump_offload.hpp
  27. dump_serialize.cpp
  28. dump_serialize.hpp
  29. dump_utils.cpp
  30. dump_utils.hpp
  31. elog_watch.cpp
  32. elog_watch.hpp
  33. errors_map.mako.hpp
  34. errors_map_gen.py
  35. example_errors_watch.yaml
  36. faultlog_dump_entry.cpp
  37. faultlog_dump_entry.hpp
  38. ffdc
  39. host_transport_exts.hpp
  40. LICENSE
  41. meson.build
  42. meson_options.txt
  43. OWNERS
  44. ramoops_manager.cpp
  45. ramoops_manager.hpp
  46. ramoops_manager_main.cpp
  47. README.md
  48. watch.cpp
  49. watch.hpp
README.md

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, 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:

    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

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

meson -Dtests=enabled build
ninja -C build test