Skip to content

Commit 850f049

Browse files
committed
Applies Viktar's feedback
1 parent 1b5b5e8 commit 850f049

File tree

10 files changed

+103
-39
lines changed

10 files changed

+103
-39
lines changed

docs/ui/insight/get-started.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ redisinsight
4747

4848
* Go to [Apple Store](https://apps.apple.com/us/app/redisinsight/id6446987963) and download the RedisInsight app.
4949

50-
5150
## Install on Linux
5251

5352
**From website**
@@ -56,13 +55,8 @@ redisinsight
5655

5756
1. Open the Linux command line and install the package.
5857

59-
* For Debian, run:
60-
61-
```
62-
sudo apt install ./RedisInsight-v2-linux-amd64.deb
63-
```
58+
* For the `.AppImage` package:
6459

65-
* For any common Linux distribution, use AppImage.
6660
- To make your downloaded file executable, run:
6761

6862
```
@@ -75,17 +69,28 @@ redisinsight
7569
./RedisInsight-v2-linux-x86_64.AppImage
7670
```
7771
72+
* For Debian, run:
73+
74+
```
75+
sudo apt install ./RedisInsight-v2-linux-amd64.deb
76+
```
77+
78+
7879
**From stores**
7980
8081
* You can install RedisInsight from [Snapcraft](https://snapcraft.io/redisinsight) or [FlatHub](https://flathub.org/apps/details/com.redis.RedisInsight) using instructions available at those sites.
8182
8283
## Add a Redis database
8384
84-
You can add a Redis database manually, create a new Redis Enterprise Cloud database, or connect to an existing database. To try Redis Enterprise Cloud, select **Try Redis Cloud with enhanced database capabilities**.
85+
If you already have a Redis database, you can:
86+
87+
* Add it manually by specifying connection details.
88+
89+
* Auto-discover your Redis Enterprise Cluster or Cloud databases, as well as your Redis Sentinel instances.
8590
86-
If you already have Redis database up and running locally, select **Autodiscover Databases**.
91+
If you need a free Redis database with modern data models and processing engines, select **Try Redis Cloud with enhanced database capabilities**.
8792
88-
Enter the requested details, then click **Submit** or **Add Redis Database**.
93+
If you already have a Redis database up and running locally, RedisInsight automatically searches for it and adds it if found.
8994
9095
Once added, your database appears with **Database Alias**, **Host:Port**, **Connection Type**, **Modules**, and **Last connection**.
9196

docs/ui/insight/plugins/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aliases:
99
With RedisInsight, you can extend the core functionality by building your own data visualizations.
1010

1111
Redis can hold a range of different data types. Visualizing these data types in a format that's convenient to you for validation and debugging is paramount.
12-
You can now easily extend the core functionality of RedisInsight independently by building your own custom visualization plugin.
12+
You can now easily extend the core functionality of RedisInsight independently by building your own custom visualization plugin.
1313

1414
Data visualization provided by the plugin is rendered in the **Workbench** results area and is based on the executed command.
1515
A Redis command can generate its own custom data visualization.

docs/ui/insight/plugins/plugin-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Default plugins are located inside the application.
2222

2323
### Files
2424

25-
`package.json` should be located in the root folder of your plugins. All other files can be included in a subfolder.
25+
`package.json` should be located in the root folder of your plugins. All other files can be included in a sub-folder.
2626

2727
* **pluginName/package.json** *(required)*: Manifest of the plugin
2828
* **pluginName/{anyName}.js** *(required)*: Core script of the plugin

docs/ui/insight/tools/browser.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,21 @@ weight: 10
66

77
---
88

9-
**Browser** offers [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) support for lists, hashes, strings, sets, sorted sets, streams, and [RedisJSON](/docs/stack/json).
9+
**Browser** allows you to visualize and interact with the data stored in your Redis and Redis Stack database.
1010

11-
* Browse, filter, and visualize your key-value Redis data structures.
11+
With the **Browser** tool, you can:
1212

13-
* Group keys according to their namespaces.
13+
* Explore Redis keys, their values, and metadata
14+
* Perform create, read, update, and delete (CRUD) operations on strings, hashes, sets, sorted sets, lists, streams, and JSON.
15+
* Navigate through and analyze your list of keys quicker by grouping keys per their namespaces using the Tree view, or use filters per key name or Redis data type to find the keys you need.
1416

15-
<img src="../../images/Browser.png">
17+
<img src="../../images/Browser.png">
1618

17-
* View, validate, and manage your key values in a human-readable format using formatters that prettify and highlight data in different formats (for example, Unicode, JSON, MessagePack, HEX, and ASCII) in the Browser tool.
19+
The Browser tool also helps you observe, validate, and manage your key values in a human-readable format using formatters that prettify and highlight data in different formats (for example, Unicode, JSON, MessagePack, HEX, ASCII, an so on), as well as automatically decompress your data to display it in a human-readable format, supporting GZIP, LZ4, SNAPPY, and other compressions.
20+
21+
<img src="../../images/data_formatting.png">
22+
23+
Leverage the [Search capabilities](/docs/ui/insight/tools/search) to see and work with found keys and their values, or use a dedicated form to create a secondary index.
24+
25+
Delete keys in bulk from your Redis or Redis Stack database based on the filters set in Browser using [Bulk actions](/docs/ui/insight/tools/bulk-actions).
1826

19-
<img src="../../images/data_formatting.png">

docs/ui/insight/tools/cli.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,16 @@ weight: 10
66

77
---
88

9-
The CLI is accessible at any time within the application. It includes:
9+
While RedisInsight provides a comprehensive graphical interface for managing Redis or Redis Stack, there are many advanced operations that you can perform only by using a command-line interface. For such cases, you can use RedisInsight CLI, which supplements the graphical interface and provides you a greater flexibility and control over your database when you run Redis commands.
1010

11-
* Type-ahead help.
12-
* A command helper that lets you filter and search commands.
11+
RedisInsight CLI is accessible at any time within your database, allowing you to run Redis commands while:
12+
13+
* Investigating the list of keys in **Browser**.
14+
* Receiving or publishing messages in pub/sub.
15+
* Troubleshooting performance issues.
16+
* Optimizing the performance and memory usage of your database based on recommendations displayed in [Database Analysis](/docs/ui/insight/tools/database-analysis).
17+
18+
RedisInsight CLI includes a type-ahead help to assist with the syntax of Redis commands. Also, RedisInsight CLI is integrated with Command Helper which allows you to read about your Redis command used in CLI, or filter and search for any Redis command to learn more about its purpose and syntax.
1319

1420
Try executing Redis commands as shown here.
1521

docs/ui/insight/tools/connection-management.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,12 @@ weight: 10
77

88
---
99

10-
* Automatically discover and add your local Redis or Redis Stack databases (that use the standalone connection type and do not require authentication).
11-
* Discover your databases in Redis Enterprise Software and databases with Flexible plans in Redis Cloud.
12-
* Use a form to enter your connection details and add any Redis database running anywhere (including OSS Cluster and Sentinel).
10+
Before viewing and interacting with your data, optimizing your Redis or Redis Stack database, or troubleshooting performance issues, you must first add the database so RedisInsight can connect to it.
11+
While all your local Redis or Redis Stack databases with the standalone connection type and without any authentication will be automatically identified and added to your list of database connections when RedisInsight launches for the first time, there are many cases when you need to add database connections to work with them via RedisInsight.
12+
To do so, you can use one of the available options:
13+
14+
* Discover your databases in Redis Enterprise Cluster and databases with Flexible plans in Redis Cloud, as well as primary groups from Redis Sentinel
15+
* Use a form to enter your connection details and add any Redis database running anywhere
16+
* Connect to your database connections via SSH tunnels using a password or private key in the PEM format.
1317

1418
<img src="../../images/Databases.png">

docs/ui/insight/tools/profiler.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,24 @@ weight: 10
66

77
---
88

9-
Analyze every command sent to Redis in real time.
9+
Debug and monitor the performance and security of your Redis or Redis Stack instance using the **Profiler** tool.
10+
11+
**Profiler** is a tool based on Redis `MONITOR` command that streams back every command processed by the Redis server in real-time.
12+
13+
**Profiler** can help you to:
14+
15+
* Debug issues with your database.
16+
* Diagnose issues and identify problematic commands.
17+
* Identify performance issues and bottlenecks.
18+
* Detect suspicious activity such as unauthorized access attempts or unusual commands being sent to the Redis server.
19+
* Spot bugs in an application both when using Redis or Redis Stack as a database and as a distributed caching system.
20+
21+
{{% alert title="Note" color="warning" %}}
22+
23+
Because `MONITOR` streams back all commands, its use comes at a cost of reducing the throughput of your database. Therefore, avoid running **Profiler** in production databases.
24+
25+
{{% /alert %}}
26+
27+
RedisInsight also allows you to download the file with all the logs streamed back to analyze them outside of the application. Before starting the **Profiler**, enable saving to save the logs to a `.txt` file.
1028

1129
<img src="../../images/Profiler.png">

docs/ui/insight/tools/search.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
---
22
title: "Search capabilities"
33
linkTitle: Search
4-
description: Learn how RedisInsight allows you to index and perform search queries
4+
description: RedisInsight allows you to index and perform search queries
55
weight: 10
66
aliases:
77
---
88

9-
If you're using Redis Stack's indexing, querying, or full-text search capabilities, RedisInsight provides UI controls to run search queries against a preselected index. You can also create a secondary index of your data in a dedicated pane.
9+
Search for keywords and phrases within your documents stored as Redis hashes or JSON with dedicated UI controls to run search queries against a pre-selected index.
10+
If you use the search capability and would like to use a dedicated UI in RedisInsight:
1011

11-
<img src="../../images/search.png">
12+
1. In **Browser**, open **Search by Values of Keys**.
13+
1. Select your index.
14+
1. Insert the search query.
15+
1. Run the query.
16+
17+
RedisInsight displays the list of keys found in the List or Tree view.
18+
19+
<img src="../../images/search.png">
20+
21+
RedisInsight also provides UI controls to create a new secondary index of your data. To create such an index, specify basic index information.

docs/ui/insight/tools/slow-log.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@ weight: 10
66

77
---
88

9-
The Slow Log tool displays the list of logs captured by the `SLOWLOG` command, which allows you to analyze all commands that exceed a specified runtime and helps you troubleshoot performance issues. Specify both the runtime and the maximum length of Slowlog (which are server configurations) to configure the list of commands logged and set the auto-refresh interval to automatically update the list of commands displayed.
9+
Use **Slow Log** to:
10+
11+
* Monitor and improve the performance of your Redis and Redis Stack databases.
12+
* Identify Redis commands that are running slowly and that can negatively impact the performance of your database.
13+
* Identify other issues such as increased latency or reduced throughput.
14+
15+
To get started:
16+
17+
1. Select **Analysis Tools > Slow Log**.
18+
19+
1. In **Configure**, specify both the runtime and the maximum length of `SLOWLOG` to configure the list of commands logged.
20+
21+
1. Under **Last refresh** dropdown, set the auto-refresh interval to `Auto Refresh` to automatically update the list of commands displayed.
22+
23+
Using `SLOWLOG`, RedisInsight captures the list of slow commands.
24+
25+
Investigate slow commands so you can optimize your Redis or Redis Stack database and ensure faster response times and improved application performance.
1026

1127
<img src="../../images/slowlog.png">

docs/ui/insight/tools/workbench.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,14 @@ weight: 10
66

77
---
88

9-
Workbench is a command-line interface with intelligent command auto-complete and complex data visualizations that lets you run commands against your Redis server.
10-
Find Workbench on the left sidebar. It provides:
9+
**Workbench** is an advanced command-line interface that lets you run commands against your Redis or Redis Stack database. It:
1110

12-
* Built-in tutorials that help you discover Redis and Redis Stack capabilities using the built-in guides.
13-
* Command auto-complete support for all capabilities in Redis and Redis Stack.
14-
* Visualizations of your [RediSearch](https://oss.redis.com/redisearch/) index, queries, and aggregations.
15-
* Visualizations of your [RedisGraph](https://oss.redis.com/redisgraph/).
16-
17-
<img src="../../images/Workbench_Graph.png">
11+
* Supports auto-complete and syntax highlighting for Redis commands.
12+
* Provides data visualizations for many Redis and Redis Stack capabilities, such as search capability, graph and time series, and `CLIENT LIST` command.
13+
<img src="../../images/Workbench_TimeSeries.png">
14+
* Allows you to extend the core functionality by building your own data visualizations. For more information, see [Plugins](/docs/ui/insight/plugins).
1815

19-
* Visualizations of your [RedisTimeSeries](https://oss.redis.com/redistimeseries/) data.
16+
Use built-in interactive guides and tutorials to discover and learn Redis and Redis Stack features and capabilities.
2017

21-
<img src="../../images/Workbench_TimeSeries.png">
18+
Share your Redis expertise with your team and the wider community by building custom RedisInsight tutorials. Use our [instructions](https://github.com/RedisInsight/Tutorials) to describe your implementations of Redis for other users to follow and interact with in the context of a connected Redis database.
19+
Let the community discover your content by labeling your GitHub repository [redis-tutorials](https://github.com/topics/redis-tutorials).

0 commit comments

Comments
 (0)