You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2021/09/04 01:03:01 UTC
[GitHub] [skywalking] wingwong-knh opened a new pull request #7649: Refine UI doc
wingwong-knh opened a new pull request #7649:
URL: https://github.com/apache/skywalking/pull/7649
<!--
⚠️ Please make sure to read this template first, pull requests that don't accord with this template
maybe closed without notice.
Texts surrounded by `<` and `>` are meant to be replaced by you, e.g. <framework name>, <issue number>.
Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]`
-->
<!-- ==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👇 ====
### Fix <bug description or the bug issue number or bug issue link>
- [ ] Add a unit test to verify that the fix works.
- [ ] Explain briefly why the bug exists and how to fix it.
==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👆 ==== -->
<!-- ==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👇 ====
### Improve the performance of <class or module or ...>
- [ ] Add a benchmark for the improvement, refer to [the existing ones](https://github.com/apache/skywalking/blob/master/apm-commons/apm-datacarrier/src/test/java/org/apache/skywalking/apm/commons/datacarrier/LinkedArrayBenchmark.java)
- [ ] The benchmark result.
```text
<Paste the benchmark results here>
```
- [ ] Links/URLs to the theory proof or discussion articles/blogs. <links/URLs here>
==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👆 ==== -->
<!-- ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👇 ====
### <Feature description>
- [ ] If this is non-trivial feature, paste the links/URLs to the design doc.
- [ ] Update the documentation to include this new feature.
- [ ] Tests(including UT, IT, E2E) are added to verify the new feature.
- [ ] If it's UI related, attach the screenshots below.
==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== -->
- [ ] If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #<issue number>.
- [ ] Update the [`CHANGES` log](https://github.com/apache/skywalking/blob/master/CHANGES.md).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng merged pull request #7649: Refine UI doc
Posted by GitBox <gi...@apache.org>.
wu-sheng merged pull request #7649:
URL: https://github.com/apache/skywalking/pull/7649
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wingwong-knh commented on a change in pull request #7649: Refine UI doc
Posted by GitBox <gi...@apache.org>.
wingwong-knh commented on a change in pull request #7649:
URL: https://github.com/apache/skywalking/pull/7649#discussion_r702249007
##########
File path: docs/en/ui/README.md
##########
@@ -81,73 +79,68 @@ templates:
disabled: false
```
-**NOTE**, UI initialized templates would only be initialized if there is no template in the storage has the same name.
-Check the entity named as `ui_template` in your storage.
+**NOTE**: UI initialized templates would only be initialized if no template in the storage has the same name.
+Check the entity named `ui_template` in your storage.
## Topology
-Topology map shows the relationship among the services and instances with metrics.
+A topology map shows the relationship between services and instances with metrics.
<img src="https://skywalking.apache.org/ui-doc/8.4.0/topology.png"/>
-* Topology shows the default global topology including all services.
-* **Service Selector** provides 2 level selectors, service group list and service name list. The group name is separated from
-the service name if it follows `<group name>::<logic name>` format. Topology map is available for single group, single service,
-or global(include all services).
-* **Custom Group** provides the any sub topology capability of service group.
-* **Service Deep Dive** opens when you click any service. The honeycomb could do metrics, trace and alarm query of the selected service.
-* **Service Relationship Metrics** gives the metrics of service RPC interactions and instances of these two services.
+Global topology is shown by default, which means that all services are included.
+* **Service Selector** provides two-level selectors, service group lists, and service name lists. The group name is separated from
+the service name if it follows the `<group name>::<logic name>` format. Topology maps are available for single group, single service,
+or global (where all services are included).
+* **Custom Group** allows you to create sub-topologies for a service group.
+* **Service Deep Dive** opens when you click on any service. The honeycomb could carry out metrics, trace, and alarm query of the selected service.
+* **Service Relationship Metrics** provides the metrics of service RPC interactions and the instances of these two services.
## Trace Query
-Trace query is a typical feature as SkyWalking provided distributed agents.
+Since SkyWalking provides distributed agents, trace query is a key feature.
<img src="https://skywalking.apache.org/ui-doc/7.0.0/trace.png"/>
-* **Trace Segment List** is not the trace list. Every trace has several segments belonging to different services. If
-query by all services or by trace id, different segments with same trace id could be list there.
-* **Span** is clickable, the detail of each span will pop up on the left side.
-* **Trace Views** provides 3 typical and different usage views to visualize the trace.
+* **Trace Segment List** is not the same as a trace list. Every trace has several segments belonging to different services. If you start a query by all services or by trace IDs, different segments with the same trace ID may be listed there.
+* **Span** can be clicked. The details of each span will pop up on the left.
+* **Trace Views** provides three typical and different usage views to visualize the trace.
## Profile
-Profile is an interaction feature. It provides the method level performance diagnosis.
+Profile is an interactive feature. It provides method-level performance diagnoses.
-To start the profile analysis, user need to create the profile task
+To start profile analysis, you need to create a profile task:
<img src="https://skywalking.apache.org/ui-doc/7.0.0/profile-create.png" width="440px"/>
1. Select the specific service.
-1. Set the endpoint name. This endpoint name typically is the operation name of the first span. Find this on the trace
+1. Set the Endpoint Name. This endpoint name is typically the operation name of the first span. Find this on the trace
segment list view.
-1. Monitor time could start right now or from any given future time.
-1. Monitor duration defines the observation time window to find the suitable request to do performance analysis.
-Even the profile add a very limited performance impact to the target system, but it is still an additional load. This duration
-make the impact controllable.
-1. Min duration threshold provides a filter mechanism, if a request of the given endpoint response quickly, it wouldn't be
-profiled. This could make sure, the profiled data is the expected one.
-1. Max sampling count gives the max dataset of agent will collect. It helps to reduce the memory and network load.
-1. One implicit condition, **in any moment, SkyWalking only accept one profile task for each service**.
-1. Agent could have different settings to control or limit this feature, read document setup for more details.
-1. Not all SkyWalking ecosystem agent supports this feature, java agent from 7.0.0 supports this in default.
-
-Once the profile done, the profiled trace segments would show up. And you could request for analysis for any span.
-Typically, we analysis spans having long self duration, if the span and its children both have long duration, you could choose
Review comment:
> `long self duration` is correct.
Thanks @wu-sheng, I reflected this in a new pull request.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng commented on a change in pull request #7649: Refine UI doc
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #7649:
URL: https://github.com/apache/skywalking/pull/7649#discussion_r702246131
##########
File path: docs/en/ui/README.md
##########
@@ -81,73 +79,68 @@ templates:
disabled: false
```
-**NOTE**, UI initialized templates would only be initialized if there is no template in the storage has the same name.
-Check the entity named as `ui_template` in your storage.
+**NOTE**: UI initialized templates would only be initialized if no template in the storage has the same name.
+Check the entity named `ui_template` in your storage.
## Topology
-Topology map shows the relationship among the services and instances with metrics.
+A topology map shows the relationship between services and instances with metrics.
<img src="https://skywalking.apache.org/ui-doc/8.4.0/topology.png"/>
-* Topology shows the default global topology including all services.
-* **Service Selector** provides 2 level selectors, service group list and service name list. The group name is separated from
-the service name if it follows `<group name>::<logic name>` format. Topology map is available for single group, single service,
-or global(include all services).
-* **Custom Group** provides the any sub topology capability of service group.
-* **Service Deep Dive** opens when you click any service. The honeycomb could do metrics, trace and alarm query of the selected service.
-* **Service Relationship Metrics** gives the metrics of service RPC interactions and instances of these two services.
+Global topology is shown by default, which means that all services are included.
+* **Service Selector** provides two-level selectors, service group lists, and service name lists. The group name is separated from
+the service name if it follows the `<group name>::<logic name>` format. Topology maps are available for single group, single service,
+or global (where all services are included).
+* **Custom Group** allows you to create sub-topologies for a service group.
+* **Service Deep Dive** opens when you click on any service. The honeycomb could carry out metrics, trace, and alarm query of the selected service.
+* **Service Relationship Metrics** provides the metrics of service RPC interactions and the instances of these two services.
## Trace Query
-Trace query is a typical feature as SkyWalking provided distributed agents.
+Since SkyWalking provides distributed agents, trace query is a key feature.
<img src="https://skywalking.apache.org/ui-doc/7.0.0/trace.png"/>
-* **Trace Segment List** is not the trace list. Every trace has several segments belonging to different services. If
-query by all services or by trace id, different segments with same trace id could be list there.
-* **Span** is clickable, the detail of each span will pop up on the left side.
-* **Trace Views** provides 3 typical and different usage views to visualize the trace.
+* **Trace Segment List** is not the same as a trace list. Every trace has several segments belonging to different services. If you start a query by all services or by trace IDs, different segments with the same trace ID may be listed there.
+* **Span** can be clicked. The details of each span will pop up on the left.
+* **Trace Views** provides three typical and different usage views to visualize the trace.
## Profile
-Profile is an interaction feature. It provides the method level performance diagnosis.
+Profile is an interactive feature. It provides method-level performance diagnoses.
-To start the profile analysis, user need to create the profile task
+To start profile analysis, you need to create a profile task:
<img src="https://skywalking.apache.org/ui-doc/7.0.0/profile-create.png" width="440px"/>
1. Select the specific service.
-1. Set the endpoint name. This endpoint name typically is the operation name of the first span. Find this on the trace
+1. Set the Endpoint Name. This endpoint name is typically the operation name of the first span. Find this on the trace
segment list view.
-1. Monitor time could start right now or from any given future time.
-1. Monitor duration defines the observation time window to find the suitable request to do performance analysis.
-Even the profile add a very limited performance impact to the target system, but it is still an additional load. This duration
-make the impact controllable.
-1. Min duration threshold provides a filter mechanism, if a request of the given endpoint response quickly, it wouldn't be
-profiled. This could make sure, the profiled data is the expected one.
-1. Max sampling count gives the max dataset of agent will collect. It helps to reduce the memory and network load.
-1. One implicit condition, **in any moment, SkyWalking only accept one profile task for each service**.
-1. Agent could have different settings to control or limit this feature, read document setup for more details.
-1. Not all SkyWalking ecosystem agent supports this feature, java agent from 7.0.0 supports this in default.
-
-Once the profile done, the profiled trace segments would show up. And you could request for analysis for any span.
-Typically, we analysis spans having long self duration, if the span and its children both have long duration, you could choose
Review comment:
`long self duration` is correct.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wingwong-knh commented on a change in pull request #7649: Refine UI doc
Posted by GitBox <gi...@apache.org>.
wingwong-knh commented on a change in pull request #7649:
URL: https://github.com/apache/skywalking/pull/7649#discussion_r702212560
##########
File path: docs/en/ui/README.md
##########
@@ -81,73 +79,68 @@ templates:
disabled: false
```
-**NOTE**, UI initialized templates would only be initialized if there is no template in the storage has the same name.
-Check the entity named as `ui_template` in your storage.
+**NOTE**: UI initialized templates would only be initialized if no template in the storage has the same name.
+Check the entity named `ui_template` in your storage.
## Topology
-Topology map shows the relationship among the services and instances with metrics.
+A topology map shows the relationship between services and instances with metrics.
<img src="https://skywalking.apache.org/ui-doc/8.4.0/topology.png"/>
-* Topology shows the default global topology including all services.
-* **Service Selector** provides 2 level selectors, service group list and service name list. The group name is separated from
-the service name if it follows `<group name>::<logic name>` format. Topology map is available for single group, single service,
-or global(include all services).
-* **Custom Group** provides the any sub topology capability of service group.
-* **Service Deep Dive** opens when you click any service. The honeycomb could do metrics, trace and alarm query of the selected service.
-* **Service Relationship Metrics** gives the metrics of service RPC interactions and instances of these two services.
+Global topology is shown by default, which means that all services are included.
+* **Service Selector** provides two-level selectors, service group lists, and service name lists. The group name is separated from
+the service name if it follows the `<group name>::<logic name>` format. Topology maps are available for single group, single service,
+or global (where all services are included).
+* **Custom Group** allows you to create sub-topologies for a service group.
+* **Service Deep Dive** opens when you click on any service. The honeycomb could carry out metrics, trace, and alarm query of the selected service.
+* **Service Relationship Metrics** provides the metrics of service RPC interactions and the instances of these two services.
## Trace Query
-Trace query is a typical feature as SkyWalking provided distributed agents.
+Since SkyWalking provides distributed agents, trace query is a key feature.
<img src="https://skywalking.apache.org/ui-doc/7.0.0/trace.png"/>
-* **Trace Segment List** is not the trace list. Every trace has several segments belonging to different services. If
-query by all services or by trace id, different segments with same trace id could be list there.
-* **Span** is clickable, the detail of each span will pop up on the left side.
-* **Trace Views** provides 3 typical and different usage views to visualize the trace.
+* **Trace Segment List** is not the same as a trace list. Every trace has several segments belonging to different services. If you start a query by all services or by trace IDs, different segments with the same trace ID may be listed there.
+* **Span** can be clicked. The details of each span will pop up on the left.
+* **Trace Views** provides three typical and different usage views to visualize the trace.
## Profile
-Profile is an interaction feature. It provides the method level performance diagnosis.
+Profile is an interactive feature. It provides method-level performance diagnoses.
-To start the profile analysis, user need to create the profile task
+To start profile analysis, you need to create a profile task:
<img src="https://skywalking.apache.org/ui-doc/7.0.0/profile-create.png" width="440px"/>
1. Select the specific service.
-1. Set the endpoint name. This endpoint name typically is the operation name of the first span. Find this on the trace
+1. Set the Endpoint Name. This endpoint name is typically the operation name of the first span. Find this on the trace
segment list view.
-1. Monitor time could start right now or from any given future time.
-1. Monitor duration defines the observation time window to find the suitable request to do performance analysis.
-Even the profile add a very limited performance impact to the target system, but it is still an additional load. This duration
-make the impact controllable.
-1. Min duration threshold provides a filter mechanism, if a request of the given endpoint response quickly, it wouldn't be
-profiled. This could make sure, the profiled data is the expected one.
-1. Max sampling count gives the max dataset of agent will collect. It helps to reduce the memory and network load.
-1. One implicit condition, **in any moment, SkyWalking only accept one profile task for each service**.
-1. Agent could have different settings to control or limit this feature, read document setup for more details.
-1. Not all SkyWalking ecosystem agent supports this feature, java agent from 7.0.0 supports this in default.
-
-Once the profile done, the profiled trace segments would show up. And you could request for analysis for any span.
-Typically, we analysis spans having long self duration, if the span and its children both have long duration, you could choose
Review comment:
Just checking if this term, **"long self duration"**, is correct? Or is it simply "long duration"?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org