Kong插件SkyWalking安装与配置指南

Kong插件SkyWalking安装与配置指南

kong-plugin-skywalking The Nginx Lua agent for Apache SkyWalking kong-plugin 项目地址: https://gitcode.com/gh_mirrors/ko/kong-plugin-skywalking

欢迎来到Apache SkyWalking在Kong中的集成插件——kong-plugin-skywalking的快速入门指南。本指南将引导您了解项目结构、关键文件以及如何配置此插件来监控您的Kong API网关。

1. 项目目录结构及介绍

项目根目录结构大致如下：

.
├── kong/plugins/skywalking            # 插件核心逻辑存放处
│   ├── init.lua                        # 插件初始化脚本
│   └── ...
├── rockspec                            # LuaRocks的规格文件，用于插件安装
├── test                                # 测试目录，包含了单元测试和端到端测试
│   └── e2e                             # 端到端测试代码
├── README.md                           # 主要的说明文档
├── LICENSE                             # 许可证文件，遵循Apache License 2.0
├── CHANGELOG.md                        # 更新日志
└── ...

• kong/plugins/skywalking: 这个目录包含了插件的主要Lua脚本，是实现监控功能的核心。
• rockspec: 描述了如何通过LuaRocks来安装此插件的规格文件。
• test: 包含了用于验证插件功能的测试套件。
• README.md: 快速入门和主要使用说明文档。
• LICENSE: 插件使用的开放源代码许可证信息。
• CHANGELOG.md: 记录了项目各版本的更新变动情况。

2. 项目的启动文件介绍

在Kong环境下，没有特定于这个插件的“启动文件”，而是通过Kong自身的配置机制来启用和配置插件。然而，为了使插件生效，您需要确保Kong服务正确启动，并且环境已配置完毕。下面是关键步骤简述：

• 环境准备:

  • 安装并通过LuaRocks安装kong-plugin-skywalking。
  • 设置环境变量如KONG_NGINX_HTTP_LUA_SHARED_DICT以配置共享字典大小。

• Kong配置: 修改Kong的配置文件(kong.conf)或通过API添加配置，加入plugins部分，启用s skywalking插件，并根据需要调整配置选项。

• 启用插件: 可以通过API请求来全局启用插件：

  curl -X POST 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'
  

3. 项目的配置文件介绍

虽然本项目本身不直接提供一个独立的配置文件，其配置是通过Kong的全局或服务/路由级别的配置进行的。关键配置项包括但不限于：

• config.backend_http_uri: SkyWalking OAP服务器的地址，用于上报追踪数据。
• config.sample_ratio: 抽样跟踪比率，值范围0-100，100表示全量跟踪。
• config.service_name: 在SkyWalking中服务的名称，默认为“kong”。
• config.service_instance_name: 服务实例的命名，便于在SkyWalking UI区分不同的Kong实例。

通过以上配置，您可以控制插件的行为，确保监控数据准确地被SkyWalking采集和分析。

请注意，实际操作时应参考最新版的插件文档，以获取最准确的指令和配置细节。

kong-plugin-skywalking The Nginx Lua agent for Apache SkyWalking kong-plugin 项目地址: https://gitcode.com/gh_mirrors/ko/kong-plugin-skywalking