1description: >
2    Implement to provide event/error entry attributes.
3    This interface should be instantiated for the phosphor::logging namespace.
4    This interface is a collection of objects, therefore it is required to
5    implement org.freedesktop.DBus.ObjectManager on the logging namespace root.
6    Optionally, implement org.openbmc.Object.Delete to allow the deletion of
7    individual entries.
8properties:
9    - name: Id
10      type: uint32
11      description: >
12          The error event entry id number.
13    - name: Timestamp
14      type: uint64
15      description: >
16          Commit timestamp of the error event entry in milliseconds since 1970.
17    - name: Severity
18      type: enum[self.Level]
19      description: >
20          The severity of the error event entry.
21    - name: Message
22      type: string
23      description: >
24          The message description of the error event entry.
25    - name: EventId
26      type: string
27      description: >
28          An implementation-dependent unique identifier for this event. This
29          property is different from Id in the sense that Id is a unique number
30          per event but EventId is an optional identifier that is associated
31          with the event. The content of this property is implementation
32          defined.
33    - name: AdditionalData
34      type: array[string]
35      description: >
36          Additional information in the form of metadata field strings VAR=val
37    - name: Resolution
38      type: string
39      description: >
40          Suggestion for error resolution of this event.
41    - name: Resolved
42      type: boolean
43      description: >
44          Error resolution status. Indicate if the problem being reported by
45          this error log has been resolved. This will start out 'false' by
46          default. Setting this to 'true' will NOT result in the error log being
47          deleted.
48    - name: ServiceProviderNotify
49      type: boolean
50      default: false
51      description: >
52          This property when set to 'true' indicates that this event log should
53          be notified to the service provider, if that is implemented on the
54          system. An event of this type requires a service action to replace the
55          hardware part or update code to correct the error.
56    - name: UpdateTimestamp
57      type: uint64
58      description: >
59          The timestamp when any property was last modified, in milliseconds
60          since the epoch (1 Jan 1970 00:00:00 UTC).  As only the
61          Resolved property has a reason to change, a value that doesn't
62          match the Timestamp property's value (which indicates when the
63          log was created) would indicate that Resolved was changed.
64
65enumerations:
66    - name: Level
67      description: >
68          Possible severity levels for an error log entry.
69      values:
70        - name: Emergency
71          description: >
72              System is unusable.
73        - name: Alert
74          description: >
75              Should be corrected immediately.
76        - name: Critical
77          description: >
78              Critical condition.
79        - name: Error
80          description: >
81              Error condition.
82        - name: Warning
83          description: >
84              An error may occur if action is not taken.
85        - name: Notice
86          description: >
87              Unusual condition, but not an error.
88        - name: Informational
89          description: >
90              Normal operational message that does not require action.
91        - name: Debug
92          description: >
93              Information useful to developers for debugging the application.
94
95methods:
96  - name: GetEntry
97    description: >
98      Returns the file descriptor to the raw Entry file, which is a binary blob.
99      The mode of the file descriptor is to be reaad-only.
100    returns:
101      - name: fd
102        type: unixfd
103        description: >
104          The file descriptor to the Entry file.
105