Skip to content
This repository was archived by the owner on Apr 14, 2025. It is now read-only.
 
 

Kong Splunk Log

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 Log Transaction:

Splunk Sample

Supported Kong Releases

Kong >= 0.12.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.

Releases

Packages

Contributors

Languages