Events
Events represent points or time ranges of interest in your organization's recordings. They help you quickly identify, categorize, and search for relevant subsets of your data.
Each event requires an associated device, timestamp, and duration (0 for an instantaneous event). It can also contain optional metadata.
How events work
Events are associated with devices, not specific recordings. An event automatically appears in any recording from that device whose time range overlaps with the event's timestamp—including recordings uploaded before the event was created and future recordings uploaded later.
Example: A device "Robot-1" has these recordings:
- Recording A:
14:00:00to14:01:00 - Recording B:
14:02:00to14:03:00
If you create an event at 14:00:30 for Robot-1 with a duration of 120 sec:
- Recording A will show the event covering its second half
- Recording B will show the event covering its first half
- Any recordings uploaded at a later point that intersect the
14:00:30to14:02:30timerange will be associated with the event
Add event during playback
Click “Visualize” for a recording on the “Recordings” page. The data will open for playback in a new window – locate the bookmark icon on the playback bar:
Seek to a point of interest in your data, then click the bookmark icon to add an event at that point on the timeline.
Added events will also persist to the “Events” page.
View and search during playback
View a list of all events associated with the current data source in the right sidebar's "Events" tab. The search input field uses the same syntax as Foxglove event search – filter events by metadata keys and values and find events of interest.
When streaming Foxglove recordings, the playback bar will also display events as blue bars. Hovering on a blue bar will display its metadata in a tooltip:
If the "Events" sidebar is open, hovering on an event on the playback timeline will highlight its corresponding information in the sidebar:
Actions
Add, list, delete, and search events from the Events page.
| Definition | CLI | |
|---|---|---|
| Add | Add an event to flag interesting data in your organization | TBD |
| List | View your organization's events | foxglove events list |
| Delete | Delete an event in your organization | TBD |
Search
Search events by device, time range, and metadata on the Events page.
Use the syntax below to filter by metadata keys and values:
| Specific key | Any key | |
|---|---|---|
| Specific value | weather:rain | *:rain |
| Any value | weather:* | |
| Multiple values (all required) | weather:rain weather:fog | |
| Multiple values (1+ required) | weather:rain,fog,"mostly sunny" |
A single word (e.g. error) will look for matching metadata keys or values.
Non-alphanumeric characters can be used inside quotes (e.g. "/weather/rain":* or "@my.custom.key":"10%").