xk6-kafka

The xk6-kafka project is a k6 extension that enables k6 users to load test Apache Kafka using a producer and possibly a consumer for debugging.

The real purpose of this extension is to test the system you meticulously designed to use Apache Kafka. So, you can test your consumers, hence your system, by auto-generating messages and sending them to your system via Apache Kafka.

You can send many messages with each connection to Kafka. These messages are arrays of objects containing a key and a value in various serialization formats, passed via configuration objects. Various serialization formats are supported, including strings, JSON, binary, Avro, and JSON Schema. Avro and JSON Schema can either be fetched from Schema Registry or hard-code directly in the script. SASL PLAIN/SCRAM authentication and message compression are also supported.

For debugging and testing purposes, a consumer is available to make sure you send the correct data to Kafka.

If you want to learn more about the extension, read the article (outdated) explaining how to load test your Kafka producers and consumers using k6 on the k6 blog. You can also watch this recording of the k6 Office Hours about this extension.

Supported Features

Produce/consume messages as String, JSON, ByteArray, Avro and JSON Schema formats
Support for user-provided Avro and JSON Schema key and value schemas in the script
Authentication with SASL PLAIN, SCRAM, SSL and AWS IAM
Create, list and delete topics
Support for loading Java Keystore (JKS) files
Support for loading Avro schemas from Schema Registry with gzip compression support
Support for byte array for binary data (from binary protocols)
Support consumption from all partitions with a group ID
Support Kafka message compression: Gzip, Snappy, Lz4 & Zstd
Support for sending messages with no key
Support for k6 thresholds on custom Kafka metrics
Support for headers on produced and consumed messages
Lots of exported metrics, as shown in the list of emitted metrics

Download Binaries

The Official Docker Image

The official Docker image is available on Docker Hub. Before running your script, make the script available to the container by mounting a volume (a directory) or passing it via stdin.

docker run --rm -i mostafamoradian/xk6-kafka:latest run - <scripts/test_json.js

The Official Binaries

The binaries are generated by the build process and published on the releases page. Currently, binaries for GNU/Linux, macOS, and Windows are available for both amd64 (x86_64) and arm64 architectures.

Note

If you want to see an official build for your machine, please build and test xk6-kafka from source and then create an issue with details. I'll add the specific binary to the build pipeline and publish them on the next release.

Build from Source

You can build the k6 binary on various platforms, each with its requirements. The following shows how to build k6 binary with this extension on GNU/Linux distributions.

Prerequisites

You must have the latest Go version installed to build the k6 binary. The latest version should match k6 and xk6. I recommend gvm because it eases version management.

gvm for easier installation and management of Go versions on your machine
Git for cloning the project
xk6 for building k6 binary with extensions

Install and build the latest tagged version

Feel free to skip the first two steps if you already have Go installed.

Install gvm by following its installation guide.
Install the latest version of Go using gvm. You need Go 1.4 installed for bootstrapping into higher Go versions, as explained here.
Install xk6:
```
go install go.k6.io/xk6/cmd/xk6@latest
```

Build the binary:

xk6 build --with github.com/mostafa/xk6-kafka@latest

Note

You can always use the latest version of k6 to build the extension, but the earliest version of k6 that supports extensions via xk6 is v0.32.0. The xk6 is constantly evolving, so some APIs may not be backward compatible.

Build for development

If you want to add a feature or make a fix, clone the project and build it using the following commands. The xk6 will force the build to use the local clone instead of fetching the latest version from the repository. This process enables you to update the code and test it locally.

git clone [email protected]:mostafa/xk6-kafka.git && cd xk6-kafka
xk6 build --with github.com/mostafa/xk6-kafka@latest=.

Build using docker

The Grafana xk6 also supports using docker to build a k6 custom binary with extensions.

Install the latest xk6 docker image.
```
docker pull grafana/xk6
```

Build the custom binary. On Mac, make sure to add the GOOS=darwin option.

docker run --rm -e GOOS=darwin -u "$(id -u):$(id -g)" -v "${PWD}:/xk6" \
    grafana/xk6 build \
    --with github.com/avitalique/xk6-file@latest \
    --with github.com/LeonAdato/xk6-output-statsd@latest \
    --with github.com/mostafa/xk6-kafka@latest

