Skywalking(https://github.com/apache/skywalking) is an OpenTracing plugin.
The skywalking server can supports both http and grpc protocols . The APISIX client only support http protocols.
Name | Requirement | Description |
---|---|---|
endpoint | required | the http endpoint of Skywalking ,for example: http://127.0.0.1:12800 |
sample_ratio | required | the ratio of sample, the minimum is 0.00001, the maximum is 1 |
service_name | optional | service name for skywalking reporter, the default values is APISIX |
Here's an example, enable the skywalking plugin on the specified route:
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "methods": ["GET"], "uris": [ "/uid/*" ], "plugins": { "skywalking": { "endpoint": "http://10.110.149.175:12800", "sample_ratio": 1, "service_name": "APISIX_SERVER" } }, "upstream": { "type": "roundrobin", "nodes": { "10.110.149.175:8089": 1 } } }'
You can open dashboard with a browser:http://127.0.0.1:9080/apisix/dashboard/
,to complete the above operation through the web interface, first add a route:
Then add skywalking plugin:
Run Skywalking Server:
By default,use H2 storage , start skywalking directly
sudo docker run --name skywalking -d -p 1234:1234 -p 11800:11800 -p 12800:12800 --restart always apache/skywalking-oap-server
Of Course,you can use elasticsearch storage
sudo docker run -d --name elasticsearch -p 9200:9200 -p 9300:9300 --restart always -e "discovery.type=single-node" elasticsearch:6.7.2
sudo docker run -d --name elastic-hq -p 5000:5000 --restart always elastichq/elasticsearch-hq
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
Skywalking WebUI:
sudo docker run --name skywalking-ui -d -p 8080:8080 --link skywalking:skywalking -e SW_OAP_ADDRESS=skywalking:12800 --restart always apache/skywalking-ui
Test:
$ curl -v http://10.110.149.192:9080/uid/12 HTTP/1.1 200 OK OK ...
http://10.110.149.175:8080/You can see the topology of all service
When you want to disable the skyWalking plugin, it is very simple, you can delete the corresponding json configuration in the plugin configuration, no need to restart the service, it will take effect immediately:
$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uris": [ "/uid/*" ], "plugins": { }, "upstream": { "type": "roundrobin", "nodes": { "10.110.149.175:8089": 1 } } }'
The skywalking plugin has been disabled now. It works for other plugins.
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"; } }
Configuring the skywalking agent, when starting the service. update the file of agent/config/agent.config
agent.service_name=yourservername collector.backend_service=10.110.149.175:11800
Run the script:
nohup java -javaagent:/root/skywalking/app/agent/skywalking-agent.jar \ -jar /root/skywalking/app/app.jar \ --server.port=8089 \ 2>&1 > /root/skywalking/app/logs/nohup.log &