Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-logging / e07f915b21c5915574d03f9c9b7527084da4abe6 / . / extensions / openpower-pels
tree: 4bde89d4816807a3d18ce84b626be7d88929bf43 [path history] [tgz]
  1. registry/
  2. additional_data.hpp
  3. ascii_string.cpp
  4. ascii_string.hpp
  5. bcd_time.cpp
  6. bcd_time.hpp
  7. callout.cpp
  8. callout.hpp
  9. callouts.cpp
  10. callouts.hpp
  11. data_interface.cpp
  12. data_interface.hpp
  13. entry_points.cpp
  14. failing_mtms.cpp
  15. failing_mtms.hpp
  16. fru_identity.cpp
  17. fru_identity.hpp
  18. generic.cpp
  19. generic.hpp
  20. log_id.cpp
  21. log_id.hpp
  22. manager.cpp
  23. manager.hpp
  24. mru.cpp
  25. mru.hpp
  26. mtms.cpp
  27. mtms.hpp
  28. openpower-pels.mk
  29. paths.cpp
  30. paths.hpp
  31. pce_identity.cpp
  32. pce_identity.hpp
  33. pel.cpp
  34. pel.hpp
  35. pel_types.hpp
  36. pel_values.cpp
  37. pel_values.hpp
  38. private_header.cpp
  39. private_header.hpp
  40. README.md
  41. registry.cpp
  42. registry.hpp
  43. repository.cpp
  44. repository.hpp
  45. section.hpp
  46. section_factory.cpp
  47. section_factory.hpp
  48. section_header.hpp
  49. severity.cpp
  50. severity.hpp
  51. src.cpp
  52. src.hpp
  53. stream.hpp
  54. user_data.cpp
  55. user_data.hpp
  56. user_data_formats.hpp
  57. user_header.cpp
  58. user_header.hpp
extensions/openpower-pels/README.md

OpenPower Platform Event Log (PEL) extension

This extension will create PELs for every OpenBMC event log. It is also possible to point to the raw PEL to use in the OpenBMC event, and then that will be used instead of creating one.

Passing PEL related data within an OpenBMC event log

An error log creator can pass in data that is relevant to a PEL by using certain keywords in the AdditionalData property of the event log.

AdditionalData keywords

RAWPEL

This keyword is used to point to an existing PEL in a binary file that should be associated with this event log. The syntax is:

RAWPEL=<path to PEL File>
e.g.
RAWPEL="/tmp/pels/pel.5"

The code will assign its own error log ID to this PEL, and also update the commit timestamp field to the current time.

_PID

This keyword that contains the application's PID is added automatically by the phosphor-logging daemon when the commit or report APIs are used to create an event log, but not when the Create D-Bus method is used. If a caller of the Create API wishes to have their PID captured in the PEL this should be used.

This will be added to the PEL in a section of type User Data (UD), along with the application name it corresponds to.

The syntax is:

_PID=<PID of application>
e.g.
_PID="12345"

Default UserData sections for BMC created PELs

The extension code that creates PELs will add these UserData sections to every PEL:

  • The AdditionalData property contents
    • If the AdditionalData property in the OpenBMC event log has anything in it, it will be saved in a UserData section as a JSON string.

The PEL Message Registry

The PEL message registry is used to create PELs from OpenBMC event logs. Documentation can be found here.

D-Bus Interfaces