You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2020/08/19 12:06:12 UTC
[skywalking-cli] branch master updated: [Doc] Fix `dashboard
global` doc (#58)
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking-cli.git
The following commit(s) were added to refs/heads/master by this push:
new 5a6f536 [Doc] Fix `dashboard global` doc (#58)
5a6f536 is described below
commit 5a6f5360f03d8e136e7af1686a2cf575357e87e1
Author: Hoshea Jiang <fg...@gmail.com>
AuthorDate: Wed Aug 19 20:05:06 2020 +0800
[Doc] Fix `dashboard global` doc (#58)
---
README.md | 30 ++++++++++++++++++++++++------
1 file changed, 24 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 298e680..3a96ab5 100644
--- a/README.md
+++ b/README.md
@@ -259,11 +259,11 @@ Ascii Graph, like coloring in terminal, so please use `json` or `yaml` instead.
| argument | description | default |
| :--- | :--- | :--- |
-| `trace id` | the trace id whose spans are to displayed | |
+| `trace id` | The trace id whose spans are to displayed | |
</details>
-### `trace ls`
+#### `trace ls`
<details>
@@ -271,9 +271,9 @@ Ascii Graph, like coloring in terminal, so please use `json` or `yaml` instead.
| argument | description | default |
| :--- | :--- | :--- |
-| `--trace-id` | the trace id whose spans are to displayed | |
-| `--service-id` | the service id whose trace are to displayed | |
-| `--service-instance-id` | the service instance id whose trace are to displayed | |
+| `--trace-id` | The trace id whose spans are to displayed | |
+| `--service-id` | The service id whose trace are to displayed | |
+| `--service-instance-id` | The service instance id whose trace are to displayed | |
| `--tags` | Only tags defined in the core/default/searchableTagKeys are searchable. Check more details on the Configuration Vocabulary page | See [Configuration Vocabulary page](https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/configuration-vocabulary.md) |
| `--start` | See [Common options](#common-options) | See [Common options](#common-options) |
| `--end` | See [Common options](#common-options) | See [Common options](#common-options) |
@@ -282,6 +282,8 @@ Ascii Graph, like coloring in terminal, so please use `json` or `yaml` instead.
### `dashboard`
+#### `dashboard global-metrics`
+
<details>
<summary>dashboard global-metrics [--template=template]</summary>
@@ -290,13 +292,29 @@ Ascii Graph, like coloring in terminal, so please use `json` or `yaml` instead.
| argument | description | default |
| :--- | :--- | :--- |
-| `--template` | the template file to customize how to display information | `templates/Dashboard.Global.json` |
+| `--template` | The template file to customize how to display information | `templates/Dashboard.Global.json` |
+| `--start` | See [Common options](#common-options) | See [Common options](#common-options) |
+| `--end` | See [Common options](#common-options) | See [Common options](#common-options) |
You can imitate the content of [the default template file](example/Dashboard.Global.json) to customize the dashboard.
</details>
+#### `dashboard global`
+
+<details>
+
+<summary>dashboard global [--template=template]</summary>
+
+`dashboard global` displays global metrics, global response latency and global heat map in the form of a dashboard.
+| argument | description | default |
+| :--- | :--- | :--- |
+| `--template` | The template file to customize how to display information | `templates/Dashboard.Global.json` |
+| `--start` | See [Common options](#common-options) | See [Common options](#common-options) |
+| `--end` | See [Common options](#common-options) | See [Common options](#common-options) |
+
+</details>
### `checkHealth`