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/19 01:25:13 UTC
[GitHub] [apisix] Superskyyy opened a new pull request #5101: Chore - Cleanup the SkyWalking doc
Superskyyy opened a new pull request #5101:
URL: https://github.com/apache/apisix/pull/5101
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
This PR cleans up and enhances en/zh documentation of the SkyWalking Plugin .
- Fixes grammar/vocab error
- Bumps up the SkyWalking version mentioned
### Pre-submission checklist:
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [x] Have you modified the corresponding document?
* [x] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713536879
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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
+## How to Set Endpoint
Review comment:
The level two `##` titles are not following a consistent capitalization style, some of them like `## How To Enable` are in caps while the others aren't, so I was trying to make them match. The same goes to the endpoint one below.
Just found out the `TO` is not supposed to be caped in any way, missed that one. But that seems to be wrong across lots of docs.
--
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
[GitHub] [apisix] spacewander merged pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #5101:
URL: https://github.com/apache/apisix/pull/5101
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713537131
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -1,5 +1,5 @@
---
-title: skywalking
+title: SkyWalking
Review comment:
Zipkin is capitalized and I was trying to keep consistent, I will revert this then.
--
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
[GitHub] [apisix] dmsolr commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
dmsolr commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-925083978
> That is a screenshot from the original plugin contributor right? I will need to deploy APISIX to make a new ss, let's merge this one first and I will do the logo fix when I got time. What you think. @dmsolr
Yes. This is good to me to update the screenshot.
--
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
[GitHub] [apisix] Superskyyy commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-925178191
Please review and merge this first, logo fix will be coming in another PR. @tokers Thanks.
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713536879
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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
+## How to Set Endpoint
Review comment:
The level two ## titles are not using a consistent capitalization, half of them are all caps while the others aren't, so I was trying to make them match. The same goes to the endpoint one below.
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713536879
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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
+## How to Set Endpoint
Review comment:
The level two `##` titles are not following a consistent capitalization style, some of them like `## How To Enable` are in caps while the others aren't, so I was trying to make them match. The same goes to the endpoint one below.
Also the `To` is not supposed to be caped in any way, missed that one. But that seems to exist across lots of plugin docs, so leaving it as is.
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r711770243
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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:
Review comment:
This following line exists widely in many APISIX docs - `You also can complete the above operation through the web interface`, should I change it for this one? Note that this also can, though sounds a bit odd, it is indeed a correct usage identical to can also.
FYI @tokers
--
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
[GitHub] [apisix] tokers commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r712842479
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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:
Review comment:
OK, I got it.
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r711770243
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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:
Review comment:
This following line exists widely in many APISIX docs - `You also can complete the above operation through the web interface`, should I change it for this one? Note that this `also can`, though sounds a bit odd, it is indeed a correct usage identical to `can also`.
FYI @tokers
--
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
[GitHub] [apisix] spacewander commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713539682
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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
+## How to Set Endpoint
Review comment:
@tzssangglass Would you kindly suggest that I simply revert the changes or make the other ones consistent with the `Cap lower` style?
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r714421605
##########
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:
My bad, fixed
--
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
[GitHub] [apisix] Superskyyy commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-927420433
Just a heads up SkyWalking 8.8.0 OAP is going to release very soon.
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713536879
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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
+## How to Set Endpoint
Review comment:
The level two `##` titles are not following a consistent capitalization style, some of them like `## How To Enable` are in caps while the others aren't, so I was trying to make them match. The same goes to the endpoint one below.
Well just found out the `TO` is not supposed to be caped in any way, missed that one.
--
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
[GitHub] [apisix] moonming commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
moonming commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-927425025
> Just a heads up SkyWalking 8.8.0 OAP is going to release very soon.
Is there anything need to modify for Apache APISIX?
--
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
[GitHub] [apisix] Superskyyy commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-927426325
> > Just a heads up SkyWalking 8.8.0 OAP is going to release very soon.
>
>
>
> Is there anything need to modify for Apache APISIX?
I'm not aware of that yet, I can help run a test when it's released.
--
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
[GitHub] [apisix] dmsolr commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
dmsolr commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-924671203
Hi, @Superskyyy I saw the picture of SkyWalking topology which is using Nginx logo as APISIX's logo.
It is out of date in SkyWalking 8.7.0. Could you update the picture?
--
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
[GitHub] [apisix] Superskyyy commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-924910084
> Hi, @Superskyyy I saw the picture of SkyWalking topology which is using Nginx logo as APISIX's logo.
> It is out of date in SkyWalking 8.7.0. Could you update the picture?
Sure! Will update later.
--
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
[GitHub] [apisix] tzssangglass commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713530885
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -27,24 +27,25 @@ title: skywalking
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- - [**Run Skywalking Example**](#run-skywalking-example)
+ - [**Run SkyWalking Example**](#running-skywalking)
Review comment:
text and links should keep same
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -1,5 +1,5 @@
---
-title: skywalking
+title: SkyWalking
Review comment:
No need for camel naming, keep it lowercase like the rest of the plugin documentation.
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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
+## How to Set Endpoint
Review comment:
why change `set endpoint` to `Set Endpoint`? This title looks strange.
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -206,7 +208,7 @@ plugins:
And then reload APISIX.
-## Upstream services(Code With SpringBoot)
+## Upstream Services(Code With SpringBoot)
Review comment:
ditto, this title looks strange.
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -27,24 +27,25 @@ title: skywalking
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- - [**Run Skywalking Example**](#run-skywalking-example)
+ - [**Run SkyWalking Example**](#running-skywalking)
Review comment:
```suggestion
- [**Running SkyWalking**](#running-skywalking)
```
--
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
[GitHub] [apisix] tokers commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r711702429
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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:
Review comment:
You also can => You can also
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r711770243
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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:
Review comment:
This following line exists widely in many APISIX docs - You also can complete the above operation through the web interface, should I change it for this one? Note that this also can, though sounds a bit odd, it is indeed a correct usage identical to can also.
FYI @tokers
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713543613
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -206,7 +208,7 @@ plugins:
And then reload APISIX.
-## Upstream services(Code With SpringBoot)
+## Upstream Services(Code With SpringBoot)
Review comment:
Reverted.
--
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
[GitHub] [apisix] moonming commented on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
moonming commented on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-927432269
> > > Just a heads up SkyWalking 8.8.0 OAP is going to release very soon.
> >
> >
> > Is there anything need to modify for Apache APISIX?
>
> I'm not aware of that yet, I can help run a test when it's released.
Great！
--
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
[GitHub] [apisix] Superskyyy edited a comment on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy edited a comment on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-924910084
> Hi, @Superskyyy I saw the picture of SkyWalking topology which is using Nginx logo as APISIX's logo.
> It is out of date in SkyWalking 8.7.0. Could you update the picture?
That is a screenshot from the original plugin contributor right? I will need to deploy APISIX to make a new ss, let's merge this one first and I will do the logo fix when I got time. What you think. @dmsolr
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713537014
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -27,24 +27,25 @@ title: skywalking
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- - [**Run Skywalking Example**](#run-skywalking-example)
+ - [**Run SkyWalking Example**](#running-skywalking)
Review comment:
My bad, missed this one.
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r713539682
##########
File path: docs/en/latest/plugins/skywalking.md
##########
@@ -78,20 +79,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
+## How to Set Endpoint
Review comment:
@tzssangglass I have reverted the title changes.
--
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
[GitHub] [apisix] Superskyyy edited a comment on pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy edited a comment on pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#issuecomment-924910084
> Hi, @Superskyyy I saw the picture of SkyWalking topology which is using Nginx logo as APISIX's logo.
> It is out of date in SkyWalking 8.7.0. Could you update the picture?
Sure! Will update later. @dmsolr
--
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
[GitHub] [apisix] Superskyyy commented on a change in pull request #5101: chore: clean up SkyWalking docs
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on a change in pull request #5101:
URL: https://github.com/apache/apisix/pull/5101#discussion_r714422930
##########
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:
Ok, fixed
--
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