Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 28 additions & 20 deletions content/develop/tools/insight/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Redis Insight is a powerful tool for visualizing and optimizing data in Redis, m
* Use a form to enter your connection details and add any Redis database running anywhere (including Redis Open Source cluster or sentinel).
* Connect to a Redis Data Integration (RDI) management plane, create, test, and deploy RDI pipelines, and view RDI statistics.

<img src="images/Databases.png">
{{< image filename="images/ri/ri-databases.png" alt="The databases screen" >}}

{{< note >}}
When you add a Redis database for a particular user using the `username` and `password` fields, that user must be able to run the `INFO` command. See the [access control list (ACL) documentation]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) for more information.
Expand All @@ -56,9 +56,15 @@ Currently, Redis Copilot provides two primary features: a general chatbot and a

**My data chatbot**: the context-aware chatbot available in Redis Insight lets you construct search queries using everyday language rather than requiring specific programming syntax. This feature lets you query and explore data easily and interactively without extensive technical knowledge.

Before you can use Redis Copilot, you must first sign in and accept the terms of use. Click on the Redis Copilot icon in the top right corner of the Redis Insight window to sign in and accept the terms of use.

{{< image filename="images/ri/ri-redis-copilot-icon.png" alt="The Redis Copilot icon" >}}

{{< image filename="images/ri/ri-redis-copilot-signin.png" alt="The Redis Copilot sign in screen" >}}

Here's an example of using Redis Copilot to search data using a simple, natural language prompt.

<img src="images/copilot-example.png">
{{< image filename="images/ri/ri-redis-copilot-query.png" alt="An example of using Redis Copilot to search data" >}}

See the [Redis Insight Copilot FAQ]({{< relref "/develop/tools/insight/copilot-faq" >}}) for more information.

Expand All @@ -69,45 +75,47 @@ Redis Insight includes Redis Data Integration (RDI) connectivity, which allows y
### 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 [JSON]({{< relref "/develop/data-types/json/" >}})
* Group keys according to their namespaces

<img src="images/Browser.png">
* [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) support for lists, hashes, strings, sets, sorted sets, and streams.
* CRUD support for [JSON]({{< relref "/develop/data-types/json/" >}}).
* Group keys according to their namespaces.

* 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">
{{< image filename="images/ri/ri-browser.png" alt="The Browser tool" >}}

### Profiler

Analyze every command sent to Redis in real time.
Analyze every command sent to Redis in real time. To use the profiler, click **Profiler** at the bottom left of the screen. It should reveal the profiler window, and there you can start the profiler by clicking on **Start Profiler**.

<img src="images/Profiler.png">
{{< image filename="images/ri/ri-profiler.png" alt="The Profiler tool" >}}

### CLI

The CLI is accessible at any time within the application.
* Employs integrated help to deliver intuitive assistance
The CLI is accessible at any time within the application. To use the CLI, click **>_ CLI** at the bottom left of the screen. It should reveal the CLI window, and there you can start typing Redis [commands]({{< relref "/commands" >}}).

The CLI includes the following features:

* 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">
{{< image filename="images/ri/ri-cli.png" alt="The CLI tool" >}}

### Workbench

Workbench is an advanced command line interface with intelligent command auto-complete and complex data visualization support.

* Built-in guides: you can conveniently discover Redis and Redis Open Source features using the built-in guides.
* Command auto-complete support for all features in Redis and Redis Open Source.
* Advanced, schema-aware auto-complete for Redis Query Engine, which provides for faster query building with context-sensitive suggestions that recognize indexes, schemas, and fields based on your current query. Start typing any Redis Query Engine command in to try this feature. See below for an example of an in-progress `FT.SEARCH` command.

<img src="images/Workbench_Search.png">
{{< image filename="images/ri/ri-workbench.png" alt="An example of an in-progress FT.SEARCH command" >}}

Workbench also includes:

* Visualizations of your indexes, queries, and aggregations.
* Visualizations of your [time series]({{< relref "/develop/data-types/timeseries/" >}}) data.

<img src="images/Workbench_TimeSeries.png">
{{< image filename="images/ri/ri-workbench-timeseries.png" alt="Visualizations of time series data" >}}

## Tools

