Apache SkyWalking Kong Agent 项目下载及安装教程

1. 项目介绍

Apache SkyWalking Kong Agent 是一个基于 Apache SkyWalking Nginx Lua Agent 开发的 Kong API 网关追踪代理。它可以帮助用户在 Apache SkyWalking APM（应用性能监控）系统中追踪 Kong API 网关的请求和响应，从而实现对整个分布式系统的监控和分析。

2. 项目下载位置

本项目托管在 GitHub 上，您可以通过以下地址获取项目源代码：

https://github.com/apache/skywalking-kong.git

3. 项目安装环境配置

在安装项目之前，您需要确保系统已安装以下环境：

• Kong 2.2+ 版本
• LuaRocks
• Apache SkyWalking

以下是环境配置的步骤和示例图片：

安装 Kong

首先，您需要从 Kong 官方网站下载并安装 Kong。具体安装步骤请参考 Kong 官方文档。

安装 LuaRocks

LuaRocks 是 Lua 的包管理器，用于安装 Kong 插件。您可以从 LuaRocks 官方网站下载并安装。

wget http://luarocks.org/releases/luarocks-3.3.1.tar.gz
tar zxpf luarocks-3.3.1.tar.gz
cd luarocks-3.3.1
./configure; make; make install

安装 Apache SkyWalking

您可以从 Apache SkyWalking 官方网站下载并安装 Apache SkyWalking。

wget https://www.apache.org/dyn/closer.cgi?path=/skywalking/8.0.0-alpha1/apache-skywalking-apm-es7-8.0.0-alpha1.tgz
tar -xzf apache-skywalking-apm-es7-8.0.0-alpha1.tgz
cd apache-skywalking-apm-es7-8.0.0-alpha1
bin/startup.sh

4. 项目安装方式

以下是安装 Apache SkyWalking Kong Agent 的步骤：

1. 克隆项目到本地：

git clone https://github.com/apache/skywalking-kong.git
cd skywalking-kong

2. 使用 LuaRocks 安装 Kong 插件：

luarocks install kong-skywalking --local

3. 修改 Kong 配置文件 kong.conf，添加以下内容：

plugins = bundled,skywalking
lua_package_path = $(user_home)/luarocks/share/lua/5.1/?.lua;$(user_home)/luarocks/share/lua/5.1/?/init.lua;;.

4. 设置环境变量：

export KONG_NGINX_HTTP_LUA_SHARED_DICT="tracing_buffer 128m"

5. 重启 Kong 服务。

6. 启用并配置插件：

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'

5. 项目处理脚本

项目处理脚本主要包括 Kong 插件的安装和配置脚本。以下是示例：

# 安装 Kong 插件
luarocks install kong-skywalking --local

# 配置 Kong
echo "plugins = bundled,skywalking" >> kong.conf
echo "lua_package_path = $(user_home)/luarocks/share/lua/5.1/?.lua;$(user_home)/luarocks/share/lua/5.1/?/init.lua;;." >> kong.conf

# 设置环境变量
export KONG_NGINX_HTTP_LUA_SHARED_DICT="tracing_buffer 128m"

# 重启 Kong 服务（此命令需根据实际情况调整）
systemctl restart kong

# 启用并配置插件
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'