> ## Documentation Index
> Fetch the complete documentation index at: https://upstash-vector.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# kafka-ui

> Connect and monitor your Upstash Kafka cluster using kafka-ui.

[kafka-ui](https://github.com/provectus/kafka-ui) is a GUI for monitoring Apache
Kafka. From their description:

> Kafka UI for Apache Kafka is a simple tool that makes your data flows
> observable, helps find and troubleshoot issues faster and deliver optimal
> performance. Its lightweight dashboard makes it easy to track key metrics of
> your Kafka clusters - Brokers, Topics, Partitions, Production, and
> Consumption.

You can connect and monitor your Upstash Kafka cluster using
[kafka-ui](https://github.com/provectus/kafka-ui).

To be able to use [kafka-ui](https://github.com/provectus/kafka-ui), first you
should create a yaml configuration file:

```yaml
kafka:
  clusters:
    - name: my-cluster
      bootstrapServers: "tops-stingray-7863-eu1-kafka.upstash.io:9092"
      properties:
        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==";
      schemaRegistry: UPSTASH_KAFKA_REST_URL/schema-registry
      schemaRegistryAuth:
          username: UPSTASH_KAFKA_REST_USERNAME
          password: UPSTASH_KAFKA_REST_PASSWORD
```

<Note>
  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](https://console.upstash.com).
  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`
</Note>

You can start [kafka-ui](https://github.com/provectus/kafka-ui) application
directly using `jar` file. First download the latest release from
[releases page](https://github.com/provectus/kafka-ui/releases). Then launch the
application using following command in the same directory with `application.yml`
file:

```shell
java -jar kafka-ui-api-X.Y.Z.jar
```

Alternatively you can start using Docker:

```shell
docker run -p 8080:8080 -v ~/kafka-ui/application.yml:/application.yml provectuslabs/kafka-ui:latest
```

After launching the [kafka-ui](https://github.com/provectus/kafka-ui) app, just
go to [http://localhost:8080](http://localhost:8080) to access UI.

For more information see
[kafka-ui documentation](https://github.com/provectus/kafka-ui/blob/master/README.md).