Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-logging / c8705e2bfcc7582fb7dc89ac1598489712c006f3 / . / extensions / openpower-pels
tree: 65f1c190ebe4e42dec887d7e93f07d28b0b244c8 [path history] [tgz]
  1. additional_data.hpp
  2. bcd_time.cpp
  3. bcd_time.hpp
  4. data_interface.cpp
  5. data_interface.hpp
  6. entry_points.cpp
  7. log_id.cpp
  8. log_id.hpp
  9. manager.cpp
  10. manager.hpp
  11. mtms.cpp
  12. mtms.hpp
  13. openpower-pels.mk
  14. paths.cpp
  15. paths.hpp
  16. pel.cpp
  17. pel.hpp
  18. private_header.cpp
  19. private_header.hpp
  20. README.md
  21. repository.cpp
  22. repository.hpp
  23. section.hpp
  24. section_header.hpp
  25. stream.hpp
  26. user_header.cpp
  27. 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"

The PEL Message Registry

D-Bus Interfaces