Skip to content

Commit babc22e

Browse files
authored
Fix the UI doc and relative screenshots. (#13017)
1 parent 44844dd commit babc22e

File tree

1 file changed

+16
-49
lines changed

1 file changed

+16
-49
lines changed

docs/en/ui/README.md

Lines changed: 16 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The SkyWalking official UI provides the default and powerful visualization capabilities for SkyWalking to observe full-stack applications.
44

5-
<img src="https://skywalking.apache.org/ui-doc/9.0.0/home.png"/>
5+
<img src="https://skywalking.apache.org/ui-doc/10.2.0/home.png"/>
66

77
The left side menu lists all available supported stacks with default dashboards.
88

@@ -29,7 +29,7 @@ menus:
2929
layer: VIRTUAL_CACHE
3030
- name: VisualMQ
3131
layer: VIRTUAL_MQ
32-
....
32+
....
3333
- name: SelfObservability
3434
icon: self_observability
3535
menus:
@@ -59,7 +59,7 @@ so).
5959
**Notice, dashboard editable is disabled on release; set system env(**SW_ENABLE_UPDATE_UI_TEMPLATE=true**) to activate
6060
them.** Before you save the edited dashboard, it is just stored in memory. Closing a tab would **LOSE** the change permanently.
6161

62-
A new dashboard should be added through `New Dashboard` in the `Dashboards` menu.
62+
A new dashboard should be added through `New Dashboard` in the `Dashboards` menu.
6363
Meanwhile, there are two ways to edit an existing dashboard.
6464
1. `Dashboard List` in the `Dashboard` menu provides edit/delete/set-as-root features to manage existing dashboards.
6565
2. In every dashboard page, click the right top `V` toggle, and turn to `E`(representing **Edit**) mode.
@@ -70,58 +70,25 @@ A dashboard consists of various widget. In the `Edit` mode, widgets could be add
7070

7171
The widget provides the ability to visualize the metrics, generated through [OAL](../concepts-and-designs/mal.md), [MAL](../concepts-and-designs/mal.md), or [LAL](../concepts-and-designs/lal.md) scripts.
7272

73-
<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-configuration.png" />
74-
75-
### Metrics
76-
77-
To display one or more metrics in a graph, the following information is required:
78-
1. **Name**: The name of the metric.
79-
2. **Data Type**: The way of reading the metrics data according to various metric types.
80-
3. **Visualization**: The graph options to visualize the metric. Each data type has its own matched graph options. See the [mapping doc](#common-graphs) for more details.
81-
4. **Unit**: The unit of the metrics data.
82-
5. **Calculation**: The calculation formula for the metric. The available formulas are [here](#calculations).
83-
84-
#### Common Graphs
85-
86-
|Metrics Data Type|Visualization|Demo|
87-
|----|-------------|----|
88-
|read all values in the duration|Line|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-line.png" />|
89-
|get sorted top N values|Top List|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-topn.png" />|
90-
|read all values of labels in the duration|Table|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-tables.png" />|
91-
|read all values in the duration|Area|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-area.png" />|
92-
|read all values in the duration|Service/Instance/Endpoint List|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-entity-table.png" />|
93-
|read sampled records in the duration|Records List|<img src="https://skywalking.apache.org/screenshots/9.2.0/customized-dashboard-metrics-20221201-sampled-records.png" />|
94-
95-
#### Calculations
96-
97-
|Label|Calculation|
98-
|----|----|
99-
|Percentage|Value / 100|
100-
|Apdex|Value / 10000|
101-
|Average|Sum of values / Count of values|
102-
|Percentage + Avg-preview|Sum of values / Count of values / 100|
103-
|Apdex + Avg-preview|Sum of values / Count of values / 10000|
104-
|Byte to KB|Value / 1024|
105-
|Byte to MB|Value / 1024 / 1024|
106-
|Byte to GB|Value / 1024 / 1024 / 1024|
107-
|Seconds to YYYY-MM-DD HH:mm:ss|dayjs(value * 1000).format("YYYY-MM-DD HH:mm:ss")|
108-
|Milliseconds to YYYY-MM-DD HH:mm:ss|dayjs(value).format("YYYY-MM-DD HH:mm:ss")|
109-
|Precision|Value.toFixed(2)|
110-
|Milliseconds to seconds|Value / 1000|
111-
|Seconds to days|Value / 86400|
73+
<img src="https://skywalking.apache.org/ui-doc/10.2.0/customize-dashboard-metrics-20250202.png" />
74+
75+
### Metric Query Expression
76+
Metric Query Expression provides the ability to query metrics from the backend.
77+
The query expression could be a simple metric name, or a complex expression with multiple functions.
78+
Read [Metrics Query Expression(MQE) Syntax doc](../api/metrics-query-expression.md) to learn more about the syntax.
11279

11380
### Graph styles
11481

115-
Graph advanced style options.
82+
Setup font size, unit, value mappings etc. to provide better visualization.
11683

11784
### Widget options
11885

11986
<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-options.png" />
12087

12188
Define the following properties of the widget:
12289
1. **Name**: The name of the widget, which used to [associate with other widget](#association-options) in the dashboard.
123-
2. **Title**: The title name of the widget.
124-
3. **Tooltip Content**: Additional explanation of the widget.
90+
2. **Title**: The title name of the widget.
91+
3. **Tooltip Content**: Additional explanation of the widget.
12592

12693
### Association Options
12794

@@ -131,17 +98,17 @@ Widget provides the ability to associate with other widgets to show axis pointer
13198
the connectivity among metrics.
13299

133100
### Widget Static Link
134-
On the right top of every widget on the dashboard, there is a `Generate Link` option, which could generate a static
101+
On the right top of every widget on the dashboard, there is a `Generate Link` option, which could generate a static
135102
link to represent this widget.
136-
By using this link, users could share this widget, or integrate it into any 3rd party iFrame to build a
103+
By using this link, users could share this widget, or integrate it into any 3rd party iFrame to build a
137104
network operations center(NOC) dashboard on the wall easily.
138105
About this link, there are several customizable options
139-
1. `Lock Query Duration`. Set the query duration manually. It is OFF by default.
106+
1. `Lock Query Duration`. Set the query duration manually. It is OFF by default.
140107
2. `Auto Fresh` option is ON with 6s query period and last 30 mins time range. Query period and range are customizable.
141108

142109
## Settings
143110

144-
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.
111+
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.
145112

146113
## FAQ
147114

0 commit comments

Comments
 (0)