Introduction
Learn about Wavekit, an on-premise UI for RisingWave observability and management. Discover its key features, benefits, available editions, and how to get help or contribute.
WaveKit is an on-premise user interface designed by RisingWave Labs to enhance your observability and simplify the management of your existing RisingWave clusters. It provides a centralized web-based dashboard to connect to, monitor, and interact with your RisingWave deployments, whether they are running in Docker, on Kubernetes, or even in RisingWave Cloud.
Key features and benefits
WaveKit empowers you to:
- Centralize cluster connections: Manage connection details for all your RisingWave clusters in one place.
- Monitor cluster status: Get at-a-glance information about your connected clusters, including their status and node count.
- Execute
risectl
commands: Run RisingWave’s command-line utility (risectl
) commands directly on your clusters through the WaveKit UI. - Manage metadata snapshots: Easily create manual metadata snapshots of your RisingWave clusters and configure automated backups for disaster recovery and state management.
- Collect diagnostic information: Trigger and automate the collection of diagnostic data and system metrics for advanced troubleshooting.
- Utilize an interactive SQL console:
- Connect to specific databases within your RisingWave clusters.
- Explore database schemas (tables, views, materialized views, sources, sinks).
- Write and execute SQL queries with support for multiple tabs and query history.
- Visualize streaming data flows with an integrated ‘Streaming Graph’ for queries involving streaming entities.
- Maintain control: As an on-premise tool, WaveKit and its metadata (stored in a PostgreSQL database you manage) remain within your infrastructure.
The primary benefits include simplified operations, improved observability into your streaming data platform, and efficient troubleshooting, all from a convenient web interface.
WaveKit editions
WaveKit is available in two editions:
- WaveKit-Lite: This is the open-source edition, licensed under Apache 2.0. It includes all the core functionalities described in this documentation and is freely available for download and use.
- WaveKit-Pro: This will be a future commercial edition offering advanced capabilities tailored for enterprise users. For more information or to express interest, please contact RisingWave Labs at sales@risingwave-labs.com.
Who is this for?
This documentation is for DevOps engineers, Site Reliability Engineers (SREs), database administrators, and RisingWave users who are responsible for operating, monitoring, and managing self-hosted or cloud-based RisingWave clusters.
Getting help and contributing
- Found an issue or have a question? Please visit our WaveKit GitHub Issues page.
- Want to contribute? We welcome contributions! Please see our CONTRIBUTING.md on GitHub.