The page that you are currently viewing is for an old version of Stroom (7.1). The documentation for the latest version of Stroom (7.6) can be found using the version drop-down at the top of the screen or by clicking here.

Dashboards

Querying and visualising the indexed data.

Create a new document/Dashboard.svg Dashboard in the Stroom 101 folder and call it Stroom 101.

images/quick-start-guide/dashboard/001_dashboard_new.png

New Dashboard

By default a new Dashboard opens with two panes; a Query pane at the top to build the query; and a Table pane at the bottom to display the results. Dashboards are highly configurable; panes can be added and resized; they can contain multiple queries; and a query pane can provide data for multiple output panes (such as Visualisations ).

Configuring the query data source

On the query pane click the settings settings-grey.svg button on the top right of the panel.

images/quick-start-guide/dashboard/002_dashboard_query_settings.png

Dashboard settings
  1. Click on the Data Source document picker.
  2. Select the index you created earlier:
    folder.svg Stroom 101 / document/Index.svg Stroom 101

Configuring the query expression

Now add a term to the query to filter the data.

  1. Right click on the root AND operator and click add.svg Add Term. A new expression is added to the tree as a child of the operator and it has three dropdowns in it ( Field , Condition and value).
  2. Create an expression term for the Application field:
    1. Field: Application
    2. Condition: =
    3. Value: *b*

This will find any records with b in the Application field value.

Configuring the table

All fields are stored in our index so we do not need to worry about configuring Search Extraction .

We first need to add some columns to our table. Using the add.svg button on the Table pane, add the following columns to the table. We want a count of records grouped by Application.

  • Application
  • Count

To group our data by Application we need to apply a group level to the Application column.

  1. Click on the Application column
  2. Click
    dashboard/group.png Group => dashboard/group.png Level 1

Now we can reverse sort the data in the table by the count.

  1. Click on the Count column.
  2. Click
    dashboard/sortaz.png Sort => dashboard/sortza.png Sort Z to A

Now click the large green and white play button to run the query. You should see 15 Applications and their counts returned in the table.

Now we are going to add a custom column to show the lowest EventId for each Application group.

  1. Click on the add.svg button on the Table pane.
  2. Select Custom (at the bottom of the list).
  3. Click on the new Custom column.
  4. Click
    dashboard/expression.png Expression
  5. In the Set Expression For ‘Custom’ dialog enter the following:
    first(${EventId})
  6. Click OK.

Instead of typing out the expression you can use the function.svg and field.svg buttons to pick from a list to add expressions and fields respectively. You can also use ctrl-<space> to auto-complete your expressions.

To rename the Custom column:

  1. Click on the Custom column.
  2. Click
    edit.svg Rename
  3. Enter the text First Event ID.
  4. Clico OK.

Now run the query again to see the results with the added column.

Add a visualisation

We will add a new pane to the dashboard to display a Visualisation .

  1. Click on the add.svg button at the top left of the Dashboard.
  2. Select Visualisation.

A new empty Visualisation pane will be added at the bottom of the Dashboard.

To configure the visualisation:

  1. Click on the settings-grey.svg button at the top right of the Visualisation pane.
  2. In the Visualisation document picker select
    folder.svg Visualisations / folder.svg Version3 / document/Visualisation.svg Bubble
  3. Click OK.
  4. On the Data tab that has now appeared in the dialog, assign the following table fields to the visualisation:
    1. Name: Application
    2. Value: Count
    3. Series: Application
  5. On the Bubble tab on the dialog, set the following:
    1. Show Labels: True
  6. Click OK.

To change the look of your Dashboard you can drag the different panes around into different positons.

  1. Click and hold on the Visualisation text in the top left of the Visualisation pane.
  2. Drag the cursor to the right hand side of the Table pane. You will see a purple rectangle showing where the pane will be moved to.
  3. Once you are happy with the position release the mouse button.
  4. Click and hold the mouse button on the borders between the panes to resize the panes to suit.
  5. Click save.svg to save the Dashboard.

You should now see something like this:

images/quick-start-guide/dashboard/010_visualisation_bubbles.png

Bubble visualisation
Last modified September 3, 2024: Merge branch '7.0' into 7.1 (27ab3d5)