| Adriana Kobylak | 8a0fd71 | 2016-11-14 16:05:52 -0600 | [diff] [blame] | 1 | description: > |
| 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. |
| 8 | properties: |
| 9 | - name: Id |
| 10 | type: uint32 |
| 11 | description: > |
| 12 | The error event entry id number. |
| Adriana Kobylak | 06e5b23 | 2017-01-22 14:36:55 -0600 | [diff] [blame] | 13 | - name: Timestamp |
| 14 | type: uint64 |
| 15 | description: > |
| 16 | Commit timestamp of the error event entry in milliseconds since 1970. |
| Adriana Kobylak | 8a0fd71 | 2016-11-14 16:05:52 -0600 | [diff] [blame] | 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. |
| Vijay Lobo | 0ae4052 | 2021-05-11 18:51:45 -0500 | [diff] [blame] | 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. |
| Adriana Kobylak | 8a0fd71 | 2016-11-14 16:05:52 -0600 | [diff] [blame] | 33 | - name: AdditionalData |
| 34 | type: array[string] |
| 35 | description: > |
| 36 | Additional information in the form of metadata field strings VAR=val |
| Deepak Kodihalli | 9bd626a | 2017-03-27 03:32:25 -0500 | [diff] [blame] | 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. |
| Matt Spinler | 05dd968 | 2020-02-25 12:34:52 -0600 | [diff] [blame] | 44 | - name: UpdateTimestamp |
| 45 | type: uint64 |
| 46 | description: > |
| 47 | The timestamp when any property was last modified, in milliseconds |
| 48 | since the epoch (1 Jan 1970 00:00:00 UTC). As only the |
| 49 | Resolved property has a reason to change, a value that doesn't |
| 50 | match the Timestamp property's value (which indicates when the |
| 51 | log was created) would indicate that Resolved was changed. |
| Adriana Kobylak | 8a0fd71 | 2016-11-14 16:05:52 -0600 | [diff] [blame] | 52 | |
| 53 | enumerations: |
| 54 | - name: Level |
| 55 | description: > |
| 56 | Possible severity levels for an error log entry. |
| 57 | values: |
| 58 | - name: Emergency |
| 59 | description: > |
| 60 | System is unusable. |
| 61 | - name: Alert |
| 62 | description: > |
| 63 | Should be corrected immediately. |
| 64 | - name: Critical |
| 65 | description: > |
| 66 | Critical condition. |
| 67 | - name: Error |
| 68 | description: > |
| 69 | Error condition. |
| 70 | - name: Warning |
| 71 | description: > |
| 72 | An error may occur if action is not taken. |
| 73 | - name: Notice |
| 74 | description: > |
| 75 | Unusual condition, but not an error. |
| 76 | - name: Informational |
| 77 | description: > |
| 78 | Normal operational message that does not require action. |
| 79 | - name: Debug |
| 80 | description: > |
| 81 | Information useful to developers for debugging the application. |
| 82 | |
| Adriana Kobylak | 66119c0 | 2021-02-04 13:23:58 -0600 | [diff] [blame] | 83 | methods: |
| 84 | - name: GetEntry |
| 85 | description: > |
| 86 | Returns the file descriptor to the raw Entry file, which is a binary blob. |
| 87 | The mode of the file descriptor is to be reaad-only. |
| 88 | returns: |
| 89 | - name: fd |
| 90 | type: unixfd |
| 91 | description: > |
| 92 | The file descriptor to the Entry file. |