splunk-hec-logging

When the Plugin is enabled, APISIX will serialize the request context information to Splunk Event Data format and submit it to the batch queue. When the maximum batch size is exceeded, the data in the queue is pushed to Splunk HEC. See for more details.

Attributes

This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every 5 seconds or when the data in the queue reaches 1000. See for more information or setting your custom configuration.

You can also set the format of the logs by configuring the Plugin metadata. The following configurations are available:

NameTypeRequiredDefaultDescription
log_formatobjectFalse{“host”: “$host”, “@timestamp”: “$time_iso8601”, “client_ip”: “$remote_addr”}Log format declared as key value pairs in JSON format. Values only support strings. or Nginx variables can be used by prefixing the string with $.
IMPORTANT

The example below shows how you can configure through the Admin API:

With this configuration, your logs would be formatted as shown below:

  1. [{"time":1673976669.269,"source":"apache-apisix-splunk-hec-logging","event":{"host":"localhost","client_ip":"127.0.0.1","@timestamp":"2023-01-09T14:47:25+08:00","route_id":"1"},"host":"DESKTOP-2022Q8F-wsl","sourcetype":"_json"}]

Enabling the Plugin

The example below shows a complete configuration of the Plugin on a specific Route:

Minimal configuration

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.         "splunk-hec-logging":{
  5.                 "uri":"http://127.0.0.1:8088/services/collector",
  6.                 "token":"BD274822-96AA-4DA6-90EC-18940FB2414C"
  7.             }
  8.         }
  9.     },
  10.     "upstream":{
  11.         "type":"roundrobin",
  12.         "nodes":{
  13.             "127.0.0.1:1980":1
  14.         }
  16. }'

Once you have configured the Route to use the Plugin, when you make a request to APISIX, it will be logged in your Splunk server:

You should be able to login and search these logs from your Splunk dashboard:

splunk hec search view

Disable Plugin

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/hello",
  4.     "plugins": {},
  5.     "upstream": {
  6.         "type": "roundrobin",
  7.         "nodes": {
  8.             "127.0.0.1:1980": 1
  9.         }