Edit this page
Report an issue
Partner Plugin: This plugin is developed, tested, and maintained by Optum.
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 in Splunk UI
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
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
Feel free to open issues, or refer to our Contribution Guidelines if you have any questions.
We recommend enabling the Splunk Logging plugin at a global level.