Configuration

configobjectrequired
Hide Child Parameters
allowed_topicsarray[string]

The list of allowed topic names to which messages can be sent. The default topic configured in the topic field is always allowed, regardless of its inclusion in allowed_topics.

authenticationobject
Hide Child Parameters
mechanismstring

The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.

Allowed values:PLAINSCRAM-SHA-256SCRAM-SHA-512

passwordstring

Password for SASL authentication.
This field is encrypted.
This field is referenceable.

strategystring

The authentication strategy for the plugin, the only option for the value is sasl.

Allowed values:sasl

tokenauthboolean

Enable this to indicate DelegationToken authentication.

userstring

Username for SASL authentication.
This field is encrypted.
This field is referenceable.

bootstrap_serversarray[object]

Set of bootstrap brokers in a {host: host, port: port} list format.

Hide Child Parameters
hoststringrequired

A string representing a host name, such as example.com.

portintegerrequired

An integer representing a port number between 0 and 65535, inclusive.

>= 0<= 65535

cluster_namestring

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

forward_bodyboolean

Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

Default:true

forward_headersboolean

Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

Default:false

forward_methodboolean

Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

Default:false

forward_uriboolean

Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

Default:false

keepaliveinteger

Keepalive timeout in milliseconds.

Default:60000

keepalive_enabledboolean

Default:false

key_query_argstring

The request query parameter name that contains the Kafka message key. If specified, messages with the same key will be sent to the same Kafka partition, ensuring consistent ordering.

message_by_lua_functionsarray[string]

The Lua functions that manipulates the message being sent to the Kafka topic.

producer_asyncboolean

Flag to enable asynchronous mode.

Default:true

producer_async_buffering_limits_messages_in_memoryinteger

Maximum number of messages that can be buffered in memory in asynchronous mode.

Default:50000

producer_async_flush_timeoutinteger

Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

Default:1000

producer_request_acksinteger

The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).

Allowed values:-101

Default:1

producer_request_limits_bytes_per_requestinteger

Maximum size of a Produce request in bytes.

Default:1048576

producer_request_limits_messages_per_requestinteger

Maximum number of messages to include into a single producer request.

Default:200

producer_request_retries_backoff_timeoutinteger

Backoff interval between retry attempts in milliseconds.

Default:100

producer_request_retries_max_attemptsinteger

Maximum number of retry attempts per single Produce request.

Default:10

producer_request_timeoutinteger

Time to wait for a Produce response in milliseconds.

Default:2000

schema_registryobject

The plugin-global schema registry configuration. This can be overwritten by the topic configuration.

Hide Child Parameters
confluentobject
Hide Child Parameters
authenticationobjectrequired
Show Child Parameters
key_schemaobject
Show Child Parameters
ssl_verifyboolean

Set to false to disable SSL certificate verification when connecting to the schema registry.

Default:true

ttlnumber

The TTL in seconds for the schema registry cache.

>= 0<= 3600

urlstring

The URL of the schema registry.

value_schemaobject
Show Child Parameters
securityobject
Hide Child Parameters
certificate_idstring

UUID of certificate entity for mTLS authentication.

sslboolean

Enables TLS.

timeoutinteger

Socket timeout in milliseconds.

Default:10000

topicstringrequired

The default Kafka topic to publish to if the query parameter defined in the topics_query_arg does not exist in the request

topics_query_argstring

The request query parameter name that contains the topics to publish to

consumerobject

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.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

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.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

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.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!