Once you've started collecting structured log data, you'll be amazed how much interesting and useful information you can find in it. Dashboards are great for keeping track of important indicators of application and business behavior.
Dashboards are "personal" by default; to make a dashboard visible to other members of your team, use the drop-down menu beside the dashboard name, select "shared", and save the dashboard.
The quickest way to add a chart to a dashboard is directly from the events screen.
After selecting one of the existing dashboards, or New Dashboard to create a new one, enter a name for the chart and press Ok.
Notice that the dashboard itself needs to be saved: pressing the Save button in the top left of the grey dashboard area will do this.
The Add to Dashboard button can also be used when viewing an SQL query to add that query onto the dashboard:
If the query is not already grouped by
time(), Seq will transform the query so that the dashboard slices results into individual time intervals.
Charts can present data in a variety of styles. This section explains each of the tabs shown when a chart is added via the events screen, with the
+ button on a dashboard, or by clicking the down-arrow in the top right-hand corner of the chart title:
Charts will initially show a simple
count query, over all events in the stream.
To narrow down the events that will contribute to the chart, select one or more signals from the Signal tab:
When multiple signals are selected, only events that match all of the signals will contribute to the chart.
To remove a signal, click the
x beside the signal name.
The Query tab is used to choose one or more measurements to present on the chart.
- select - Use this section to specify the measurements that are shown on the chart. The first input box accepts an aggregation expression like
percentile, while the second box sets the label that will identify the series when more than one line is shown. Press
+to add multiple measurements; delete the text in the first input box to remove a measurement.
- where - This input accepts an SQL predicate to further restrict which data contributes to the chart. Strict SQL syntax is required (single-quoted strings, SQL-style operators).
- group by - Multiple series can be displayed for a single measurement by grouping the data, e.g. using a property name like
+to add more than one grouping, and clear the text from a grouping in order to remove it.
- having - This input is similar to where, but applies its predicate over a grouping. This field is only relevant to rowset-based charts like pies and tables.
- order by - Specify an ordering for the data. This field is only relevant to rowset-based charts like pies and tables.
- limit - Specify an upper limit on the number of rows returned. This field is only relevant to rowset-based charts like pies and tables.
Because Seq charts are driven by Seq's underlying SQL engine, the query being used to generate a chart can be inspected and, if desired, copied for use as the basis of an interactive diagnostic session. The query is shown in the SQL tab:
Charts can be shown in a variety of color palettes and styles.
The default Line chart style is for continuous data, i.e. where there are no gaps in the measurement from one time slice to another.
Fill to zero (Y axis) shades the area under the line. Show point markers can be used to show or hide the "dots" marking each data point.
Point charts can be useful for displaying sparse data sets, for example, latencies from an infrequently-called API, where there are gaps in the measurement across time slices:
The Bar chart type is ideal for histograms showing a
The total of all bars can be shown as an overlay; this is great for error or transaction counts.
The Pie chart type is ideal for visualizing the relative size of unique values in a small set.
The Table chart type is ideal for showing small rowsets.
Alerts are used to send notifications based on the values from a chart. See the alerts documentation for a description of this feature.
Finally, the Position tab permits a chart to be moved around the dashboard, cloned, or removed.
Dashboards are so useful (and beautiful!) that you'll create quite a few, and want to share them with the rest of your team in different ways.
On the left-hand side of the dashboards screen, a list of available dashboards is shown. New dashboards can be created using the
+ button beside the "Dashboards" heading.
The top left-hand corner of a dashboard displays the title, some toolbar buttons, and a drop-down menu for managing the dashboard.
- To rename the dashboard, click in the title area: the title can be edited in-place.
- Use the full-screen button to display the dashboard alone without the title bar or dashboards list. This is great for dashboards on overhead displays.
- The filter button configures a whole-dashboard filter.
- All changes made to the charts and alerts on a dashboard need to be saved using the save button; changes can be discarded with the revert button.
- Shared dashboards are visible to the whole team.
- Protected dashboards can only be edited by admin users. A shared dashboard that isn't protected can be edited by any user on the team.
- Switch to Clone to create several variations of the same dashboard layout.
- Edit as JSON to edit the dashboard entity directly.
- Remove from Workspace to remove a dashboard from your active workspace. This won't delete the dashboard.
- Delete removes the dashboard.
For information radiators/overhead displays, it may not always be possible or convenient for a Seq user to log in so that a dashboard can be displayed.
An API key with read-level permissions can be embedded in the dashboard's URI fragment with an
&apiKey= parameter like:
When the dashboard is opened, the API key will be removed from the URL.
&theme= values are
This feature is currently limited to use with shared dashboards only.
Updated about 2 years ago