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

Kong agent for Apache SkyWalking
https://github.com/apache/skywalking-kong

apm dapper distributed-tracing gateway kong lua nginx observability skywalking

Last synced: 3 months ago
JSON representation

Kong agent for Apache SkyWalking

• Host: GitHub
• URL: https://github.com/apache/skywalking-kong
• Owner: apache
• License: apache-2.0
• Created: 2021-04-16T11:36:37.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-22T11:00:13.000Z (5 months ago)
• Last Synced: 2024-09-30T01:21:19.162Z (3 months ago)
• Topics: apm, dapper, distributed-tracing, gateway, kong, lua, nginx, observability, skywalking
• Language: Java
• Homepage: https://skywalking.apache.org/
• Size: 38.1 KB
• Stars: 27
• Watchers: 38
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Apache SkyWalking Kong Agent

==========



[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)

[![CI AND IT](https://github.com/apache/skywalking-kong/actions/workflows/ci.yaml/badge.svg)](https://github.com/apache/skywalking-kong/actions/workflows/ci.yaml)

SkyWalking Kong agent built on [SkyWalking Nginx Lua agent](https://github.com/apache/skywalking-nginx-lua) to trace Kong API gateway for [Apache SkyWalking](https://github.com/apache/skywalking) APM.

## Usage

Kong 2.2+ required.

1. Install the plugin in Kong:

Install kong-plugin-skywalking using `luarocks`:

```bash

$ luarocks install kong-skywalking --local

```

Edit kong.conf:

```

plugins = bundled,skywalking

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

```

Set environment:

```bash

$ export KONG_NGINX_HTTP_LUA_SHARED_DICT="tracing_buffer 128m"

```

Restart Kong

2. Enabling & configuring plugin:

Add the plugin to global:

```bash

$ 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

* Submit an [issue](https://github.com/apache/skywalking/issues) with `[KONG]` as the issue title prefix.

* Mail list: **[email protected]**. Mail to `[email protected]`, follow the reply to subscribe the mail list.

* Join `skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY). If the link is not working, find the latest one at [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).

* QQ Group: 392443393(2000/2000, not available), 901167865(available)

# Release Guide

All committers should follow [Release Guide](release.md) to publish the official release.

# License

Apache 2.0