Dashboards
A dashboard is a page of widgets inside an App: time range, generation frequency, sources, user inputs, layout, filters, Live mode, scheduled PDF and CSV exports, permalinks and the widget types.
What you will do: build a dashboard whose widgets share one time range, one set of sources and one input form, and schedule it as a report.
Dashboards live inside an App (see Apps); an App holds many, each for one purpose — application errors, performance, network, security. A dashboard arranges widgets, each backed by a search query, in a one, two or three column layout; widgets can be dragged, pinned to the top and resized by layout. Settings inherit App → dashboard → widget unless overridden.
Dashboard settings
| Section | Settings |
|---|---|
| General | name, description |
| Time | Time Range for every widget (Live runs in real time only while open, nothing is generated in the background); Generation Frequency (Never turns the dashboard into an offline report generated on export or on demand) |
| Dashboard Sources | logs, folders and servers added to every widget query; inherits the App's sources unless Override Application Sources |
| User Inputs | checkboxes, text, drop-downs or radio buttons shown at the top; the key is used in widget queries as [XI:key] |
| Export | one or several schedulers, each with a date range and input values; PDF and/or CSV by email (semicolon-separated recipients) and/or to a file location with retention; CSV carries no images |
Steps: a dashboard with an input
- Open the App, choose Add New Dashboard, name it and set the default time range and generation frequency.
- Add Widget, pick a visual type, give it a title and a query; Group By aggregates a simple query, a complex query brings its own grouping. Set Max Number of Results and the widget's own time range if it differs.
- In Edit Dashboard > User Inputs define an input, for example
intervalas a list of1 minute,1 hour(default),1 day. - Edit the widget query to use it:
* | count | interval [XI:interval] | display count as events over time. - Save; the input form appears above the widgets and Apply reloads them with the selection.
- Add an export scheduler when the dashboard is also a report.
Viewing
- Time frame menu: Default, Last N, Previous N (midnight to midnight), Today shortcuts, Date Range, Live, Custom.
- Filter adds a query constraint to every widget; the icon clears it.
- Layout: one, two or three columns; Save Layout makes it the default, Reset Layout restores it.
- Slideshow rotates every open dashboard every 5 seconds to 1 minute (NOC mode); Dashboard Theme switches white and black.
- Every widget footer offers View in Search, View in XpoLog or View in Analytics to drill into the data; the widget menu offers Edit, Duplicate, Delete, Generate Now, Pin to Top, Export to PDF / CSV / Excel and Copy Permalink.
- A permalink (
&autoLogin=true&username=…&password=…when security is on,&allowZoom=false,&blackTheme=truefor dashboards) embeds a dashboard or widget in an external portal; prefer a dedicated read-only user for it.
Widget types
Line, Area, Column, Bar, Stacked Grouped Column, Pie (regular, donut, semi-circle, 2D or 3D), Scatter, Gauge, Heat Map, Table (search results summary), Summary (search results table), Events (static or dynamic list), Map and Google Map, Transactions, Analytics, Container (with Data Highlights and Data Trends), Monitors, Monitors Alerts, Sankey, Venn. Change widget type keeps the definition and switches the visual.
Permissions and portability
A user sees only the Apps and dashboards whose source logs they may view; each App has an immutable owner whose permissions generate the results. Export Conf writes a dashboard's configuration to a zip; Import Dashboard Conf. recreates it in another App or deployment. Exporting the App carries all its dashboards.
Next: Apps
Source: XPLG wiki, pages 1597539171, 1597539173, 1594131441, 1597539357, 1597539353, 1594131443, 1598685255, 1598685264, 1597539274, 1597539276, 1594131449, 1597539188, 1597539190, 1594131445, 1597539362, 1597539408, 1594131439, 1599570802, 1594132438, 1597539102, 1599570164, 1627750485, 1602191371, 1602191376, 1597539204, 1597539296 (https://xpolog.atlassian.net/wiki/spaces/XPOL/pages/1597539171).
