Using the Apica Panels Dashboards
- Former user (Deleted)
The Panel Widgets allow you to populate your Grafana dashboards with data visualizations from your Synthetic Monitoring according to your needs.
Add Dashboard
You can create new dashboards directly from the Dashboard Search menu.
To add a new dashboard:
Click the Dashboard Search
Click New Dashboard
A new empty dashboard called New Dashboard is added:
You can now go on to add Panel Widgets and/or Configure Dashboard the dashboard settings.
Configure Dashboards
All configurations for dashboards are available from the dashboard configuration menu.
Edit Panel Widget
To edit a panel widget:
Click configuration to open the menu
Select the configuration option you want to work with.
Annotations
With Annotations, you can add events to your graphs, either in Grafana itself, or through queries from supporting Data Source.
Add Annotation
Annotations can be added directly in the graph.
Display Annotation Events
Annotation events are displayed as icons and vertical lines and icons on graph panels.
Hovering over annotations will display details about the event. The dashboard configuration allows you to filter which annotations to display.
Item | Description |
|
|---|---|---|
Name | Display name for the filter. |
|
Data Source | Source for the annotations. |
|
Enabled | Show annotations. |
|
Hidden | Hide the filter from the dashboard. |
|
Color | Display color for the indicator lines. |
|
Query
Item | Description |
|
|---|---|---|
Filter By | Filter method. |
|
Max Limit | Maximum number of annotations to display. |
|
Filter Method
Filtering by Tags will display only the annotations that match any of the tags in the list.
With Dashboard filtering, all annotations are displayed on their originating panel widget.
Configure Dash History
In the Version History, you can see a list of all saved versions of the dashboard.
Compare Dashboards
With the Compare feature, you can see the differences between two versions of a dashboard.
The view shows all differences in the JSON between the selected versions.
Restore
You can Restore previous versions of the dashboard. This will replace the latest version with the selected version. The restore button is available from two places:
on the right-hand side in the History:
At the top of the Compare:
Dialog
View JSON
The View JSON menu option opens a panel displaying the JSON for the current dashboard.
Menu
Dialog
You can select and copy the JSON code from the panel, but not edit and save it in place.
Save As
The Save As menu option allows you to save a complete copy of the current dashboard under a different name.
Menu
Dialog
Configure Dash Settings
The Dashboard Settings allow you to configure options and parameters for the dashboard.
Edit Settings
Edit
All settings for a panel widget are available from the panel widget settings dialog.
Edit Settings
To edit Dashboard Settings:
Click configuration to open the menu
Click Settings
You can now select the appropriate settings tab to work with.
“General” Settings Tab
General
The General tab covers settings relating to the dashboard display.
View
Item | Description |
|
|---|---|---|
Name | Identifier/title for the dashboard. |
|
Description | Longer description of the dashboard. |
|
Tags | Dashboard tags for filering, search and organization. |
|
Timezone | Timezone to use for display. |
|
Toggles
In the Toggles section you can set parameters relating to
Item | Description |
|
|---|---|---|
Editable | Turn dashboard editing on or off. | Dahsboard must be saved to apply changes. |
Hide Controls | Show or hide the dashboard controls. |
|
Panel Options
The Panel Options governs the default Graph Tooltips behavior for the panel widgets in the dashboard.
Item | Description |
|
|---|---|---|
Graph Tooltip |
|
|
The default behavior is single mode.
You can also toogle between behaviors by pressing ctrl-o/command-o while working in the dashboard.
Hide Controls
The dashboard controls - the row menu and the add row button, can be hidden from the display.
Controls on:
Controls off:
Links Tab
In the Links tab you can create links to web pages or other dashboards.
View
Add Link
To add more than one link:
Click the Add Link button
Dashboard
In the Links tab you can create links to web pages or other dashboards. optionally based on a tag filter.
View
Item |
| Description | Comment |
|
|---|---|---|---|---|
Type |
| Type of link. |
|
|
Wit Tags |
| Filter for dashboard Settings General. |
|
|
As Dropdown |
| Show the filtered list as dropdown menu to select individual dashboards. |
|
|
Title |
| Title for the link. |
|
|
Include |
|
|
|
|
| Time Range | Apply the current Time Range to the linked dashboard view. |
|
|
| Variable Values | Apply any current Templates to the linked dashboard view. |
|
|
Open In New Tab |
| Link will open in separate browser tab. |
|
|
Dashboard Display
Creating Links to Web Pages
In the Links tab you can create links to web pages or other dashboards. optionally based on a tag filter.
View
Item |
| Description | Comment |
|
|---|---|---|---|---|
Type | Type of link. |
|
| |
Url | External link to access. |
|
| |
Title | Title for the link. |
|
| |
Tooltip | Tooltip to display when hovering over the link. |
|
| |
Icon | Icon to display before the link. | |
| |
Include |
|
|
| |
| Time Range | n/a |
| |
| Variable Values | n/a |
| |
Open In New Tab | Link will open in separate browser tab. |
| ||
Dashboard Display
Metadata
The *Metadata tab shows administrative information about the dashboard.
View
Item | Description | Commment |
|---|---|---|
Last Updated At | Timestamp for last change. |
|
Last Updated By | User that did the last change. |
|
Created At | Dashboard creation timestamp. |
|
Created By | User who created the dashboard. |
|
Current Version | Version of dashboard. | Corresponds to number of times saved. |
Rows
In the Rows tab, you can configure individual settings for the rows in the dashboard.
View
This feature is useful if you want provide the row with a title, when multiple panel widgets are related to the same theme.
The
Icon | Item | Description |
|
|---|---|---|---|
| Title | Title to display for the row. |
|
 | Show Title | Turn title display on or off. |
