You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/09/23 01:27:08 UTC
[GitHub] [apisix] spacewander commented on a change in pull request #5101: chore: clean up SkyWalking docs
spacewander commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r714413738
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -26,25 +26,27 @@ title: skywalking
- [**Name**](#name)
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
+- [**How to set endpoint**](#how-to-set-endpoint)
- [**Test Plugin**](#test-plugin)
- - [**Run Skywalking Example**](#run-skywalking-example)
+ - [**Running SkyWalking**](#running-skywalking)
Review comment:
Please use `Run` like other titles
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -26,25 +26,27 @@ title: skywalking
- [**Name**](#name)
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
+- [**How to set endpoint**](#how-to-set-endpoint)
- [**Test Plugin**](#test-plugin)
- - [**Run Skywalking Example**](#run-skywalking-example)
+ - [**Running SkyWalking**](#running-skywalking)
- [**Disable Plugin**](#disable-plugin)
- [**Upstream services(Code With SpringBoot)**](#Upstream-services(Code-With-SpringBoot))
## Name
-[**Skywalking**](https://github.com/apache/skywalking) uses its native Nginx LUA tracer to provide tracing, topology analysis, and metrics from service and URI perspective.
-The skywalking server can supports both http and grpc protocols. The APISIX client only support http protocols.
+[**SkyWalking**](https://github.com/apache/skywalking) uses its native Nginx LUA tracer to provide tracing, topology analysis, and metrics from service and URI perspective.
+
+The SkyWalking server can support both HTTP and gRPC protocols. Currently, the APISIX client only supports the HTTP protocol.
## Attributes
| Name | Type | Requirement | Default | Valid | Description |
| ------------ | ------ | ----------- | -------- | ------------ | -------------------------------------------------------------------- |
-| sample_ratio | number | required | 1 | [0.00001, 1] | the ratio of sample |
+| sample_ratio | number | required | 1 | [0.00001, 1] | The ratio of sampling |
Review comment:
Please use lowercase for the first word like other cells
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +80,20 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```
-You also can complete the above operation through the web interface, first add a route, then add skywalking plugin:
+You also can complete the above operation through the web interface, first add a route, then add SkyWalking plugin:
## How to set endpoint
-We can set the endpoint by specified the configuration in `conf/config.yaml`.
+We can set the endpoint by specifying the configuration in `conf/config.yaml`.
| Name | Type | Default | Description |
| ------------ | ------ | -------- | -------------------------------------------------------------------- |
-| service_name | string | "APISIX" | service name for skywalking reporter |
-| service_instance_name | string |"APISIX Instance Name" | service instance name for skywalking reporter， set it to `$hostname` to get local hostname directly.|
-| endpoint_addr | string | "http://127.0.0.1:12800" | the http endpoint of Skywalking, for example: http://127.0.0.1:12800 |
-| report_interval | integer | use the value in the skywalking client library | the report interval, in seconds |
+| service_name | string | "APISIX" | service name for SkyWalking reporter |
+| service_instance_name | string |"APISIX Instance Name" | service instance name for SkyWalking reporter， set it to `$hostname` to get local hostname directly.|
+| endpoint_addr | string | "http://127.0.0.1:12800" | the HTTP endpoint of SkyWalking, for example: http://127.0.0.1:12800 |
+| report_interval | integer | uses the value in the SkyWalking client library | the report interval, in seconds |
Review comment:
```suggestion
| report_interval | integer | use the value in the SkyWalking client library | the report interval, in seconds |
```
--
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@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org