Event Stream Widget
New announcements from Dash: Incident Management, Continuous Profiler, and more! New announcements from Dash!

Event Stream Widget

The event stream is a widget version of the stream of events on the Event Stream view.

Note: this widget displays only the 100 most recent events.

Setup

Configuration

  1. Enter a search query to filter the event stream.
  2. On screenboards only, choose whether your widget has a custom timeframe or the screenboard’s global timeframe.
  3. Use the size parameter to choose to display either only the events title or the full event body.

Options

Title

Display a custom title for your widget by activating the Show a Title check box:

Optionally define its size and alignment.

API

The dedicated widget JSON schema definition for the event stream widget is:

EVENT_STREAM_SCHEMA = {
    "type": "object",
    "properties": {
        "type": {"enum": ["event_stream"]},
        "query": {"type": "string"},
        "event_size": {"enum": ["s", "l"]},
        "title": {"type": "string"},
        "title_size": {"type": "string"},
        "title_align": {"enum": ["center", "left", "right"]}
        "time": TIME_SCHEMA
    },
    "required": ["type", "query"],
    "additionalProperties": false
}
ParameterTypeRequiredDescription
typestringyesType of the widget, for the event stream widget use event_stream
querystringyesQuery to filter the event stream with
event_sizestringnoSize to use to display an event (small or large). Available values are: s or l
titlestringnoTitle of the widget
title_sizestringnoSize of the title
title_alignstringnoHow to align the title. Available values are: center, left, or right
timeobjectnoTime setting for the widget. See the dedicated Time JSON schema documentation to learn how to build the TIME_SCHEMA

Further Reading

Additional helpful documentation, links, and articles: