1description: > 2 Implement to provide event/error entry attributes. This interface should be 3 instantiated for the phosphor::logging namespace. This interface is a 4 collection of objects, therefore it is required to implement 5 org.freedesktop.DBus.ObjectManager on the logging namespace root. 6 Optionally, implement xyz.openbmc_project.Object.Delete to allow the 7 deletion of 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: dict[string, string] 35 description: > 36 Additional information in the form of metadata field strings {VAR,val} 37 - name: AdditionalData2 38 type: dict[string, string] 39 description: > 40 Additional information in the form of metadata field strings {VAR,val} 41 - name: Resolution 42 type: string 43 description: > 44 Suggestion for error resolution of this event. 45 - name: Resolved 46 type: boolean 47 description: > 48 Error resolution status. Indicate if the problem being reported by 49 this error log has been resolved. This will start out 'false' by 50 default. Setting this to 'true' will NOT result in the error log being 51 deleted. 52 errors: 53 - xyz.openbmc_project.Common.Error.Unavailable 54 - name: ServiceProviderNotify 55 type: enum[self.Notify] 56 default: NotSupported 57 description: > 58 If this property value is set to 'Notify', the service provider must 59 be notified about the Entry. If the value is set to 'Inhibit' then 60 notification is not sent to the service provider. An event of this 61 type requires a service action to correct the event, such as replacing 62 the hardware part or updating code. 63 - name: UpdateTimestamp 64 type: uint64 65 description: > 66 The timestamp when any property was last modified, in milliseconds 67 since the epoch (1 Jan 1970 00:00:00 UTC). As only the Resolved 68 property has a reason to change, a value that doesn't match the 69 Timestamp property's value (which indicates when the log was created) 70 would indicate that Resolved was changed. 71 72enumerations: 73 - name: Level 74 description: > 75 Possible severity levels for an error log entry. 76 values: 77 - name: Emergency 78 description: > 79 System is unusable. 80 - name: Alert 81 description: > 82 Should be corrected immediately. 83 - name: Critical 84 description: > 85 Critical condition. 86 - name: Error 87 description: > 88 Error condition. 89 - name: Warning 90 description: > 91 An error may occur if action is not taken. 92 - name: Notice 93 description: > 94 Unusual condition, but not an error. 95 - name: Informational 96 description: > 97 Normal operational message that does not require action. 98 - name: Debug 99 description: > 100 Information useful to developers for debugging the application. 101 102 - name: Notify 103 description: > 104 Possible ServiceProviderNotify values for an error log entry. 105 values: 106 - name: NotSupported 107 description: > 108 ServiceProviderNotify property is not supported. 109 - name: Notify 110 description: > 111 The service provider should be notified about the event log. 112 - name: Inhibit 113 description: > 114 The service provider should not be notified about the event log. 115 116methods: 117 - name: GetEntry 118 description: > 119 Returns the file descriptor to the raw Entry file, which is a binary 120 blob. The mode of the file descriptor is to be reaad-only. 121 returns: 122 - name: fd 123 type: unixfd 124 description: > 125 The file descriptor to the Entry file. 126 127service_names: 128 - default: xyz.openbmc_project.Logging 129 130paths: 131 - namespace: /xyz/openbmc_project/logging 132 segments: 133 - name: Entry 134 value: entry 135