Skip to main content

Documentation Index

Fetch the complete documentation index at: https://upstash-vector.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

AKHQ is a GUI for monitoring & managing Apache Kafka topics, topics data, consumers group etc. You can connect and monitor your Upstash Kafka cluster using AKHQ. To be able to use AKHQ, first you should create a yaml configuration file: 
akhq:
  connections:
    my-cluster:
      properties:
        bootstrap.servers: "tops-stingray-7863-eu1-kafka.upstash.io:9092"
        sasl.mechanism: SCRAM-SHA-512
        security.protocol: SASL_SSL
        sasl.jaas.config: org.apache.kafka.common.security.scram.ScramLoginModule required username="ZmlycG9iZXJtYW4ZHtSXVwmyJQ" password="J6ocnQfe25vUsI8AX-XxA==";
      schema-registry:
        url: UPSTASH_KAFKA_REST_URL/schema-registry
        basic-auth-username: UPSTASH_KAFKA_REST_USERNAME
        basic-auth-password: UPSTASH_KAFKA_REST_PASSWORD
You should replace bootstrap.servers and sasl.jaas.config attributes with your cluster endpoint and credentials.You can find the endpoint, username and password from the cluster page at Upstash Console. Scroll down to the REST API section to find schema-registry related configs:
  • UPSTASH_KAFKA_REST_URL
  • UPSTASH_KAFKA_REST_USERNAME
  • UPSTASH_KAFKA_REST_PASSWORD
You can start AKHQ application directly using jar file. First download the latest release from releases page. Then launch the application using following command: 
java -Dmicronaut.config.files=application.yml -jar akhq.jar
Alternatively you can start using Docker: 
docker run -p 8080:8080 -v ~/akhq/application.yml:/app/application.yml tchiotludo/akhq
After launching the AKHQ app, just go to http://localhost:8080 to access UI. For more information see AKHQ documentation.