Expand All @@ -119,21 +127,21 @@ Use the database analysis tool to optimize the performance and memory usage of y
The database analysis tool will only analyze up to 10,000 keys. If more than 10,000 keys are present, the tool will attempt to use extrapolation in its analysis.
{{< /note >}}

<img src="images/database_analysis.png">
{{< image filename="images/ri/ri-analysis.png" alt="The database analysis tool" >}}

### 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 Redis Insight.

<img src="images/streams.png">
{{< image filename="images/ri/ri-streams.png" alt="Redis Streams support" >}}

### Search features

If you're using the indexing, querying, or full-text search features of Redis Open Source, Redis Insight 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">
{{< image filename="images/ri/ri-search.png" alt="Search features" >}}

### Bulk actions

Expand All @@ -142,13 +150,13 @@ Easily and quickly delete multiple keys of the same type and/or with the same ke
When the bulk deletion is completed, Redis Insight 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">
{{< image filename="images/ri/ri-bulk-actions.png" alt="Bulk actions" >}}

### 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">
{{< image filename="images/ri/ri-slow-log.png" alt="Slow Log" >}}

## Plugins

Expand Down
Binary file removed content/develop/tools/insight/images/Browser.png
Binary file not shown.
Binary file removed content/develop/tools/insight/images/CLI.png
Binary file not shown.
Binary file removed content/develop/tools/insight/images/Databases.png
Binary file not shown.
Binary file removed content/develop/tools/insight/images/Profiler.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
22 changes: 0 additions & 22 deletions content/develop/tools/insight/images/ico-redisinsight.svg

This file was deleted.

Binary file not shown.
Binary file removed content/develop/tools/insight/images/search.png
Binary file not shown.
Binary file removed content/develop/tools/insight/images/slowlog.png
Binary file not shown.
Binary file removed content/develop/tools/insight/images/streams.png
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
aliases: /develop/connect/insight/tutorials/insight-stream-consumer
aliases:
- /develop/connect/insight/tutorials/insight-stream-consumer
- /develop/tools/insight/tutorials/insight-stream-consumer
categories:
- docs
- develop
Expand Down Expand Up @@ -31,8 +33,7 @@ In this stream, sensors are considered _producers_, which broadcast data.
A _consumer_ reads from the stream and does some work on it.
For example, if the temperature is above a certain threshold, it puts a message out to turn on the air conditioner in that unit or notify the maintenance.

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

{{< image filename="images/ri/stream.png" alt="A stream that models temperature and humidity sensors." >}}

It is possible to have multiple consumers doing different jobs, one measuring humidity, and another taking temperature measurements over periods of time.
Redis stores a copy of the entire dataset in memory, which is a finite resource.
Expand All @@ -51,7 +52,7 @@ There are a couple of ways of retrieving things. You can retrieve entries by tim

A more realistic use case would be a system with many temperature sensors whose data Redis puts in a stream, records the time they arrive, and orders them.

<img src="../images/consumer.png">
{{< image filename="images/ri/consumer.png" alt="A stream that models temperature and humidity sensors." >}}

On the right side we have two consumers that read the stream. One of them is alerting if the temperature is over a certain number and texting the maintenance crew that they need to do something, and the other is a data warehouse that is taking the data and putting it into a database.

Expand Down Expand Up @@ -193,8 +194,7 @@ Note that in this model, each consumer instance does not receive all of the entr
2. Select `localhost:6379`
3. Select **STREAM**. Optionally, select full screen from the upper right corner to expand the view.

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

{{< image filename="../images/ri/ri-streams-cg.png" alt="The Streams view in Redis Insight." >}}

You can now toggle between **Stream** and **Consumer Groups** views to see your data.
As mentioned earlier in this topic, a stream is an append-only log so you can't modify the contents of an entry, but you can delete an entire entry.
Expand All @@ -211,4 +211,4 @@ Use streams for auditing and processing events in banking, gaming, supply chain,
## Related topics

