Apache SkyWalking Kong 插件使用教程

Apache SkyWalking Kong 插件使用教程

skywalking-kongApache SkyWalking Kong: 这是一个用于监控 Apache SkyWalking 的插件，基于 Kong 插件框架。Apache SkyWalking 是一个开源的分布式系统监控和诊断工具，用于收集和分析系统的性能指标和日志数据。这个插件可以帮助开发者将 SkyWalking 集成到 Kong 网关中，从而实现流量监控和故障排查。这个插件适合所有使用 Apache SkyWalking 和 Kong 的开发者。项目地址:https://gitcode.com/gh_mirrors/sky/skywalking-kong

1. 项目的目录结构及介绍

Apache SkyWalking Kong 插件的目录结构如下：

skywalking-kong/
├── github
│   └── workflows
│       └── mvn
│           └── wrapper
├── kong
│   └── plugins
│       └── skywalking
├── rockspec
├── test
│   └── e2e
├── asf.yaml
├── .gitignore
├── .licenserc.yaml
├── .luacheckrc
├── CHANGES.md
├── LICENSE
├── Makefile
├── NOTICE
├── README.md
├── mvnw
├── mvnw.cmd
├── release.md

目录结构介绍

• github/workflows/mvn/wrapper: 包含 GitHub Actions 的工作流配置和 Maven 包装器。
• kong/plugins/skywalking: 包含 SkyWalking 插件的核心代码。
• rockspec: 包含 LuaRocks 的规范文件。
• test/e2e: 包含端到端测试的代码。
• asf.yaml: Apache 软件基金会的配置文件。
• .gitignore: Git 忽略文件。
• .licenserc.yaml: 许可证配置文件。
• .luacheckrc: Lua 代码检查配置文件。
• CHANGES.md: 变更日志。
• LICENSE: 许可证文件。
• Makefile: 构建脚本。
• NOTICE: 版权声明。
• README.md: 项目说明文档。
• mvnw 和 mvnw.cmd: Maven 包装器脚本。
• release.md: 发布指南。

2. 项目的启动文件介绍

项目的启动文件主要是 kong/plugins/skywalking 目录下的 Lua 文件。这些文件负责在 Kong 网关中启用 SkyWalking 插件，并进行必要的初始化。

主要启动文件

• handler.lua: 插件的主处理文件，负责处理请求和响应的追踪。
• schema.lua: 插件的配置模式文件，定义了插件的配置选项。

3. 项目的配置文件介绍

项目的配置文件主要包括 kong.conf 和插件的配置。

kong.conf 配置

在 kong.conf 文件中，需要添加以下配置以启用 SkyWalking 插件：

plugins = bundled,skywalking
lua_package_path = ${user_home}/luarocks/share/lua/5.1/?.lua

插件配置

启用插件后，可以通过以下命令配置插件：

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'

配置选项

• backend_http_uri: SkyWalking OAP 服务的地址。
• sample_ratio: 采样率，范围为 0 到 100。
• service_name: 服务名称。
• service_instance_name: 服务实例名称。

以上是 Apache SkyWalking Kong 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

skywalking-kongApache SkyWalking Kong: 这是一个用于监控 Apache SkyWalking 的插件，基于 Kong 插件框架。Apache SkyWalking 是一个开源的分布式系统监控和诊断工具，用于收集和分析系统的性能指标和日志数据。这个插件可以帮助开发者将 SkyWalking 集成到 Kong 网关中，从而实现流量监控和故障排查。这个插件适合所有使用 Apache SkyWalking 和 Kong 的开发者。项目地址:https://gitcode.com/gh_mirrors/sky/skywalking-kong