Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: polishing zipkin and opentelemetery plugin's docs #6302

Merged
merged 8 commits into from
Feb 16, 2022
Merged

docs: polishing zipkin and opentelemetery plugin's docs #6302

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
af28102
docs: polishing zipkin and opentelemetery plugin's docs
dmsolr Feb 11, 2022
4bc69fc
fix markdownlint
dmsolr Feb 13, 2022
2c385ae
Apply suggestions from code review
dmsolr Feb 14, 2022
b7af09d
fix
dmsolr Feb 14, 2022
c516a07
Apply suggestions from code review
dmsolr Feb 14, 2022
575531d
remove `$`
dmsolr Feb 15, 2022
1300386
Merge branch 'docs/polising' of https://github.com/dmsolr/apisix into…
dmsolr Feb 15, 2022
337ec19
polishing zh docs
dmsolr Feb 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove $
  • Loading branch information
@dmsolr
dmsolr committed Feb 15, 2022
commit 575531d5626af312c120f3f0bf901928e0e042be
12 changes: 2 additions & 10 deletions docs/en/latest/plugins/skywalking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ plugin_attr:
- By default, SkyWalking uses H2 storage, start SkyWalking directly by

```shell
sudo docker run --name skywalking -d -p 1234:1234 -p 11800:11800 -p 12800:12800 --restart always apache/skywalking-oap-server:8.7.0-es6
sudo docker run --name skywalking -d -p 1234:1234 -p 12800:12800 --restart always apache/skywalking-oap-server:8.7.0-es6
```

- Of Course, you may want to use Elasticsearch storage instead
Expand All @@ -133,7 +133,7 @@ plugin_attr:
3. Finally, run SkyWalking OAP server:

```shell
sudo docker run --name skywalking -d -p 1234:1234 -p 11800:11800 -p 12800:12800 --restart always --link elasticsearch:elasticsearch -e SW_STORAGE=elasticsearch -e SW_STORAGE_ES_CLUSTER_NODES=elasticsearch:9200 apache/skywalking-oap-server:8.7.0-es6
sudo docker run --name skywalking -d -p 1234:1234 -p 12800:12800 --restart always --link elasticsearch:elasticsearch -e SW_STORAGE=elasticsearch -e SW_STORAGE_ES_CLUSTER_NODES=elasticsearch:9200 apache/skywalking-oap-server:8.7.0-es6
```

2. SkyWalking Web UI:
Expand Down Expand Up @@ -210,23 +210,15 @@ And then reload APISIX.
## Upstream services(Code With SpringBoot)

```java
package com.lenovo.ai.controller;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;

/**
* @author cyxinda
* @create 2020-05-29 14:02
* @desc skywalking test controller
**/
@RestController
public class TestController {
@RequestMapping("/uid/{count}")
public String getUidList(@PathVariable("count") String countStr, HttpServletRequest request) {
System.out.println("counter:::::-----"+countStr);
return "OK";
}
}
Expand Down
18 changes: 5 additions & 13 deletions docs/en/latest/plugins/zipkin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,12 @@ docker run -d -p 9411:9411 openzipkin/zipkin
Here is a test example:

```shell
$ curl http://127.0.0.1:9080/index.html
curl http://127.0.0.1:9080/index.html
HTTP/1.1 200 OK
...
```

Then you can use a browser to access the webUI of Zipkin:

```
http://127.0.0.1:9411/zipkin
```
Then you can use a browser to access `http://127.0.0.1:9411/zipkin`, the webUI of Zipkin:

![zipkin web-ui](../../../assets/images/plugin/zipkin-1.jpg)

Expand Down Expand Up @@ -167,16 +163,12 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
Access the service:

```shell
$ curl http://127.0.0.1:9080/index.html
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
```
Then you can access `http://127.0.0.1:16686`, the WebUI of Jaeger, to view traceson browser:

![jaeger web-ui](../../../assets/images/plugin/jaeger-1.png)

Expand All @@ -189,7 +181,7 @@ When you want to disable the zipkin plugin, it is very simple,
no need to restart the service, it will take effect immediately:

```shell
$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/index.html",
Expand Down