Class: Producer

July 18, 2026 ยท View on GitHub

xk6-kafka


Class: Producer

Defined in: index.d.ts:375

Classdesc

Producer writes messages to Kafka.

Example

// In init context
const producer = new Producer({
  brokers: ["localhost:9092"],
  topic: "my-topic",
  autoCreateTopic: true,
});

// In VU code (default function)
producer.produce({
  messages: [
    {
      key: "key",
      value: "value",
    },
  ],
});

// In teardown function
producer.close();

Constructors

Constructor

new Producer(writerConfig): Producer

Defined in: index.d.ts:376

Parameters

writerConfig

WriterConfig

Returns

Producer

Methods

close()

close(): void

Defined in: index.d.ts:380

Returns

void


flush()

flush(): void

Defined in: index.d.ts:378

Returns

void


produce()

produce(produceConfig): void

Defined in: index.d.ts:377

Parameters

produceConfig

ProduceConfig

Returns

void


stats()

stats(): ProducerStats

Defined in: index.d.ts:379

Returns

ProducerStats