Example scripts

There are many examples in the script directory that show how to use various features of the extension.

How to Test Your Kafka Setup

You can start testing your setup immediately, but it takes some time to develop the script, so it would be better to test your script against a development environment and then start testing your environment.

Development environment

I recommend the fast-data-dev Docker image by Lenses.io, a Kafka setup for development that includes Kafka, Zookeeper, Schema Registry, Kafka-Connect, Landoop Tools, 20+ connectors. It is relatively easy to set up if you have Docker installed. Just monitor Docker logs to have a working setup before attempting to test because the initial setup, leader election, and test data ingestion take time.

Run the Kafka environment and expose the ports:

docker run \
    --detach --rm \
    --name lensesio \
    -p 2181:2181 \
    -p 3030:3030 \
    -p 8081-8083:8081-8083 \
    -p 9581-9585:9581-9585 \
    -p 9092:9092 \
    -e ADV_HOST=127.0.0.1 \
    -e RUN_TESTS=0 \
    lensesio/fast-data-dev:latest

After running the command, visit localhost:3030 to get into the fast-data-dev environment.
You can run the command to see the container logs:
```
docker logs -f -t lensesio
```

Note

If you have errors running the Kafka development environment, refer to the fast-data-dev documentation.

The xk6-kafka API

All the exported functions are available by importing the module object from k6/x/kafka. The exported objects, constants and other data structures are available in the index.d.ts file, and they always reflect the latest changes on the main branch. You can access the generated documentation at api-docs/docs/README.md.

Note

The JavaScript API is stable as of version 1.0.0 and is not subject to major changes in future versions unless a new major version is released.

k6 Test Scripts

The example scripts are available as test_<format/feature>.js with more code and commented sections in the scripts directory. Since this project extends the functionality of k6, it has four stages in the test life cycle.

Click to expand detailed usage guide with code examples

To use the extension, you need to import it in your script, like any other JS module:

// Either import the module object
import * as kafka from "k6/x/kafka";

// Or individual classes and constants
import { sleep } from "k6";
import {
  Writer,
  Reader,
  Connection,
  SchemaRegistry,
  SCHEMA_TYPE_STRING,
} from "k6/x/kafka";

You need to instantiate the classes in the init context. All the k6 options are also configured here:

// Creates a new Writer object to produce messages to Kafka
const writer = new Writer({
  // WriterConfig object
  brokers: ["localhost:9092"],
  topic: "my-topic",
});

const reader = new Reader({
  // ReaderConfig object
  brokers: ["localhost:9092"],
  topic: "my-topic",
});

const connection = new Connection({
  // ConnectionConfig object
  address: "localhost:9092",
});

const schemaRegistry = new SchemaRegistry({
  // SchemaRegistryConfig object or be left empty
    url: "http://localhost:8081",
});

// Create topic in setup() to avoid race conditions with multiple VUs
export function setup() {
  // Connection must be created inside setup() to ensure proper VU context
  const setupConnection = new Connection({
    address: "localhost:9092",
  });
  setupConnection.createTopic({
    // TopicConfig object
    topic: "my-topic",
    numPartitions: 10, // optional, defaults to 1
    replicationFactor: 1, // optional, defaults to 1
  });

  // Verify topic was created
  const topics = setupConnection.listTopics();
  if (!topics.includes("my-topic")) {
    throw new Error("Topic was not created successfully");
  }

  setupConnection.close();

  // Wait for Kafka metadata to propagate to all brokers
  // This ensures Writer/Reader can see all partitions
  sleep(2);
}

⚠️ Important: Do NOT use if (__VU == 0) at module level for topic creation. This causes race conditions where other VUs start before the topic is created. Always use the setup() function or set autoCreateTopic: true on the Writer.

Alternative: If you don't need to control partition count, use autoCreateTopic:

const writer = new Writer({
  brokers: ["localhost:9092"],
  topic: "my-topic",
  autoCreateTopic: true, // Let Writer auto-create the topic
});

In the VU code, you can produce messages to Kafka or consume messages from it:

