Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

KafkaRecords are produced by Kafka Collections Agentscollections agents, and consumed by Kafka Forwarding Agentsforwarding agents.

Field

Description

context (any)

An optional field for user-defined information.

errorMessage (string)

Automatically populated if an error occurs during forwarding of the message.

headers (list<RecordHeader (Kafka)>)

An optional list of headers.

key (bytearray)

An optional field for the key.

offset (long)

The

A read-only field with the offset of the collected message

. A read only field

.

outstandingRecordCnt (int)

A read-only field indicating how many records are left to

process. This value can be used as an indication for scaling

send.

partition (int)

The partition the message was collected from

/ is

or will be forwarded to. Automatically set.

timestamp (long)

The collection

/

or forwarding time

. Automatically

which is set automatically.

topic (string)

The topic the message was collected from

/ is

or will be forwarded to.

value (bytearray)

The contents of the message.

...

Note!

When forwarding a message to Kafka, all fields are optional, except for topic and value.