1. Get your Lenses license key 

Sign up with Lenses and download your license key.

2. Sign up for CloudKarafka and create a Kafka 

CloudKarafka is a fully managed Apache Kafka streaming platform, deployable in the cloud of your choice.

Start by signing up for a CloudKarafka account. Follow the in-product instructions to launch Kafka clusters within the CloudKarafka user interface.

Then, gather the connection points of your cluster.

Gather 1 connection point 

  1. Kafka endpoint. Go to Details > Using SASL/SCRAM.
Kafka endpoint

3. Run Lenses with Docker 

Run the following in a terminal:

docker run -e LENSES_PORT=8080 -p 8080:8080 lensesio/lenses

Wait for this message in the logs:

2021-12-16 18:17:04,322 INFO  [i.l.b.r.HttpServer] [ioapp-compute-6] Lenses http server started and listening to requests.

Now your Lenses is up and running.

4. Login 

Head to http://localhost:8080.

Login as admin:

  • User: admin
  • Password: admin
Lenses login page

5. Wizard setup 

On the wizard step 2 on Bootstrap Servers configuration add the endpoints from above, comma-separated. On our case it would be:


Select SASL SSL from the Security Protocol options and in the SASL Mechanism choose SCRAM-SHA-256.

On the JAAS Configuration below add the username and the password provided in the Connection details. required 

Click on Test Kafka Brokers. And you should get the message: Validation completed successfully.

Broker Validation

6. License 

Add your Lenses license. Copy and paste the JSON file you downloaded from your email. Lenses will check that the license is valid.

License Validation

7. Boot 

Click on Save & Boot Lenses. Lenses will finish configuring itself.

Wizard Validation

8. Eureka! 

Lenses Dashboard

Next steps 


With CloudKarafka, these endpoints are only available in specific configurations:

  • Kafka metrics via JMX, only with VPC peering.
  • Schema Registry
  • Kafka Connect

Without these endpoints the below Lenses features are not available:

Last modified: July 3, 2024