Ratan Gupta | 85bb6f3 | 2017-10-05 15:42:56 +0530 | [diff] [blame] | 1 | #TODO This interface and the logging entry interface |
| 2 | # is having common properties,Ideally there should be |
| 3 | # one common interface and the specific properties |
| 4 | # for logging should go in (Logging/Entry). |
| 5 | # https://github.com/openbmc/openbmc/issues/2923 |
| 6 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 7 | Implement to provide event entry attributes. This interface should be |
| 8 | instantiated for the phosphor::events namespace. This interface is a |
| 9 | collection of objects, therefore it is required to implement |
| 10 | org.freedesktop.DBus.ObjectManager on the events namespace root. Optionally, |
| 11 | implement xyz.openbmc_project.Delete to allow the deletion of individual |
| 12 | entries. The event D-Bus object path would look like |
| 13 | <PhosphorDbusRoot>/events/<type>/<id> Here "type" is the type of event, |
| 14 | Could be network/system state event etc. Type would be given by the |
| 15 | application configuration file which would be implementing this interface. |
Ratan Gupta | 85bb6f3 | 2017-10-05 15:42:56 +0530 | [diff] [blame] | 16 | Here "id" is positive integer starts from 1 and it gets incremented by 1 |
| 17 | with any newly created object. |
| 18 | properties: |
| 19 | - name: Timestamp |
| 20 | type: uint64 |
| 21 | description: > |
| 22 | Event creation timestamp in milliseconds since 1970. |
| 23 | - name: Message |
| 24 | type: string |
| 25 | description: > |
| 26 | The message description of the event entry. |
| 27 | - name: AdditionalData |
| 28 | type: array[string] |
| 29 | description: > |
| 30 | Additional information in the form of metadata field strings VAR=val |
Patrick Williams | 6c25fd0 | 2024-01-17 11:52:54 -0600 | [diff] [blame^] | 31 | |
| 32 | service_names: |
| 33 | - default: xyz.openbmc_project.Logging |
| 34 | |
| 35 | paths: |
| 36 | - namespace: /xyz/openbmc_project/logging |