export default function () {
  // Fetch the list of all topics
  const topics = connection.listTopics();
  console.log(topics); // list of topics

  // Produces message to Kafka
  writer.produce({
    // ProduceConfig object
    messages: [
      // Message object(s)
      {
        key: schemaRegistry.serialize({
          data: "my-key",
          schemaType: SCHEMA_TYPE_STRING,
        }),
        value: schemaRegistry.serialize({
          data: "my-value",
          schemaType: SCHEMA_TYPE_STRING,
        }),
      },
    ],
  });

  // Consume messages from Kafka
  let messages = reader.consume({
    // ConsumeConfig object
    limit: 10,
  });

  // your messages
  console.log(messages);

  // You can use checks to verify the contents,
  // length and other properties of the message(s)

  // To serialize the data back into a string, you should use
  // the deserialize method of the Schema Registry client. You
  // can use it inside a check, as shown in the example scripts.
  let deserializedValue = schemaRegistry.deserialize({
    data: messages[0].value,
    schemaType: SCHEMA_TYPE_STRING,
  });
}

In the teardown function, close all the connections and possibly delete the topic:

export function teardown(data) {
  // Delete the topic
  connection.deleteTopic("my-topic");

  // Close all connections
  writer.close();
  reader.close();
  connection.close();
}

You can now run k6 with the extension using the following command:
```
./k6 run --vus 50 --duration 60s scripts/test_json.js
```

