Skip to content

apache/skywalking-kong

Apache SkyWalking Kong Agent

Sky Walking logo

Twitter Follow

CI AND IT

SkyWalking Kong agent built on SkyWalking Nginx Lua agent to trace Kong API gateway for Apache SkyWalking APM.

Usage

Kong 2.2+ required.

  1. Install the plugin in Kong:

Install kong-plugin-skywalking using luarocks:

$ luarocks install kong-skywalking --local

Edit kong.conf:

plugins = bundled,skywalking

lua_package_path = ${user.home}/.luarocks/share/lua/5.1/?.lua;;

Set environment:

$ export KONG_NGINX_HTTP_LUA_SHARED_DICT="tracing_buffer 128m"

Restart Kong

  1. Enabling & configuring plugin:

Add the plugin to global:

$ curl -X POST --url http://localhost:8001/plugins/ \
   --data 'name=skywalking' \
   --data 'config.backend_http_uri=http://localhost:12800' \
   --data 'config.sample_ratio=100' \
   --data 'config.service_name=kong' \
   --data 'config.service_instance_name=kong-with-skywalking'

Contact Us

Release Guide

All committers should follow Release Guide to publish the official release.

License

Apache 2.0