Kafka Runner

The Kafka runner is able to send and receive messages from a Kafka broker

Config

config:
  servers: string
  keyEncoding: string
  valueEncoding: string
  securityProtocol: string
  saslMechanism: string
  saslUsername: string
  saslPassword: string
  saslKerberosServiceName: string
  saslKerberosDomainName string
  saslOauthTokenProvider: string

Servers

, seperated list of Kafka servers to connect to

Key Encoding

How to convert message keys between strings and bytes. Defaults to utf-8

Value Encoding

How to convert message values between strings and bytes. Defaults to utf-8

Security Protocol

Security protocol to use when communicating with brokers. Defaults to PLAINTEXT. Valid values are PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL

At the moment, not all SSL options are supported

SASL Mechanism

Authentication mechanism when securityProtocol is SASL_PLAINTEXT or SASL_SSL. Defaults to None. Valid values are: PLAIN, GSSAPI, OAUTHBEARER, SCRAM-SHA-256, SCRAM-SHA-512

SASL Username

Username must be specified when saslMechanism is PLAIN or SCRAM

SASL Password

Password must be specified when saslMechanism is PLAIN or SCRAM

SASL Kerberos Service Name

Service name to include in GSSAPI SASL mechanism handshake. Defaults to kafka

SASL Kerberos Domain Name

Kerberos domain name to use in GSSAPI SASL mechanism handshake. Chooses one of the brokers randomly by default

SASL OAuth Token Provider

Connect to OAuth token provider if specified

Actions

type: string
params:
  topic: string
  timeout_ms: int
  max_records: int
  key: string
  messages: [
    topic: string
    key: string
    value: string
  ]
  offset: string

Returns

{
    messages_sent: int
    messages_received: [
      topic: string
      key: string
      value: string
    ]
    errors: [string]
    runtime: int
}

Supported Action Types

• Send
• Receive

Topic

Kafka message topic to send all messages in list to or for a single message

Timeout MS

Time in milliseconds to wait for messages to receive

Max Records

Max number of messages to receive in a single poll

Key

Key to assign to all messages sent or single message

Value

Value to provide to a single message

Offset

Where to begin polling the stream. Defaults to earliest. Valid values are earliest and latest.

Messages Sent

Number of messages sent

Messages Received

List of messages received

Errors

List of errors raised when sending messages

Runtime

Time in milliseconds to complete action

Asserts

type: string
params:
  actionParams: ActionParams
  expected:
    topic: string
    key: string
    value: string

Supported Assert Types

• FindMessage