And here's the test result output:

         /\      Grafana   /‾‾/
    /\  /  \     |\  __   /  /
   /  \/    \    | |/ /  /   ‾‾\
  /          \   |   (  |  (‾)  |
 / __________ \  |_|\_\  \_____/

     execution: local
        script: scripts/test_json.js
        output: -

     scenarios: (100.00%) 1 scenario, 50 max VUs, 1m30s max duration (incl. graceful stop):
              * default: 50 looping VUs for 1m0s (gracefulStop: 30s)



  █ THRESHOLDS

    kafka_reader_error_count
    ✓ 'count == 0' count=0

    kafka_writer_error_count
    ✗ 'count == 0' count=2


  █ TOTAL RESULTS

    checks_total.......: 185697  2729.030778/s
    checks_succeeded...: 100.00% 185697 out of 185697
    checks_failed......: 0.00%   0 out of 185697

    ✓ 10 messages are received
    ✓ Topic equals to xk6_kafka_json_topic
    ✓ Key contains key/value and is JSON
    ✓ Value contains key/value and is JSON
    ✓ Header equals {'mykey': 'myvalue'}
    ✓ Time is past
    ✓ Partition is zero
    ✓ Offset is gte zero
    ✓ High watermark is gte zero

    CUSTOM
    kafka_reader_dial_count............: 50      0.734807/s
    kafka_reader_dial_seconds..........: avg=93.76µs  min=0s     med=0s      max=85.44ms p(90)=0s       p(95)=0s
    kafka_reader_error_count...........: 0       0/s
    kafka_reader_fetch_bytes...........: 62 MB   910 kB/s
    kafka_reader_fetch_bytes_max.......: 1000000 min=1000000      max=1000000
    kafka_reader_fetch_bytes_min.......: 1       min=1            max=1
    kafka_reader_fetch_size............: 157680  2317.288772/s
    kafka_reader_fetch_wait_max........: 10s     min=10s          max=10s
    kafka_reader_fetches_count.........: 98      1.440223/s
    kafka_reader_lag...................: 2615790 min=518          max=2619354
    kafka_reader_message_bytes.........: 41 MB   609 kB/s
    kafka_reader_message_count.........: 210880  3099.123898/s
    kafka_reader_offset................: 4390    min=36           max=6000
    kafka_reader_queue_capacity........: 100     min=100          max=100
    kafka_reader_queue_length..........: 91      min=26           max=100
    kafka_reader_read_seconds..........: avg=90.51ms  min=0s     med=0s      max=58.22s  p(90)=0s       p(95)=0s
    kafka_reader_rebalance_count.......: 0       0/s
    kafka_reader_timeouts_count........: 48      0.705415/s
    kafka_reader_wait_seconds..........: avg=75.12µs  min=0s     med=0s      max=94.95ms p(90)=0s       p(95)=0s
    kafka_writer_acks_required.........: 0       min=0            max=0
    kafka_writer_async.................: 0.00%   0 out of 2063300
    kafka_writer_attempts_max..........: 10      min=10           max=10
    kafka_writer_batch_bytes...........: 482 MB  7.1 MB/s
    kafka_writer_batch_max.............: 1       min=1            max=1
    kafka_writer_batch_queue_seconds...: avg=77.09µs  min=0s     med=6.11µs  max=41.11ms p(90)=143.95µs p(95)=302.24µs
    kafka_writer_batch_seconds.........: avg=394.84µs min=3.34µs med=25.17µs max=5.05s   p(90)=318.84µs p(95)=663.36µs
    kafka_writer_batch_size............: 2063300 30322.564204/s
    kafka_writer_batch_timeout.........: 1s      min=1s           max=1s
    kafka_writer_error_count...........: 2       0.029392/s
    kafka_writer_message_bytes.........: 965 MB  14 MB/s
    kafka_writer_message_count.........: 4126602 60645.157801/s
    kafka_writer_read_timeout..........: 10s     min=10s          max=10s
    kafka_writer_retries_count.........: 2       0.029392/s
    kafka_writer_wait_seconds..........: avg=0s       min=0s     med=0s      max=0s      p(90)=0s       p(95)=0s
    kafka_writer_write_count...........: 4126602 60645.157801/s
    kafka_writer_write_seconds.........: avg=429.33µs min=6.43µs med=25.13µs max=4.99s   p(90)=53.27µs  p(95)=71.35µs
    kafka_writer_write_timeout.........: 10s     min=10s          max=10s

    EXECUTION
    iteration_duration.................: avg=150.93ms min=8.63ms med=60.05ms max=10.12s  p(90)=176.66ms p(95)=221.25ms
    iterations.........................: 20633   303.225642/s
    vus................................: 1       min=0            max=50
    vus_max............................: 50      min=50           max=50

    NETWORK
    data_received......................: 0 B     0 B/s
    data_sent..........................: 0 B     0 B/s




running (1m08.0s), 00/50 VUs, 20633 complete and 0 interrupted iterations
default ✓ [======================================] 50 VUs  1m0s
ERRO[0068] thresholds on metrics 'kafka_writer_error_count' have been crossed

Emitted Metrics

Click to expand full metrics table

Metric	Type	Description
kafka_reader_dial_count	Counter	Total number of times the reader tries to connect.
kafka_reader_fetches_count	Counter	Total number of times the reader fetches batches of messages.
kafka_reader_message_count	Counter	Total number of messages consumed.
kafka_reader_message_bytes	Counter	Total bytes consumed.
kafka_reader_rebalance_count	Counter	Total number of rebalances of a topic in a consumer group (deprecated).
kafka_reader_timeouts_count	Counter	Total number of timeouts occurred when reading.
kafka_reader_error_count	Counter	Total number of errors occurred when reading.
kafka_reader_dial_seconds	Trend	The time it takes to connect to the leader in a Kafka cluster.
kafka_reader_read_seconds	Trend	The time it takes to read a batch of message.
kafka_reader_wait_seconds	Trend	Waiting time before read a batch of messages.
kafka_reader_fetch_size	Counter	Total messages fetched.
kafka_reader_fetch_bytes	Counter	Total bytes fetched.
kafka_reader_offset	Gauge	Number of messages read after the given offset in a batch.
kafka_reader_lag	Gauge	The lag between the last message offset and the current read offset.
kafka_reader_fetch_bytes_min	Gauge	Minimum number of bytes fetched.
kafka_reader_fetch_bytes_max	Gauge	Maximum number of bytes fetched.
kafka_reader_fetch_wait_max	Gauge	The maximum time it takes to fetch a batch of messages.
kafka_reader_queue_length	Gauge	The queue length while reading batch of messages.
kafka_reader_queue_capacity	Gauge	The queue capacity while reading batch of messages.
kafka_writer_write_count	Counter	Total number of times the writer writes batches of messages.
kafka_writer_message_count	Counter	Total number of messages produced.
kafka_writer_message_bytes	Counter	Total bytes produced.
kafka_writer_error_count	Counter	Total number of errors occurred when writing.
kafka_writer_batch_seconds	Trend	The time it takes to write a batch of messages.
kafka_writer_batch_queue_seconds	Trend	The time it takes to queue a batch of messages.
kafka_writer_write_seconds	Trend	The time it takes writing messages.
kafka_writer_wait_seconds	Trend	Waiting time before writing messages.
kafka_writer_retries_count	Counter	Total number of attempts at writing messages.
kafka_writer_batch_size	Counter	Total batch size.
kafka_writer_batch_bytes	Counter	Total number of bytes in a batch of messages.
kafka_writer_attempts_max	Gauge	Maximum number of attempts at writing messages.
kafka_writer_batch_max	Gauge	Maximum batch size.
kafka_writer_batch_timeout	Gauge	Batch timeout.
kafka_writer_read_timeout	Gauge	Batch read timeout.
kafka_writer_write_timeout	Gauge	Batch write timeout.
kafka_writer_acks_required	Gauge	Required Acks.
kafka_writer_async	Rate	Async writer.

FAQ

Click to expand FAQ (16 questions)

Why do I receive Error writing messages?

There are a few reasons why this might happen. The most prominent one is that the topic might not exist, which causes the producer to fail to send messages to a non-existent topic.

Solution 1 (Recommended): Create the topic in the setup() function to avoid race conditions:

export function setup() {
  const connection = new Connection({ address: "localhost:9092" });
  connection.createTopic({ topic: "my-topic", numPartitions: 10 });

  // Verify and wait for metadata propagation
  const topics = connection.listTopics();
  if (!topics.includes("my-topic")) {
    throw new Error("Topic creation failed");
  }
  connection.close();
  sleep(2); // Allow metadata to propagate
}

Solution 2: Set autoCreateTopic: true in WriterConfig (uses broker defaults):

const writer = new Writer({
  brokers: ["localhost:9092"],
  topic: "my-topic",
  autoCreateTopic: true,
});

Solution 3: Create a topic manually using the kafka-topics command:

$ docker exec -it lensesio bash
(inside container)$ kafka-topics --create --topic xk6_kafka_avro_topic --bootstrap-server localhost:9092
(inside container)$ kafka-topics --create --topic xk6_kafka_json_topic --bootstrap-server localhost:9092

Why does the reader.consume keep hanging?

If the reader.consume keeps hanging, it might be because the topic doesn't exist or is empty.
I want to test SASL authentication. How should I do that?

If you want to test SASL authentication, look at this commit message, in which I describe how to run a test environment to test SASL authentication.
Why doesn't the consumer group consume messages from the topic?

As explained in issue #37, multiple inits by k6 cause multiple consumer group instances to be created in the init context, which sometimes causes the random partitions to be selected by each instance. This, in turn, causes confusion when consuming messages from different partitions. This can be solved by using a UUID when naming the consumer group, thereby guaranteeing that the consumer group object was assigned to all partitions in a topic.
Why do I receive a MessageTooLargeError when I produce messages bigger than 1 MB?

Kafka has a maximum message size of 1 MB by default, which is set by message.max.bytes, and this limit is also applied to the Writer object.

There are two ways to produce larger messages: 1) Change the default value of your Kafka instance to a larger number. 2) Use compression.

