Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
|
search
Plugin Hub
github-edit-pageEdit this page
report-issueReport an issue
header icon

TCP Log Configuration

By Kong Inc.
You are browsing documentation for an outdated plugin version. See the latest documentation here.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The TCP Log plugin is compatible with the following protocols:

grpc, grpcs, http, https, tcp, tls, udp

Parameters

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

  • name

    string required

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

  • 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/SERVICE_NAME|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/ROUTE_NAME|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/CONSUMER_NAME|ID/plugins.

  • enabled

    boolean default: true

    Whether this plugin will be applied.

  • config

    record required

    • host

      string required

      The IP address or host name to send data to.

    • port

      integer required between: 0 65535

      The port to send data to on the upstream server.

    • 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 lives before being closed.

    • tls

      boolean required default: false

      Indicates whether to perform a TLS handshake against the remote server.

    • tls_sni

      string

      An optional string that defines the SNI (Server Name Indication) hostname to send in the TLS handshake.

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