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 2022/02/11 11:13:02 UTC
[GitHub] [apisix] dmsolr opened a new pull request #6302: docs: polishing zipkin and opentelemetery plugin's docs
dmsolr opened a new pull request #6302:
URL: https://github.com/apache/apisix/pull/6302
### 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. -->
### Pre-submission checklist:
<!--
Please follow the PR manners:
1. Use Draft if the PR is not ready to be reviewed
2. Test is required for the feat/fix PR, unless you have a good reason
3. Doc is required for the feat PR
4. Use a new commit to resolve review instead of `push -f`
5. If you need to resolve merge conflicts after the PR is reviewed, please merge master but do not rebase
6. Use "request review" to notify the reviewer once you have resolved the review
7. Only reviewer can click "Resolve conversation" to mark the reviewer's review resolved
-->
* [ ] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [ ] Have you modified the corresponding document?
* [ ] 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] spacewander merged pull request #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #6302:
URL: https://github.com/apache/apisix/pull/6302
--
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 #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6302:
URL: https://github.com/apache/apisix/pull/6302#discussion_r805533237
##########
File path: docs/zh/latest/plugins/zipkin.md
##########
@@ -125,6 +125,61 @@ http://127.0.0.1:9411/zipkin
+### Run the Jaeger instance
+
+除了对接 Zipkin，该插件也支持将 traces 上报到 Jaeger。下面运行在`docker`环境上的示例：
Review comment:
```suggestion
除了对接 Zipkin，该插件也支持将 traces 上报到 Jaeger。下面运行在 docker 环境上的示例：
```
##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -126,6 +127,61 @@ http://127.0.0.1:9411/zipkin
+### Run the Jaeger instance
+
+Besides Zipkin, this plugin supports reporting the traces to Jaeger as well. Here is a sample run on docker.
+Run Jaeger backend on docker first:
+
+```
+docker run -d --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ -p 16686:16686 \
+ -p 9411:9411 \
+ jaegertracing/all-in-one:1.31
+```
+
+Create a route with Zipkin plugin like Ziplin's example:
Review comment:
```suggestion
Create a route with Zipkin plugin like Zipkin's example:
```
--
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] starsz commented on pull request #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
starsz commented on pull request #6302:
URL: https://github.com/apache/apisix/pull/6302#issuecomment-1037230913
@dmsolr Need to fix CI.
--
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] starsz commented on a change in pull request #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
starsz commented on a change in pull request #6302:
URL: https://github.com/apache/apisix/pull/6302#discussion_r805457424
##########
File path: docs/zh/latest/plugins/zipkin.md
##########
@@ -31,9 +31,9 @@ title: zipkin
## 名字
-`zipkin`(https://github.com/openzipkin/zipkin) 是一个开源的服务跟踪插件。
+[Zipkin](https://github.com/openzipkin/zipkin)是开源的分布调用链追踪系统。该插件基于[Zipkin API规范](https://zipkin.io/pages/instrumenting.html)，支持收集跟踪信息，并上报 Zipkin Collector。
Review comment:
```suggestion
[Zipkin](https://github.com/openzipkin/zipkin) 是开源的分布调用链追踪系统。该插件基于[Zipkin API规范](https://zipkin.io/pages/instrumenting.html)，支持收集跟踪信息，并上报 Zipkin Collector。
```
##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -27,14 +27,15 @@ title: Zipkin
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- - [run the Zipkin instance](#run-the-zipkin-instance)
+ - [Run the Zipkin instance](#run-the-zipkin-instance)
+ - [Run the Jaeger instance](#run-the-jaeger-instance)
- [**Disable Plugin**](#disable-plugin)
## Name
-[Zipkin](https://github.com/openzipkin/zipkin) is a OpenTracing plugin.
+[Zipkin](https://github.com/openzipkin/zipkin) an open source distributed tracing system. This plugin is supported to collect tracing and report to Zipkin Collector based on [Zipkin API specification](https://zipkin.io/pages/instrumenting.html).
-It's also works with `Apache SkyWalking`, which is support Zipkin v1/v2 format.
+It's also works with [Apache SkyWalking](https://skywalking.apache.org/docs/main/latest/en/setup/backend/zipkin-trace/#zipkin-receiver) and [Jaeger](https://www.jaegertracing.io/docs/1.31/getting-started/#migrating-from-zipkin), which are support Zipkin [v1](https://zipkin.io/zipkin-api/zipkin-api.yaml)/[v2](https://zipkin.io/zipkin-api/zipkin2-api.yaml) format. And of course, it can integrate other tracing systems adapted to Zipkin v1/v2 format as well.
Review comment:
```suggestion
It's also works with [Apache SkyWalking](https://skywalking.apache.org/docs/main/latest/en/setup/backend/zipkin-trace/#zipkin-receiver) and [Jaeger](https://www.jaegertracing.io/docs/1.31/getting-started/#migrating-from-zipkin), which are support Zipkin [v1](https://zipkin.io/zipkin-api/zipkin-api.yaml)/[v2](https://zipkin.io/zipkin-api/zipkin2-api.yaml) format. And of course, it can integrate other tracing systems adapted to Zipkin v1/v2 format as well.
```
--
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 #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on a change in pull request #6302:
URL: https://github.com/apache/apisix/pull/6302#discussion_r806394128
##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -126,6 +127,61 @@ http://127.0.0.1:9411/zipkin
+### Run the Jaeger instance
+
+Besides Zipkin, this plugin supports reporting the traces to Jaeger as well. Here is a sample run on docker.
+Run Jaeger backend on docker first:
+
+```
+docker run -d --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ -p 16686:16686 \
+ -p 9411:9411 \
+ jaegertracing/all-in-one:1.31
+```
+
+Create a route with Zipkin plugin like Zipkin's example:
+
+```
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "methods": ["GET"],
+ "uri": "/index.html",
+ "plugins": {
+ "zipkin": {
+ "endpoint": "http://127.0.0.1:9411/api/v2/spans",
+ "sample_ratio": 1,
+ "service_name": "APISIX-IN-SG",
+ "server_addr": "192.168.3.50"
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ }
+}'
+```
+
+Access the service:
+
+```shell
+$ curl http://127.0.0.1:9080/index.html
+HTTP/1.1 200 OK
+...
+```
+
+Then you can access the WebUI of Jaeger to view traceson browser:
+
+```
+http://127.0.0.1:16686
+```
Review comment:
```suggestion
Then you can access the WebUI of Jaeger(http://127.0.0.1:16686) to view traceson browser.
```
##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -126,6 +127,61 @@ http://127.0.0.1:9411/zipkin
+### Run the Jaeger instance
+
+Besides Zipkin, this plugin supports reporting the traces to Jaeger as well. Here is a sample run on docker.
+Run Jaeger backend on docker first:
+
+```
+docker run -d --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ -p 16686:16686 \
+ -p 9411:9411 \
+ jaegertracing/all-in-one:1.31
+```
+
+Create a route with Zipkin plugin like Zipkin's example:
+
+```
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "methods": ["GET"],
+ "uri": "/index.html",
+ "plugins": {
+ "zipkin": {
+ "endpoint": "http://127.0.0.1:9411/api/v2/spans",
+ "sample_ratio": 1,
+ "service_name": "APISIX-IN-SG",
+ "server_addr": "192.168.3.50"
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ }
+}'
+```
+
+Access the service:
+
+```shell
+$ curl http://127.0.0.1:9080/index.html
+HTTP/1.1 200 OK
+...
+```
+
+Then you can access the WebUI of Jaeger to view traceson browser:
+
+```
+http://127.0.0.1:16686
Review comment:
with `$` or not, It is best to maintain uniformity in the same document.
--
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] starsz commented on pull request #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
starsz commented on pull request #6302:
URL: https://github.com/apache/apisix/pull/6302#issuecomment-1037230913
@dmsolr Need to fix CI.
--
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] starsz commented on a change in pull request #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
starsz commented on a change in pull request #6302:
URL: https://github.com/apache/apisix/pull/6302#discussion_r805457424
##########
File path: docs/zh/latest/plugins/zipkin.md
##########
@@ -31,9 +31,9 @@ title: zipkin
## 名字
-`zipkin`(https://github.com/openzipkin/zipkin) 是一个开源的服务跟踪插件。
+[Zipkin](https://github.com/openzipkin/zipkin)是开源的分布调用链追踪系统。该插件基于[Zipkin API规范](https://zipkin.io/pages/instrumenting.html)，支持收集跟踪信息，并上报 Zipkin Collector。
Review comment:
```suggestion
[Zipkin](https://github.com/openzipkin/zipkin) 是开源的分布调用链追踪系统。该插件基于[Zipkin API规范](https://zipkin.io/pages/instrumenting.html)，支持收集跟踪信息，并上报 Zipkin Collector。
```
##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -27,14 +27,15 @@ title: Zipkin
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- - [run the Zipkin instance](#run-the-zipkin-instance)
+ - [Run the Zipkin instance](#run-the-zipkin-instance)
+ - [Run the Jaeger instance](#run-the-jaeger-instance)
- [**Disable Plugin**](#disable-plugin)
## Name
-[Zipkin](https://github.com/openzipkin/zipkin) is a OpenTracing plugin.
+[Zipkin](https://github.com/openzipkin/zipkin) an open source distributed tracing system. This plugin is supported to collect tracing and report to Zipkin Collector based on [Zipkin API specification](https://zipkin.io/pages/instrumenting.html).
-It's also works with `Apache SkyWalking`, which is support Zipkin v1/v2 format.
+It's also works with [Apache SkyWalking](https://skywalking.apache.org/docs/main/latest/en/setup/backend/zipkin-trace/#zipkin-receiver) and [Jaeger](https://www.jaegertracing.io/docs/1.31/getting-started/#migrating-from-zipkin), which are support Zipkin [v1](https://zipkin.io/zipkin-api/zipkin-api.yaml)/[v2](https://zipkin.io/zipkin-api/zipkin2-api.yaml) format. And of course, it can integrate other tracing systems adapted to Zipkin v1/v2 format as well.
Review comment:
```suggestion
It's also works with [Apache SkyWalking](https://skywalking.apache.org/docs/main/latest/en/setup/backend/zipkin-trace/#zipkin-receiver) and [Jaeger](https://www.jaegertracing.io/docs/1.31/getting-started/#migrating-from-zipkin), which are support Zipkin [v1](https://zipkin.io/zipkin-api/zipkin-api.yaml)/[v2](https://zipkin.io/zipkin-api/zipkin2-api.yaml) format. And of course, it can integrate other tracing systems adapted to Zipkin v1/v2 format as well.
```
--
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 #6302: docs: polishing zipkin and opentelemetery plugin's docs
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on a change in pull request #6302:
URL: https://github.com/apache/apisix/pull/6302#discussion_r806394128
##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -126,6 +127,61 @@ http://127.0.0.1:9411/zipkin
+### Run the Jaeger instance
+
+Besides Zipkin, this plugin supports reporting the traces to Jaeger as well. Here is a sample run on docker.
+Run Jaeger backend on docker first:
+
+```
+docker run -d --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ -p 16686:16686 \
+ -p 9411:9411 \
+ jaegertracing/all-in-one:1.31
+```
+
+Create a route with Zipkin plugin like Zipkin's example:
+
+```
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "methods": ["GET"],
+ "uri": "/index.html",
+ "plugins": {
+ "zipkin": {
+ "endpoint": "http://127.0.0.1:9411/api/v2/spans",
+ "sample_ratio": 1,
+ "service_name": "APISIX-IN-SG",
+ "server_addr": "192.168.3.50"
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ }
+}'
+```
+
+Access the service:
+
+```shell
+$ curl http://127.0.0.1:9080/index.html
+HTTP/1.1 200 OK
+...
+```
+
+Then you can access the WebUI of Jaeger to view traceson browser:
+
+```
+http://127.0.0.1:16686
+```
Review comment:
```suggestion
Then you can access the WebUI of Jaeger(http://127.0.0.1:16686) to view traceson browser.
```
##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -126,6 +127,61 @@ http://127.0.0.1:9411/zipkin
+### Run the Jaeger instance
+
+Besides Zipkin, this plugin supports reporting the traces to Jaeger as well. Here is a sample run on docker.
+Run Jaeger backend on docker first:
+
+```
+docker run -d --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ -p 16686:16686 \
+ -p 9411:9411 \
+ jaegertracing/all-in-one:1.31
+```
+
+Create a route with Zipkin plugin like Zipkin's example:
+
+```
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "methods": ["GET"],
+ "uri": "/index.html",
+ "plugins": {
+ "zipkin": {
+ "endpoint": "http://127.0.0.1:9411/api/v2/spans",
+ "sample_ratio": 1,
+ "service_name": "APISIX-IN-SG",
+ "server_addr": "192.168.3.50"
+ }
+ },
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:1980": 1
+ }
+ }
+}'
+```
+
+Access the service:
+
+```shell
+$ curl http://127.0.0.1:9080/index.html
+HTTP/1.1 200 OK
+...
+```
+
+Then you can access the WebUI of Jaeger to view traceson browser:
+
+```
+http://127.0.0.1:16686
Review comment:
with `$` or not, It is best to maintain uniformity in the same document.
--
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