> For the complete documentation index, see [llms.txt](https://docs.livestreamiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.livestreamiq.com/readme-1/3.-guide-to-navigation/3.3-dashboard-console.md).

# 3.3 Dashboard Console

A centralized dashboard providing real-time visibility into the health, performance, and operational status of your Kafka infrastructure.

The **LivestreamIQ Dashboard** provides a centralized overview of the Kafka environment, enabling administrators and operators to monitor cluster health, broker status, message activity, and key operational metrics in real time. It serves as the primary landing page, offering quick access to critical insights and helping users identify the overall status of their Kafka infrastructure at a glance.

![](https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-c5335282406bda1af7ddbd631d1f1a85b7bc2043%2Funknown%20\(47\).png?alt=media)

**Key Components of the Dashboard:**

1. **Online Cluster**: A Kafka cluster that is active, running, and available to process data and client requests.<br>

   ![](https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-a65374472b4b1defcab991603a1b7fb4219e438f%2Funknown%20\(48\).png?alt=media)
2. **Offline Cluster**: A Kafka cluster that is stopped, disconnected, or unavailable to process data and client requests.

<img src="https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-58d3530ab34a7292495a44798df7162ca587c01e%2Funknown%20(49).png?alt=media" alt="" height="280" width="594">

3. **Initialized Cluster**: A Kafka cluster that has completed its setup and is ready to manage data and client requests.<br>

<img src="https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-8e820554f3807e4a1fcd02744cabfea51fe59fe3%2Funknown%20(50).png?alt=media" alt="" height="272" width="600">

4. **Active Users:** An authenticated user or application currently connected to the Kafka cluster and sending or receiving data.

![](https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-23c879e928742b875b78b8265c98fe6487e111a1%2Funknown%20\(51\).png?alt=media)

5. **Cluster Status**: Indicates the current health and operational status of the Kafka cluster.<br>

   ![](https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-3a7d63025a207f8f2aed9c81ac9db7dbc0ba2dfa%2Funknown%20\(52\).png?alt=media)

The Sub-components of Cluster Status sections:

1. **Message Status:** Indicates the current delivery and processing status of a message in the Kafka cluster.<br>

   ![](https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-ca16485e7600064fb9fdeef5b68df26a0e78a50d%2Funknown%20\(53\).png?alt=media)
2. **Topic Cluster Status**: Indicates the health and operational status of Kafka topics within the cluster.<br>

   <img src="https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-36d9a86eeec1084f050370cabaf19985bba8ff69%2Funknown%20(54).png?alt=media" alt="" width="425">
3. **Broker Distribution** : Shows how brokers are distributed across the Kafka cluster.

<img src="https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-27b22438495fc13451024f40e82922807635d8d6%2Funknown%20(55).png?alt=media" alt="" width="443">

4. **Switch Environment and Cluster**: Allows user to switch between different Kafka clusters and environments.<br>

   <figure><img src="https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-9815cade34c907b4d180705e24c95557ad6bfc80%2Fimage%20(15).png?alt=media" alt=""><figcaption></figcaption></figure>
5. **Cluster List Status**: It displays the existing Kafka clusters and their current status, including brokers, topics, logs, latency, KSQL DB, and Kafka Connectors. [More info](https://ztrust.gitbook.io/livestreamiq/readme/3.-guide-to-navigation/3.4-cluster-overview)<br>

   ![](https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-7a8c1163a9e4e5f2f5ccaa89e5624c216c7dd599%2Funknown%20\(58\).png?alt=media)
6. **Toggle Environment and Cluster**: It allows users to switch between Kafka environments and select a cluster to monitor and manage its resources.<br>

   <img src="https://1499573743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6jSyTKzD9UG0uYLYFS7I%2Fuploads%2Fgit-blob-f10d235c150bb416d805ce15d72d21737ce642ca%2Funknown%20(57).png?alt=media" alt="" width="396">

Follow the steps below to switch between environments and Kafka clusters.

Step 1 : Click Select Clusters from the Dashboard.

Step 2: Select the required environments (e.g., DEV, SIT, UAT, PREPROD, PROD, or DR).

Or

Step 2: Use the Search Clusters field to find a specific cluster, if needed.

*The dashboard will automatically updated to display data for the selected environment and Kafka cluster.*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.livestreamiq.com/readme-1/3.-guide-to-navigation/3.3-dashboard-console.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
