DocumentationDiscussions
DocumentationDiscussions
Hey! These docs are for version 2021.3, which is no longer officially supported. Click here for the latest version, 2022.1!

Alert Properties

Notifications from Alerts (including template-based HTML Email) can include the following fields:

Property

Contains

Example (JSON syntax)

Alert.HavingClause

The having clause that represents the alert condition

"count > 5"

Alert.Id

The id of the alert that triggered the notification

"alert-1234"

Alert.OwnerUsername

The Seq username of the user who owns the alert, or null if the alert is shared

"admin"

Alert.Query

The Seq query that generated the alert

"select count(*) as count
from stream
group by time(1m)
having count > 5"

Alert.SignalExpressionDescription

A human-readable description of the signal applied to the underlying data

"Errors in Production"

Alert.TimeGrouping

The window over which the alert is measured, as a string

"00:30:00"

Alert.Title

The title of the alert, as defined on the dashboard

"High Error Rate"

Alert.Url

A link to the alert itself in Seq

"https://seq.example.com/#/alerts/alert-123"

Failures

An array of errors that occurred when checking the alert

["X failed", "Y failed"]

NamespacedAlertTitle

The title of the alert, prefixed with the owner's username if the alert is persona.

"admin / High Error Rate"

Source.ContributingEvents

A table of events contributing to this notification

See Contributing Events below

Source.RangeEnd

The (exclusive) end of the range over which the alert was checked when the notification was triggered

"2021-10-28T12:34:56.789"

Source.RangeStart

The (inclusive) start of the range over which the alert was checked when the notification was triggered

"2021-10-28T12:33:56.789"

Source.Results

The results that triggered the notification

See Results below

Source.ResultsUrl

A link to Seq where the results can be inspected

"https://seq.example.com/#/events?q=..."

SuppressedUntil

The datetime until which the alert is suppressed

"2021-10-28T12:35:56.789"

Contributing events

Contributing events, if included in the notification, are a table represented as an array of arrays.

The first row describes the columns of the table.

  "Source": {
    "ContributingEvents": [
        ["@Id", "ToIsoString(@Timestamp)", "Message"],
        ["event-123", "2021-10-28T12:34:56.789", "Unhandled exception"],
        ["event-456", "2021-10-28T12:34:57.890", "An operation timed out"]
    ],

Results

The results property is a table represented as an array of arrays.

The first row describes the columns of the table.

  "Source": {
    "Results": [
        ["time", "Application", "count"],
        ["2021-10-28T12:34:56.789", "Cafe", 7],
        ["2021-10-28T12:34:57.890", "Warehousing", 11]
    ],

Notification properties

Properties that are explicitly added to the alert's notification properties are included at the root of the notification payload.


Did this page help you?