Skip to content
This repository has been archived by the owner on Jun 12, 2024. It is now read-only.
/ kong-splunk-log Public archive

Kong plugin designed to log API transactions to Splunk.

License

Notifications You must be signed in to change notification settings

Optum/kong-splunk-log

Repository files navigation

Kong Splunk Log

⚠️ Notice ⚠️

We have decided to update this plugin one last time for Kong 3.7 compatibility. But going forward this repo/plugin will no longer be maintained. In the future we recommend using a modified http-log plugin paired with a modified Kong pdk log serializer patch file going forward.

See https://docs.konghq.com/hub/kong-inc/http-log/how-to/splunk/ for more information

Overview

Kong plugin designed to log API transactions to Splunk using the Splunk HTTP collector.

Kong provides many great logging tools out of the box, this is a modified version of the Kong HTTP logging plugin that has been refactored and tailored to work with Splunk.

Example Event Log Transaction:

Splunk Sample

Supported Kong Releases

Kong >= 3.x

Installation

Recommended:

$ luarocks install kong-splunk-log

Other:

$ git clone https://github.com/Optum/kong-splunk-log.git /path/to/kong/plugins/kong-splunk-log
$ cd /path/to/kong/plugins/kong-splunk-log
$ luarocks make *.rockspec

Configuration

The plugin requires an environment variable SPLUNK_HOST . This is how we define the host="" splunk field in the example log picture embedded above in our README.

Example Plugin Configuration:

Splunk Config

If not already set, it can be done so as follows:

$ export SPLUNK_HOST="gateway.company.com"

One last step is to make the environment variable accessible by an nginx worker. To do this, simply add this line to your nginx.conf

env SPLUNK_HOST;

Maintainers

jeremyjpj0916
rsbrisci

Feel free to open issues, or refer to our Contribution Guidelines if you have any questions.

About

Kong plugin designed to log API transactions to Splunk.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages