HTTP Log Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The HTTP Log plugin is compatible with the following protocols:

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

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 http-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 http-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.

• consumer.name or consumer.id

  string

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

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • http_endpoint

    string required referenceable encrypted

    The HTTP URL endpoint (including the protocol to use) to which the data is sent.

    If the http_endpoint contains a username and password (for example, http://bob:password@example.com/logs), then Kong Gateway automatically includes a basic-auth Authorization header in the log requests.

  • method

    string default: POST Must be one of: POST, PUT, PATCH

    An optional method used to send data to the HTTP server. Supported values are POST (default), PUT, and PATCH.

  • content_type

    string default: application/json Must be one of: application/json, application/json; charset=utf-8

    Indicates the type of data sent. The available options are application/json and application/json; charset=utf-8.

  • timeout

    number default: 10000

    An optional timeout in milliseconds when sending data to the upstream server.

  • keepalive

    number default: 60000

    An optional value in milliseconds that defines how long an idle connection will live before being closed.

  • retry_count

    integer

    Number of times to retry when sending data to the upstream server.

  • queue_size

    integer

    Maximum number of log entries to be sent on each message to the upstream server.

  • flush_timeout

    number

    Optional time in seconds. If queue_size > 1, this is the max idle time before sending a log with less than queue_size records.

  • headers

    map

    An optional table of headers included in the HTTP message to the upstream server. Values are indexed by header name, and each header name accepts a single string.

    The following headers are not allowed: Host, Content-Length, Content-Type.

    Note: Before version 3.0.0, the values were arrays of strings (multiple values per header name).

  • queue

    record required
    • max_batch_size

      number default: 1 between: 1 1000000

      Maximum number of entries to be processed together as a batch.

    • max_coalescing_delay

      number default: 1 between: 0 3600

      Maximum number of seconds (as a fraction) that can elapse after the first entry was queued before the queue starts processing entries. This parameter has no effect when batch_max_size is one because queued entries will be sent immediately in that case.

    • max_entries

      number default: 10000 between: 1 1000000

      Maximum number of entries that can be waiting on the queue. Once this number of requests is reached, the oldest entry is deleted from the queue before a new one is added.

    • max_bytes

      number

      Maximum number of bytes that can be waiting on a queue. Once this many bytes are present on a queue, old entries up to the size of a new entry to be enqueued are deleted from the queue.

    • max_retry_time

      number default: 60

      Time (in seconds) before the queue gives up trying to send a batch of entries. Once this time is exceeded for a batch, it is deleted from the queue without being sent. If this parameter is set to -1, no retries will be made for a failed batch.

    • initial_retry_delay

      number default: 0.01

    • max_retry_delay

      number default: 60

      Maximum time (in seconds) between retries sending a batch of entries. The interval between retries follows an exponential back-off algorithm capped at this number of seconds.

  • custom_fields_by_lua

    map

    A list of key-value pairs, where the key is the name of a log field and the value is a chunk of Lua code, whose return value sets or replaces the log field value.