1# OpenPower Platform Event Log (PEL) extension
2
3This extension will create PELs for every OpenBMC event log. It is also
4possible to point to the raw PEL to use in the OpenBMC event, and then that
5will be used instead of creating one.
6
7## Passing PEL related data within an OpenBMC event log
8
9An error log creator can pass in data that is relevant to a PEL by using
10certain keywords in the AdditionalData property of the event log.
11
12### AdditionalData keywords
13
14#### RAWPEL
15
16This keyword is used to point to an existing PEL in a binary file that should
17be associated with this event log.  The syntax is:
18```
19RAWPEL=<path to PEL File>
20e.g.
21RAWPEL="/tmp/pels/pel.5"
22```
23The code will assign its own error log ID to this PEL, and also update the
24commit timestamp field to the current time.
25
26#### _PID
27
28This keyword that contains the application's PID is added automatically by the
29phosphor-logging daemon when the `commit` or `report` APIs are used to create
30an event log, but not when the `Create` D-Bus method is used.  If a caller of
31the `Create` API wishes to have their PID captured in the PEL this should be
32used.
33
34This will be added to the PEL in a section of type User Data (UD), along with
35the application name it corresponds to.
36
37The syntax is:
38```
39_PID=<PID of application>
40e.g.
41_PID="12345"
42```
43
44## The PEL Message Registry
45
46The PEL message registry is used to create PELs from OpenBMC event logs.
47Documentation can be found [here](registry/README.md).
48
49## D-Bus Interfaces
50