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: Resolved
38      type: boolean
39      description: >
40          Error resolution status. Indicate if the problem being reported by
41          this error log has been resolved. This will start out 'false' by
42          default. Setting this to 'true' will NOT result in the error log being
43          deleted.
44    - name: ServiceProviderNotify
45      type: boolean
46      default: false
47      description: >
48          This property when set to 'true' indicates that this event log should
49          be notified to the service provider, if that is implemented on the
50          system. An event of this type requires a service action to replace the
51          hardware part or update code to correct the error.
52    - name: UpdateTimestamp
53      type: uint64
54      description: >
55          The timestamp when any property was last modified, in milliseconds
56          since the epoch (1 Jan 1970 00:00:00 UTC).  As only the
57          Resolved property has a reason to change, a value that doesn't
58          match the Timestamp property's value (which indicates when the
59          log was created) would indicate that Resolved was changed.
60
61enumerations:
62    - name: Level
63      description: >
64          Possible severity levels for an error log entry.
65      values:
66        - name: Emergency
67          description: >
68              System is unusable.
69        - name: Alert
70          description: >
71              Should be corrected immediately.
72        - name: Critical
73          description: >
74              Critical condition.
75        - name: Error
76          description: >
77              Error condition.
78        - name: Warning
79          description: >
80              An error may occur if action is not taken.
81        - name: Notice
82          description: >
83              Unusual condition, but not an error.
84        - name: Informational
85          description: >
86              Normal operational message that does not require action.
87        - name: Debug
88          description: >
89              Information useful to developers for debugging the application.
90
91methods:
92  - name: GetEntry
93    description: >
94      Returns the file descriptor to the raw Entry file, which is a binary blob.
95      The mode of the file descriptor is to be reaad-only.
96    returns:
97      - name: fd
98        type: unixfd
99        description: >
100          The file descriptor to the Entry file.
101