skywalking

    名字

    服务端目前支持http和grpc两种协议,在apisix中目前只支持http协议

    如何启用

    首先,你需要在 config.yaml 里面启用 Skywalking 插件:

    然后重载 APISIX,这样会创建一个后台定时器,向 skywalking 服务器定期上报数据。

    下面是一个示例,在指定的 route 上开启了 skywalking 插件:

    1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    2. {
    3. "methods": ["GET"],
    4. "uris": [
    5. "/uid/*"
    6. ],
    7. "plugins": {
    8. "skywalking": {
    9. "sample_ratio": 1
    10. }
    11. },
    12. "upstream": {
    13. "type": "roundrobin",
    14. "nodes": {
    15. "10.110.149.175:8089": 1
    16. }
    17. }'

    你可以使用浏览器打开 dashboard:http://127.0.0.1:9080/apisix/dashboard/,通过 web 界面来完成上面的操作,先增加一个 route:

    plugin_skywalking

    我们可以通过指定 conf/config.yaml 中的配置来指定 endpoint:

    名称类型默认值描述
    service_namestring“APISIX”skywalking 上报的 service 名称
    service_instance_namestring“APISIX Instance Name”skywalking 上报的 service 实例名, 如果期望直接获取本机主机名则设置为 $hostname
    endpoint_addrstringSkywalking 的 HTTP endpoint 地址,例如:http://127.0.0.1:12800
    report_intervalinteger使用 skywalking 客户端内置的值上报时间间隔,单位是秒

    配置示例:

    1. plugin_attr:
    2. skywalking:
    3. service_name: APISIX
    4. service_instance_name: "APISIX Instance Name"

    测试插件

    例子

    1. 启动 Skywalking Server:

      • 默认使用 H2 存储,直接启动 skywalking 即可

        1. sudo docker run --name skywalking -d -p 1234:1234 -p 11800:11800 -p 12800:12800 --restart always apache/skywalking-oap-server:8.3.0-es6
    1. Skywalking 管理系统:

        1. sudo docker run --name skywalking-ui -d -p 8080:8080 --link skywalking:skywalking -e SW_OAP_ADDRESS=skywalking:12800 --restart always apache/skywalking-ui
    1. 2. 打开管理页面 在浏览器里面输入 [http://10.110.149.175:8080,出现了如下界面,则表示安装成功](http://10.110.149.175:8080%EF%BC%8C%E5%87%BA%E7%8E%B0%E4%BA%86%E5%A6%82%E4%B8%8B%E7%95%8C%E9%9D%A2%EF%BC%8C%E5%88%99%E8%A1%A8%E7%A4%BA%E5%AE%89%E8%A3%85%E6%88%90%E5%8A%9F)
    2. ![plugin_skywalking](/projects/apisix-2.9-zh/347a76397917befc98b64946aa87f74f.png)
    1. 测试示例:

      • 通过访问apisix,访问上游服务

        1. $ curl -v http://10.110.149.192:9080/uid/12
        2. HTTP/1.1 200 OK
        3. OK
        4. ...

    当你想去掉路由上的插件规则的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效:

    1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    2. {
    3. "methods": ["GET"],
    4. "uris": [
    5. "/uid/*"
    6. ],
    7. "plugins": {
    8. },
    9. "upstream": {
    10. "type": "roundrobin",
    11. "10.110.149.175:8089": 1
    12. }
    13. }
    14. }'

    现在就已经移除了 Skywalking 插件了。其他插件的开启和移除也是同样的方法。

    如果你想完全禁用 skywalking 插件,比如停掉后台上报数据的定时器,需要在 config.yaml 里把插件注释掉:

    1. plugins:
    2. #- skywalking

    然后重载 APISIX。

    上游服务是 java 的 SpringBoot 示例代码

    1. package com.lenovo.ai.controller;
    2. import org.springframework.web.bind.annotation.PathVariable;
    3. import org.springframework.web.bind.annotation.RequestMapping;
    4. import org.springframework.web.bind.annotation.RestController;
    5. import javax.servlet.http.HttpServletRequest;
    6. /**
    7. * @author cyxinda
    8. * @create 2020-05-29 14:02
    9. * @desc skywalking测试中央控制层
    10. **/
    11. @RestController
    12. public class TestController {
    13. @RequestMapping("/uid/{count}")
    14. public String getUidList(@PathVariable("count") String countStr, HttpServletRequest request) {
    15. System.out.println("counter:::::"+countStr);
    16. return "OK";
    17. }
    18. }

    启动服务脚本:

    1. nohup java -javaagent:/root/skywalking/app/agent/skywalking-agent.jar \
    2. -jar /root/skywalking/app/app.jar \
    3. --server.port=8089 \