TcpLogPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TcpLogPluginConfig",
  "title": "TcpLogPluginConfig",
  "x-speakeasy-entity": "PluginTcpLog",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "custom_fields_by_lua": {
          "description": "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.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "host": {
          "description": "The IP address or host name to send data to.",
          "type": "string"
        },
        "keepalive": {
          "description": "An optional value in milliseconds that defines how long an idle connection lives before being closed.",
          "type": "number",
          "default": 60000
        },
        "port": {
          "description": "The port to send data to on the upstream server.",
          "type": "integer",
          "maximum": 65535,
          "minimum": 0
        },
        "ssl_verify": {
          "description": "When using TLS, this option enables verification of the certificate presented by the server.",
          "type": "boolean",
          "default": true
        },
        "timeout": {
          "description": "An optional timeout in milliseconds when sending data to the upstream server.",
          "type": "number",
          "default": 10000
        },
        "tls": {
          "description": "Indicates whether to perform a TLS handshake against the remote server.",
          "type": "boolean",
          "default": false
        },
        "tls_sni": {
          "description": "An optional string that defines the SNI (Server Name Indication) hostname to send in the TLS handshake.",
          "type": "string"
        }
      },
      "required": [
        "host",
        "port"
      ]
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "tcp-log"
    },
    "protocols": {
      "description": "A set of strings representing protocols.",
      "type": "array",
      "items": {
        "description": "A string representing a protocol, such as HTTP or HTTPS.",
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https",
          "tcp",
          "tls",
          "tls_passthrough",
          "udp",
          "ws",
          "wss"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "config"
  ]
}