- [Redis Streams]({{< relref "/develop/data-types/streams" >}})
- [Introducing Redis Streams with Redis Insight, node.js, and Python](https://www.youtube.com/watch?v=q2UOkQmIo9Q) (video)
- [Introducing Redis Streams with Redis Insight, node.js, and Python](https://www.youtube.com/watch?v=q2UOkQmIo9Q) (video)
42 changes: 23 additions & 19 deletions content/develop/tools/insight/rdi-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,29 @@ You can read more about RDI's ingest architecture [on these pages]({{< relref "/

As of version `2.54.0`, Redis Insight includes RDI connectivity, which allows you to connect to [RDI management planes]({{< relref "/integrate/redis-data-integration/architecture" >}}#how-rdi-is-deployed), create, test, and deploy [RDI pipelines]({{< relref "/integrate/redis-data-integration/data-pipelines" >}}), and view RDI statistics.

{{< note >}}
Most of the screenshots on this page were taken using a previous version of Redis Insight. The functionality is the same in the current version, but the user interface has changed.
{{< /note >}}

## Connect

Open Redis Insight, click on the **Redis Data Integration** tab, and then click on one of the two **+ Add RDI Endpoint** buttons as shown below.
Open Redis Insight and then click on the **Redis Data Integration** tab, which looks like this:

<img src="../images/ri-rdi-add-endpoint1.png">
{{< image filename="images/ri/ri-rdi-main.png" alt="Redis Data Integration tab" >}}

Enter your RDI server details in the provided dialog. The **RDI Alias** field can be any name you choose and it will be used as the primary name in the **RDI Instances** list view.
Next, click on **Let's connect to RDI**, which will open the **Add RDI Endpoint** dialog.

<img src="../images/ri-rdi-add-endpoint2.png">
{{< image filename="images/ri/ri-rdi-add-ep.png" alt="Connect to RDI" >}}

You'll receive notification if your connection is successful.
Enter your RDI server details into the dialog. The **RDI Alias** field can be any name you choose and it will be used as the primary name in the **RDI Instances** list view. You'll receive notification if your connection is successful.

<img src="../images/ri-rdi-endpoint-added.png">
{{< image filename="images/ri/ri-rdi-endpoint-added.png" alt="RDI endpoint added" >}}

## Create, test, and deploy RDI pipelines

Begin by clicking the alias of your newly configured RDI endpoint in the **RDI Instances** view (for example, **Test connection** in the above image). You'll see the following dialog in the center of the screen.

<img src="../images/ri-rdi-pl-start.png">
{{< image filename="images/ri/ri-rdi-pl-start.png" alt="Start with your pipeline" >}}

Choose from the following options:

Expand All @@ -52,15 +56,15 @@ Each of these menu options will be described in more detail in subsequent sectio

There are also equivalent buttons at the top of the editor pane for the first two of these functions.

<img src="../images/ri-rdi-pl-editor-minibuttons.png">
{{< image filename="images/ri/ri-rdi-pl-editor-minibuttons.png" alt="Editor minibuttons" >}}

If you'd rather start with an empty configuration, exit the dialog, which will leave you in the **Configuration file** editor where you can begin editing the configuration component of your pipeline; the `config.yaml` file.

### Download a pipeline from your RDI configuration

Click the **Download from server** button in the **Start with your pipeline** dialog to download a previously defined pipeline from your RDI configuration. The downloaded pipeline will be displayed in the **Pipeline management** pane. As shown below, each pipeline consists of a configuration file (`config.yaml`) and zero or more `job` YAML files. The configuration file will be displayed in the center editor panel.

<img src="../images/ri-rdi-pl-dl.png">
{{< image filename="images/ri/ri-rdi-pl-dl.png" alt="Download a pipeline" >}}

### Upload a pipeline from your local machine

Expand All @@ -78,7 +82,7 @@ The `config.yaml` file, your configuration YAML file, is required. The `jobs` di

Click the **Create new pipeline** button in the **Start with your pipeline** dialog to create a new pipeline using the built-in editors. After doing so, you'll enter the **Configuration file** editor and you'll see an open **Select a template** dialog in the upper right-hand corner of the editor.

<img src="../images/ri-rdi-pl-editor-dlg.png">
{{< image filename="images/ri/ri-rdi-pl-editor-dlg.png" alt="Select a template" >}}

Make your selections in the provided fields:

Expand All @@ -99,13 +103,13 @@ After you make your selections and click **Apply**, Redis Insight will populate

See the [RDI documentation]({{< relref "/integrate/redis-data-integration/reference/config-yaml-reference" >}}) for information about required fields.

<img src="../images/ri-rdi-pl-editor-template.png">
{{< image filename="images/ri/ri-rdi-pl-editor-template.png" alt="Editor template" >}}

### Test your target database connection

After you've created your **Target database configuration**, you can test the connection using the **Test Connection** button in the bottom right of the editor pane. A new panel will open to the right containing the test results as shown below.

<img src="../images/ri-rdi-pl-test-cxn.png">
{{< image filename="images/ri/ri-rdi-pl-test-cxn.png" alt="Test connection" >}}

### Create a new transformation job file using the built-in editor

Expand All @@ -119,7 +123,7 @@ The options listed in the above menu depend on the capabilities of your RDI conf

The [RDI documentation]({{< relref "/integrate/redis-data-integration/data-pipelines/transform-examples" >}}) has several examples of transformation jobs that can help get you started. Note: RDI uses a very specific YAML format for job files. See [here]({{< relref "/integrate/redis-data-integration/data-pipelines" >}}#job-files) for more information.

<img src="../images/ri-rdi-job-editor-template.png">
{{< image filename="images/ri/ri-rdi-job-editor-template.png" alt="Job editor template" >}}

## Use the built-in editors

Expand All @@ -130,13 +134,13 @@ The Redis Insight pipeline file editors are context-aware. They provide auto-com

If you decided to write your own configuration pipeline without using a template, you would see auto-completion prompts such as the one shown below.

<img src="../images/ri-rdi-pl-editor-autoc.png">
{{< image filename="images/ri/ri-rdi-pl-editor-autoc.png" alt="Editor autocompletion" >}}

While this isn't a replacement for the RDI documentation, it can help speed you along after you have basic familiarity with the building blocks of RDI pipeline files.

Redis Insight will also highlight any errors as shown below.

<img src="../images/ri-rdi-pl-editor-errs.png">
{{< image filename="images/ri/ri-rdi-pl-editor-errs.png" alt="Editor errors" >}}

Here's an example showing the SQL and JMESPath editor pane. Note the toggle in the bottom left corner of this editor pane. Clicking it allows you to select from:

Expand All @@ -145,12 +149,12 @@ Here's an example showing the SQL and JMESPath editor pane. Note the toggle in t

After constructing your SQLite or JMESPath code, copy it to the main editor window. Here's a [reference]({{< relref "/integrate/redis-data-integration/reference/jmespath-custom-functions" >}}) to the supported JMESPath extension functions and expressions that you can use in your job files.

<img src="../images/ri-rdi-pl-editor-sql-minie.png">
{{< image filename="images/ri/ri-rdi-pl-editor-sql-minie.png" alt="Editor SQL minieditor" >}}

{{< warning >}}
Any changes you make in the editors will be lost if you exit Redis Insight without saving your work. To save any changes you made to your pipeline files, deploy them to your RDI server (see below) or download the modified files as a zip file to your local disk using the **Download** button in the top right of the RDI window. Redis Insight will prepend a green circle on unsaved/undeployed files.

<img src="../images/ri-rdi-pl-unsaved.png">
{{< image filename="images/ri/ri-rdi-pl-unsaved.png" alt="Unsaved pipeline" >}}
{{< /warning >}}

## Dry run transformation job pipelines
Expand All @@ -164,7 +168,7 @@ There are two tabs in the **Results** section:

Here's an example.

<img src="../images/ri-rdi-pl-dryrun.png">
{{< image filename="images/ri/ri-rdi-pl-dryrun.png" alt="Dry run" >}}

## Deploy pipelines and add target DB to Redis Insight

Expand All @@ -177,7 +181,7 @@ Doing so will allow you to monitor key creation from your RDI pipeline over time

You can view various statistics for your RDI deployment. To do so, click the **Pipeline Status** menu button in the left side menu panel.

<img src="../images/ri-rdi-stats-view.png">
{{< image filename="images/ri/ri-rdi-stats-view.png" alt="RDI statistics" >}}

Each statistics section is either static or refreshed automatically at a particular interval that you set.
The first section, **Processing performance information** is set by default to refresh every 5 seconds.
Expand Down
Binary file not shown.
Loading