Introduction to UI
The SkyWalking official UI provides the default and powerful visualization capabilities for SkyWalking to observe full-stack applications.
The left side menu lists all available supported stacks with default dashboards.
Official Dashboards menu to explore all default dashboards on their ways to monitor different tech stacks.
Besides official dashboards, Dashboards provide customization capabilities to end-users to add new tabs/pages/widgets, and flexibility to re-config the dashboard on your own preference.
The dashboard has two key attributes, Layer and Entity Type. Learn these two concepts first before you begin any customization. Also, trace, metrics, and log analysis are relative to OAL, MAL, and LAL engines in the SkyWalking kernel. It would help if you learned them first, too.
Service and All entity type dashboard could be set as root(
set this to root), which means this dashboard would be used
as the entrance of its Layer. If you have multiple root dashboards, UI will choose one randomly (We don’t recommend doing
Notice, dashboard editable is disabled on release; set system env(SW_ENABLE_UPDATE_UI_TEMPLATE=true) to activate them. Before you save the edited dashboard, it is just stored in memory. Closing a tab would LOSE the change permanently.
A new dashboard should be added through
New Dashboard in the
Meanwhile, there are two ways to edit an existing dashboard.
Dashboard Listin the
Dashboardmenu provides edit/delete/set-as-root features to manage existing dashboards.
- In every dashboard page, click the right top
Vtoggle, and turn to
E(representing Edit) mode.
A dashboard consists of various widget. In the
Edit mode, widgets could be added/moved/removed/edit according to the Layer.(Every widget declares its suitable layer.)
To display one or more metrics in a graph, the following information is required:
- Name: The name of the metric.
- Data Type: The way of reading the metrics data according to various metric types.
- Visualization: The graph options to visualize the metric. Each data type has its own matched graph options. See the mapping doc for more details.
- Unit: The unit of the metrics data.
- Calculation: The calculation formula for the metric. The available formulas are here.
|Metrics Data Type||Visualization||Demo|
|read all values in the duration||Line|
|get sorted top N values||Top List|
|read all values of labels in the duration||Table|
|read all values in the duration||Area|
|read all values in the duration||Service/Instance/Endpoint List|
|read sampled records in the duration||Records List|
|Percentage||Value / 100|
|Apdex||Value / 10000|
|Average||Sum of values / Count of values|
|Percentage + Avg-preview||Sum of values / Count of values / 100|
|Apdex + Avg-preview||Sum of values / Count of values / 10000|
|Byte to KB||Value / 1024|
|Byte to MB||Value / 1024 / 1024|
|Byte to GB||Value / 1024 / 1024 / 1024|
|Seconds to YYYY-MM-DD HH:mm:ss||dayjs(value * 1000).format(“YYYY-MM-DD HH:mm:ss”)|
|Milliseconds to YYYY-MM-DD HH:mm:ss||dayjs(value).format(“YYYY-MM-DD HH:mm:ss”)|
|Milliseconds to seconds||Value / 1000|
|Seconds to days||Value / 86400|
Graph advanced style options.
Define the following properties of the widget:
- Name: The name of the widget, which used to associate with other widget in the dashboard.
- Title: The title name of the widget.
- Tooltip Content: Additional explanation of the widget.
Widget provides the ability to associate with other widgets to show axis pointer with tips for the same time point, in order to help users to understand the connectivity among metrics.
Settings provide language, server time zone, and auto-fresh options. These settings are stored in the browser’s local storage. Unless you clear them manually, those will not change.
Login and Authentication
SkyWalking doesn’t provide login and authentication as usual for years. If you need, a lot of Gateway solutions have provides well-established solutions, such as the Nginx ecosystem.