summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRatan Gupta <ratagupt@in.ibm.com>2017-10-05 15:42:56 +0530
committerRatan Gupta <ratagupt@in.ibm.com>2018-02-21 19:45:31 +0530
commit85bb6f3b78701261470eb589a06f09784aa67612 (patch)
tree3835ea1f9f7f84d61ac7d85aab2c2f4c5e523036
parent61e56d31bba08bf533e10b4168595b9c02cc7457 (diff)
downloadphosphor-dbus-interfaces-85bb6f3b78701261470eb589a06f09784aa67612.zip
phosphor-dbus-interfaces-85bb6f3b78701261470eb589a06f09784aa67612.tar.gz
Logging: Create the new event interface.
This interface should be instantiated for the phosphor::events namespace. Currently Event interface and Entry Interface has common properties but the plan is to split the Entry interface into Event and Entry specific properties. Will do it later with github issue https://github.com/openbmc/openbmc/issues/2923 Change-Id: Ic84ea85d20126473e2723e4868c685f0a9d298e0 Signed-off-by: Ratan Gupta <ratagupt@in.ibm.com>
-rwxr-xr-xxyz/openbmc_project/Logging/Event.interface.yaml32
1 files changed, 32 insertions, 0 deletions
diff --git a/xyz/openbmc_project/Logging/Event.interface.yaml b/xyz/openbmc_project/Logging/Event.interface.yaml
new file mode 100755
index 0000000..c083fc9
--- /dev/null
+++ b/xyz/openbmc_project/Logging/Event.interface.yaml
@@ -0,0 +1,32 @@
+#TODO This interface and the logging entry interface
+# is having common properties,Ideally there should be
+# one common interface and the specific properties
+# for logging should go in (Logging/Entry).
+# https://github.com/openbmc/openbmc/issues/2923
+description: >
+ Implement to provide event entry attributes.
+ This interface should be instantiated for the phosphor::events namespace.
+ This interface is a collection of objects, therefore it is required to
+ implement org.freedesktop.DBus.ObjectManager on the events namespace root.
+ Optionally, implement xyz.openbmc_project.Delete to allow the deletion of
+ individual entries.
+ The event D-Bus object path would look like
+ <PhosphorDbusRoot>/events/<type>/<id>
+ Here "type" is the type of event, Could be network/system state event etc.
+ Type would be given by the application configuration file which would
+ be implementing this interface.
+ Here "id" is positive integer starts from 1 and it gets incremented by 1
+ with any newly created object.
+properties:
+ - name: Timestamp
+ type: uint64
+ description: >
+ Event creation timestamp in milliseconds since 1970.
+ - name: Message
+ type: string
+ description: >
+ The message description of the event entry.
+ - name: AdditionalData
+ type: array[string]
+ description: >
+ Additional information in the form of metadata field strings VAR=val
OpenPOWER on IntegriCloud