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

Action Flags and Event Type Rules

The Action Flags and Event Type PEL fields are optional in the message registry, and if not present the code will set them based on certain rules layed out in the PEL spec. In fact, even if they were specified, the checks are still done to ensure consistency across all the logs.

These rules are:

  1. Always set the Report flag, unless the Do Not Report flag is already on.
  2. Always clear the SP Call Home flag, as that feature isn't supported.
  3. If the severity is Non-error Event:
    • Clear the Service Action flag.
    • Clear the Call Home flag.
    • If the Event Type field is Not Applicable, change it to Information Only.
    • If the Event Type field is Information Only or Tracing, set the Hidden flag.
  4. If the severity is Recovered:
    • Set the Hidden flag.
    • Clear the Service Action flag.
    • Clear the Call Home flag.
  5. For all other severities:
    • Clear the Hidden flag.
    • Set the Service Action flag.
    • Set the Call Home flag.

Additional rules may be added in the future if necessary.

D-Bus Interfaces