Just like the logs, event engine relies on AWS Cloudwatch. It will look for a log group called $ORGANIZATION_NAME-$SOME_ID-events where events are stored in a JSON format.

To first setup the event engine, go to the organization's list page and fill the various parameters, to allow Cycloid to manipulate events.

Event engin

Once you have setup the event engine, you can send yourself events using the Cycloid's API. To build your own events, feel free to use the event resource that we wrote for this purpose. The README shall guide you through the structure of the events, and possible limitations of fields. The event will then be uploaded in the JSON format:

{
  "title": "title of the event",
  "message": "some useful message here",
  "icon": "<icon>",
  "tags": [
    { "key": "foo", "value": "bar" },
    { "key": "foo2", "value": "bar2" }
  ],
  "severity": "<severity>",
  "type": "<type>"
}
1
2
3
4
5
6
7
8
9
10
11

Which you will be able to display on the 'Events' section of the left panel:

Events