blob: 739b6e6cbca9f7052fabccdf1cceb2020ef38f77 [file] [log] [blame]
Adriana Kobylak8a0fd712016-11-14 16:05:52 -06001description: >
Patrick Williamsa1347412022-12-06 10:56:22 -06002 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.
Adriana Kobylak8a0fd712016-11-14 16:05:52 -06006 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
Vijay F Lobo3c7b8582021-10-08 11:41:40 -050049 type: enum[self.Notify]
50 default: NotSupported
Vijay Lobo208b4e42021-05-06 14:56:35 -050051 description: >
Vijay F Lobo3c7b8582021-10-08 11:41:40 -050052 If this property value is set to 'Notify', the service provider must
53 be notified about the Entry. If the value is set to 'Inhibit' then
54 notification is not sent to the service provider. An event of this
55 type requires a service action to correct the event, such as replacing
56 the hardware part or updating code.
Matt Spinler05dd9682020-02-25 12:34:52 -060057 - name: UpdateTimestamp
58 type: uint64
59 description: >
60 The timestamp when any property was last modified, in milliseconds
Patrick Williamsa1347412022-12-06 10:56:22 -060061 since the epoch (1 Jan 1970 00:00:00 UTC). As only the Resolved
62 property has a reason to change, a value that doesn't match the
63 Timestamp property's value (which indicates when the log was created)
64 would indicate that Resolved was changed.
Adriana Kobylak8a0fd712016-11-14 16:05:52 -060065
66enumerations:
67 - name: Level
68 description: >
69 Possible severity levels for an error log entry.
70 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050071 - name: Emergency
72 description: >
73 System is unusable.
74 - name: Alert
75 description: >
76 Should be corrected immediately.
77 - name: Critical
78 description: >
79 Critical condition.
80 - name: Error
81 description: >
82 Error condition.
83 - name: Warning
84 description: >
85 An error may occur if action is not taken.
86 - name: Notice
87 description: >
88 Unusual condition, but not an error.
89 - name: Informational
90 description: >
91 Normal operational message that does not require action.
92 - name: Debug
93 description: >
94 Information useful to developers for debugging the application.
Adriana Kobylak8a0fd712016-11-14 16:05:52 -060095
Vijay F Lobo3c7b8582021-10-08 11:41:40 -050096 - name: Notify
97 description: >
98 Possible ServiceProviderNotify values for an error log entry.
99 values:
100 - name: NotSupported
101 description: >
102 ServiceProviderNotify property is not supported.
103 - name: Notify
104 description: >
105 The service provider should be notified about the event log.
106 - name: Inhibit
107 description: >
108 The service provider should not be notified about the event log.
109
Adriana Kobylak66119c02021-02-04 13:23:58 -0600110methods:
Patrick Williams8da396c2022-03-14 14:21:02 -0500111 - name: GetEntry
112 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600113 Returns the file descriptor to the raw Entry file, which is a binary
114 blob. The mode of the file descriptor is to be reaad-only.
Patrick Williams8da396c2022-03-14 14:21:02 -0500115 returns:
116 - name: fd
117 type: unixfd
118 description: >
119 The file descriptor to the Entry file.