Remember that the Writer object will reject messages larger than the default Kafka message size limit (1 MB). Hence you need to set batchBytes to a larger value, for example, 1024 * 1024 * 2 (2 MB). The batchBytes refers to the raw uncompressed size of all the keys and values (data) in your array of messages you pass to the Writer object. You can calculate the raw data size of your messages using this example script.
Can I consume messages from a consumer group in a topic with multiple partitions?

Yes, you can. Just pass the groupID to your Reader object. You must not specify the partition anymore. Visit this documentation article to learn more about Kafka consumer groups.

Remember that you must set sessionTimeout on your Reader object if the consume function terminates abruptly, thus failing to consume messages.
Why does the Reader.consume produces an unable to read message error?

The maxWait option controls how long the reader waits for messages before timing out. If not specified, it uses the default from the underlying Kafka library (typically 1 second). For performance testing reasons, you may want to set a shorter timeout (e.g., 200ms) to avoid hanging. If you keep receiving timeout errors, consider increasing maxWait to a larger value:
```
const reader = new Reader({
  brokers: ["localhost:9092"],
  topic: "my-topic",
  maxWait: "5s", // Wait up to 5 seconds for messages
});
```
How can I consume from multiple partitions on a single topic?

You can configure your reader to consume from a (list of) topic(s) and its partitions using a consumer group. This can be achieved by setting groupTopics, groupID and a few other options for timeouts, intervals and lags. Have a look at the test_consumer_group.js example script.
How can I use autocompletion in IDEs?

