The state-of-the-art Dashboard of Apache RoccketMQ provides excellent monitoring capability. Various graphs and statistics of events, performance and system inf
The state-of-the-art Dashboard of Apache RoccketMQ provides excellent monitoring capability. Various graphs and statistics of events, performance and system inf
English | 中文
Cross-cluster · Cross-architecture · Cross-cloud unified RocketMQ management platform
RocketMQ Studio is a unified management platform for RocketMQ, supporting multi-cluster, multi-architecture, and multi-cloud environments. It provides instance management, cluster operations, Topic / Consumer Group CRUD, ACL permission control, message query and tracing, dead letter queue handling, monitoring alerts, audit logs, and an AI assistant.
cd deploy/rocketmq && docker compose up -d
cd .. && docker compose up -d --buildVisit http://127.0.0.1:6789 after startup.
The first command starts the bundled RocketMQ topology and creates the
rocketmq_net Docker network used by the Studio services. Check that it
is healthy before starting Studio with docker compose ps from deploy/rocketmq.
The default schema creates only Studio tables. It does not seed instances, topics, consumer groups, or ACL
records. Development-only sample data can be imported explicitly from deploy/mysql/; it is not part of the
default deployment. Import upgrade-demo-instance.sql first and then upgrade-demo-acl.sql; both scripts
target the current numeric-ID schema and are idempotent. They are sample-data loaders, not upgrade migrations,
and should never be imported into a production database.
Studio ports: Frontend 6789 (Nginx), Backend 8888 (Spring Boot)
RocketMQ ports: NameServer 9876, Broker 10911, Proxy Remoting 8080, Proxy gRPC 8081
To enable login protection for a shared environment, copy deploy/.env.example to
deploy/.env, set STUDIO_AUTH_LOGIN_REQUIRED=true, and configure
STUDIO_AUTH_ADMIN_USERNAME / STUDIO_AUTH_ADMIN_PASSWORD. These configured credentials are a
bootstrap seed: on the first login against an empty database Studio creates the configured users
in the rmq_studio_user table, and the database becomes the source of truth afterwards.
Administrators manage accounts (create users, enable/disable, reset passwords) on the
user-management page; browsers authenticate with an HttpOnly session cookie, and API clients can
request a bearer token explicitly. Disabling login protection only skips API interception for local
development.
Dashboard · AI chat — a single entry point that switches between AI chat, cluster diagnosis, resource management, and message query, with model selection and MCP tool calls.
Consumer group management — the group list shows subscription mode, online clients, total lag, and consumption delay; expanding a row reveals per-Topic subscription consistency and filter expressions, alongside offset reset and config import/export.
Message query — search messages by Topic / Message Key / Message ID within a time range, then inspect details, trace, verification, or download a single message.
| Module | Capabilities |
|---|---|
| Dashboard | Global statistics for clusters, brokers, topics, and consumer groups with TPS trends |
| Instances | Multi-instance access (Proxy / Direct mode), instance CRUD |
| Clusters | Cluster details, Broker / NameServer / Proxy node operations, hot config updates, NameServer configuration drift detection |
| K8s Certs | Studio-local TLS / mTLS / ServiceAccount certificate configuration |
| Topics | Topic CRUD, route viewer, consumer list, multi-type support (Normal / FIFO / Delay / Transaction / Lite) |
| Consumer Groups | Consumer group CRUD, consumption progress, subscription details, offset reset, config import/export |
| ACL | ACL rules and user management, v1 / v2 dual version support |
| Messages | Query by Topic / MsgId / Key / time range, message trace visualization |
| Dead Letter Queue | DLQ message viewing and batch resend |
| Clients | Producer / Consumer online connection list, protocol and language version stats |
| Alert Rules | Multi-dimensional alert rules (disk / lag / TPS / node offline), DingTalk / email / SMS notifications |
| System Alerts | System-level alert viewing, acknowledgment, and cleanup |
| Audit Logs | Operation audit log query, filter by type / time / result, history cleanup |
| AI Assistant | SSE streaming chat, supports query / diagnose / manage / general modes, MCP tool integration |
| Settings | General preferences, LLM config, datasource management |
deploy.sh for remote deploymentmaster is the development trunk: base your branches and pull requests on it. master_archive keeps the legacy dashboard history and is not used for development. See CONTRIBUTING.md for the full workflowfeat: / fix: / refactor: / chore: / docs: / perf:)mvn test runs ArchUnit hexagonal architecture constraint checksweb/src/i18n/)tableScrollX(columns) from web/src/utils/table.ts to compute scroll.x from declared column widths instead of hardcoded magic numbers; when a modal contains a wide table, adjust the modal width dynamically per active tab (e.g., Group detail: Overview 800 / Progress 1080) so that container width ≥ table width; long-text columns (e.g., long Topic names) should use ellipsis: true + title for hover-to-see-full-name truncation (no wrapping)No open issues yet, or sync has not completed.