jlandersen / vscode-kafka

Apache Kafka® extension for Visual Studio Code

Tools for Apache Kafka®

Work with Apache Kafka® directly in Visual Studio Code-based editors. Kafka clusters running version 0.11 or higher are supported.

Features:

• Connect to multiple clusters
• View brokers in cluster
• View topics
• View configs
• Create/Delete topic
• Produce (randomized) messages
• Consume messages
• SASL/PLAIN, SASL/SCRAM-256, SASL/SCRAM-512 Authentication (Kafka 0.10+)
• SSL Support
• Clusters can be contributed by 3rd party extensions

Planned features, in no particular order:

• More administration features
• Improved .kafka validation support
• Better SSL support

You might also find useful information in the Online Documentation or you can read this documentation inside your editor with the command Open Documentation available with Ctrl+Shift+P:

Kafka explorer

The Kafka explorer shows configured clusters with their topics, brokers, consumers and configurations.

See Kafka explorer section for more information.

Producing messages

Define simple producers in a .kafka file, using the following format:

PRODUCER keyed-message
topic: my-topic
key: mykeyq
headers: header1=value1, header2=value2
record content

###

PRODUCER non-keyed-json-message
topic: json-events
{
    "type": "my_test_event-{{random.number}}"
}

See Producing messages section for more information.

Consuming messages

Consuming topics can be done by right-clicking on a topic in the Kafka explorer, from the command palette, or from a .kafka file:

CONSUMER consumer-group-id
topic: json-events
partitions: 0
from: 1

See Consuming messages section for more information.

Discover new cluster providers

You can search for extensions contributing cluster providers in the extension gallery, by clicking on the Discover Cluster Providers button (also available via the command palette):

Those extensions must have the kafka-provider keyword in their package.json, eg.

"keywords": [
		"kafka-provider"
],

CI Builds

Tools for Apache Kafka® is built using Github Actions. Here's how to download and install the latest successful build:

• Go to the CI Workflow page
• Click on the most recent run,
• Locate the vscode-kafka artifact down the page and download it,
• Unzip the archive,
• Install the vscode-kafka-*.vsix extension by following these instructions.

Contributing

This is an open source project open to anyone. Contributions are extremely welcome!

For information on getting started, refer to the CONTRIBUTING instructions.

License

MIT License. See LICENSE file.

Apache, Apache Kafka®, Kafka® and associated logos are trademarks of the Apache Software Foundation (ASF). Tools for Apache Kafka® is not affiliated with, endorsed by, or otherwise associated with the Apache Software Foundation or any of its projects.