blob: 348bb91b7726cad78464ab9e822635044245be68 [file] [log] [blame]
Adriana Kobylak8a0fd712016-11-14 16:05:52 -06001description: >
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.
Adriana Kobylak06e5b232017-01-22 14:36:55 -060013 - name: Timestamp
14 type: uint64
15 description: >
16 Commit timestamp of the error event entry in milliseconds since 1970.
Adriana Kobylak8a0fd712016-11-14 16:05:52 -060017 - 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 Lobo0ae40522021-05-11 18:51:45 -050025 - 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 Kobylak8a0fd712016-11-14 16:05:52 -060033 - name: AdditionalData
34 type: array[string]
35 description: >
36 Additional information in the form of metadata field strings VAR=val
Vijay Lobo39bdb472021-05-13 07:47:54 -050037 - name: Resolution
38 type: string
39 description: >
40 Suggestion for error resolution of this event.
Deepak Kodihalli9bd626a2017-03-27 03:32:25 -050041 - 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.
Vijay Lobo208b4e42021-05-06 14:56:35 -050048 - 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.
Matt Spinler05dd9682020-02-25 12:34:52 -060056 - 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.
Adriana Kobylak8a0fd712016-11-14 16:05:52 -060064
65enumerations:
66 - name: Level
67 description: >
68 Possible severity levels for an error log entry.
69 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050070 - 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.
Adriana Kobylak8a0fd712016-11-14 16:05:52 -060094
Adriana Kobylak66119c02021-02-04 13:23:58 -060095methods:
Patrick Williams8da396c2022-03-14 14:21:02 -050096 - 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.