Copy api-docs/index.d.ts into your project directory and reference it at the top of your JavaScript file:
```
/// <reference path="index.d.ts" />

...
```
Why timeouts give up sooner than expected?

There are many ways to configure timeout for the Reader and Writer objects. They follow Go's time conventions, which means that one second is equal to 1000000000 (one billion). For ease of use, I added the constants that can be imported from the module.
```
import { SECOND } from "k6/x/kafka";

console.log(2 * SECOND); // 2000000000
console.log(typeof SECOND); // number
```
Can I catch errors returned by the consume function?

Yes. You can catch errors by using a try-catch block. The consume function returns an error object. If the consume function raises, the error object will be populated with the error message.
```
try {
  let messages = reader.consume({
    limit: 10,
  });
} catch (error) {
  console.error(error);
}
```
I am using a nested Avro schema and getting unknown errors. How can I debug them?

If you have a nested Avro schema and you want to test it against your data, I created a small tool for it, called nested-avro-schema. This tool will help you to find discrepancies and errors in your schema data, so that you can fix them before you run xk6-kafka tests. Refer to this comment for more information.
What is the difference between hard-coded schemas in the script and the ones fetched from the Schema Registry?

Read this comment.
I want to specify the offset of a message when consuming from a topic. How can I do that?

To specify the offset of a message while consuming from a topic, use the following options based on your consumption setup:
1. When consuming from a group: Use the startOffset option in the Reader object. This option allows you to define the starting point for message consumption. Here are the values you can use for startOffset:
  - -1: Consume from the most recent message. This is equivalent to START_OFFSETS_LAST_OFFSET.
  - -2: Consume from the oldest message. This is equivalent to START_OFFSETS_FIRST_OFFSET.
  - Any positive number: Consume from the specific offset number provided.
    
    The constants START_OFFSETS_LAST_OFFSET and START_OFFSETS_FIRST_OFFSET are part of the xk6-kafka module. You can import and use them in your script. The startOffset option is a string.
```
import { Reader, START_OFFSETS_LAST_OFFSET } from "k6/x/kafka";

const reader = new Reader({
  brokers: ["localhost:9092"], // Replace with your broker(s)
  groupID: "example-group", // Specify your consumer group ID
  groupTopics: ["example-topic"], // List of topics for the group
  startOffset: START_OFFSETS_LAST_OFFSET, // Use the most recent offset
});
```
2. When consuming from a topic:
  
  Use the offset option instead of startOffset. The offset option is a number that directly specifies the offset of the message you want to consume, unlike startOffset, which is a string.
```
import { Reader } from "k6/x/kafka";

const reader = new Reader({
  brokers: ["localhost:9092"], // Replace with your broker(s)
  topic: "example-topic", // Specify the topic
  offset: 10, // Consume from offset 10
});
```
How can I use Avro union types in my Avro schema?

Read this comment.
What if I want to use a custom profile for the SASL authentication with AWS IAM instead of the default profile?

You can use the AWS_PROFILE environment variable to specify the profile name or use the awsProfile option in the SASLConfig object.

Avro Union Types

xk6-kafka uses hamba/avro for Avro serialization/deserialization. When working with Avro union types, you can provide union values directly without wrapping them in type-specific objects. For nullable fields, you can use null directly. See the Schema Registry documentation for detailed examples and best practices.

