xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Logging/Event.interface.yaml (revision 6c25fd029fcb359ec5f0ab1f039f4ec3aaca7f5c)
1b1b4d261SWilliam A. Kennington III#TODO This interface and the logging entry interface
2b1b4d261SWilliam A. Kennington III#     is having common properties,Ideally there should be
3b1b4d261SWilliam A. Kennington III#     one common interface and the specific properties
4b1b4d261SWilliam A. Kennington III#     for logging should go in (Logging/Entry).
5b1b4d261SWilliam A. Kennington III#     https://github.com/openbmc/openbmc/issues/2923
6b1b4d261SWilliam A. Kennington IIIdescription: >
7a1347418SPatrick Williams    Implement to provide event entry attributes. This interface should be
8a1347418SPatrick Williams    instantiated for the phosphor::events namespace. This interface is a
9a1347418SPatrick Williams    collection of objects, therefore it is required to implement
10a1347418SPatrick Williams    org.freedesktop.DBus.ObjectManager on the events namespace root. Optionally,
11a1347418SPatrick Williams    implement xyz.openbmc_project.Delete to allow the deletion of individual
12a1347418SPatrick Williams    entries. The event D-Bus object path would look like
13a1347418SPatrick Williams    <PhosphorDbusRoot>/events/<type>/<id> Here "type" is the type of event,
14a1347418SPatrick Williams    Could be network/system state event etc. Type would be given by the
15a1347418SPatrick Williams    application configuration file which would be implementing this interface.
16b1b4d261SWilliam A. Kennington III    Here "id" is positive integer starts from 1 and it gets incremented by 1
17b1b4d261SWilliam A. Kennington III    with any newly created object.
18b1b4d261SWilliam A. Kennington IIIproperties:
19b1b4d261SWilliam A. Kennington III    - name: Timestamp
20b1b4d261SWilliam A. Kennington III      type: uint64
21b1b4d261SWilliam A. Kennington III      description: >
22b1b4d261SWilliam A. Kennington III          Event creation timestamp in milliseconds since 1970.
23b1b4d261SWilliam A. Kennington III    - name: Message
24b1b4d261SWilliam A. Kennington III      type: string
25b1b4d261SWilliam A. Kennington III      description: >
26b1b4d261SWilliam A. Kennington III          The message description of the event entry.
27b1b4d261SWilliam A. Kennington III    - name: AdditionalData
28b1b4d261SWilliam A. Kennington III      type: array[string]
29b1b4d261SWilliam A. Kennington III      description: >
30b1b4d261SWilliam A. Kennington III          Additional information in the form of metadata field strings VAR=val
31*6c25fd02SPatrick Williams
32*6c25fd02SPatrick Williamsservice_names:
33*6c25fd02SPatrick Williams    - default: xyz.openbmc_project.Logging
34*6c25fd02SPatrick Williams
35*6c25fd02SPatrick Williamspaths:
36*6c25fd02SPatrick Williams    - namespace: /xyz/openbmc_project/logging
37