Skip to content

v1.0.0

Latest
Latest
Compare
Choose a tag to compare
@github-actions github-actions released this 28 May 16:39
v1.0.0
This tag was signed with the committer’s verified signature.
mostafa Mostafa Moradian
GPG key ID: 97CC91FDDDBF5865
Verified
Learn about vigilant mode.
18c1155
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

xk6-kafka v1.0.0 is here! 🎉

After nearly 5 years of continuous development, from the initial commit on May 9, 2020, to today's milestone, xk6-kafka v1.0.0 represents our commitment to stability, clarity, and long-term support for everyone load-testing Kafka with k6. In that time, this extension has seen 277 commits, amassed 176 stars and 81 forks on GitHub, and benefitted from 21+ community contributors, with 72,000+ Docker pulls and 9,000+ binary downloads. With v1.0.0, we're formalizing versioning guarantees, polishing our public API, and delivering a rock-solid foundation you can build on with confidence.

Thank you, xk6-kafka community! 🌍

This release wouldn't be possible without you:

  • ⭐️ 176 stars on GitHub.
  • 🍴 81 forks to explore and extend.
  • 🧠 277 commits driving the project forward.
  • 🤝 21+ contributors shaping features and fixes.
  • 📦 72,000+ Docker pulls of mostafamoradian/xk6-kafka.
  • 📥 9,000+ GitHub artifact downloads for prebuilt binaries.

From enhancing serialization formats and authentication to expanding metrics coverage and improving developer ergonomics, your issues, PRs, and feedback have been invaluable. Thank you for every test run, discussion, and contribution that brought us here.

What's New in xk6-kafka v1.0.0?

1. Stability You Can Trust

  • ✅ Semantic Versioning: We've adopted SemVer 2.0.0, breaking changes only in major releases, with deprecation warnings in advance.
  • 🔒 2-Year Support Guarantee: Critical fixes and security patches for all v1.x releases, for at least two years.
  • 📦 Public API Surface: A clearly documented, supported set of functions (Writer, Reader, Connection, SchemaRegistry) and options you can rely on.

2. First-Class TypeScript Definitions

Leverage TypeScript's type-safety when writing Kafka tests:

import { Writer, Reader, SchemaRegistry, SCHEMA_TYPE_AVRO } from 'k6/x/kafka';

const writer = new Writer({
  brokers: ['localhost:9092'],
  topic: 'orders',
  keySchema: { type: SCHEMA_TYPE_AVRO, schema: orderKeySchema },
  valueSchema: { type: SCHEMA_TYPE_AVRO, schema: orderValueSchema },
});

export default function () {
  writer.produce([{ key: '123', value: orderPayload }]);
}

3. Streamlined Extension Workflow

No more toolchain quirks, just build and run:

xk6 build --with github.com/mostafa/[email protected]
k6 run script.js

Or use the official Docker image:

docker pull mostafamoradian/xk6-kafka:v1.0.0
docker run --rm -v "$(pwd)":/scripts \
  mostafamoradian/xk6-kafka:v1.0.0 \
  run /scripts/test_avro.js

4. Enhanced Metrics & Monitoring

  • 📊 New consumer metrics: Track kafka_consumer_lag, kafka_consumer_bytes, and more.
  • ⚖️ Improved thresholds: Apply thresholds on Kafka-specific metrics for automated pass/fail criteria.
  • 🔍 Hierarchical summaries: Group results by topic, partition, and metric category in the end-of-test report.

5. Quality-of-Life Upgrades

  • ✔️ Full Schema Registry support: Auto-fetch Avro/JSON Schema from your registry or embed inline.
  • 🔐 Expanded auth options: SASL/PLAIN, SCRAM, SSL, and AWS IAM are all first-class citizens.
  • ⚡ Performance optimizations: Bulk-produce mode and connection pooling for high-throughput scenarios.

Ready to get started? Download the binaries or grab the Docker image, and let v1.0.0 supercharge your Kafka load tests. If you encounter any issues or have feature ideas, we'd love to hear from you on GitHub!

Assets 10
Loading