events() queries to display events in charts. An
events() query cannot be the only query on the chart; at least one time series must be enabled on the chart in addition to the
events() query to display the events.
Event Query Syntax
events([<filterName>=”<filterValue>”] [and|or|not <filterName>=”<filterValue>”]])
where <filterName> is one of the supported event filters.
You can specify multiple event filters separated by boolean operators (and, or, not). You can use a comma instead of the boolean operator and. You cannot create
events() queries in the Query Builder.
events(name="Request\*" and (severity="severe" or severity="warn")or
events(name="Request\*", severity="warn" or severity="severe")- Display user events or events based on any alerts that start with
Requestand are either severity
events(severity="warn" or source="app-1")- Display events with severity
warnor generated by the source
Event filters allow you to limit which events are returned from events() queries.
|alertId||The ID of the alert that created the event.||events(alertId=1411189741192)|
|alertTag||A tag associated with the alert that generated the event.||events(alertTag="ops")|
|eventTag||A tag associated with the event.||events(eventTag="codepushes")|
|name||The name of the event. Manually created events have a unique name, while events generated by an alert have the same name as the associated alert. The name filter requires quotes if spaces exist in the name.||events(name="Request Latency too high")|
|severity||The classification of the user event or the severity of alert that generated the event. User event classification levels are severe, warn, info, and unclassified. Although an event can be left as unclassified, the severity filter does not accept unclassified as a valid value.||events(severity="info")|
|source or tag||The source or source tag associated with the alert that generated the event. The source filter allows you to display events generated by an alert based on a single source or set of sources. The tag filter works the same way, but allows you to specify a source tag instead of a source name.||events(source="app-*" or tag="dc2")|
|subtype||The subtype of event of type alert-detail: failing, recovered.||events(subtype="failing")|
|target||The target of the alert that generated the event. The list of targets associated with an alert are considered a single string. If you want to identify a single target within that string, then you must use wildcards. For example, if the notification field contains: email@example.com, firstname.lastname@example.org, pd:fbw21c9ee0219473w2179r4t23f8c34, to use email@example.com as the target filter, specify the email as *firstname.lastname@example.org*.||events(target="*email@example.com*")|
|type||The type of an event. There are system-generated event types: alert, maintenanceWindow, alert-detail, credentials-error, alert-created, alert-updated, alert-deleted, dashboard-deleted, maintenancewindow-created, maintenancewindow-updated, maintenancewindow-deleted and you can optionally assign a type to a user event. The value requires quotes if it contains spaces or starts with a wildcard.||events(type="Code push")
When Does an Event Query Return Events?
Where an event happens in relation to the query start time and query end time determines whether a query returns an event or not. Returning an event means showing the event in the UI, or, if you use the API, returning the event itself. The following illustration illustrates the behavior:
Here are some details. Note that for two cases, the behavior changed in Wavefront 2018.10; however, the following table shows general behavior and does not focus on this (fairly minor) change.
|Event Number||Event start||Event end||Returned?|
|Event 1||Before query start time time||Before query start time||No|
|Event 2||After query start time||Before query end time||Yes|
|Event 3||Before query start time||After query start time||Yes|
|Event 4||Before query start time||After query end time||No(*)|
|Event 5||Before query start time||N.A. (ongoing event)||No(*)|
|Event 6||After query start time||After query end time||Yes|
|Event 7||After query end time||N.A. (ongoing event)||No|
|Event 8||After query start time||N.A. (ongoing event)||Yes|
|Event 9||After query end time||After query end time||No|
(*) Wavefront returned the event before 2018.10, but we no longer return it. Performance improvements are significant.