Event Stream Widget

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

This widget can be used with the Dashboards API. Refer to the Dashboards API documentation for additional reference.

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

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

This widget can be used with the Dashboards API. Refer to the Dashboards API documentation for additional reference.

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

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

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

This widget can be used with the Dashboards API. Refer to the Dashboards API documentation for additional reference.

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

Expand All

Field

Type

Description

event_size

enum

Size to use to display an event. Allowed enum values: s,l

query [required]

string

Query to filter the event stream with.

tags_execution

string

The execution method for multi-value filters. Can be either and or or.

time

object

Time setting for the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the event stream widget. Allowed enum values: event_stream

{
  "event_size": "string",
  "query": "",
  "tags_execution": "string",
  "time": {
    "live_span": "string"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "event_stream"
}

Further Reading

Additional helpful documentation, links, and articles: