Skip to content

[DOC UPDATE] Updates RedisInsight docs, adds new sections #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 40 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
0965581
Updates RedisInsight docs, adds new sections
nermiller Feb 23, 2023
afcab27
Update get-started.md
nermiller Feb 23, 2023
20b3b65
Update tools.md
nermiller Feb 23, 2023
23fe892
Update docs/ui/insight/examples.md
nermiller Feb 23, 2023
7088b68
Update docs/ui/insight/tools.md
nermiller Feb 23, 2023
26da4bd
Update docs/ui/insight/tools.md
nermiller Feb 23, 2023
7529b66
Update docs/ui/insight/tools.md
nermiller Feb 23, 2023
54e7a6f
Merge branch 'main' into ri-feature-doc
nermiller Feb 23, 2023
1acecc2
Adds more content plus small updates
nermiller Feb 24, 2023
d859e8e
Updates dictionary, fixes spelling
nermiller Feb 24, 2023
41d7eec
Updates dictionary
nermiller Feb 24, 2023
e16ba58
Updates dictionary
nermiller Feb 24, 2023
3336c1d
Updates dictionary
nermiller Feb 24, 2023
a672f04
Updates best practices
nermiller Mar 13, 2023
3247d2f
Updates install instructions per Pieter's feedback
nermiller Mar 13, 2023
1975d86
Adds more topics
nermiller Apr 3, 2023
596dfd0
Updates dictionary
nermiller Apr 3, 2023
2973f47
Merge branch 'main' into ri-feature-doc
nermiller Apr 3, 2023
0af0aea
Removes tabs
nermiller Apr 3, 2023
cac928d
Updates get-started
nermiller Apr 3, 2023
ff25c10
Additional updates
nermiller Apr 11, 2023
8a8ca3c
Updates to most topics with restructure and incorporated feedback
nermiller Apr 12, 2023
9ca8be2
Updates dictionary
nermiller Apr 12, 2023
9bc5294
Updates dictionary
nermiller Apr 12, 2023
83e9232
Updates dictionary
nermiller Apr 12, 2023
29cfbef
Updates dictionary
nermiller Apr 12, 2023
65d1ad8
Updates About Stack topic per Pieter's and Viktar's feedback
nermiller Apr 12, 2023
01b1d86
Update docs/ui/insight/get-started.md
nermiller Apr 14, 2023
8a7f7d4
Update docs/ui/insight/get-started.md
nermiller Apr 14, 2023
e35f627
Update docs/ui/insight/get-started.md
nermiller Apr 14, 2023
c755180
Update docs/ui/insight/get-started.md
nermiller Apr 14, 2023
08e5d90
Update docs/ui/insight/plugins/plugin-development.md
nermiller Apr 14, 2023
8eb3202
Update docs/ui/insight/plugins/plugin-development.md
nermiller Apr 14, 2023
e2dac13
Update docs/ui/insight/plugins/plugin-development.md
nermiller Apr 14, 2023
21b7c46
Update docs/ui/insight/plugins/plugin-development.md
nermiller Apr 14, 2023
f00a7a2
Update docs/ui/insight/tools/slow-log.md
nermiller Apr 14, 2023
1b5b5e8
Apply suggestions from code review
nermiller Apr 14, 2023
850f049
Applies Viktar's feedback
nermiller Apr 21, 2023
208b573
Merge branch 'main' into ri-feature-doc
nermiller Apr 21, 2023
366fcfd
Updates dictionary
nermiller Apr 21, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,15 @@ createClient
dataset
david-paich.json
dearmor
deserialization
devtools
dotenv
downsampling
dr
entityId
entityStream
epel-release
EVAL
findAllPeople
findByAddress_City
findByAgeBetween
Expand All @@ -197,6 +200,7 @@ geo-location
getters
gpg
gpgcheck=1
hardcode
hmmm
homeLoc
homebrew
Expand Down Expand Up @@ -226,6 +230,8 @@ locationRouter
locationUpdated
lon
lsb_release
LUA
LZO
macOS
maxAge
minAge
Expand All @@ -241,7 +247,9 @@ personalStatement
piña
postalCode
predictively
prev
profiler
programmatically
redis
redis-benchmark
redis-cli
Expand Down Expand Up @@ -293,6 +301,37 @@ x86
XDEL
XLEN
xml
ziplist
ziplists
zshrc
REPL
Slowlog
Lua
8k
3MB
85MB
redis-server
cron
serializer
MessagePack
Sanfilippo
Protobuf
bitset
Hyperloglog
SHA1
sharding
datashards
gzip
IntSet
CRC32
enums
hash-max-ziplist-entries
hash-max-ziplist-values
NamedTuple
MD5
resharding
8kb
prev-
Snapcraft
FlatHub
Autodiscover
2 changes: 1 addition & 1 deletion docs/stack/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ to help you build modern applications where performance is paramount.

## RedisInsight

