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/15 02:23:41 UTC

[GitHub] [apisix] tzssangglass commented on a change in pull request #6302: docs: polishing zipkin and opentelemetery plugin's docs

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
 
 ![zipkin web-ui list view](../../../assets/images/plugin/zipkin-2.jpg)
 
+### 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
 
 ![zipkin web-ui list view](../../../assets/images/plugin/zipkin-2.jpg)
 
+### 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