|
| Move Up | Change display order in the dashboard. |
|
| Move Down | Changes display order in the dashboard. |
|
| Delete | Remove the row and all panel widgets it contains. |
|
Dashboard Display
Time Picker
With the Time Picker tab, you can configure how often the dashboard should be refreshed and define now for relative time calculations.
View
The Timepicker settings apply per Dashboard.
| Item | Description | Comment |
|---|---|---|---|
Auto-Refresh | Interval between automatic reloads and data refresh in the dashboard. |
|
|
Now Delay | Add delay to | Gives extra time for data aggregation. |
|
Shortcuts
The Shortcuts view provides a list of keyboard shortcuts for Grafana.
Menu
Dialog
Templates
Dashboard templates allows you to create more dynamic dashboards, by providing dropdown menus where you can select what to display based on predefined variables.
Menu
View
Add Variable
You can add multiple variables of different types as needed.
View
Click the New button
The New tab opens
Select the type of variable you want to add
Add settings according to the variable type
Click the Add button
The variable is added to the list.
Template Ad Hoc
Ad Hoc
Ad Hoc filters are currently not supported by The Synthetic Monitoring data source.
View
Ad hoc filters allows you to add key/value filters that will automatically be added to all metric queries that use the specified data source.
Constant
Constant
A Constant can be used as a defined as a metric path prefixes for shared dashboards.
View
When the dashboard is ExportImport, constant variables are concerted to import options.
Variable
Item | Description | Comment |
|---|---|---|
Name | Name of the variable. |
|
Label | Display label in dashboard. |
|
Type | Type of variable. |
|
Hide | Display elements to hide. | |
Constant Options
Item | Description | Comment |
|---|---|---|
Value | Constant value to use. |
|
Preview
List of values that will be displayed in the dropdown.
Template Custom
In Custom variables, you provide a manually defined list of values .
View
Variable
Item | Description | Comment |
|---|---|---|
Name | Name of the variable. |
|
Label | Display label in dashboard. |
|
Type | Type of variable. |
|
Hide | Display elements to hide. |
|
Custom Options
Item | Description | Comment |
|---|---|---|
Values | Values to use. | Comma-separated list. |
Selection Options
Item | Description | Comment |
|---|---|---|
Multi-value | Allow selection of multiple values in the dropdown. |
|
Include All Option | Add | Will include all values in a combined query expression. |
Custom All Value | Query expression to use as |
|
Custom All Value
The standard All value combines all options, which can result in a very long expression and possibly affect performance.
It may therefore be better to provide a custom expression more suitable for your data source, for example a Regular Expression.
Note: Characters in the expression are not escaped.
Preview
List of values that will be displayed in the dropdown.
Interval
With the Interval variable you can provide a selector for different time spans to apply to the dashboard.
View
Variable
Item | Description | Comment |
|---|---|---|
Name | Name of the variable. |
|
Label | Display label in dashboard. |
|
Type | Type of variable. |
|
Hide | Display elements to hide. | |
Interval Options
Item | Description | Comment |
|---|---|---|
Values | Time values to include in the list. |
|
Auto Option | Generate the list automatically based on the current time span. |
|
Step Count | Number times to divide the current time span. |
|
Min Interval | Lowest value in the list. |
|
Preview
List of values that will be displayed in the dropdown.
Query
Query
The Query variable type uses a Data Source query to return a list of values.
View
Variable
Item | Description | Comment |
|---|---|---|
Name | Name of the variable. |
|
Label | Display label in dashboard. |
|
Type | Type of variable. |
Can't find what you're looking for? Send an E-mail to support@apica.io