Apache SkyWalking Kong Agent 安装与使用指南

Apache SkyWalking Kong Agent 安装与使用指南

skywalking-kongKong agent for Apache SkyWalking项目地址:https://gitcode.com/gh_mirrors/sk/skywalking-kong

目录结构及介绍

在克隆或下载了 apache/skywalking-kong 仓库之后，你会看到以下主要文件和目录：

• kong/plugins/skywalking: 此目录包含了用于Kong API Gateway的SkyWalking插件源代码。
• rockspec: 包含LuaRocks包的元数据，用于安装Kong-Skywalking插件。
• test/e2e: 端到端测试脚本和数据，用于验证插件功能是否正常工作。

此外，还有一些辅助文件如:

• .asf.yaml: ASF元数据配置文件。
• .gitignore: 版本控制系统忽略规则文件。
• .licenserc: 许可证检查配置文件。
• .luacheckrc: Lua语法检查工具配置文件。
• LICENSE: 开源许可证文本。
• NOTICE: 法律声明文件。
• README.md: 项目的简介和快速入门指南。
• Makefile: 自动化构建任务脚本。

启动文件介绍

尽管没有专门的“启动”文件提及，但将SkyWalking插件添加到你的Kong实例中时，你可以通过以下步骤进行操作：

安装 SkyWalking 插件至 Kong

使用LuRocks

$ luarocks install kong-plugin-skywalking

这将把插件安装进你的Kong环境。

在Kong中启用并配置插件

编辑Kong配置文件，确保以下参数正确设置：

plugins = bundled,symbol,skywalking
lua_package_path = /home/[username]/luarocks/share/lua/5.1/

还需设置环境变量以增加共享内存大小：

export KONG_NGINX_HTTP_LUA_SHARED_DICT="tracing_buffer 128m"

重新启动Kong服务后，在Kong管理API上向全局添加该插件：

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

替换上述命令中的 http://your.skywalking.server:12800 和 kong-with-skywalking 参数以匹配你的实际设置。

完成以上步骤即可启动并激活SkyWalking监控Kong API网关的能力。

配置文件介绍

对于Kong的配置，主要是修改 /etc/kong/kong.conf 或者根据自己的部署位置找到相应的配置文件来加入插件相关的选项。

在Kong的配置文件（通常是/etc/kong/kong.conf）中，你需要做的是：

1. 将 skywalking 添加到 plugins 列表中；
2. 设置 Lua 包路径以加载 SkyWalking 的库；
3. 可选地，调整Nginx的共享内存大小配置，以便更好地支持追踪数据收集。

具体而言，在配置文件中可以有类似以下的内容：

plugins = ...
            ...
            skywalking

lua_package_path = ...
                    ...
                    /path/to/your/lua/rocks/

...

请注意，这些配置项的位置应当适合你的部署环境和Kong的具体版本要求。此外，确保在更新任何配置之后重启Kong服务使更改生效。

skywalking-kongKong agent for Apache SkyWalking项目地址:https://gitcode.com/gh_mirrors/sk/skywalking-kong