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

    A string representing a URL, such as https://example.com/path/to/resource?q=search.

  • 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 only available option is application/json.

  • 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 default: 10

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

    Deprecation notice: http-log: config.retry_count no longer works, please use config.queue.max_retry_time instead. This field is planned to be removed in version 4.0.

  • queue_size

    integer default: 1

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

    Deprecation notice: http-log: config.queue_size is deprecated, please use config.queue.max_batch_size instead. This field is planned to be removed in version 4.0.

  • flush_timeout

    number default: 2

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

    Deprecation notice: http-log: config.flush_timeout is deprecated, please use config.queue.max_coalescing_delay instead. This field is planned to be removed in version 4.0.

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

  • queue

    record required
    • max_batch_size

      integer default: 1 between: 1 1000000

      Maximum number of entries that can be processed at a time.

    • max_coalescing_delay

      number default: 1 between: 0 3600

      Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.

    • max_entries

      integer default: 10000 between: 1 1000000

      Maximum number of entries that can be waiting on the queue.

    • max_bytes

      integer

      Maximum number of bytes that can be waiting on a queue, requires string content.

    • max_retry_time

      number default: 60

      Time in seconds before the queue gives up calling a failed handler for a batch.

    • initial_retry_delay

      number default: 0.01 between: 0.001 1000000

      Time in seconds before the initial retry is made for a failing batch.

    • max_retry_delay

      number default: 60 between: 0.001 1000000

      Maximum time in seconds between retries, caps exponential backoff.

  • custom_fields_by_lua

    map

    Lua code as a key-value map