Kong Splunk Log Configuration

Configuration

This plugin is compatible with DB-less mode.

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case kong-splunk-log.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example kong-splunk-log_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • splunk_endpoint

    string required

    Splunk HTTP Event Collector(HEC) Endpoint

  • splunk_access_token

    string required

    Passes required Splunk header Authorization Splunk: aaaaaaaa-bbbb-cccc-dddd-ffffffffffff

  • method

    string default: POST

    HTTP Method to send to Splunk

  • content_type

    string default: application/json

    Defines the Content-Type header to send to Splunk

  • timeout

    number default: 10000

    The amount of time to wait on a Splunk transaction before timing out

  • retry_count

    number default: 5

    The number of attempts to retry logging an event on splunk connection errors

  • queue_size

    number default: 20

    The max number of event logs the plugin may send in a single request

  • flush_timeout

    number default: 30

    The time taken in seconds before flushing a queue of transactions to splunk that has not reached its max queue_size

  • keepalive

    number default: 60000

    The amount of time to keep plugin connections with Splunk active