Contributions, Issues and Feedback

I'd be thrilled to receive contributions and feedback on this project. You're always welcome to create an issue if you find one (or many). I would do my best to address the issues. Also, feel free to contribute by opening a PR with changes, and I'll do my best to review and merge it as soon as I can.

The Release Process

The main branch is the development branch, and pull requests are squashed and merged into the main branch. When a commit is tagged with a version (e.g., v1.2.0), the build pipeline builds the main branch at that commit, creating binaries and Docker images. To test the latest unreleased features, clone the main branch and build using the local repository as explained in the build for development section.

Image Signatures

Docker images are signed with cosign using keyless signing. You can verify the signature of any image using:

cosign verify --certificate-identity-regexp ".*" --certificate-oidc-issuer https://token.actions.githubusercontent.com \
  mostafamoradian/xk6-kafka:<version>

Replace <version> with the specific version tag you want to verify (e.g., 1.2.0).

The CycloneDX SBOM

CycloneDX SBOMs in JSON format are generated for go.mod and Docker images for each release. They are available in the release assets for each tagged version.

Disclaimer

This project was a proof of concept but is now used by various companies. It is not officially supported by the k6 team, but rather maintained by me personally. The JavaScript API is stable as of version 1.0.0, but breaking changes may occur in future major versions.

This project was AGPL3-licensed up until 7 October 2021, and then we relicensed it under the Apache License 2.0.

Name		Name	Last commit message	Last commit date
Latest commit History 290 Commits
.github/workflows		.github/workflows
api-docs		api-docs
assets		assets
docs		docs
fixtures		fixtures
scripts		scripts
.gitattributes		.gitattributes
.gitignore		.gitignore
.golangci.yaml		.golangci.yaml
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
auth.go		auth.go
auth_test.go		auth_test.go
avro.go		avro.go
avro_conversion_test.go		avro_conversion_test.go
avro_test.go		avro_test.go
balancer.go		balancer.go
bytearray.go		bytearray.go
bytearray_test.go		bytearray_test.go
error_codes.go		error_codes.go
go.mod		go.mod
go.sum		go.sum
interfaces.go		interfaces.go
jks.go		jks.go
jks_test.go		jks_test.go
json.go		json.go
json_test.go		json_test.go
kafka_helpers_test.go		kafka_helpers_test.go
module.go		module.go
reader.go		reader.go
reader_test.go		reader_test.go
schema_registry.go		schema_registry.go
schema_registry_gzip_test.go		schema_registry_gzip_test.go
schema_registry_resolver_test.go		schema_registry_resolver_test.go
schema_registry_test.go		schema_registry_test.go
serdes.go		serdes.go
serdes_test.go		serdes_test.go
stats.go		stats.go
string.go		string.go
string_test.go		string_test.go
topic.go		topic.go
topic_test.go		topic_test.go
utils.go		utils.go
writer.go		writer.go
writer_test.go		writer_test.go

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

xk6-kafka

Supported Features

Download Binaries

The Official Docker Image

The Official Binaries

Build from Source

Prerequisites

Install and build the latest tagged version

Build for development

Build using docker

Example scripts

How to Test Your Kafka Setup

Development environment

The xk6-kafka API

k6 Test Scripts

Emitted Metrics

FAQ

Avro Union Types

Contributions, Issues and Feedback

The Release Process

Image Signatures

The CycloneDX SBOM

Disclaimer

About

Uh oh!

Releases 54

Uh oh!

Contributors 25

Uh oh!

Languages

License

mostafa/xk6-kafka

Folders and files

Latest commit

History

Repository files navigation

xk6-kafka

Supported Features

Download Binaries

The Official Docker Image

The Official Binaries

Build from Source

Prerequisites

Install and build the latest tagged version

Build for development

Build using docker

Example scripts

How to Test Your Kafka Setup

Development environment

The xk6-kafka API

k6 Test Scripts

Emitted Metrics

FAQ

Avro Union Types

Contributions, Issues and Feedback

The Release Process

Image Signatures

The CycloneDX SBOM

Disclaimer

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 54

Uh oh!

Contributors 25

Uh oh!

Languages