diff --git a/docker/description.md b/docker/description.md index 745bacf1..64f2b8b6 100644 --- a/docker/description.md +++ b/docker/description.md @@ -8,6 +8,7 @@ ## Official releases +[1.1.0](https://github.com/valkey-io/valkey-admin/blob/v1.1.0/docker/Dockerfile.app) [1.0.1](https://github.com/valkey-io/valkey-admin/blob/v1.0.1/docker/Dockerfile.app) What is [Valkey Admin](https://github.com/valkey-io/valkey-admin)? diff --git a/docs-site/astro.config.mjs b/docs-site/astro.config.mjs index 2589c8c5..e9707c65 100644 --- a/docs-site/astro.config.mjs +++ b/docs-site/astro.config.mjs @@ -24,7 +24,7 @@ export default defineConfig({ { label: 'Getting Started', items: [ - { label: 'Introduction', slug: 'introduction' }, + { label: "What's New", slug: 'releases' }, ], }, { @@ -47,12 +47,6 @@ export default defineConfig({ { label: 'Resource Sizing', slug: 'deployment/resource-sizing' }, ], }, - { - label: 'Settings', - items: [ - { label: 'Settings', slug: 'settings/settings' }, - ], - }, { label: 'Configuration', items: [ diff --git a/docs-site/package-lock.json b/docs-site/package-lock.json index 316af60f..691c5892 100644 --- a/docs-site/package-lock.json +++ b/docs-site/package-lock.json @@ -5,7 +5,6 @@ "requires": true, "packages": { "": { - "name": "docs-site", "version": "0.0.1", "dependencies": { "@astrojs/starlight": "^0.41.4", diff --git a/docs-site/src/assets/monitoring_big_keys.png b/docs-site/src/assets/monitoring_big_keys.png index 93b099dc..36191b2b 100644 Binary files a/docs-site/src/assets/monitoring_big_keys.png and b/docs-site/src/assets/monitoring_big_keys.png differ diff --git a/docs-site/src/content/docs/index.mdx b/docs-site/src/content/docs/index.mdx index 0c8538c1..a93a2318 100644 --- a/docs-site/src/content/docs/index.mdx +++ b/docs-site/src/content/docs/index.mdx @@ -8,7 +8,7 @@ hero: file: ../../assets/logo.png actions: - text: Documentation - link: /introduction/ + link: /releases/ icon: right-arrow variant: primary - text: View on GitHub @@ -35,7 +35,7 @@ Valkey Admin is an open-source observability and management tool from the [Valke Browse, search, inspect, and edit keys across all data types (String, Hash, List, Set, Sorted Set, Stream, JSON). - Execute Valkey commands with response formatting and command history. + Execute Valkey commands with autocomplete, response formatting, and command history. Visual map of shards, primaries, and replicas with per-node metrics. @@ -43,6 +43,9 @@ Valkey Admin is an open-source observability and management tool from the [Valke Identify frequently accessed keys across all cluster nodes. + + Scan the keyspace to find the largest keys by memory usage with access frequency insights. + View slow commands, large requests, and large replies aggregated across the cluster. @@ -89,6 +92,12 @@ Valkey Admin is an open-source observability and management tool from the [Valke Track the most accessed keys in real-time to identify potential bottlenecks and optimize data distribution. + + ![Big keys analysis showing largest keys by memory usage](../../assets/monitoring_big_keys.png) + + Identify the largest keys in your keyspace by memory usage, with access frequency to distinguish hot from cold. + + ![Slow log viewer displaying commands exceeding execution threshold](../../assets/monitoring_slow_logs.png) diff --git a/docs-site/src/content/docs/introduction.mdx b/docs-site/src/content/docs/introduction.mdx deleted file mode 100644 index c8fb1dec..00000000 --- a/docs-site/src/content/docs/introduction.mdx +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: Introduction -description: An open-source observability and management tool from the Valkey project that brings cluster visibility, data inspection, and troubleshooting into a single view. ---- - -import { Card, CardGrid, Tabs, TabItem } from '@astrojs/starlight/components'; - -## What is Valkey Admin? - -Valkey Admin is an open-source observability and management tool from the [Valkey](https://valkey.io) project that brings cluster visibility, data inspection, and troubleshooting into a single view. It ships as a native desktop application for macOS and Linux, and as a containerized web deployment on Docker and Kubernetes. Valkey Admin provides real-time cluster dashboards, topology visualization with per-node metrics, a key browser, hot key identification, and [COMMANDLOG](https://valkey.io/commands/commandlog-get/) aggregated across the cluster. - ---- - -## Features - - - - Real-time metrics including memory usage, CPU, connected clients, hit ratio, and command throughput. - - - Browse, search, inspect, and edit keys across all data types (String, Hash, List, Set, Sorted Set, Stream, JSON). - - - Execute Valkey commands with response formatting and command history. - - - Visual map of shards, primaries, and replicas with per-node metrics. - - - Identify frequently accessed keys across all cluster nodes. - - - View slow commands, large requests, and large replies aggregated across the cluster. - - - ---- - -## See It in Action - - - - ![Valkey Admin Dashboard showing cluster metrics, node status, and real-time performance indicators](../../assets/dashboard.png) - - **Real-time cluster monitoring** with metrics for memory, CPU, connections, and throughput across all nodes. - - - - ![Key Browser interface with search, filtering, and inline editing capabilities](../../assets/key_browser.png) - - **Powerful key management** with pattern matching, type filtering, and support for all data structures (strings, hashes, lists, sets, sorted sets, streams). - - - - ![Interactive command terminal with syntax highlighting and auto-completion](../../assets/command.png) - - **User friendly Send Command** with syntax highlighting, response searching and command history. - - - - ![Visual cluster topology diagram showing nodes, replication, and slot distribution](../../assets/cluster_topology.png) - - **Visual cluster topology** displaying primary-replica relationships, slot assignments, and node connection status. - - - ---- - -## Activity - - - - ![Hot keys monitoring showing most frequently accessed keys](../../assets/monitoring_hot_keys.png) - - Track the most accessed keys in real-time to identify potential bottlenecks and optimize data distribution. - - - - ![Slow log viewer displaying commands exceeding execution threshold](../../assets/monitoring_slow_logs.png) - - Monitor slow logs with detailed timing information to optimize performance-critical operations. - - - - ![Large request monitoring showing oversized command payloads](../../assets/monitoring_large_requests.png) - - Detect large request payloads that may impact network performance and cause blocking operations. - - - - ![Large reply monitoring showing oversized response data](../../assets/monitoring_large_replies.png) - - Identify commands returning large responses to optimize queries and reduce network overhead. - - - ---- - -## License - -Valkey Admin is released under the **Apache License 2.0** - free for commercial and personal use. - -[View license details →](/reference/license/) diff --git a/docs-site/src/content/docs/releases.md b/docs-site/src/content/docs/releases.md new file mode 100644 index 00000000..135a54b8 --- /dev/null +++ b/docs-site/src/content/docs/releases.md @@ -0,0 +1,77 @@ +--- +title: What's New +description: Release notes and changelog for Valkey Admin +sidebar: + order: 0 +--- + +## v1.1.0 + +Release Date: July 2026 + +### Key Features + +**Big Keys Analysis**: Scan your keyspace to identify the largest keys by memory usage. Configurable scan limit and top N, with per-key access frequency via `OBJECT FREQ` when an LFU eviction policy is configured. Results show key name, size, type, TTL, owning node (cluster mode), and access frequency. ([#376](https://github.com/valkey-io/valkey-admin/pull/376), [#378](https://github.com/valkey-io/valkey-admin/pull/378), [#383](https://github.com/valkey-io/valkey-admin/pull/383), [#390](https://github.com/valkey-io/valkey-admin/pull/390)) + +**Command Autocomplete**: The Send Command interface now provides autocomplete suggestions from a built-in list of Valkey commands with full subcommand support (396 total entries including subcommands like `CLUSTER SHARDS`, `COMMANDLOG GET`, `CLIENT TRACKING`, etc.). ([#361](https://github.com/valkey-io/valkey-admin/pull/361), [#362](https://github.com/valkey-io/valkey-admin/pull/362), [#415](https://github.com/valkey-io/valkey-admin/pull/415)) + +**Numbered Database Support**: Connect to specific logical databases (db 0–15) via a database dropdown in the connection modal. Each `(host, port, db)` combination opens an independent client. Cluster mode supports multiple databases on Valkey 9.0+. ([#366](https://github.com/valkey-io/valkey-admin/pull/366), [#368](https://github.com/valkey-io/valkey-admin/pull/368)) + +**Persist State Across Refresh**: Page refreshes no longer kick users back to the connection page. The application auto-reconnects and navigates back to the previous view. Command history also persists across refreshes. ([#389](https://github.com/valkey-io/valkey-admin/pull/389), [#393](https://github.com/valkey-io/valkey-admin/pull/393)) + +**Cluster Config Retry**: Configuration updates fan out to all cluster nodes with automatic per-node retry and Fibonacci backoff. Live per-node status is streamed to the UI so operators can see which nodes are updating, retrying, or failed. ([#391](https://github.com/valkey-io/valkey-admin/pull/391)) + +**Large Cluster Reliability**: Fixed intermittent "No primary node found" errors when connecting to clusters with 50+ nodes by upgrading to Valkey GLIDE 2.4 with `NodeDiscoveryMode.STATIC`. ([#371](https://github.com/valkey-io/valkey-admin/pull/371), [#359](https://github.com/valkey-io/valkey-admin/pull/359)) + +### Improvements + +- Preconfigured standalone connections — `VALKEY_HOST`/`VALKEY_PORT` now auto-detect standalone vs cluster ([#379](https://github.com/valkey-io/valkey-admin/pull/379)) +- Key Browser uses pagination for all collection types (hash, list, set, sorted set) ([#364](https://github.com/valkey-io/valkey-admin/pull/364)) +- Dangerous commands are blocked or require confirmation before execution ([#358](https://github.com/valkey-io/valkey-admin/pull/358)) +- Command parsing correctly handles quoted keys and escaped characters ([#381](https://github.com/valkey-io/valkey-admin/pull/381)) +- Binary values display as hex (`\x80\x00\x88`) with printable ASCII shown as-is ([#381](https://github.com/valkey-io/valkey-admin/pull/381)) +- Monitor and Command Log errors now surface in the Activity view instead of failing silently ([#373](https://github.com/valkey-io/valkey-admin/pull/373)) +- Homebrew cask install available for macOS: `brew install --cask valkey-admin` ([#380](https://github.com/valkey-io/valkey-admin/pull/380)) +- `KEY_VALUE_SIZE_LIMIT_BYTES` configurable via environment variable ([#370](https://github.com/valkey-io/valkey-admin/pull/370)) +- Upgraded Valkey GLIDE client to 2.4.0 ([#359](https://github.com/valkey-io/valkey-admin/pull/359)) + +### Security + +- Enforce session-based connection authorization in WebSocket dispatch loop ([#411](https://github.com/valkey-io/valkey-admin/pull/411)) +- Fix Electron CSP blocking WebSocket connections ([#410](https://github.com/valkey-io/valkey-admin/pull/410)) +- Update vulnerable dependencies ([#412](https://github.com/valkey-io/valkey-admin/pull/412)) +- Upgrade react-router to 8.3.0 ([#420](https://github.com/valkey-io/valkey-admin/pull/420)) +- Add explicit permissions to CI workflows + +### Bug Fixes + +- Fix metrics server not starting for cluster connections in Electron mode ([#388](https://github.com/valkey-io/valkey-admin/pull/388)) +- Fix NodeErrorsBanner showing incorrect label across Activity tabs ([#388](https://github.com/valkey-io/valkey-admin/pull/388)) +- Fix `upgrade-insecure-requests` breaking non-localhost HTTP deployments ([#385](https://github.com/valkey-io/valkey-admin/pull/385)) +- Fix number input spinners snapping to unexpected values ([#421](https://github.com/valkey-io/valkey-admin/pull/421)) +- Fix session authorization rejecting db-stripped node IDs ([#419](https://github.com/valkey-io/valkey-admin/pull/419)) +- Fix hot keys returning empty on first MONITOR cycle ([#434](https://github.com/valkey-io/valkey-admin/pull/434)) +- Fix monitor stop failing when metrics server crashes ([#431](https://github.com/valkey-io/valkey-admin/pull/431)) +- Fix closeMetricsServer sending wrong ID to metrics process ([#428](https://github.com/valkey-io/valkey-admin/pull/428)) +- Make search case-insensitive in Send Command view ([#426](https://github.com/valkey-io/valkey-admin/pull/426)) + +### Contributors + +@ravjotbrar, @ArgusLi, @nassery318, @dbaker-arch, @michaelstingl, @antonin-suzor + +**Full Changelog**: [v1.0.1...v1.1.0](https://github.com/valkey-io/valkey-admin/compare/v1.0.1...release/1.1.0) + +**Release**: [GitHub Releases](https://github.com/valkey-io/valkey-admin/releases/tag/v1.1.0) + +**Container Images**: +- Docker Hub: `docker pull valkey/valkey-admin:1.1.0` +- GHCR: `docker pull ghcr.io/valkey-io/valkey-admin:1.1.0` +- ECR Public: `docker pull public.ecr.aws/valkey/valkey-admin:1.1.0` + +--- + +## v1.0.1 + +Release Date: June 2026 + +Initial stable release with dashboard, key browser, send command, cluster topology, hot keys monitoring, and command logs.