From 7537f7109d326fdb11b1d732685d6e0f42c93ace Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Mon, 20 May 2024 08:46:14 -0700 Subject: [PATCH 1/3] DEV: minor updates per recent feedback spreadsheet --- content/commands/acl-setuser/index.md | 2 ++ content/commands/slowlog/index.md | 8 +++++++- .../operate/redisinsight/install/install-on-desktop.md | 2 ++ content/operate/redisinsight/install/install-on-docker.md | 4 +--- content/operate/redisinsight/install/install-on-k8s.md | 8 ++++---- 5 files changed, 16 insertions(+), 8 deletions(-) diff --git a/content/commands/acl-setuser/index.md b/content/commands/acl-setuser/index.md index ccd9a996d7..87a95c517f 100644 --- a/content/commands/acl-setuser/index.md +++ b/content/commands/acl-setuser/index.md @@ -94,6 +94,8 @@ ACL rules are either words like "on", "off", "reset", "allkeys", or are special rules that start with a special character, and are followed by another string (without any space in between), like "+SET". +For information on persisting ACLs, see the [ACL tutorial]({{< relref "/operate/oss_and_stack/management/security/acl" >}}#use-an-external-acl-file) + The following documentation is a reference manual about the capabilities of this command, however our [ACL tutorial]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) may be a more gentle introduction to how the ACL system works in general. ## ACL rules diff --git a/content/commands/slowlog/index.md b/content/commands/slowlog/index.md index 0313889f83..72a2722404 100644 --- a/content/commands/slowlog/index.md +++ b/content/commands/slowlog/index.md @@ -23,6 +23,12 @@ syntax_fmt: SLOWLOG syntax_str: '' title: SLOWLOG --- +The Redis Slow Log is a system to log queries that exceeded a specified execution time. +The execution time does not include I/O operations like talking with the client, sending the reply and so forth, but just the time needed to actually execute the command (this is the only stage of command execution where the thread is blocked and can not serve other requests in the meantime). + +A new entry is added to the slow log whenever a command exceeds the execution time threshold defined by the `slowlog-log-slower-than` configuration directive. + +The maximum number of entries in the slow log is governed by the `slowlog-max-len` configuration directive. This is a container command for slow log management commands. -To see the list of available commands you can call [`SLOWLOG HELP`]({{< relref "/commands/slowlog-help" >}}). +See [`SLOWLOG GET`]({{< relref "/commands/slowlog-get" >}}) for a description of what's stored in the Redis Slow Log. To see the list of available commands use the [`SLOWLOG HELP`]({{< relref "/commands/slowlog-help" >}}) command. diff --git a/content/operate/redisinsight/install/install-on-desktop.md b/content/operate/redisinsight/install/install-on-desktop.md index c181f00757..eb57cf7c24 100644 --- a/content/operate/redisinsight/install/install-on-desktop.md +++ b/content/operate/redisinsight/install/install-on-desktop.md @@ -28,6 +28,8 @@ It is also available on: - Flathub - [Docker Hub]({{< relref "/operate/redisinsight/install/install-on-docker" >}}). +After installation, run the Redis Insight application in the same was as you would run other desktop applications. + ## Build Alternatively, you can also build Redis Insight from source. See the [wiki](https://github.com/RedisInsight/RedisInsight#build) for instructions. \ No newline at end of file diff --git a/content/operate/redisinsight/install/install-on-docker.md b/content/operate/redisinsight/install/install-on-docker.md index 403b8d792a..56f033c69e 100644 --- a/content/operate/redisinsight/install/install-on-docker.md +++ b/content/operate/redisinsight/install/install-on-docker.md @@ -3,9 +3,7 @@ categories: - docs - operate - redisinsight -description: 'How to install Redis Insight on Docker - - ' +description: How to install Redis Insight on Docker linkTitle: Install on Docker title: Install on Docker weight: 2 diff --git a/content/operate/redisinsight/install/install-on-k8s.md b/content/operate/redisinsight/install/install-on-k8s.md index 172e7db49f..02aba25935 100644 --- a/content/operate/redisinsight/install/install-on-k8s.md +++ b/content/operate/redisinsight/install/install-on-k8s.md @@ -3,9 +3,7 @@ categories: - docs - operate - redisinsight -description: 'How to install Redis Insight on Kubernetes - - ' +description: How to install Redis Insight on Kubernetes linkTitle: Install on Kubernetes title: Install on Kubernetes weight: 3 @@ -263,7 +261,9 @@ kubectl apply -f redisinsight.yaml If the deployment will be exposed by a service whose name is 'redisinsight', set `RI_APP_HOST` and `RI_APP_PORT` environment variables to override the environment variables created by the service. {{< /alert >}} -3. Once the deployment has been successfully applied and the deployment is complete, access Redis Insight. This can be accomplished by exposing the deployment as a K8s Service or by using port forwarding, as in the example below: +## Run Redis Insight + +Once the deployment has been successfully applied and the deployment is complete, access Redis Insight. This can be accomplished by exposing the deployment as a K8s Service or by using port forwarding, as in the example below: ```sh kubectl port-forward deployment/redisinsight 5540 From e3959ace97ea52a6df1717ed05aad4b2ef5da5ce Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Mon, 20 May 2024 09:21:55 -0700 Subject: [PATCH 2/3] a few typo updates --- content/commands/acl-setuser/index.md | 2 +- content/commands/slowlog/index.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/commands/acl-setuser/index.md b/content/commands/acl-setuser/index.md index 87a95c517f..b66bbd6d08 100644 --- a/content/commands/acl-setuser/index.md +++ b/content/commands/acl-setuser/index.md @@ -94,7 +94,7 @@ ACL rules are either words like "on", "off", "reset", "allkeys", or are special rules that start with a special character, and are followed by another string (without any space in between), like "+SET". -For information on persisting ACLs, see the [ACL tutorial]({{< relref "/operate/oss_and_stack/management/security/acl" >}}#use-an-external-acl-file) +For information on persisting ACLs, see the [ACL tutorial]({{< relref "/operate/oss_and_stack/management/security/acl" >}}#use-an-external-acl-file). The following documentation is a reference manual about the capabilities of this command, however our [ACL tutorial]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) may be a more gentle introduction to how the ACL system works in general. diff --git a/content/commands/slowlog/index.md b/content/commands/slowlog/index.md index 72a2722404..9caf29d77c 100644 --- a/content/commands/slowlog/index.md +++ b/content/commands/slowlog/index.md @@ -24,11 +24,11 @@ syntax_str: '' title: SLOWLOG --- The Redis Slow Log is a system to log queries that exceeded a specified execution time. -The execution time does not include I/O operations like talking with the client, sending the reply and so forth, but just the time needed to actually execute the command (this is the only stage of command execution where the thread is blocked and can not serve other requests in the meantime). +The execution time does not include I/O operations like talking with the client, just the time needed to execute the command (this is the only stage of command execution where the thread is blocked and cannot serve other requests). A new entry is added to the slow log whenever a command exceeds the execution time threshold defined by the `slowlog-log-slower-than` configuration directive. The maximum number of entries in the slow log is governed by the `slowlog-max-len` configuration directive. This is a container command for slow log management commands. -See [`SLOWLOG GET`]({{< relref "/commands/slowlog-get" >}}) for a description of what's stored in the Redis Slow Log. To see the list of available commands use the [`SLOWLOG HELP`]({{< relref "/commands/slowlog-help" >}}) command. +See [`SLOWLOG GET`]({{< relref "/commands/slowlog-get" >}}) for a description of what's stored in the Redis slow log. To see the list of available commands use the [`SLOWLOG HELP`]({{< relref "/commands/slowlog-help" >}}) command. From 71519c621a2498d0b65269dd05d40d5e5e1978db Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Mon, 20 May 2024 09:33:18 -0700 Subject: [PATCH 3/3] DEV: also updating vector search article --- content/develop/get-started/vector-database.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/develop/get-started/vector-database.md b/content/develop/get-started/vector-database.md index 8a98e6b10d..0985455601 100644 --- a/content/develop/get-started/vector-database.md +++ b/content/develop/get-started/vector-database.md @@ -47,6 +47,8 @@ This free Redis Cloud database comes out of the box with all the Redis Stack fea You can alternatively use the [installation guides]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) to install Redis Stack on your local machine. +You need to have the following features configured for your Redis server: JSON and search and query. + ## Install the required Python packages The code examples are currently provided for Redis CLI and Python. For Python, you will need to create a virtual environment and install the following Python packages: