Overview
Witboost logs various events related to actions triggered by the user. Each logged event provides a detailed record of an activity, ensuring traceability and accountability.
Each event is associated to a topic id, which is a unique symbol to indicate the related action.
The topic id is composed of a namespace followed by the topic name (e.g. namespace.topic-name).
A namespace is a logical group name which refers to the Witboost module generating the events.
Common structure of events
The following table illustrates the common structure of the events, indicating the name of each field and its description.
| Field name | Description |
|---|---|
| uuid | The unique id which is assigned to this event. |
| topic_id | The topic id which this event is associated to. |
| payload | Some additional fields to describe specifically this event. The structure may vary depending on the topic. |
| published at | The timestamp of when this event was published. |
| correlation_id | An id which allows this event to be correlated to another. |
| generator_system | The Witboost module which generated this event. |
| originator_uri | The actor that triggered the action described by this event. |
| _key_builder_catalog | An optional reference id to an object from the builder catalog module. |
| _key_marketplace | An optional reference id to an object from the marketplace module. |
| _key_cgp | An optional reference id to an object from the CGP module. |
| _key_coordinator | An optional reference id to an object from the coordinator module. |
All events are described in the following sections named with the defined namespaces in which they are grouped: