Skip to main content
Version: 2.13



SkyWalking uses its native Nginx LUA tracer to provide tracing, topology analysis, and metrics from service and URI perspective.

The SkyWalking server can support both HTTP and gRPC protocols. Currently, the APISIX client only supports the HTTP protocol.


sample_rationumberrequired1[0.00001, 1]the ratio of sampling

How To Enable#

First of all, enable the SkyWalking plugin in the config.yaml:

# Add this in config.yaml
- ... # plugin you need
- skywalking

Then reload APISIX, a background timer will be created to report data to the SkyWalking OAP server.

Here's an example, enable the SkyWalking plugin on the specified route:

curl  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"methods": ["GET"],
"uris": [
"plugins": {
"skywalking": {
"sample_ratio": 1
"upstream": {
"type": "roundrobin",
"nodes": {
"": 1

You also can complete the above operation through the web interface, first add a route, then add SkyWalking plugin:

How to set endpoint#

We can set the endpoint by specifying the configuration in conf/config.yaml.

service_namestring"APISIX"service name for SkyWalking reporter
service_instance_namestring"APISIX Instance Name"service instance name for SkyWalking reporter, set it to $hostname to get local hostname directly.
endpoint_addrstring""the HTTP endpoint of SkyWalking, for example:
report_intervalintegeruse the value in the SkyWalking client librarythe report interval, in seconds

Here is an example:

service_name: APISIX
service_instance_name: "APISIX Instance Name"

Test Plugin#

Run SkyWalking Example#

  1. Start the SkyWalking OAP Server:

    • By default, SkyWalking uses H2 storage, start SkyWalking directly by

      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

      1. First, you should install Elasticsearch:

        sudo docker run -d --name elasticsearch -p 9200:9200 -p 9300:9300 --restart always -e "discovery.type=single-node" elasticsearch:6.7.2
      2. Optionally, you can install ElasticSearch management page: elasticsearch-hq

        sudo docker run -d --name elastic-hq -p 5000:5000 --restart always elastichq/elasticsearch-hq
      3. Finally, run SkyWalking OAP server:

        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:

    1. Run SkyWalking web UI Server:

      sudo docker run --name skywalking-ui -d -p 8080:8080 --link skywalking:skywalking -e SW_OAP_ADDRESS=skywalking:12800 --restart always apache/skywalking-ui
    2. Access the web UI of SkyWalking: You can access the dashboard from a browser: It will show the following if the installation is successful.

  3. Test:

    • Access to upstream services through accessing APISIX:

      $ curl -v
      HTTP/1.1 200 OK
    • Open the web UI of SkyWalking:

      You can see the topology of all services\

      \ You can also see the traces from all services\

Disable Plugin#

When you want to disable the SkyWalking plugin on a route/service, 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  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"methods": ["GET"],
"uris": [
"plugins": {
"upstream": {
"type": "roundrobin",
"nodes": {
"": 1

The SkyWalking plugin has been disabled now. The step works in the same fashion for other plugins.

If you want to completely disable the SkyWalking plugin, for example, stopping the background report timer, you will need to comment out the plugin in the config.yaml:

- ... # plugin you need
#- skywalking

And then reload APISIX.

Upstream services(Code With SpringBoot)#

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;

public class TestController {
public String getUidList(@PathVariable("count") String countStr, HttpServletRequest request) {
return "OK";

Configure the SkyWalking agent when starting the service.

Update the file of agent/config/agent.config


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 &