The best way to get started with Redis Stack is with [RedisInsight](https://docs.redis.com/latest/ri/), a visualization tool for understanding and optimizing Redis data.
The best way to get started with Redis Stack is with [RedisInsight](/docs/ui/insight), a visualization tool for understanding and optimizing Redis data.

RedisInsight allows you to:
* View data structures visually with the Browser tool and group keys according to their namespaces.
Expand Down
109 changes: 2 additions & 107 deletions docs/ui/insight/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: RedisInsight
linkTitle: RedisInsight
description: Visualize and optimize Redis data
weight: 3
weight: 30
aliases:
- /docs/stack/insight
---
Expand All @@ -12,111 +12,6 @@ aliases:

RedisInsight is a powerful tool for visualizing and optimizing data in Redis or Redis Stack, making real-time application development easier and more fun than ever before. RedisInsight lets you do both GUI- and CLI-based interactions in a fully-featured desktop GUI client.

### Download the latest RedisInsight

* Download the latest RedisInsight [here](https://redis.com/redis-enterprise/redis-insight/)
* [RedisInsight Release Notes](https://github.com/RedisInsight/RedisInsight/releases)

## Overview

### Connection management

* Automatically discover and add your local Redis or Redis Stack databases (that use standalone connection type and do not require authentication).
* Discover your databases in Redis Enterprise Cluster and databases with Flexible plans in Redis Cloud.
* Use a form to enter your connection details and add any Redis database running anywhere (including OSS Cluster, Sentinel).

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

### Browser

Browse, filter and visualize your key-value Redis data structures.
* [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) support for lists, hashes, strings, sets, sorted sets, and streams
* CRUD support for [RedisJSON](/docs/stack/json)
* Group keys according to their namespaces

<img src="images/Browser.png">

* 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.

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

### Profiler

Analyze every command sent to Redis in real time.

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

### CLI

The CLI is accessible at any time within the application.
* Employs integrated help to deliver intuitive assistance
* Use together with a convenient command helper that lets you search and read on Redis commands.

<img src="images/CLI.png">

### Workbench

Advanced command line interface with intelligent command auto-complete and complex data visualizations.
* Built-in guides: you can conveniently discover Redis and Redis Stack capabilities using the built-in guides.
* Command auto-complete support for all capabilities in Redis and Redis Stack.
* Visualizations of your [RediSearch](https://oss.redis.com/redisearch/) index, queries, and aggregations.
* Visualizations of your [RedisGraph](https://oss.redis.com/redisgraph/).

<img src="images/Workbench_Graph.png">

* Visualizations of your [RedisTimeSeries](https://oss.redis.com/redistimeseries/) data.

<img src="images/Workbench_TimeSeries.png">

## Tools

### Database analysis

Use the database analysis tool to optimize the performance and memory usage of your Redis database. Check data type distribution and memory allocation and review the summary of key expiration time and memory to be freed over time. Inspect the top keys and namespaces sorted by consumed memory or key length and count of keys, respectively. Capture and track the changes in your database by viewing historical analysis reports. Next figure shows a sample database analysis report.

<img src="images/database_analysis.png">

### Redis Streams support

Create and manage streams by adding, removing, and filtering entries per timestamp. To see and work with new entries, enable and customize the automatic refresh rate.

View and manage the list of consumer groups. See existing consumers in a given consumer name as well as the last messages delivered to them. Inspect the list of pending messages, explicitly acknowledge the processed items, or claim unprocessed messages via RedisInsight.

<img src="images/streams.png">

### Search capabilities

If you're using Redis Stack's indexing, querying, or full-text search capabilities, RedisInsight provides UI controls to quickly and conveniently run search queries against a preselected index. You can also create a secondary index of your data in a dedicated pane.

<img src="images/search.png">

### Bulk actions

Easily and quickly delete multiple keys of the same type and/or with the same key name pattern in bulk. To do so, in the List or Tree view, set filters per key type or key names and open the Bulk Actions section. The section displays a summary of all the keys with the expected number of keys that will be deleted based on the set filters.

When the bulk deletion is completed, RedisInsight displays the results of this operation with the number of keys processed and the time taken to delete the keys in bulk.
Use bulk deletion to optimize the usage of your database based on the results from the Redis database analysis.

<img src="images/bulk_actions.png">

### Slow Log

The Slow Log tool displays the list of logs captured by the SLOWLOG command to analyze all commands that exceed a specified runtime, which helps with troubleshooting 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.

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

## Plugins

With RedisInsight you can now also extend the core functionality by building your own data visualizations. See our [plugin documentation](https://github.com/RedisInsight/RedisInsight/wiki/Plugin-Documentation) for more information.

## Telemetry

RedisInsight includes an opt-in telemetry system. This help us improve the developer experience of the app. We value your privacy; all collected data is anonymized.

## Feedback

To provide your feedback, [open a ticket in our RedisInsight repository](https://github.com/RedisInsight/RedisInsight/issues/new).

## License

RedisInsight is licensed under [SSPL](https://github.com/RedisInsight/RedisInsight/blob/main/LICENSE) license.
RedisInsight is licensed under [SSPL](https://github.com/RedisInsight/RedisInsight/blob/main/LICENSE) license.
Loading