url
stringlengths 38
157
| content
stringlengths 72
15.1M
|
|---|---|
https://redis.io/docs/latest/commands/lpos/.html | <section class="prose w-full py-12">
<h1 class="command-name">
LPOS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">LPOS key element [RANK rank] [COUNT num-matches] [MAXLEN len]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
6.0.6
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@list
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The command returns the index of matching elements inside a Redis list.
By default, when no options are given, it will scan the list from head to tail,
looking for the first match of "element". If the element is found, its index (the zero-based position in the list) is returned. Otherwise, if no match is found,
<code>
nil
</code>
is returned.
</p>
<pre tabindex="0"><code>> RPUSH mylist a b c 1 2 3 c c
> LPOS mylist c
2
</code></pre>
<p>
The optional arguments and options can modify the command's behavior.
The
<code>
RANK
</code>
option specifies the "rank" of the first element to return, in case there are multiple matches. A rank of 1 means to return the first match, 2 to return the second match, and so forth.
</p>
<p>
For instance, in the above example the element "c" is present multiple times, if I want the index of the second match, I'll write:
</p>
<pre tabindex="0"><code>> LPOS mylist c RANK 2
6
</code></pre>
<p>
That is, the second occurrence of "c" is at position 6.
A negative "rank" as the
<code>
RANK
</code>
argument tells
<code>
LPOS
</code>
to invert the search direction, starting from the tail to the head.
</p>
<p>
So, we want to say, give me the first element starting from the tail of the list:
</p>
<pre tabindex="0"><code>> LPOS mylist c RANK -1
7
</code></pre>
<p>
Note that the indexes are still reported in the "natural" way, that is, considering the first element starting from the head of the list at index 0, the next element at index 1, and so forth. This basically means that the returned indexes are stable whatever the rank is positive or negative.
</p>
<p>
Sometimes we want to return not just the Nth matching element, but the position of all the first N matching elements. This can be achieved using the
<code>
COUNT
</code>
option.
</p>
<pre tabindex="0"><code>> LPOS mylist c COUNT 2
[2,6]
</code></pre>
<p>
We can combine
<code>
COUNT
</code>
and
<code>
RANK
</code>
, so that
<code>
COUNT
</code>
will try to return up to the specified number of matches, but starting from the Nth match, as specified by the
<code>
RANK
</code>
option.
</p>
<pre tabindex="0"><code>> LPOS mylist c RANK -1 COUNT 2
[7,6]
</code></pre>
<p>
When
<code>
COUNT
</code>
is used, it is possible to specify 0 as the number of matches, as a way to tell the command we want all the matches found returned as an array of indexes. This is better than giving a very large
<code>
COUNT
</code>
option because it is more general.
</p>
<pre tabindex="0"><code>> LPOS mylist c COUNT 0
[2,6,7]
</code></pre>
<p>
When
<code>
COUNT
</code>
is used and no match is found, an empty array is returned. However when
<code>
COUNT
</code>
is not used and there are no matches, the command returns
<code>
nil
</code>
.
</p>
<p>
Finally, the
<code>
MAXLEN
</code>
option tells the command to compare the provided element only with a given maximum number of list items. So for instance specifying
<code>
MAXLEN 1000
</code>
will make sure that the command performs only 1000 comparisons, effectively running the algorithm on a subset of the list (the first part or the last part depending on the fact we use a positive or negative rank). This is useful to limit the maximum complexity of the command. It is also useful when we expect the match to be found very early, but want to be sure that in case this is not true, the command does not take too much time to run.
</p>
<p>
When
<code>
MAXLEN
</code>
is used, it is possible to specify 0 as the maximum number of comparisons, as a way to tell the command we want unlimited comparisons. This is better than giving a very large
<code>
MAXLEN
</code>
option because it is more general.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> RPUSH mylist a b c d 1 2 3 4 3 3 3
(integer) 11
redis> LPOS mylist 3
(integer) 6
redis> LPOS mylist 3 COUNT 0 RANK 2
1) (integer) 8
2) (integer) 9
3) (integer) 10
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<p>
Any of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Nil reply
</a>
: if there is no matching element.
</li>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: an integer representing the matching element.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: If the COUNT option is given, an array of integers representing the matching elements (or an empty array if there are no matches).
</li>
</ul>
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<p>
Any of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#nulls">
Null reply
</a>
: if there is no matching element.
</li>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: an integer representing the matching element.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: If the COUNT option is given, an array of integers representing the matching elements (or an empty array if there are no matches).
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/lpos/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/tools/redis-for-vscode/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis for VS Code
</h1>
<p class="text-lg -mt-5 mb-10">
Connect to Redis from Visual Studio Code.
</p>
<p>
Redis for VS Code is an extension that allows you to connect to your Redis databases from within Microsoft Visual Studio Code.
After connecting to a database, you can view, add, modify, and delete keys, and interact with your Redis databases using a Redis Insight like UI and also a built-in CLI interface.
The following data types are supported:
</p>
<ul>
<li>
<a href="/docs/latest/develop/data-types/hashes/">
Hash
</a>
</li>
<li>
<a href="/docs/latest/develop/data-types/lists/">
List
</a>
</li>
<li>
<a href="/docs/latest/develop/data-types/sets/">
Set
</a>
</li>
<li>
<a href="/docs/latest/develop/data-types/sorted-sets/">
Sorted Set
</a>
</li>
<li>
<a href="/docs/latest/develop/data-types/strings/">
String
</a>
</li>
<li>
<a href="/docs/latest/develop/data-types/json/">
JSON
</a>
</li>
</ul>
<h2 id="install-the-redis-for-vs-code-extension">
Install the Redis for VS Code extension
</h2>
<p>
Open VS Code and click on the
<strong>
Extensions
</strong>
menu button. In the
<strong>
Search Extensions in Marketplace
</strong>
field, type "Redis for VS Code" and press the
<code>
enter
</code>
or
<code>
return
</code>
key. There may be more than one option shown, so be sure to click on the extension published by Redis. The correct extension is shown below. Click on the
<strong>
Install
</strong>
to install the extension.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-install1.png" sdata-lightbox="/images/dev/connect/vscode/vscode-install1.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-install1.png"/>
</a>
<p>
Once installed, check the
<strong>
Auto Update
</strong>
button to allow VS Code to install future revisions of the extension automatically.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-install2.png" sdata-lightbox="/images/dev/connect/vscode/vscode-install2.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-install2.png"/>
</a>
<p>
After installing the extension, your VS Code menu will look similar to the following.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-menu.png" sdata-lightbox="/images/dev/connect/vscode/vscode-menu.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-menu.png"/>
</a>
<h2 id="connect-db">
Connect to Redis databases
</h2>
<p>
Click on the Redis mark (the cursive
<strong>
R
</strong>
) in the VS Code menu to begin connecting a Redis database to VS Code. If you do not currently have access to a Redis database, consider giving Redis Cloud a try.
<a href="https://redis.io/try-free/">
It's free
</a>
.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-initial.png" sdata-lightbox="/images/dev/connect/vscode/vscode-initial.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-initial.png"/>
</a>
<p>
Click on the
<strong>
+ Connect database
</strong>
button. A dialog will display in the main pane. In the image shown below, all the options have been checked to show the available details for each connection. These connection details are similar to those accessible from
<a href="/docs/latest/develop/tools/cli/">
<code>
redis-cli
</code>
</a>
.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
In the first release of Redis for VS Code, there is no way to change the logical database after you have selected it. If you need to connect to a different logical database, you need to add a separate database connection.
</div>
</div>
<a href="/docs/latest/images/dev/connect/vscode/vscode-add-menu.png" sdata-lightbox="/images/dev/connect/vscode/vscode-add-menu.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-add-menu.png"/>
</a>
<p>
After filling out the necessary fields, click on the
<strong>
Add Redis database
</strong>
button. The pane on the left side, where you would normally see the Explorer view, shows your database connections.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-cnx-view.png" sdata-lightbox="/images/dev/connect/vscode/vscode-cnx-view.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-cnx-view.png"/>
</a>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Local databases, excluding OSS cluster databases, with default usernames and no passwords will automatically be added to your list of database connections.
</div>
</div>
<h3 id="connection-tools">
Connection tools
</h3>
<p>
Several tools are displayed for each open connection.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-cnx-tools.png" sdata-lightbox="/images/dev/connect/vscode/vscode-cnx-tools.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-cnx-tools.png"/>
</a>
<p>
Left to right, they are:
</p>
<ul>
<li>
Refresh connection, which retrieves fresh data from the connected Redis database.
</li>
<li>
Edit connection, which shows a dialog similar to the one described in
<a href="#connect-db">
Connect to Redis Databases
</a>
above.
</li>
<li>
Delete connection.
</li>
<li>
Open CLI. See
<a href="#cli">
CLI tool
</a>
below for more information.
</li>
<li>
Sort keys, either ascending or descending.
</li>
<li>
Filter keys by key name or pattern, and by key type.
</li>
<li>
Add a new key by type: Hash, List, Set, Sorted Set, String, or JSON.
</li>
</ul>
<h2 id="key-view">
Key view
</h2>
<p>
Here's what you'll see when there are no keys in your database (the image on the left) and when keys are present (the image on the right).
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-key-view-w-wo-keys.png" sdata-lightbox="/images/dev/connect/vscode/vscode-key-view-w-wo-keys.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-key-view-w-wo-keys.png"/>
</a>
<p>
Redis for VS Code will automatically group the keys based on the one available setting,
<strong>
Delimiter to separate namespaces
</strong>
, which you can view by clicking on the gear icon in the top-right of the left side pane. Click on the current value to change it. The default setting is the colon (
<code>
:
</code>
) character.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-settings.png" sdata-lightbox="/images/dev/connect/vscode/vscode-settings.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-settings.png"/>
</a>
<p>
Click on a key to display its contents.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-key-view.png" sdata-lightbox="/images/dev/connect/vscode/vscode-key-view.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-key-view.png"/>
</a>
<h3 id="key-editing-tools">
Key editing tools
</h3>
<p>
There are several editing tools that you can use to edit key data. Each data type has its own editing capabilities. The following examples show edits to JSON data. Note that changes to keys are immediately written to the server.
</p>
<ul>
<li>
<strong>
Rename
</strong>
. Click on the key name field to change the name.
</li>
</ul>
<a href="/docs/latest/images/dev/connect/vscode/vscode-edit-name.png" sdata-lightbox="/images/dev/connect/vscode/vscode-edit-name.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-edit-name.png"/>
</a>
<ul>
<li>
<strong>
Set time-to-live (TTL)
</strong>
. Click on the
<strong>
TTL
</strong>
field to set the duration in seconds.
</li>
</ul>
<a href="/docs/latest/images/dev/connect/vscode/vscode-edit-ttl.png" sdata-lightbox="/images/dev/connect/vscode/vscode-edit-ttl.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-edit-ttl.png"/>
</a>
<ul>
<li>
<strong>
Delete
</strong>
. Click on the trash can icons to delete the entire key (highlighted in red) or portions of a key (highlighted in yellow).
</li>
</ul>
<a href="/docs/latest/images/dev/connect/vscode/vscode-edit-del.png" sdata-lightbox="/images/dev/connect/vscode/vscode-edit-del.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-edit-del.png"/>
</a>
<ul>
<li>
<strong>
Add to key
</strong>
. Click on the
<code>
+
</code>
button next to the closing bracket (shown highlighted in green above) to add a new component to a key.
</li>
</ul>
<a href="/docs/latest/images/dev/connect/vscode/vscode-edit-add.png" sdata-lightbox="/images/dev/connect/vscode/vscode-edit-add.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-edit-add.png"/>
</a>
<ul>
<li>
<strong>
Refresh
</strong>
. Click on the refresh icon (the circular arrow) to retrieve fresh data from the server. In the examples below, refresh was clicked (the image on the left) and the key now has a new field called "test" that was added by another Redis client (the image on the right).
</li>
</ul>
<a href="/docs/latest/images/dev/connect/vscode/vscode-recycle-before-after.png" sdata-lightbox="/images/dev/connect/vscode/vscode-recycle-before-after.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-recycle-before-after.png"/>
</a>
<p>
For strings, hashes, lists, sets, and sorted sets, the extension supports numerous value formatters (highlighted in red in the image below). They are:
</p>
<ul>
<li>
Unicode
</li>
<li>
ASCII
</li>
<li>
Binary (blob)
</li>
<li>
HEX
</li>
<li>
JSON
</li>
<li>
Msgpack
</li>
<li>
Pickle
</li>
<li>
Protobuf
</li>
<li>
PHP serialized
</li>
<li>
Java serialized
</li>
<li>
32-bit vector
</li>
<li>
64-bit vector
</li>
</ul>
<a href="/docs/latest/images/dev/connect/vscode/vscode-edit-value-formatters.png" sdata-lightbox="/images/dev/connect/vscode/vscode-edit-value-formatters.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-edit-value-formatters.png"/>
</a>
<p>
Also for Hash keys, you can set per-field TTLs (highlighted in yellow in the image above), a new feature added to Redis Community Edition 7.4.
</p>
<h2 id="cli">
CLI tool
</h2>
<p>
The connection tool with the boxed
<code>
>_
</code>
icon opens a Redis CLI window in the
<strong>
REDIS CLI
</strong>
tab at the bottom of the primary pane.
</p>
<a href="/docs/latest/images/dev/connect/vscode/vscode-cli.png" sdata-lightbox="/images/dev/connect/vscode/vscode-cli.png">
<img src="/docs/latest/images/dev/connect/vscode/vscode-cli.png"/>
</a>
<p>
The CLI interface works just like the
<a href="/docs/latest/develop/tools/cli/">
<code>
redis-cli
</code>
</a>
command.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/tools/redis-for-vscode/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/job_scheduler/cert_rotation_job_settings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Certificate rotation job settings object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the cert_rotation_job_settings object used with Redis Enterprise Software REST API calls.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
cron_expression
</td>
<td>
string
</td>
<td>
<a href="https://en.wikipedia.org/wiki/Cron#CRON_expression">
CRON expression
</a>
that defines the certificate rotation schedule
</td>
</tr>
<tr>
<td>
expiry_days_before_rotation
</td>
<td>
integer, (range: 1-90) (default: 60)
</td>
<td>
Number of days before a certificate expires before rotation
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/job_scheduler/cert_rotation_job_settings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/flush/.html | <section class="prose w-full py-12 max-w-none">
<h1>
crdb-cli crdb flush
</h1>
<p class="text-lg -mt-5 mb-10">
Clears all keys from an Active-Active database.
</p>
<p>
Clears all keys from an Active-Active database.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">crdb-cli crdb flush --crdb-guid <guid>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> --no-wait <span class="o">]</span>
</span></span></code></pre>
</div>
<p>
This command is irreversible. If the data in your database is important, back it up before you flush the database.
</p>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
crdb-guid
</td>
<td>
string
</td>
<td>
The GUID of the database (required)
</td>
</tr>
<tr>
<td>
no-wait
</td>
<td>
</td>
<td>
Does not wait for the task to complete
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns the task ID of the task clearing the database.
</p>
<p>
If
<code>
--no-wait
</code>
is specified, the command exits. Otherwise, it will wait for the database to be cleared and return
<code>
finished
</code>
.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ crdb-cli crdb flush --crdb-guid d84f6fe4-5bb7-49d2-a188-8900e09c6f66
</span></span><span class="line"><span class="cl">Task 53cdc59e-ecf5-4564-a8dd-448d71f9e568 created
</span></span><span class="line"><span class="cl"> ---> Status changed: queued -> started
</span></span><span class="line"><span class="cl"> ---> Status changed: started -> finished
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/flush/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/clusters/cluster-recovery/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Recover a failed cluster
</h1>
<p class="text-lg -mt-5 mb-10">
How to use the cluster configuration file and database data to recover a failed cluster.
</p>
<p>
When a Redis Enterprise Software cluster fails,
you must use the cluster configuration file and database data to recover the cluster.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
For cluster recovery in a Kubernetes deployment, see
<a href="/docs/latest/operate/kubernetes/re-clusters/cluster-recovery/">
Recover a Redis Enterprise cluster on Kubernetes
</a>
.
</div>
</div>
<p>
Cluster failure can be caused by:
</p>
<ul>
<li>
A hardware or software failure that causes the cluster to be unresponsive to client requests or administrative actions.
</li>
<li>
More than half of the cluster nodes lose connection with the cluster, resulting in quorum loss.
</li>
</ul>
<p>
To recover a cluster and re-create it as it was before the failure,
you must restore the cluster configuration
<code>
ccs-redis.rdb
</code>
to the cluster nodes.
To recover databases in the new cluster, you must restore the databases from persistence files such as backup files, append-only files (AOF), or RDB snapshots.
These files are stored in the
<a href="/docs/latest/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/">
persistent storage location
</a>
.
</p>
<p>
The cluster recovery process includes:
</p>
<ol>
<li>
Install Redis Enterprise Software on the nodes of the new cluster.
</li>
<li>
Mount the persistent storage with the recovery files from the original cluster to the nodes of the new cluster.
</li>
<li>
Recover the cluster configuration on the first node in the new cluster.
</li>
<li>
Join the remaining nodes to the new cluster.
</li>
<li>
<a href="/docs/latest/operate/rs/databases/recover/">
Recover the databases
</a>
.
</li>
</ol>
<h2 id="prerequisites">
Prerequisites
</h2>
<ul>
<li>
We recommend that you recover the cluster to clean nodes.
If you use the original nodes,
make sure there are no Redis processes running on any nodes in the new cluster.
</li>
<li>
We recommend that you use clean persistent storage drives for the new cluster.
If you use the original storage drives,
make sure you back up the files on the original storage drives to a safe location.
</li>
<li>
Identify the cluster configuration file that you want to use as the configuration for the recovered cluster.
The cluster configuration file is
<code>
/css/ccs-redis.rdb
</code>
on the persistent storage for each node.
</li>
</ul>
<h2 id="recover-the-cluster">
Recover the cluster
</h2>
<ol>
<li>
<p>
(Optional) If you want to recover the cluster to the original cluster nodes, uninstall Redis Enterprise Software from the nodes.
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/installing-upgrading/install/install-on-linux/">
Install Redis Enterprise Software
</a>
on the new cluster nodes.
</p>
<p>
The new servers must have the same basic hardware and software configuration as the original servers, including:
</p>
<ul>
<li>
The same number of nodes
</li>
<li>
At least the same amount of memory
</li>
<li>
The same Redis Enterprise Software version
</li>
<li>
The same installation user and paths
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
The cluster recovery can fail if these requirements are not met.
</div>
</div>
</li>
<li>
<p>
Mount the persistent storage drives with the recovery files to the new nodes.
These drives must contain the cluster configuration backup files and database persistence files.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Make sure that the user redislabs has permissions to access the storage location
of the configuration and persistence files on each of the nodes.
</div>
</div>
<p>
If you use local persistent storage, place all of the recovery files on each of the cluster nodes.
</p>
</li>
<li>
<p>
To recover the original cluster configuration, run
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/recover/">
<code>
rladmin cluster recover
</code>
</a>
on the first node in the new cluster:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster recover filename <span class="o">[</span> <persistent_path> <span class="p">|</span> <ephemeral_path> <span class="o">]</span><filename> node_uid <node_uid> rack_id <rack_id>
</span></span></code></pre>
</div>
<p>
For example:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster recover filename /tmp/persist/ccs/ccs-redis.rdb node_uid <span class="m">1</span> rack_id <span class="m">5</span>
</span></span></code></pre>
</div>
<p>
When the recovery command succeeds,
this node is configured as the node from the old cluster that has ID 1.
</p>
</li>
<li>
<p>
To join the remaining servers to the new cluster, run
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/join/">
<code>
rladmin cluster join
</code>
</a>
from each new node:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster join nodes <cluster_member_ip_address> username <username> password <password> replace_node <node_id>
</span></span></code></pre>
</div>
<p>
For example:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster join nodes 10.142.0.4 username [email protected] password mysecret replace_node <span class="m">2</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/">
<code>
rladmin status
</code>
</a>
to verify the recovered nodes are now active and the databases are pending recovery:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin status
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Make sure that you update your
<a href="/docs/latest/operate/rs/networking/cluster-dns/">
DNS records
</a>
with the IP addresses of the new nodes.
</div>
</div>
</li>
</ol>
<p>
After the cluster is recovered, you must
<a href="/docs/latest/operate/rs/databases/recover/">
recover the databases
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/clusters/cluster-recovery/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/objects/statistics/db-metrics/.html | <section class="prose w-full py-12 max-w-none">
<h1>
DB metrics
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the DB metrics used with Redis Enterprise Software REST API calls.
</p>
<table>
<thead>
<tr>
<th>
Metric name
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
avg_latency
</td>
<td>
float
</td>
<td>
Average latency of operations on the DB (microseconds). Only returned when there is traffic.
</td>
</tr>
<tr>
<td>
avg_other_latency
</td>
<td>
float
</td>
<td>
Average latency of other (non read/write) operations (microseconds). Only returned when there is traffic.
</td>
</tr>
<tr>
<td>
avg_read_latency
</td>
<td>
float
</td>
<td>
Average latency of read operations (microseconds). Only returned when there is traffic.
</td>
</tr>
<tr>
<td>
avg_write_latency
</td>
<td>
float
</td>
<td>
Average latency of write operations (microseconds). Only returned when there is traffic.
</td>
</tr>
<tr>
<td>
big_del_flash
</td>
<td>
float
</td>
<td>
Rate of key deletes for keys on flash (BigRedis) (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
big_del_ram
</td>
<td>
float
</td>
<td>
Rate of key deletes for keys in RAM (BigRedis) (key access/sec); this includes write misses (new keys created). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
big_fetch_flash
</td>
<td>
float
</td>
<td>
Rate of key reads/updates for keys on flash (BigRedis) (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
big_fetch_ram
</td>
<td>
float
</td>
<td>
Rate of key reads/updates for keys in RAM (BigRedis) (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
big_io_ratio_flash
</td>
<td>
float
</td>
<td>
Rate of key operations on flash. Can be used to compute the ratio of I/O operations (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
big_io_ratio_redis
</td>
<td>
float
</td>
<td>
Rate of Redis operations on keys. Can be used to compute the ratio of I/O operations (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
big_write_flash
</td>
<td>
float
</td>
<td>
Rate of key writes for keys on flash (BigRedis) (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
big_write_ram
</td>
<td>
float
</td>
<td>
Rate of key writes for keys in RAM (BigRedis) (key access/sec); this includes write misses (new keys created). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
bigstore_io_dels
</td>
<td>
float
</td>
<td>
Rate of key deletions from flash (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
bigstore_io_read_bytes
</td>
<td>
float
</td>
<td>
Throughput of I/O read operations against backend flash
</td>
</tr>
<tr>
<td>
bigstore_io_reads
</td>
<td>
float
</td>
<td>
Rate of key reads from flash (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
bigstore_io_write_bytes
</td>
<td>
float
</td>
<td>
Throughput of I/O write operations against backend flash
</td>
</tr>
<tr>
<td>
bigstore_io_writes
</td>
<td>
float
</td>
<td>
Rate of key writes from flash (key access/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
bigstore_iops
</td>
<td>
float
</td>
<td>
Rate of I/O operations against backend flash for all shards of the DB (BigRedis) (ops/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
bigstore_kv_ops
</td>
<td>
float
</td>
<td>
Rate of value read/write/del operations against backend flash for all shards of the DB (BigRedis) (key access/sec). Only returned when BigRedis is enabled
</td>
</tr>
<tr>
<td>
bigstore_objs_flash
</td>
<td>
float
</td>
<td>
Value count on flash (BigRedis). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
bigstore_objs_ram
</td>
<td>
float
</td>
<td>
Value count in RAM (BigRedis). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
bigstore_throughput
</td>
<td>
float
</td>
<td>
Throughput of I/O operations against backend flash for all shards of the DB (BigRedis) (bytes/sec). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
conns
</td>
<td>
float
</td>
<td>
Number of client connections to the DB’s endpoints
</td>
</tr>
<tr>
<td>
disk_frag_ratio
</td>
<td>
float
</td>
<td>
Flash fragmentation ratio (used/required). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
egress_bytes
</td>
<td>
float
</td>
<td>
Rate of outgoing network traffic to the DB’s endpoint (bytes/sec)
</td>
</tr>
<tr>
<td>
evicted_objects
</td>
<td>
float
</td>
<td>
Rate of key evictions from DB (evictions/sec)
</td>
</tr>
<tr>
<td>
expired_objects
</td>
<td>
float
</td>
<td>
Rate keys expired in DB (expirations/sec)
</td>
</tr>
<tr>
<td>
fork_cpu_system
</td>
<td>
float
</td>
<td>
% cores utilization in system mode for all Redis shard fork child processes of this database
</td>
</tr>
<tr>
<td>
fork_cpu_user
</td>
<td>
float
</td>
<td>
% cores utilization in user mode for all Redis shard fork child processes of this database
</td>
</tr>
<tr>
<td>
ingress_bytes
</td>
<td>
float
</td>
<td>
Rate of incoming network traffic to the DB’s endpoint (bytes/sec)
</td>
</tr>
<tr>
<td>
instantaneous_ops_per_sec
</td>
<td>
float
</td>
<td>
Request rate handled by all shards of the DB (ops/sec)
</td>
</tr>
<tr>
<td>
last_req_time
</td>
<td>
date, ISO_8601 format
</td>
<td>
Last request time received to the DB (ISO format 2015-07-05T22:16:18Z). Returns 1/1/1970 when unavailable.
</td>
</tr>
<tr>
<td>
last_res_time
</td>
<td>
date, ISO_8601 format
</td>
<td>
Last response time received from DB (ISO format 2015-07-05T22:16:18Z). Returns 1/1/1970 when unavailable.
</td>
</tr>
<tr>
<td>
main_thread_cpu_system
</td>
<td>
float
</td>
<td>
% cores utilization in system mode for all Redis shard main threads of this database
</td>
</tr>
<tr>
<td>
main_thread_cpu_user
</td>
<td>
float
</td>
<td>
% cores utilization in user mode for all Redis shard main threads of this database
</td>
</tr>
<tr>
<td>
mem_frag_ratio
</td>
<td>
float
</td>
<td>
RAM fragmentation ratio (RSS/allocated RAM)
</td>
</tr>
<tr>
<td>
mem_not_counted_for_evict
</td>
<td>
float
</td>
<td>
Portion of used_memory (in bytes) not counted for eviction and OOM errors
</td>
</tr>
<tr>
<td>
mem_size_lua
</td>
<td>
float
</td>
<td>
Redis Lua scripting heap size (bytes)
</td>
</tr>
<tr>
<td>
monitor_sessions_count
</td>
<td>
float
</td>
<td>
Number of client connected in monitor mode to the DB
</td>
</tr>
<tr>
<td>
no_of_expires
</td>
<td>
float
</td>
<td>
Number of volatile keys in the DB
</td>
</tr>
<tr>
<td>
no_of_keys
</td>
<td>
float
</td>
<td>
Number of keys in the DB
</td>
</tr>
<tr>
<td>
other_req
</td>
<td>
float
</td>
<td>
Rate of other (non read/write) requests on DB (ops/sec)
</td>
</tr>
<tr>
<td>
other_res
</td>
<td>
float
</td>
<td>
Rate of other (non read/write) responses on DB (ops/sec)
</td>
</tr>
<tr>
<td>
pubsub_channels
</td>
<td>
float
</td>
<td>
Count the pub/sub channels with subscribed clients
</td>
</tr>
<tr>
<td>
pubsub_patterns
</td>
<td>
float
</td>
<td>
Count the pub/sub patterns with subscribed clients
</td>
</tr>
<tr>
<td>
ram_overhead
</td>
<td>
float
</td>
<td>
Non values RAM overhead (BigRedis) (bytes). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
read_hits
</td>
<td>
float
</td>
<td>
Rate of read operations accessing an existing key (ops/sec)
</td>
</tr>
<tr>
<td>
read_misses
</td>
<td>
float
</td>
<td>
Rate of read operations accessing a nonexistent key (ops/sec)
</td>
</tr>
<tr>
<td>
read_req
</td>
<td>
float
</td>
<td>
Rate of read requests on DB (ops/sec)
</td>
</tr>
<tr>
<td>
read_res
</td>
<td>
float
</td>
<td>
Rate of read responses on DB (ops/sec)
</td>
</tr>
<tr>
<td>
shard_cpu_system
</td>
<td>
float
</td>
<td>
% cores utilization in system mode for all Redis shard processes of this database
</td>
</tr>
<tr>
<td>
shard_cpu_user
</td>
<td>
float
</td>
<td>
% cores utilization in user mode for the Redis shard process
</td>
</tr>
<tr>
<td>
total_connections_received
</td>
<td>
float
</td>
<td>
Rate of new client connections to the DB (connections/sec)
</td>
</tr>
<tr>
<td>
total_req
</td>
<td>
float
</td>
<td>
Rate of all requests on DB (ops/sec)
</td>
</tr>
<tr>
<td>
total_res
</td>
<td>
float
</td>
<td>
Rate of all responses on DB (ops/sec)
</td>
</tr>
<tr>
<td>
used_bigstore
</td>
<td>
float
</td>
<td>
Flash used by DB (BigRedis) (bytes). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
used_memory
</td>
<td>
float
</td>
<td>
Memory used by DB (in BigRedis this includes flash) (bytes)
</td>
</tr>
<tr>
<td>
used_ram
</td>
<td>
float
</td>
<td>
RAM used by DB (BigRedis) (bytes). Only returned when BigRedis is enabled.
</td>
</tr>
<tr>
<td>
write_hits
</td>
<td>
float
</td>
<td>
Rate of write operations accessing an existing key (ops/sec)
</td>
</tr>
<tr>
<td>
write_misses
</td>
<td>
float
</td>
<td>
Rate of write operations accessing a nonexistent key (ops/sec)
</td>
</tr>
<tr>
<td>
write_req
</td>
<td>
float
</td>
<td>
Rate of write requests on DB (ops/sec)
</td>
</tr>
<tr>
<td>
write_res
</td>
<td>
float
</td>
<td>
Rate of write responses on DB (ops/sec)
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/objects/statistics/db-metrics/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-4-1/.html | <section class="prose w-full py-12">
<h1>
Redis Data Integration release notes 1.4.1 (November 2024)
</h1>
<p class="text-lg -mt-5 mb-10">
Installation on Kubernetes with a Helm chart. Improvements for installation on VMs.
</p>
<blockquote>
<p>
This maintenance release replaces the 1.4.0 release.
</p>
</blockquote>
<p>
RDI’s mission is to help Redis customers sync Redis Enterprise with live data from their slow disk-based databases to:
</p>
<ul>
<li>
Meet the required speed and scale of read queries and provide an excellent and predictable user experience.
</li>
<li>
Save resources and time when building pipelines and coding data transformations.
</li>
<li>
Reduce the total cost of ownership by saving money on expensive database read replicas.
</li>
</ul>
<p>
RDI keeps the Redis cache up to date with changes in the primary database, using a
<a href="https://en.wikipedia.org/wiki/Change_data_capture">
<em>
Change Data Capture (CDC)
</em>
</a>
mechanism.
It also lets you
<em>
transform
</em>
the data from relational tables into convenient and fast data structures that match your app's requirements. You specify the transformations using a configuration system, so no coding is required.
</p>
<h2 id="headlines">
Headlines
</h2>
<ul>
<li>
<p>
Installation on
<a href="/docs/latest/integrate/redis-data-integration/installation/install-k8s/">
Kubernetes
</a>
using a
<a href="https://helm.sh/docs/">
Helm chart
</a>
. You can install on
<a href="https://docs.openshift.com/">
OpenShift
</a>
or other flavours of K8s using Helm.
</p>
</li>
<li>
<p>
Improvements for installation on VMs:
</p>
<ul>
<li>
Installer checks if the OS firewall is enabled on Ubuntu and RHEL.
</li>
<li>
Installer verifies DNS resolution from RDI components.
</li>
<li>
Installer provides log lines from components that failed during RDI deployment if a problem occurs.
</li>
<li>
Improved verification of RDI installation.
</li>
<li>
Installer verifies if the RDI database is in use by another instance of RDI.
</li>
<li>
Installer checks and warns if any
<a href="https://www.netfilter.org/projects/iptables/index.html">
<code>
iptables
</code>
</a>
rules are set.
</li>
<li>
Improved message when RDI tries to connect to its Redis database with invalid TLS keys.
</li>
</ul>
</li>
</ul>
<h2 id="issues-fixed">
Issues fixed
</h2>
<ul>
<li>
<strong>
RDSC-2806
</strong>
: Remove incorrectly created deployment.
</li>
<li>
<strong>
RDSC-2792
</strong>
: Disable
<code>
kubectl run
</code>
checks.
</li>
<li>
<strong>
RDSC-2782
</strong>
: Fix
<code>
coredns
</code>
issue.
</li>
</ul>
<h2 id="limitations">
Limitations
</h2>
<p>
RDI can write data to a Redis Active-Active database. However, it doesn't support writing data to two or more Active-Active replicas. Writing data from RDI to several Active-Active replicas could easily harm data integrity as RDI is not synchronous with the source database commits.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-4-1/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/bind/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin bind
</h1>
<p class="text-lg -mt-5 mb-10">
Manages the proxy policy for a specified database endpoint.
</p>
<p>
Manages the proxy policy for a specific database endpoint.
</p>
<h2 id="bind-endpoint-exclude">
<code>
bind endpoint exclude
</code>
</h2>
<p>
Defines a list of nodes to exclude from the proxy policy for a specific database endpoint. When you exclude a node, the endpoint cannot bind to the node's proxy.
</p>
<p>
Each time you run an exclude command, it overwrites the previous list of excluded nodes.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> endpoint <id> exclude
</span></span><span class="line"><span class="cl"> <proxy_id1 .. proxy_idN>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Only allows endpoints for the specified database
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
endpoint ID
</td>
<td>
Changes proxy settings for the specified endpoint
</td>
</tr>
<tr>
<td>
proxy
</td>
<td>
list of proxy IDs
</td>
<td>
Proxies to exclude
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns
<code>
Finished successfully
</code>
if the list of excluded proxies was successfully changed. Otherwise, it returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-endpoints">
<code>
rladmin status endpoints
</code>
</a>
to verify that the policy changed.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:2 all-nodes No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-nodes No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-nodes No
</span></span><span class="line"><span class="cl">$ rladmin <span class="nb">bind</span> endpoint 6:1 exclude <span class="m">2</span>
</span></span><span class="line"><span class="cl">Executing <span class="nb">bind</span> endpoint: OOO.
</span></span><span class="line"><span class="cl">Finished successfully
</span></span><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-nodes -2 No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-nodes -2 No
</span></span></code></pre>
</div>
<h2 id="bind-endpoint-include">
<code>
bind endpoint include
</code>
</h2>
<p>
Defines a list of nodes to include in the proxy policy for the specific database endpoint.
</p>
<p>
Each time you run an include command, it overwrites the previous list of included nodes.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> endpoint <id> include
</span></span><span class="line"><span class="cl"> <proxy_id1 .. proxy_idN>
</span></span></code></pre>
</div>
<h3 id="parameters-1">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Only allows endpoints for the specified database
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
endpoint ID
</td>
<td>
Changes proxy settings for the specified endpoint
</td>
</tr>
<tr>
<td>
proxy
</td>
<td>
list of proxy IDs
</td>
<td>
Proxies to include
</td>
</tr>
</tbody>
</table>
<h3 id="returns-1">
Returns
</h3>
<p>
Returns
<code>
Finished successfully
</code>
if the list of included proxies was successfully changed. Otherwise, it returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-endpoints">
<code>
rladmin status endpoints
</code>
</a>
to verify that the policy changed.
</p>
<h3 id="example-1">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-master-shards No
</span></span><span class="line"><span class="cl">$ rladmin <span class="nb">bind</span> endpoint 6:1 include <span class="m">3</span>
</span></span><span class="line"><span class="cl">Executing <span class="nb">bind</span> endpoint: OOO.
</span></span><span class="line"><span class="cl">Finished successfully
</span></span><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-master-shards +3 No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-master-shards +3 No
</span></span></code></pre>
</div>
<h2 id="bind-endpoint-policy">
<code>
bind endpoint policy
</code>
</h2>
<p>
Changes the overall proxy policy for a specific database endpoint.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> endpoint <id>
</span></span><span class="line"><span class="cl"> policy <span class="o">{</span> single <span class="p">|</span> all-master-shards <span class="p">|</span> all-nodes <span class="o">}</span>
</span></span></code></pre>
</div>
<h3 id="parameters-2">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Only allows endpoints for the specified database
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
endpoint ID
</td>
<td>
Changes proxy settings for the specified endpoint
</td>
</tr>
<tr>
<td>
policy
</td>
<td>
<nobr>
'all-master-shards'
</nobr>
<br/>
<nobr>
'all-nodes'
</nobr>
<br/>
'single'
</td>
<td>
Changes the
<a href="#proxy-policies">
proxy policy
</a>
to the specified policy
</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>
Proxy policy
<a name="proxy-policies">
</a>
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
all-master-shards
</td>
<td>
Multiple proxies, one on each master node (best for high traffic and multiple master shards)
</td>
</tr>
<tr>
<td>
all-nodes
</td>
<td>
Multiple proxies, one on each node of the cluster (increases traffic in the cluster, only used in special cases)
</td>
</tr>
<tr>
<td>
single
</td>
<td>
All traffic flows through a single proxy bound to the database endpoint (preferable in most cases)
</td>
</tr>
</tbody>
</table>
<h3 id="returns-2">
Returns
</h3>
<p>
Returns
<code>
Finished successfully
</code>
if the proxy policy was successfully changed. Otherwise, it returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-endpoints">
<code>
rladmin status endpoints
</code>
</a>
to verify that the policy changed.
</p>
<h3 id="example-2">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-nodes -2 No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-nodes -2 No
</span></span><span class="line"><span class="cl">$ rladmin <span class="nb">bind</span> endpoint 6:1 policy all-master-shards
</span></span><span class="line"><span class="cl">Executing <span class="nb">bind</span> endpoint: OOO.
</span></span><span class="line"><span class="cl">Finished successfully
</span></span><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-master-shards No
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/bind/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/security/encryption/tls/ciphers/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Configure cipher suites
</h1>
<p class="text-lg -mt-5 mb-10">
Shows how to configure cipher suites.
</p>
<p>
Ciphers are algorithms that help secure connections between clients and servers. You can change the ciphers to improve the security of your Redis Enterprise cluster and databases. The default settings are in line with industry best practices, but you can customize them to match the security policy of your organization.
</p>
<h2 id="tls-12-cipher-suites">
TLS 1.2 cipher suites
</h2>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Configurable
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
control_cipher_suites
</td>
<td>
<span title="Yes">
✅ Yes
</span>
</td>
<td>
Cipher list for TLS 1.2 communications for cluster administration (control plane)
</td>
</tr>
<tr>
<td>
data_cipher_list
</td>
<td>
<span title="Yes">
✅ Yes
</span>
</td>
<td>
Cipher list for TLS 1.2 communications between applications and databases (data plane)
</td>
</tr>
<tr>
<td>
sentinel_cipher_suites
</td>
<td>
<span title="Yes">
✅ Yes
</span>
</td>
<td>
Cipher list for
<a href="/docs/latest/operate/rs/databases/durability-ha/discovery-service/">
discovery service
</a>
(Sentinel) TLS 1.2 communications
</td>
</tr>
</tbody>
</table>
<h2 id="tls-13-cipher-suites">
TLS 1.3 cipher suites
</h2>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Configurable
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
control_cipher_suites_tls_1_3
</td>
<td>
<span title="No">
❌ No
</span>
</td>
<td>
Cipher list for TLS 1.3 communications for cluster administration (control plane)
</td>
</tr>
<tr>
<td>
data_cipher_suites_tls_1_3
</td>
<td>
<span title="Yes">
✅ Yes
</span>
</td>
<td>
Cipher list for TLS 1.3 communications between applications and databases (data plane)
</td>
</tr>
<tr>
<td>
sentinel_cipher_suites_tls_1_3
</td>
<td>
<span title="No">
❌ No
</span>
</td>
<td>
Cipher list for
<a href="/docs/latest/operate/rs/databases/durability-ha/discovery-service/">
discovery service
</a>
(Sentinel) TLS 1.3 communications
</td>
</tr>
</tbody>
</table>
<h2 id="configure-cipher-suites">
Configure cipher suites
</h2>
<p>
You can configure ciphers with the
<a href="#edit-ciphers-ui">
Cluster Manager UI
</a>
,
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/config/">
<code>
rladmin
</code>
</a>
, or the
<a href="/docs/latest/operate/rs/references/rest-api/requests/cluster/#put-cluster">
REST API
</a>
.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Configuring cipher suites overwrites existing ciphers rather than appending new ciphers to the list.
</div>
</div>
<p>
When you modify your cipher suites, make sure:
</p>
<ul>
<li>
The configured TLS version matches the required cipher suites.
</li>
<li>
The certificates in use are properly signed to support the required cipher suites.
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<ul>
<li>
<p>
Redis Enterprise Software doesn't support static
<a href="https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange">
Diffie–Hellman (
<code>
DH
</code>
) key exchange
</a>
ciphers.
</p>
</li>
<li>
<p>
It does support Ephemeral Diffie–Hellman (
<code>
DHE
</code>
or
<code>
ECDHE
</code>
) key exchange ciphers on Red Hat Enterprise Linux (RHEL) 8 and Bionic OS.
</p>
</li>
</ul>
</div>
</div>
<h3 id="edit-ciphers-ui">
Edit cipher suites in the UI
</h3>
<p>
To configure cipher suites using the Cluster Manager UI:
</p>
<ol>
<li>
<p>
Go to
<strong>
Cluster > Security
</strong>
, then select the
<strong>
TLS
</strong>
tab.
</p>
</li>
<li>
<p>
In the
<strong>
Cipher suites lists
</strong>
section, click
<strong>
Configure
</strong>
:
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/security-tls-cipher-suites-view.png" sdata-lightbox="/images/rs/screenshots/cluster/security-tls-cipher-suites-view.png">
<img alt="Cipher suites lists as shown in the Cluster Manager UI." src="/docs/latest/images/rs/screenshots/cluster/security-tls-cipher-suites-view.png"/>
</a>
</li>
<li>
<p>
Edit the TLS cipher suites in the text boxes:
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/security-tls-cipher-suites-edit.png" sdata-lightbox="/images/rs/screenshots/cluster/security-tls-cipher-suites-edit.png">
<img alt="Edit cipher suites drawer in the Cluster Manager UI." src="/docs/latest/images/rs/screenshots/cluster/security-tls-cipher-suites-edit.png"/>
</a>
</li>
<li>
<p>
Click
<strong>
Save
</strong>
.
</p>
</li>
</ol>
<h3 id="control-plane-ciphers-tls-1-2">
Control plane cipher suites
</h3>
<p>
As of Redis Enterprise Software version 6.0.12, control plane cipher suites can use the BoringSSL library format for TLS connections to the Cluster Manager UI. See the BoringSSL documentation for a full list of available
<a href="https://github.com/google/boringssl/blob/master/ssl/test/runner/cipher_suites.go#L99-L131">
BoringSSL configurations
</a>
.
</p>
<h4 id="configure-tls-12-control-plane-cipher-suites">
Configure TLS 1.2 control plane cipher suites
</h4>
<p>
To configure TLS 1.2 cipher suites for cluster communication, use the following
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/">
<code>
rladmin
</code>
</a>
command syntax:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config control_cipher_suites <BoringSSL cipher list>
</span></span></code></pre>
</div>
<p>
See the example below to configure cipher suites for the control plane:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config control_cipher_suites ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<ul>
<li>
The deprecated 3DES and RC4 cipher suites are no longer supported.
</li>
</ul>
</div>
</div>
<h3 id="data-plane-ciphers-tls-1-2">
Data plane cipher suites
</h3>
<p>
Data plane cipher suites use the OpenSSL library format in Redis Enterprise Software version 6.0.20 or later. For a list of available OpenSSL configurations, see
<a href="https://www.openssl.org/docs/man1.1.1/man1/ciphers.html">
Ciphers
</a>
(OpenSSL).
</p>
<h4 id="configure-tls-12-data-plane-cipher-suites">
Configure TLS 1.2 data plane cipher suites
</h4>
<p>
To configure TLS 1.2 cipher suites for communications between applications and databases, use the following
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/">
<code>
rladmin
</code>
</a>
command syntax:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config data_cipher_list <OpenSSL cipher list>
</span></span></code></pre>
</div>
<p>
See the example below to configure cipher suites for the data plane:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config data_cipher_list AES128-SHA:AES256-SHA
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<ul>
<li>
The deprecated 3DES and RC4 cipher suites are no longer supported.
</li>
</ul>
</div>
</div>
<h4 id="configure-tls-13-data-plane-cipher-suites">
Configure TLS 1.3 data plane cipher suites
</h4>
<p>
To configure TLS 1.3 cipher suites for communications between applications and databases, use the following
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/">
<code>
rladmin
</code>
</a>
command syntax:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config data_cipher_suites_tls_1_3 <OpenSSL cipher list>
</span></span></code></pre>
</div>
<p>
The following example configures TLS 1.3 cipher suites for the data plane:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config data_cipher_suites_tls_1_3 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
</span></span></code></pre>
</div>
<h3 id="discovery-service-ciphers-tls-1-2">
Discovery service cipher suites
</h3>
<p>
Sentinel service cipher suites use the golang.org OpenSSL format for
<a href="/docs/latest/operate/rs/databases/durability-ha/discovery-service/">
discovery service
</a>
TLS connections in Redis Enterprise Software version 6.0.20 or later. See their documentation for a list of
<a href="https://golang.org/src/crypto/tls/cipher_suites.go">
available configurations
</a>
.
</p>
<h4 id="configure-tls-12-discovery-service-cipher-suites">
Configure TLS 1.2 discovery service cipher suites
</h4>
<p>
To configure TLS 1.2 cipher suites for the discovery service cipher suites, use the following
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/">
<code>
rladmin
</code>
</a>
command syntax:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config sentinel_cipher_suites <golang cipher list>
</span></span></code></pre>
</div>
<p>
See the example below to configure cipher suites for the sentinel service:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster config sentinel_cipher_suites TLS_RSA_WITH_AES_128_CBC_SHA:TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/security/encryption/tls/ciphers/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/sscan/.html | <section class="prose w-full py-12">
<h1 class="command-name">
SSCAN
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">SSCAN key cursor [MATCH pattern] [COUNT count]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.8.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@set
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
See
<a href="/docs/latest/commands/scan/">
<code>
SCAN
</code>
</a>
for
<code>
SSCAN
</code>
documentation.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<p>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: specifically, an array with two elements:
</p>
<ul>
<li>
The first element is a
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
that represents an unsigned 64-bit number, the cursor.
</li>
<li>
The second element is an
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
with the names of scanned members.
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/sscan/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.0-release-notes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RediSearch 2.0 release notes
</h1>
<p class="text-lg -mt-5 mb-10">
Automatically indexes data based on a key pattern. Scale a single index over multiple Redis shards. Improved query performance.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RediSearch v2.0.13 requires:
</p>
<ul>
<li>
Minimum Redis compatibility version (database): 6.0.0
</li>
<li>
Minimum Redis Enterprise Software version (cluster): 6.0.0
</li>
</ul>
<h2 id="v2015-december-2021">
v2.0.15 (December 2021)
</h2>
<p>
This is a maintenance release for RediSearch 2.0.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
- Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
Bug fixes:
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/2388">
#2388
</a>
Garbage Collection (GC) for empty ranges in numeric index
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/2409">
#2409
</a>
Introduction of
<code>
FORK_GC_CLEAN_NUMERIC_EMPTY_NODES true
</code>
module argument to enable
<a href="https://github.com/RediSearch/RediSearch/pull/2388">
#2388
</a>
(off by default)
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/325">
#325
</a>
Used Redis allocator in hiredis (RSCoordinator)
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/2362">
#2362
</a>
Crash on empty field name
</li>
</ul>
</li>
</ul>
<h2 id="v2013-november-2021">
v2.0.13 (November 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Enhancements:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2243">
2243
</a>
Add
<code>
LOAD *
</code>
for FT.AGGREGATE which will load all fields
</li>
</ul>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2269">
2269
</a>
#
<a href="https://github.com/redisearch/redisearch/issues/2291">
2291
</a>
Remove TAG values from trie with no entries on Garbage Collection.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2287">
2287
</a>
Uninitialized read on
<code>
FT.ADD
</code>
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2342">
2342
</a>
Check for NULL result on intersect iterator
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2350">
2350
</a>
Crash on
<code>
FT.AGGREGATE
</code>
with
<code>
LIMIT 0 0
</code>
</li>
</ul>
</li>
</ul>
<h2 id="v2012-september-2021">
v2.0.12 (September 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Enhancements:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2184">
2184
</a>
API: getter functions for score, language and stop words list
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2188">
2188
</a>
Introduced the UNF parameter to SORTABLE to disable normalisation on TAG/TEXT fields
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2218">
2218
</a>
API: added RediSearch_CreateDocument2
</li>
</ul>
</li>
<li>
<p>
Bug fix:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2153">
2153
</a>
Restore FT.INFO complexity to O(1)
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2203">
2203
</a>
FT.AGGREGATE returns inaccurate results when TAG field is not set in hash
</li>
</ul>
</li>
</ul>
<h2 id="v2011-august-2021">
v2.0.11 (August 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Enhancements:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2156">
2156
</a>
TAG fields can now be case sensitive using the
<code>
CASESENSITIVE
</code>
parameter
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2113">
2113
</a>
An already existing document that can't be updated is removed from the index (JIRA MOD-1266)
</li>
<li>
#
<a href="https://github.com/RediSearch/RSCoordinator/pull/267">
267
</a>
#
<a href="https://github.com/RediSearch/RSCoordinator/pull/287">
287
</a>
Updated Hiredis to support Intershard TLS
</li>
</ul>
</li>
<li>
<p>
Bug Fixes:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2117">
2117
</a>
#
<a href="https://github.com/redisearch/redisearch/issues/2115">
2115
</a>
Fix crash on coordinator on first value reducer
</li>
</ul>
</li>
</ul>
<h2 id="v2010-july-2021">
v2.0.10 (July 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Enhancements:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2025">
2025
</a>
Improve performances on numeric range search
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1958">
1958
</a>
#
<a href="https://github.com/redisearch/redisearch/issues/2033">
2033
</a>
Support of sortable on the
<code>
GEO
</code>
type
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2079">
2079
</a>
Update to Snowball 2.1.0, adds Armenian, Serbian and Yiddish stemming support
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2002">
2002
</a>
Add stopwords list support in the API
</li>
</ul>
</li>
<li>
<p>
Bug fix:
</p>
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2045">
2045
</a>
Possible crash when loading an RDB file (silently ignore double load of alias)
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/2099">
2099
</a>
#
<a href="https://github.com/redisearch/redisearch/issues/2101">
2101
</a>
Fixes possible crash with CRDT on
<code>
FT.DROPINDEX
</code>
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1994">
1994
</a>
Skip intersect iterator qsort if
<code>
INORDER
</code>
flag is used
</li>
<li>
#
<a href="https://github.com/redisearch/rscoordinator/issues/257">
257
</a>
Switch coordinator to send _FT.CURSOR instead FT.CURSOR to prevent data access without holding the lock
</li>
</ul>
</li>
</ul>
<h2 id="v209-may-2021">
v2.0.9 (May 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
Bug fix in RSCoordinator:
<ul>
<li>
#
<a href="https://github.com/RediSearch/RSCoordinator/pull/259">
259
</a>
: Fix deadlock on cursor read by performing cursor command on background thread
</li>
</ul>
</li>
</ul>
<h2 id="v208-may-2021">
v2.0.8 (May 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
This release fixes an important regression introduced by the 2.0 release. The payload is supposed to be returned only when the WITHPAYLOADS parameter is set.
</p>
<p>
Details:
</p>
<ul>
<li>
Bug fixes:
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1959">
1959
</a>
Renamed parse_time() to parsetime()
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1932">
1932
</a>
Fixed crash resulted from LIMIT arguments
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1919">
1919
</a>
Prevent GC fork from crashing
</li>
</ul>
</li>
<li>
Minor enhancements:
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1880">
1880
</a>
Optimisation of intersect iterator
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1914">
1914
</a>
Do not return payload as a field
</li>
</ul>
</li>
</ul>
<h2 id="v207-may-2021">
v2.0.7 (May 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
Major enhancements:
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1864">
1864
</a>
Improve query time by predetermining reply array length.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1879">
1879
</a>
Improve loading time by calling RM_ScanKey instead of RM_Call
</li>
</ul>
</li>
<li>
Major bug fix:
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1866">
1866
</a>
Fix a linking issue causing incompatibility with Redis 6.2.0.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1842">
1842
</a>
#1852 Fix macOS build.
</li>
</ul>
</li>
<li>
Minor bug fixes:
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1850">
1850
</a>
Fix a race condition on drop temporary index.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1855">
1855
</a>
Fix a binary payload corruption.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1876">
1876
</a>
Fix crash if the depth of the reply array is larger than 7.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1843">
1843
</a>
#
<a href="https://github.com/redisearch/redisearch/issues/1860">
1860
</a>
Fix low-level API issues.
</li>
</ul>
</li>
</ul>
<h2 id="v206-february-2021">
v2.0.6 (February 2021)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
Minor additions:
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1696">
1696
</a>
The maximum number of results produced by
<code>
FT.AGGREGATE
</code>
is now configurable:
<code>
MAXAGGREGATERESULTS
</code>
.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1708">
1708
</a>
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/stemming/">
Stemming
</a>
updated with support of new languages: Basque, Catalan, Greek, Indonesian, Irish, Lithuanian, Nepali.
</li>
</ul>
</li>
<li>
Minor bugfixes:
<ul>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1668">
1668
</a>
Fixes support of stop words in
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/tags/">
tag fields
</a>
. Solves also the following related issues: #
<a href="https://github.com/redisearch/redisearch/issues/166">
166
</a>
, #
<a href="https://github.com/redisearch/redisearch/issues/984">
984
</a>
, #
<a href="https://github.com/redisearch/redisearch/issues/1237">
1237
</a>
, #
<a href="https://github.com/redisearch/redisearch/issues/1294">
1294
</a>
.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1689">
1689
</a>
Consistency fix and performance improvement when using
<code>
FT.SUGGET
</code>
with
<a href="https://github.com/RediSearch/RSCoordinator">
RSCoordinator
</a>
.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1774">
1774
</a>
<code>
MINPREFIX
</code>
and
<code>
MAXFILTEREXPANSION
</code>
configuration options can be changed at runtime.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1745">
1745
</a>
Enforce 0 value for
<code>
REDUCER COUNT
</code>
.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1757">
1757
</a>
Return an error when reaching the maximum number of sortable fields, instead of crashing.
</li>
<li>
#
<a href="https://github.com/redisearch/redisearch/issues/1762">
1762
</a>
Align the maximum number of sortable fields with the maximum number of fields (1024)
</li>
</ul>
</li>
</ul>
<h2 id="v205-december-2020">
v2.0.5 (December 2020)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
Minor features:
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1696">
#1696
</a>
Add
<code>
MAXAGGREGATERESULTS
</code>
module configuration for
<code>
FT.AGGREGATE
</code>
. Similar to
<code>
MAXSEARCHRESULTS
</code>
for
<code>
FT.SEARCH
</code>
, it limits the maximum number of results returned.
</li>
</ul>
</li>
</ul>
<h2 id="v204-december-2020">
v2.0.4 (December 2020)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Details:
</p>
<ul>
<li>
Bugfixes in RediSearch:
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1668">
#1668
</a>
Stopwords are not filtered out on tag fields.
</li>
</ul>
</li>
<li>
Bugfixes in RSCoordinator:
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/206">
#206
</a>
<code>
FT.AGGREGATE
</code>
with
<code>
LIMIT
</code>
and
<code>
offset
</code>
greater than
<code>
0
</code>
returned fewer results than requested.
</li>
</ul>
</li>
</ul>
<h2 id="v203-november-2020">
v2.0.3 (November 2020)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<p>
Minor bugfixes:
</p>
<ul>
<li>
Added
<a href="https://github.com/RediSearch/RSCoordinator#running-rscoordinator">
<code>
OSS_GLOBAL_PASSWORD
</code>
</a>
config argument to allow specify shards password on OSS cluster.
</li>
<li>
Update
<code>
min_redis_pack_version
</code>
to 6.0.8
</li>
</ul>
<h2 id="v202-november-2020">
v2.0.2 (November 2020)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<ul>
<li>
<p>
Minor enhancements:
</p>
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1625">
#1625
</a>
MAXPREFIXEXPANSIONS configuration which replaces the now deprecated config MAXEXPANSIONS. Same behaviour, more declarative naming.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1614">
#1614
</a>
Prevent multiple sortby steps on FT.AGGREGATE
</li>
</ul>
</li>
<li>
<p>
Minor bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1605">
#1605
</a>
Rare bug where identical results would get a lower score
</li>
</ul>
</li>
</ul>
<h2 id="v201-october-2020">
v2.0.1 (October 2020)
</h2>
<p>
This is a maintenance release for version 2.0.
</p>
<ul>
<li>
<p>
Minor additions:
</p>
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1432">
#1432
</a>
FT.AGGREGATE allows filtering by key and returning the key by using LOAD "@__key" .
</li>
</ul>
</li>
<li>
<p>
Minor bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1571">
#1571
</a>
Using FILTER in FT.CREATE might cause index to not be in sync with data.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1572">
#1572
</a>
Crash when using WITHSORTKEYS without SORTBY.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1540">
#1540
</a>
SORTBY should raise an error if the field is not defined as SORTABLE.
</li>
</ul>
</li>
</ul>
<h2 id="v200-september-2020">
v2.0.0 (September 2020)
</h2>
<p>
RediSearch 2.0 is a public preview release meeting GA standards. This release includes several improvements in performance and usability over RediSearch 1.0. These improvements necessitate a few backward-breaking changes to the API.
</p>
<h3 id="highlights">
Highlights
</h3>
<p>
For this release, we changed the way in which the search indexes are kept in sync with your data. In RediSearch 1.x, you had to manually add data to your indexes using the
<code>
FT.ADD
</code>
command. In RediSearch 2.x, your data is indexed automatically based on a key pattern.
</p>
<p>
These changes are designed to enhance developer productivity, and to ensure that
your search indexes are always kept in sync with your data. To support this, we've
made a few changes to the API.
</p>
<p>
In addition to simplifying indexing, RediSearch 2.0 allows you to scale a single index over multiple Redis shards using the Redis cluster API.
</p>
<p>
Finally, RediSearch 2.x keeps its indexes outside of the main Redis key space. Improvements to the indexing code have increased query performance 2.4x.
</p>
<p>
You can read more details in
<a href="https://redislabs.com/blog/introducing-redisearch-2-0/">
the RediSearch 2.0 announcement blog post
</a>
, and you can get started by checking out this
<a href="https://redislabs.com/blog/getting-started-with-redisearch-2-0/">
quick start blog post
</a>
.
</p>
<a href="/docs/latest/images/modules/redisearch-2-0-architecture.png" sdata-lightbox="/images/modules/redisearch-2-0-architecture.png">
<img alt="Compares the architecture of RediSearch 2.0 to architecture of earlier versions." src="/docs/latest/images/modules/redisearch-2-0-architecture.png"/>
</a>
<h3 id="details">
Details
</h3>
<ul>
<li>
When you create an index, you must specify a prefix condition and/or a filter. This determines which hashes RediSearch will index.
</li>
<li>
Several RediSearch commands now map to their Redis equivalents:
<code>
FT.ADD
</code>
->
<code>
HSET
</code>
,
<code>
FT.DEL
</code>
->
<code>
DEL
</code>
(equivalent to
<code>
FT.DEL
</code>
with the DD flag in RediSearch 1.x),
<code>
FT.GET
</code>
->
<code>
HGETALL
</code>
,
<code>
FT.MGET
</code>
->
<code>
HGETALL
</code>
.
</li>
<li>
RediSearch indexes no longer reside within the key space, and the indexes are no longer saved to the RDB.
</li>
<li>
You can upgrade from RediSearch 1.x to RediSearch 2.x.
</li>
</ul>
<h3 id="noteworthy-changes">
Noteworthy changes
</h3>
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1246">
#1246
</a>
:
<code>
geodistance
</code>
function for
<code>
FT.AGGREGATE
</code>
APPLY operation.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1394">
#1394
</a>
: Expired documents (TTL) will be removed from the index.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1394">
#1394
</a>
: Optimization to avoid reindexing documents when non-indexed fields are updated.
</li>
<li>
After index creation, an initial scan starts for existing documents. You can check the status of this scan by calling
<code>
FT.INFO
</code>
and looking at the
<code>
indexing
</code>
and
<code>
percent_indexed
</code>
values. While
<code>
indexing
</code>
is true, queries return partial results.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1435">
#1435
</a>
:
<code>
NOINITIALINDEX
</code>
flag on
<code>
FT.CREATE
</code>
to skip the initial scan of documents on index creation.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1401">
#1401
</a>
: Support upgrade from v1.x and for reading RDB's created by RediSearch 1.x.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1445">
#1445
</a>
: Support for load event. This event indexes documents when they are loaded from RDB, ensuring that indexes are fully available when RDB loading is complete (available from Redis 6.0.7 and above).
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1384">
#1384
</a>
:
<code>
FT.DROPINDEX
</code>
, which by default does not delete documents underlying the index (see deprecated
<code>
FT.DROP
</code>
).
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1385">
#1385
</a>
: Add index definition to
<code>
FT.INFO
</code>
response.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1097">
#1097
</a>
: Add Hindi snowball stemmer.
</li>
<li>
The
<code>
FT._LIST
</code>
command returns a list of all available indices. Note that this is a temporary command, as indicated by the
<code>
_
</code>
in the name, so it's not documented. We're working on a [
<code>
SCAN
</code>
](/docs/latest/commands/scan/-like command for databases with many indexes.
</li>
<li>
The RediSearch version will appear in Redis as
<code>
20000
</code>
, which is equivalent to 2.0.0 in semantic versioning. Since the version of a module in Redis is numeric, we cannot explicitly add an GA flag.
</li>
<li>
RediSearch 2.x requires Redis 6.0 or later.
</li>
</ul>
<h3 id="behavior-changes">
Behavior changes
</h3>
<p>
Make sure you review these changes before upgrading to RediSearch 2.0:
</p>
<ul>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1381">
#1381
</a>
:
<code>
FT.SYNADD
</code>
is removed; use
<code>
FT.SYNUPDATE
</code>
instead.
<code>
FT.SYNUPDATE
</code>
requires both
and index name and a synonym group ID. This ID can be any ASCII string.
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1437">
#1437
</a>
: Documents that expire during query execution time will not appear in the results (but might have been counted in the number of produced documents).
</li>
<li>
<a href="https://github.com/RediSearch/RediSearch/pull/1221">
#1221
</a>
: Synonyms support for lower case. This can result in a different result set on FT.SEARCH when using synonyms.
</li>
<li>
RediSearch will not index hashes whose fields do not match an existing index schema. You can see the number of hashes not indexed using
<code>
FT.INFO
</code>
-
<code>
hash_indexing_failures
</code>
. The requirement for adding support for partially indexing and blocking is captured here:
<a href="https://github.com/RediSearch/RediSearch/pull/1455">
#1455
</a>
.
</li>
<li>
Removed support for
<code>
NOSAVE
</code>
.
</li>
<li>
RDB loading will take longer due to the index not being persisted.
</li>
<li>
Field names in the
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/query_syntax/">
query syntax
</a>
are now case-sensitive.
</li>
<li>
Deprecated commands:
<ul>
<li>
<code>
FT.DROP
</code>
(replaced by
<code>
FT.DROPINDEX
</code>
, which by default keeps the documents)
</li>
<li>
<code>
FT.ADD
</code>
(mapped to
<code>
HSET
</code>
for backward compatibility)
</li>
<li>
<code>
FT.DEL
</code>
(mapped to
<code>
DEL
</code>
for backward compatibility)
</li>
<li>
<code>
FT.GET
</code>
(mapped to
<code>
HGETALL
</code>
for backward compatibility)
</li>
<li>
<code>
FT.MGET
</code>
(mapped to
<code>
HGETALL
</code>
for backward compatibility)
</li>
</ul>
</li>
<li>
Removed commands:
<ul>
<li>
<code>
FT.ADDHASH
</code>
(no longer makes sense)
</li>
<li>
<code>
FT.SYNADD
</code>
(see
<a href="https://github.com/RediSearch/RediSearch/pull/1381">
#1381
</a>
)
</li>
<li>
<code>
FT.OPTIMIZE
</code>
</li>
</ul>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.0-release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/stats/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Node stats requests
</h1>
<p class="text-lg -mt-5 mb-10">
Node statistics requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-nodes-stats">
GET
</a>
</td>
<td>
<code>
/v1/nodes/stats
</code>
</td>
<td>
Get stats for all nodes
</td>
</tr>
<tr>
<td>
<a href="#get-node-stats">
GET
</a>
</td>
<td>
<code>
/v1/nodes/stats/{uid}
</code>
</td>
<td>
Get stats for a single node
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-nodes-stats">
Get all nodes stats
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/nodes/stats
</span></span></code></pre>
</div>
<p>
Get statistics for all nodes.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_all_nodes_stats">
view_all_nodes_stats
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /nodes/stats?interval<span class="o">=</span>1hour<span class="p">&</span><span class="nv">stime</span><span class="o">=</span>2014-08-28T10:00:00Z
</span></span></code></pre>
</div>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="query-parameters">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
interval
</td>
<td>
string
</td>
<td>
Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional)
</td>
</tr>
<tr>
<td>
stime
</td>
<td>
ISO_8601
</td>
<td>
Start time from which we want the stats. Should comply with the
<a href="https://en.wikipedia.org/wiki/ISO_8601">
ISO_8601
</a>
format (optional)
</td>
</tr>
<tr>
<td>
etime
</td>
<td>
ISO_8601
</td>
<td>
End time after which we don't want the stats. Should comply with the
<a href="https://en.wikipedia.org/wiki/ISO_8601">
ISO_8601
</a>
format (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns a JSON array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/statistics/">
statistics
</a>
for all nodes.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1sec"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:11Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:12Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"conns"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_idle"</span><span class="p">:</span> <span class="mf">0.5499999999883585</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_system"</span><span class="p">:</span> <span class="mf">0.03499999999985448</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_user"</span><span class="p">:</span> <span class="mf">0.38000000000101863</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"egress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_avail"</span><span class="p">:</span> <span class="mf">2929315840.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_free"</span><span class="p">:</span> <span class="mf">3977830400.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"free_memory"</span><span class="p">:</span> <span class="mf">893485056.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ingress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_avail"</span><span class="p">:</span> <span class="mf">2929315840.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_free"</span><span class="p">:</span> <span class="mf">3977830400.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_req"</span><span class="p">:</span> <span class="mf">0.0</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1sec"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:12Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:13Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_idle"</span><span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional fields..."</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1sec"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:11Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:12Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"conns"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_idle"</span><span class="p">:</span> <span class="mf">0.5499999999883585</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_system"</span><span class="p">:</span> <span class="mf">0.03499999999985448</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_user"</span><span class="p">:</span> <span class="mf">0.38000000000101863</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"egress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_avail"</span><span class="p">:</span> <span class="mf">2929315840.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_free"</span><span class="p">:</span> <span class="mf">3977830400.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"free_memory"</span><span class="p">:</span> <span class="mf">893485056.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ingress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_avail"</span><span class="p">:</span> <span class="mf">2929315840.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_free"</span><span class="p">:</span> <span class="mf">3977830400.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_req"</span><span class="p">:</span> <span class="mf">0.0</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1sec"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:12Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:13Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_idle"</span><span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional fields..."</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span></code></pre>
</div>
<h3 id="get-all-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
No nodes exist
</td>
</tr>
</tbody>
</table>
<h2 id="get-node-stats">
Get node stats
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/nodes/stats/<span class="o">{</span>int: uid<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Get statistics for a node.
</p>
<h4 id="required-permissions-1">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_node_stats">
view_node_stats
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /nodes/stats/1?interval<span class="o">=</span>1hour<span class="p">&</span><span class="nv">stime</span><span class="o">=</span>2014-08-28T10:00:00Z
</span></span></code></pre>
</div>
<h4 id="request-headers-1">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The unique ID of the node requested.
</td>
</tr>
</tbody>
</table>
<h4 id="query-parameters-1">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
interval
</td>
<td>
string
</td>
<td>
Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional)
</td>
</tr>
<tr>
<td>
stime
</td>
<td>
ISO_8601
</td>
<td>
Start time from which we want the stats. Should comply with the
<a href="https://en.wikipedia.org/wiki/ISO_8601">
ISO_8601
</a>
format (optional)
</td>
</tr>
<tr>
<td>
etime
</td>
<td>
ISO_8601
</td>
<td>
End time after which we don't want the stats. Should comply with the
<a href="https://en.wikipedia.org/wiki/ISO_8601">
ISO_8601
</a>
format (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns
<a href="/docs/latest/operate/rs/references/rest-api/objects/statistics/">
statistics
</a>
for the specified node.
</p>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1sec"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:11Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:12Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"conns"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_idle"</span><span class="p">:</span> <span class="mf">0.5499999999883585</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_system"</span><span class="p">:</span> <span class="mf">0.03499999999985448</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_user"</span><span class="p">:</span> <span class="mf">0.38000000000101863</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"egress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_avail"</span><span class="p">:</span> <span class="mf">2929315840.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_free"</span><span class="p">:</span> <span class="mf">3977830400.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"free_memory"</span><span class="p">:</span> <span class="mf">893485056.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ingress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_avail"</span><span class="p">:</span> <span class="mf">2929315840.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_free"</span><span class="p">:</span> <span class="mf">3977830400.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_req"</span><span class="p">:</span> <span class="mf">0.0</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1sec"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:12Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:40:13Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_idle"</span><span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional fields..."</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Node does not exist
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">
406 Not Acceptable
</a>
</td>
<td>
Node isn't currently active
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4">
503 Service Unavailable
</a>
</td>
<td>
Node is in recovery state
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/stats/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/write-behind/reference/data-transformation-block-types/filter/.html | <section class="prose w-full py-12 max-w-none">
<h1>
filter
</h1>
<p class="text-lg -mt-5 mb-10">
Filter records
</p>
<p>
Filter records
</p>
<p>
<strong>
Properties
</strong>
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
expression
</strong>
</td>
<td>
<code>
string
</code>
</td>
<td>
Expression
<br/>
</td>
<td>
yes
</td>
</tr>
<tr>
<td>
<strong>
language
</strong>
</td>
<td>
<code>
string
</code>
</td>
<td>
Language
<br/>
Enum:
<code>
"jmespath"
</code>
,
<code>
"sql"
</code>
<br/>
</td>
<td>
yes
</td>
</tr>
</tbody>
</table>
<p>
<strong>
Additional Properties:
</strong>
not allowed
</p>
<p>
<strong>
Example
</strong>
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">source</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">server_name</span><span class="p">:</span><span class="w"> </span><span class="l">redislabs</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> </span><span class="l">dbo</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">table</span><span class="p">:</span><span class="w"> </span><span class="l">emp</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">transform</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l">filter</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">with</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l">sql</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">expression</span><span class="p">:</span><span class="w"> </span><span class="l">age>20</span><span class="w">
</span></span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/write-behind/reference/data-transformation-block-types/filter/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/clusters/monitoring/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Monitoring with metrics and alerts
</h1>
<p class="text-lg -mt-5 mb-10">
Use the metrics that measure the performance of your Redis Enterprise Software clusters, nodes, databases, and shards to track the performance of your databases.
</p>
<p>
You can use the metrics that measure the performance of your Redis Enterprise Software clusters, nodes, databases, and shards
to monitor the performance of your databases.
In the Redis Enterprise Cluster Manager UI, you can see real-time metrics and configure alerts that send notifications based on alert parameters. You can also access metrics and configure alerts through the REST API.
</p>
<p>
To integrate Redis Enterprise metrics into your monitoring environment, see the integration guides for
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/">
Prometheus and Grafana
</a>
or
<a href="/docs/latest/integrate/uptrace-with-redis-enterprise/">
Uptrace
</a>
.
</p>
<p>
Make sure you read the
<a href="/docs/latest/operate/rs/7.4/references/metrics/">
definition of each metric
</a>
so that you understand exactly what it represents.
</p>
<h2 id="real-time-metrics">
Real-time metrics
</h2>
<p>
You can see the metrics of the cluster in:
</p>
<ul>
<li>
<strong>
Cluster > Metrics
</strong>
</li>
<li>
<strong>
Node > Metrics
</strong>
for each node
</li>
<li>
<strong>
Database > Metrics
</strong>
for each database, including the shards for that database
</li>
</ul>
<p>
The scale selector at the top of the page allows you to set the X-axis (time) scale of the graph.
</p>
<p>
To choose which metrics to display in the two large graphs at the top of the page:
</p>
<ol>
<li>
Hover over the graph you want to show in a large graph.
</li>
<li>
Click on the right or left arrow to choose which side to show the graph.
</li>
</ol>
<p>
We recommend that you show two similar metrics in the top graphs so you can compare them side-by-side.
</p>
<h2 id="cluster-alerts">
Cluster alerts
</h2>
<p>
In
<strong>
Cluster > Alert Settings
</strong>
, you can enable alerts for node or cluster events, such as high memory usage or throughput.
</p>
<p>
Configured alerts are shown:
</p>
<ul>
<li>
As a notification on the status icon (
<a href="/docs/latest/images/rs/icons/icon_warning.png#no-click" sdata-lightbox="/images/rs/icons/icon_warning.png#no-click">
<img alt="Warning" class="inline" src="/docs/latest/images/rs/icons/icon_warning.png#no-click" width="18px"/>
</a>
) for the node and cluster
</li>
<li>
In the
<strong>
log
</strong>
</li>
<li>
In email notifications, if you configure
<a href="#send-alerts-by-email">
email alerts
</a>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
If you enable alerts for "Node joined" or "Node removed" actions,
you must also enable "Receive email alerts" so that the notifications are sent.
</div>
</div>
<p>
To enable alerts for a cluster:
</p>
<ol>
<li>
In
<strong>
Cluster > Alert Settings
</strong>
, click
<strong>
Edit
</strong>
.
</li>
<li>
Select the alerts that you want to show for the cluster and click
<strong>
Save
</strong>
.
</li>
</ol>
<h2 id="database-alerts">
Database alerts
</h2>
<p>
For each database, you can enable alerts for database events, such as high memory usage or throughput.
</p>
<p>
Configured alerts are shown:
</p>
<ul>
<li>
As a notification on the status icon (
<a href="/docs/latest/images/rs/icons/icon_warning.png#no-click" sdata-lightbox="/images/rs/icons/icon_warning.png#no-click">
<img alt="Warning" class="inline" src="/docs/latest/images/rs/icons/icon_warning.png#no-click" width="18px"/>
</a>
) for the database
</li>
<li>
In the
<strong>
log
</strong>
</li>
<li>
In emails, if you configure
<a href="#send-alerts-by-email">
email alerts
</a>
</li>
</ul>
<p>
To enable alerts for a database:
</p>
<ol>
<li>
In
<strong>
Configuration
</strong>
for the database, click
<strong>
Edit
</strong>
.
</li>
<li>
Select the
<strong>
Alerts
</strong>
section to open it.
</li>
<li>
Select the alerts that you want to show for the database and click
<strong>
Save
</strong>
.
</li>
</ol>
<h2 id="send-alerts-by-email">
Send alerts by email
</h2>
<p>
To send cluster and database alerts by email:
</p>
<ol>
<li>
In
<strong>
Cluster > Alert Settings
</strong>
, click
<strong>
Edit
</strong>
.
</li>
<li>
Select
<strong>
Set an email
</strong>
to configure the
<a href="/docs/latest/operate/rs/7.4/clusters/configure/cluster-settings/#configuring-email-server-settings">
email server settings
</a>
.
</li>
<li>
In
<strong>
Configuration
</strong>
for the database, click
<strong>
Edit
</strong>
.
</li>
<li>
Select the
<strong>
Alerts
</strong>
section to open it.
</li>
<li>
Select
<strong>
Receive email alerts
</strong>
and click
<strong>
Save
</strong>
.
</li>
<li>
In
<strong>
Access Control
</strong>
, select the
<a href="/docs/latest/operate/rs/7.4/security/access-control/manage-users/">
database and cluster alerts
</a>
that you want each user to receive.
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/clusters/monitoring/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/debuginfo/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Node debug info requests
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the Redis Enterprise Software REST API /nodes/debuginfo requests.
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-debuginfo-all-nodes">
GET
</a>
</td>
<td>
<code>
/v1/nodes/debuginfo
</code>
</td>
<td>
Get debug info from all nodes
</td>
</tr>
<tr>
<td>
<a href="#get-debuginfo-node">
GET
</a>
</td>
<td>
<code>
/v1/nodes/{node_uid}/debuginfo
</code>
</td>
<td>
Get debug info from a specific node
</td>
</tr>
</tbody>
</table>
<h2 id="get-debuginfo-all-nodes">
Get debug info from all nodes
</h2>
<pre><code>GET /v1/nodes/debuginfo
</code></pre>
<p>
Downloads a tar file that contains debug info from all nodes.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_debugging_info">
view_debugging_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /nodes/debuginfo
</code></pre>
<h3 id="get-all-response">
Response
</h3>
<p>
Downloads the debug info in a tar file called
<code>
filename.tar.gz
</code>
. Extract the files from the tar file to access the debug info.
</p>
<h4 id="response-headers">
Response headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Content-Type
</td>
<td>
application/x-gzip
</td>
<td>
Media type of request/response body
</td>
</tr>
<tr>
<td>
Content-Length
</td>
<td>
653350
</td>
<td>
Length of the response body in octets
</td>
</tr>
<tr>
<td>
Content-Disposition
</td>
<td>
attachment; filename=debuginfo.tar.gz
</td>
<td>
Display response in browser or download as attachment
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">
500 Internal Server Error
</a>
</td>
<td>
Failed to get debug info.
</td>
</tr>
</tbody>
</table>
<h2 id="get-debuginfo-node">
Get node debug info
</h2>
<pre><code>GET /v1/nodes/{int: node_uid}/debuginfo
</code></pre>
<p>
Downloads a tar file that contains debug info from a specific node.
</p>
<h4 id="required-permissions-1">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_debugging_info">
view_debugging_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>GET /nodes/1/debuginfo
</code></pre>
<h3 id="get-response">
Response
</h3>
<p>
Downloads the debug info in a tar file called
<code>
filename.tar.gz
</code>
. Extract the files from the tar file to access the debug info.
</p>
<h4 id="response-headers-1">
Response headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Content-Type
</td>
<td>
application/x-gzip
</td>
<td>
Media type of request/response body
</td>
</tr>
<tr>
<td>
Content-Length
</td>
<td>
653350
</td>
<td>
Length of the response body in octets
</td>
</tr>
<tr>
<td>
Content-Disposition
</td>
<td>
attachment; filename=debuginfo.tar.gz
</td>
<td>
Display response in browser or download as attachment
</td>
</tr>
</tbody>
</table>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">
500 Internal Server Error
</a>
</td>
<td>
Failed to get debug info.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/debuginfo/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/json.objlen/.html | <section class="prose w-full py-12">
<h1 class="command-name">
JSON.OBJLEN
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">JSON.OBJLEN key [path]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/json">
JSON 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key
</dd>
</dl>
<p>
Report the number of keys in the JSON object at
<code>
path
</code>
in
<code>
key
</code>
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is key to parse. Returns
<code>
null
</code>
for nonexistent keys.
</p>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
path
</code>
</summary>
<p>
is JSONPath to specify. Default is root
<code>
$
</code>
. Returns
<code>
null
</code>
for nonexistant path.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
JSON.OBJLEN returns an array of integer replies for each path specified as the number of keys in the object or
<code>
nil
</code>
, if the matching JSON value is not an object.
For more information about replies, see
<a href="/docs/latest/develop/reference/protocol-spec/">
Redis serialization protocol specification
</a>
.
</p>
<h2 id="examples">
Examples
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.SET doc $ <span class="s1">'{"a":[3], "nested": {"a": {"b":2, "c": 1}}}'</span>
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">redis> JSON.OBJLEN doc $..a
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span></span></span></code></pre>
</div>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/json.arrindex/">
<code>
JSON.ARRINDEX
</code>
</a>
|
<a href="/docs/latest/commands/json.arrinsert/">
<code>
JSON.ARRINSERT
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/data-types/json/">
RedisJSON
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/indexing/">
Index and search JSON documents
</a>
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/json.objlen/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ts.revrange/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.REVRANGE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.REVRANGE key fromTimestamp toTimestamp
[LATEST]
[FILTER_BY_TS ts...]
[FILTER_BY_VALUE min max]
[COUNT count]
[[ALIGN align] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/timeseries">
TimeSeries 1.4.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(n/m+k) where n = Number of data points, m = Chunk size (data points per chunk), k = Number of data points that are in the requested range
</dd>
</dl>
<p>
Query a range in reverse direction
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is the key name for the time series.
</p>
</details>
<details open="">
<summary>
<code>
fromTimestamp
</code>
</summary>
<p>
is start timestamp for the range query (integer Unix timestamp in milliseconds) or
<code>
-
</code>
to denote the timestamp of the earliest sample in the time series.
</p>
</details>
<details open="">
<summary>
<code>
toTimestamp
</code>
</summary>
<p>
is end timestamp for the range query (integer Unix timestamp in milliseconds) or
<code>
+
</code>
to denote the timestamp of the latest sample in the time series.
</p>
<p>
<note>
<b>
Note:
</b>
When the time series is a compaction, the last compacted value may aggregate raw values with timestamp beyond
<code>
toTimestamp
</code>
. That is because
<code>
toTimestamp
</code>
limits only the timestamp of the compacted value, which is the start time of the raw bucket that was compacted.
</note>
</p>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
LATEST
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
is used when a time series is a compaction. With
<code>
LATEST
</code>
, TS.REVRANGE also reports the compacted value of the latest, possibly partial, bucket, given that this bucket's start time falls within
<code>
[fromTimestamp, toTimestamp]
</code>
. Without
<code>
LATEST
</code>
, TS.REVRANGE does not report the latest, possibly partial, bucket. When a time series is not a compaction,
<code>
LATEST
</code>
is ignored.
</p>
<p>
The data in the latest bucket of a compaction is possibly partial. A bucket is
<em>
closed
</em>
and compacted only upon arrival of a new sample that
<em>
opens
</em>
a new
<em>
latest
</em>
bucket. There are cases, however, when the compacted value of the latest, possibly partial, bucket is also required. In such a case, use
<code>
LATEST
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
FILTER_BY_TS ts...
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
filters samples by a list of specific timestamps. A sample passes the filter if its exact timestamp is specified and falls within
<code>
[fromTimestamp, toTimestamp]
</code>
.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: samples are filtered before being aggregated.
</p>
</details>
<details open="">
<summary>
<code>
FILTER_BY_VALUE min max
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
filters samples by minimum and maximum values.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: samples are filtered before being aggregated.
</p>
</details>
<details open="">
<summary>
<code>
COUNT count
</code>
</summary>
<p>
When used without
<code>
AGGREGATION
</code>
: limits the number of reported samples.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: limits the number of reported buckets.
</p>
</details>
<details open="">
<summary>
<code>
ALIGN align
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
is a time bucket alignment control for
<code>
AGGREGATION
</code>
. It controls the time bucket timestamps by changing the reference timestamp on which a bucket is defined.
Values include:
</p>
<ul>
<li>
<code>
start
</code>
or
<code>
-
</code>
: The reference timestamp will be the query start interval time (
<code>
fromTimestamp
</code>
) which can't be
<code>
-
</code>
</li>
<li>
<code>
end
</code>
or
<code>
+
</code>
: The reference timestamp will be the query end interval time (
<code>
toTimestamp
</code>
) which can't be
<code>
+
</code>
</li>
<li>
A specific timestamp: align the reference timestamp to a specific time
</li>
</ul>
<p>
<note>
<b>
NOTE:
</b>
When not provided, alignment is set to
<code>
0
</code>
.
</note>
</p>
</details>
<details open="">
<summary>
<code>
AGGREGATION aggregator bucketDuration
</code>
</summary>
aggregates samples into time buckets, where:
<ul>
<li>
<p>
<code>
aggregator
</code>
takes one of the following aggregation types:
</p>
<table>
<thead>
<tr>
<th>
<code>
aggregator
</code>
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
avg
</code>
</td>
<td>
Arithmetic mean of all values
</td>
</tr>
<tr>
<td>
<code>
sum
</code>
</td>
<td>
Sum of all values
</td>
</tr>
<tr>
<td>
<code>
min
</code>
</td>
<td>
Minimum value
</td>
</tr>
<tr>
<td>
<code>
max
</code>
</td>
<td>
Maximum value
</td>
</tr>
<tr>
<td>
<code>
range
</code>
</td>
<td>
Difference between the maximum and the minimum value
</td>
</tr>
<tr>
<td>
<code>
count
</code>
</td>
<td>
Number of values
</td>
</tr>
<tr>
<td>
<code>
first
</code>
</td>
<td>
Value with lowest timestamp in the bucket
</td>
</tr>
<tr>
<td>
<code>
last
</code>
</td>
<td>
Value with highest timestamp in the bucket
</td>
</tr>
<tr>
<td>
<code>
std.p
</code>
</td>
<td>
Population standard deviation of the values
</td>
</tr>
<tr>
<td>
<code>
std.s
</code>
</td>
<td>
Sample standard deviation of the values
</td>
</tr>
<tr>
<td>
<code>
var.p
</code>
</td>
<td>
Population variance of the values
</td>
</tr>
<tr>
<td>
<code>
var.s
</code>
</td>
<td>
Sample variance of the values
</td>
</tr>
<tr>
<td>
<code>
twa
</code>
</td>
<td>
Time-weighted average over the bucket's timeframe (since RedisTimeSeries v1.8)
</td>
</tr>
</tbody>
</table>
</li>
<li>
<p>
<code>
bucketDuration
</code>
is duration of each bucket, in milliseconds.
</p>
</li>
</ul>
<p>
Without
<code>
ALIGN
</code>
, bucket start times are multiples of
<code>
bucketDuration
</code>
.
</p>
<p>
With
<code>
ALIGN align
</code>
, bucket start times are multiples of
<code>
bucketDuration
</code>
with remainder
<code>
align % bucketDuration
</code>
.
</p>
<p>
The first bucket start time is less than or equal to
<code>
fromTimestamp
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
[BUCKETTIMESTAMP bt]
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
controls how bucket timestamps are reported.
</p>
<table>
<thead>
<tr>
<th>
<code>
bt
</code>
</th>
<th>
Timestamp reported for each bucket
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
-
</code>
or
<code>
start
</code>
</td>
<td>
the bucket's start time (default)
</td>
</tr>
<tr>
<td>
<code>
+
</code>
or
<code>
end
</code>
</td>
<td>
the bucket's end time
</td>
</tr>
<tr>
<td>
<code>
~
</code>
or
<code>
mid
</code>
</td>
<td>
the bucket's mid time (rounded down if not an integer)
</td>
</tr>
</tbody>
</table>
</details>
<details open="">
<summary>
<code>
[EMPTY]
</code>
(since RedisTimeSeries v1.8)
</summary>
is a flag, which, when specified, reports aggregations also for empty buckets.
<table>
<thead>
<tr>
<th>
<code>
aggregator
</code>
</th>
<th>
Value reported for each empty bucket
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
sum
</code>
,
<code>
count
</code>
</td>
<td>
<code>
0
</code>
</td>
</tr>
<tr>
<td>
<code>
last
</code>
</td>
<td>
The value of the last sample before the bucket's start.
<code>
NaN
</code>
when no such sample.
</td>
</tr>
<tr>
<td>
<code>
twa
</code>
</td>
<td>
Average value over the bucket's timeframe based on linear interpolation of the last sample before the bucket's start and the first sample after the bucket's end.
<code>
NaN
</code>
when no such samples.
</td>
</tr>
<tr>
<td>
<code>
min
</code>
,
<code>
max
</code>
,
<code>
range
</code>
,
<code>
avg
</code>
,
<code>
first
</code>
,
<code>
std.p
</code>
,
<code>
std.s
</code>
</td>
<td>
<code>
NaN
</code>
</td>
</tr>
</tbody>
</table>
<p>
Regardless of the values of
<code>
fromTimestamp
</code>
and
<code>
toTimestamp
</code>
, no data is reported for buckets that end before the earliest sample or begin after the latest sample in the time series.
</p>
</details>
<h2 id="return-value">
Return value
</h2>
<p>
Returns one of these replies:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
of (
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#simple-strings">
Simple string reply
</a>
) pairs representing (timestamp, value(double))
</li>
<li>
[] (e.g., on invalid filter value)
</li>
</ul>
<h2 id="complexity">
Complexity
</h2>
<p>
TS.REVRANGE complexity can be improved in the future by using binary search to find the start of the range, which makes this
<code>
O(Log(n/m)+k*m)
</code>
.
But, because
<code>
m
</code>
is small, you can disregard it and look at the operation as
<code>
O(Log(n)+k)
</code>
.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Filter results by timestamp or sample value
</b>
</summary>
<p>
Consider a metric where acceptable values are between -100 and 100, and the value 9999 is used as an indication of bad measurement.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE temp:TLV LABELS <span class="nb">type</span> temp location TLV
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD temp:TLV <span class="m">1000</span> <span class="m">30</span> temp:TLV <span class="m">1010</span> <span class="m">35</span> temp:TLV <span class="m">1020</span> <span class="m">9999</span> temp:TLV <span class="m">1030</span> <span class="m">40</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1030</span></span></span></code></pre>
</div>
<p>
Now, retrieve all values except out-of-range values.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">TS.REVRANGE temp:TLV - + FILTER_BY_VALUE -100 <span class="m">100</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1030</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">40</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">35</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">30</span></span></span></code></pre>
</div>
<p>
Now, retrieve the average value, while ignoring out-of-range values.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">TS.REVRANGE temp:TLV - + FILTER_BY_VALUE -100 <span class="m">100</span> AGGREGATION avg <span class="m">1000</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">35</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Align aggregation buckets
</b>
</summary>
<p>
To demonstrate alignment, let’s create a stock and add prices at three different timestamps.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:A LABELS <span class="nb">type</span> stock name A
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">1000</span> <span class="m">100</span> stock:A <span class="m">1010</span> <span class="m">110</span> stock:A <span class="m">1020</span> <span class="m">120</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">2000</span> <span class="m">200</span> stock:A <span class="m">2010</span> <span class="m">210</span> stock:A <span class="m">2020</span> <span class="m">220</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">3000</span> <span class="m">300</span> stock:A <span class="m">3010</span> <span class="m">310</span> stock:A <span class="m">3020</span> <span class="m">320</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3020</span></span></span></code></pre>
</div>
<p>
Next, aggregate without using
<code>
ALIGN
</code>
, defaulting to alignment 0.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.REVRANGE stock:A - + AGGREGATION min <span class="m">20</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3020</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">320</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">300</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2020</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">220</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">120</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span></span></span></code></pre>
</div>
<p>
And now set
<code>
ALIGN
</code>
to 10 to have a bucket start at time 10, and align all the buckets with a 20 milliseconds duration.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.REVRANGE stock:A - + ALIGN <span class="m">10</span> AGGREGATION min <span class="m">20</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">310</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2990</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">300</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">210</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1990</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">110</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">990</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span></span></span></code></pre>
</div>
<p>
When the start timestamp for the range query is explicitly stated (not
<code>
-
</code>
), you can set ALIGN to that time by setting align to
<code>
-
</code>
or to
<code>
start
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.REVRANGE stock:A <span class="m">5</span> + ALIGN - AGGREGATION min <span class="m">20</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3005</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">310</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2985</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">300</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2005</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">210</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1985</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1005</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">110</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">985</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span></span></span></code></pre>
</div>
<p>
Similarly, when the end timestamp for the range query is explicitly stated, you can set ALIGN to that time by setting align to
<code>
+
</code>
or to
<code>
end
</code>
.
</p>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.range/">
<code>
TS.RANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.mrange/">
<code>
TS.MRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.mrevrange/">
<code>
TS.MREVRANGE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/data-types/timeseries/">
RedisTimeSeries
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ts.revrange/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/psubscribe/.html | <section class="prose w-full py-12">
<h1 class="command-name">
PSUBSCRIBE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">PSUBSCRIBE pattern [pattern ...]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the number of patterns to subscribe to.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@pubsub
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Subscribes the client to the given patterns.
</p>
<p>
Supported glob-style patterns:
</p>
<ul>
<li>
<code>
h?llo
</code>
subscribes to
<code>
hello
</code>
,
<code>
hallo
</code>
and
<code>
hxllo
</code>
</li>
<li>
<code>
h*llo
</code>
subscribes to
<code>
hllo
</code>
and
<code>
heeeello
</code>
</li>
<li>
<code>
h[ae]llo
</code>
subscribes to
<code>
hello
</code>
and
<code>
hallo,
</code>
but not
<code>
hillo
</code>
</li>
</ul>
<p>
Use
<code>
\
</code>
to escape special characters if you want to match them verbatim.
</p>
<p>
Once the client enters the subscribed state it is not supposed to issue any other commands, except for additional
<a href="/docs/latest/commands/subscribe/">
<code>
SUBSCRIBE
</code>
</a>
,
<a href="/docs/latest/commands/ssubscribe/">
<code>
SSUBSCRIBE
</code>
</a>
,
<code>
PSUBSCRIBE
</code>
,
<a href="/docs/latest/commands/unsubscribe/">
<code>
UNSUBSCRIBE
</code>
</a>
,
<a href="/docs/latest/commands/sunsubscribe/">
<code>
SUNSUBSCRIBE
</code>
</a>
,
<a href="/docs/latest/commands/punsubscribe/">
<code>
PUNSUBSCRIBE
</code>
</a>
,
<a href="/docs/latest/commands/ping/">
<code>
PING
</code>
</a>
,
<a href="/docs/latest/commands/reset/">
<code>
RESET
</code>
</a>
and
<a href="/docs/latest/commands/quit/">
<code>
QUIT
</code>
</a>
commands.
However, if RESP3 is used (see
<a href="/docs/latest/commands/hello/">
<code>
HELLO
</code>
</a>
) it is possible for a client to issue any commands while in subscribed state.
</p>
<p>
For more information, see
<a href="/docs/latest/develop/interact/pubsub/">
Pub/sub
</a>
.
</p>
<h2 id="behavior-change-history">
Behavior change history
</h2>
<ul>
<li>
<code>
>= 6.2.0
</code>
:
<a href="/docs/latest/commands/reset/">
<code>
RESET
</code>
</a>
can be called to exit subscribed state.
</li>
</ul>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
When successful, this command doesn't return anything. Instead, for each pattern, one message with the first element being the string
<code>
psubscribe
</code>
is pushed as a confirmation that the command succeeded.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/psubscribe/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/k8s-6-2-4-1-2021-09/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes Release Notes 6.2.4-1 (September 2021)
</h1>
<p class="text-lg -mt-5 mb-10">
Support for RS 6.2.4 and OpenShift 4.8. Support for K8s 1.19 (EKS and AKS), K8s 1.20 (Rancher, EKS, AKS), K8s 1.21 (GKE and kOps).
</p>
<h2 id="overview">
Overview
</h2>
<p>
The Redis Enterprise
<a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases/tag/v6.2.4-1">
K8s 6.2.4-1
</a>
release provides support for the
<a href="/docs/latest/operate/rs/release-notes/rs-6-2-4-august-2021/">
Redis Enterprise Software release 6.2.4
</a>
and includes several enhancements and bug fixes.
</p>
<p>
The key new features, bug fixes, and known limitations are described below.
</p>
<h2 id="images">
Images
</h2>
<p>
This release includes the following container images:
</p>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
:
<code>
redislabs/redis:6.2.4-55
</code>
or
<code>
redislabs/redis:6.2.4-55.rhel7-openshift
</code>
</li>
<li>
<strong>
Operator
</strong>
:
<code>
redislabs/operator:6.2.4-1
</code>
</li>
<li>
<strong>
Services Rigger
</strong>
:
<code>
redislabs/k8s-controller:6.2.4-1
</code>
or
<code>
redislabs/services-manager:6.2.4-1
</code>
(on the Red Hat registry)
</li>
</ul>
<h2 id="new-features">
New features
</h2>
<ul>
<li>
Internode encryption configuration through K8s custom resources (RED-59699, RED-60318)
</li>
</ul>
<h2 id="feature-improvements">
Feature improvements
</h2>
<ul>
<li>
Support for addition attribute in REDB secret containing comma separated list of service names (RED-48469)
</li>
<li>
Support OpenShift 4.8 (K8s 1.21) (RED-59424)
</li>
<li>
Support K8s 1.21 - GKE (RED-59048)
</li>
<li>
Support K8s 1.21 - kOps (RED-59047)
</li>
<li>
Support K8s 1.19-1.21 - EKS (RED-60287)
</li>
<li>
Support K8s 1.19, 1.20 - AKS (RED-59050)
</li>
<li>
Support K8s 1.20 - Rancher (RED-59049)
</li>
</ul>
<h2 id="fixed-bugs">
Fixed bugs
</h2>
<ul>
<li>
Fixed issue with RS pods not recovering from container failures (RED-53042)
</li>
<li>
Fixed rare problem of Redis Enterprise pod restarting too early while statefulSet was rolling out, causing quorum loss (RED-53042)
</li>
<li>
Improved Github public documentation around using the admission controller with multiple namespaces (RED-59915)
</li>
<li>
Fixed integration issues with HashiCorp Vault enterprise namespaces and custom auth paths (RED-61273)
</li>
</ul>
<h2 id="known-limitations">
Known limitations
</h2>
<h3 id="large-clusters">
Large clusters
</h3>
<p>
On clusters with more than 9 REC nodes, a Kubernetes upgrade can render the Redis cluster unresponsive in some cases. A fix is available in the 6.4.2-5 release. Upgrade your operator version to 6.4.2-5 or later before upgrading your Kubernetes cluster. (RED-93025)
</p>
<h3 id="applying-bundleyaml-generated-a-warning">
Applying bundle.yaml generated a warning
</h3>
<p>
When applying bundle.yaml on K8s clusters 1.20 and above, the following warning is generated:
</p>
<pre tabindex="0"><code>Warning: apiextensions.k8s.io/v1beta1 CustomResourceDefinition is deprecated in v1.16+, unavailable in v1.22+; use apiextensions.k8s.io/v1 CustomResourceDefinition
</code></pre>
<p>
The warning can be safely ignored. A future release will leverage the updated API version for CustomResourceDefinition, once support for K8s 1.22 is introduced.
</p>
<h3 id="enabling-the-kubernetes-webhook-generates-a-warning">
Enabling the Kubernetes webhook generates a warning
</h3>
<p>
When
<a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs#installation">
installing
</a>
and configuring the admission controller webhook (step 5), the following warning is generated:
</p>
<pre tabindex="0"><code>Warning: admissionregistration.k8s.io/v1beta1 ValidatingWebhookConfiguration is deprecated in v1.16+, unavailable in v1.22+; use admissionregistration.k8s.io/v1 ValidatingWebhookConfiguration
</code></pre>
<p>
The warning can be safely ignored. A future release will leverage the updated API version for ValidatingWebhookConfiguration, once support for K8s 1.22 is introduced.
</p>
<h3 id="hashicorp-vault-integration---no-support-for-gesher-red-55080">
Hashicorp Vault integration - no support for Gesher (RED-55080)
</h3>
<p>
There is no workaround at this time
</p>
<h3 id="long-cluster-names-cause-routes-to-be-rejected--red-25871">
Long cluster names cause routes to be rejected (RED-25871)
</h3>
<p>
A cluster name longer than 20 characters will result in a rejected route configuration because the host part of the domain name will exceed 63 characters. The workaround is to limit cluster name to 20 characters or fewer.
</p>
<h3 id="cluster-cr-rec-errors-are-not-reported-after-invalid-updates-red-25542">
Cluster CR (REC) errors are not reported after invalid updates (RED-25542)
</h3>
<p>
A cluster CR specification error is not reported if two or more invalid CR resources are updated in sequence.
</p>
<h3 id="an-unreachable-cluster-has-status-running-red-32805">
An unreachable cluster has status running (RED-32805)
</h3>
<p>
When a cluster is in an unreachable state, the state is still
<code>
running
</code>
instead of being reported as an error.
</p>
<h3 id="readiness-probe-incorrect-on-failures-red-39300">
Readiness probe incorrect on failures (RED-39300)
</h3>
<p>
STS Readiness probe does not mark a node as "not ready" when running
<code>
rladmin status
</code>
on the node fails.
</p>
<h3 id="role-missing-on-replica-sets-red-39002">
Role missing on replica sets (RED-39002)
</h3>
<p>
The
<code>
redis-enterprise-operator
</code>
role is missing permission on replica sets.
</p>
<h3 id="private-registries-are-not-supported-on-openshift-311-red-38579">
Private registries are not supported on OpenShift 3.11 (RED-38579)
</h3>
<p>
OpenShift 3.11 does not support DockerHub private registries. This is a known OpenShift issue.
</p>
<h3 id="internal-dns-and-kubernetes-dns-may-have-conflicts-red-37462">
Internal DNS and Kubernetes DNS may have conflicts (RED-37462)
</h3>
<p>
DNS conflicts are possible between the cluster
<code>
mdns_server
</code>
and the K8s DNS. This only impacts DNS resolution from within cluster nodes for Kubernetes DNS names.
</p>
<h3 id="5410-negatively-impacts-546-red-37233">
5.4.10 negatively impacts 5.4.6 (RED-37233)
</h3>
<p>
Kubernetes-based 5.4.10 deployments seem to negatively impact existing 5.4.6 deployments that share a Kubernetes cluster.
</p>
<h3 id="node-cpu-usage-is-reported-instead-of-pod-cpu-usage-red-36884">
Node CPU usage is reported instead of pod CPU usage (RED-36884)
</h3>
<p>
In Kubernetes, the node CPU usage we report on is the usage of the Kubernetes worker node hosting the REC pod.
</p>
<h3 id="clusters-must-be-named-rec-in-olm-based-deployments-red-39825">
Clusters must be named "rec" in OLM-based deployments (RED-39825)
</h3>
<p>
In OLM-deployed operators, the deployment of the cluster will fail if the name is not "rec". When the operator is deployed via the OLM, the security context constraints (scc) are bound to a specific service account name (i.e., "rec"). The workaround is to name the cluster "rec".
</p>
<h3 id="rec-clusters-fail-to-start-on-kubernetes-clusters-with-unsynchronized-clocks-red-47254">
REC clusters fail to start on Kubernetes clusters with unsynchronized clocks (RED-47254)
</h3>
<p>
When REC clusters are deployed on Kubernetes clusters with unsynchronized clocks, the REC cluster does not start correctly. The fix is to use NTP to synchronize the underlying K8s nodes.
</p>
<h3 id="deleting-an-openshift-project-with-an-rec-deployed-may-hang-red-47192">
Deleting an OpenShift project with an REC deployed may hang (RED-47192)
</h3>
<p>
When a REC cluster is deployed in a project (namespace) and has REDB resources, the
REDB resources must be deleted first before the REC can be deleted. As such, until the
REDB resources are deleted, the project deletion will hang. The fix is to delete the
REDB resources first and the REC second. Afterwards, you may delete the project.
</p>
<h3 id="rec-extralabels-are-not-applied-to-pvcs-on-k8s-versions-115-or-older-red-51921">
REC extraLabels are not applied to PVCs on K8s versions 1.15 or older (RED-51921)
</h3>
<p>
In K8s 1.15 or older, the PVC labels come from the match selectors and not the
PVC templates. As such, these versions can not support PVC labels. If this feature
is required, the only fix is to upgrade the K8s cluster to a newer version.
</p>
<h3 id="rec-might-report-error-states-on-initial-startup-red-61707">
REC might report error states on initial startup (RED-61707)
</h3>
<p>
There is no workaround at this time except to ignore the errors.
</p>
<h3 id="pvc-size-issues-when-using-decimal-value-in-spec-red-62132">
PVC size issues when using decimal value in spec (RED-62132)
</h3>
<p>
The workaround for this issue is to make sure you use integer values for the PVC size.
</p>
<h3 id="long-rec-names-or-namespace-names-cause-failures-red-62222">
Long REC names or namespace names cause failures (RED-62222)
</h3>
<p>
The combined length of the REC name and namespace name must be equal to or less than 45 characters.
</p>
<h2 id="compatibility-notes">
Compatibility Notes
</h2>
<p>
See
<a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/">
Supported Kubernetes distributions
</a>
for the full list of supported distributions.
</p>
<h3 id="now-supported">
Now supported
</h3>
<ul>
<li>
OpenShift 4.8
</li>
<li>
GKE K8s version 1.21
</li>
<li>
kOps K8s version 1.21
</li>
<li>
EKS K8s versions 1.19-1.21
</li>
<li>
AKS K8s versions 1.19-1.20
</li>
<li>
Rancher K8s version 1.20
</li>
</ul>
<h3 id="no-longer-supported">
No longer supported
</h3>
<ul>
<li>
GKE K8s version 1.17 (previously deprecated)
</li>
<li>
kOps K8s version 1.15 (previously deprecated)
</li>
</ul>
<h2 id="deprecation-notice">
Deprecation notice
</h2>
<ul>
<li>
kOps 1.16 and 1.17 are deprecated
</li>
<li>
VMWare TKGI 1.7 (K8s 1.16), VMWare TKGI 1.8 (K8s 1.17) are deprecated (no longer supported by VMWare)
</li>
<li>
Openshift 3.11 (K8s 1.11) is now deprecated. Redis will continue to support existing deployments for the lifetime of Openshift 3.11, but new deployments are strongly discouraged.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/k8s-6-2-4-1-2021-09/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/substr/.html | <section class="prose w-full py-12">
<h1 class="command-name">
SUBSTR
<span class="text-base">
(deprecated)
</span>
</h1>
<div class="border-l-8 pl-4">
<p>
As of Redis version 2.0.0, this command is regarded as deprecated.
</p>
<p>
It can be replaced by
<a href="/docs/latest/commands/getrange/">
<code>
GETRANGE
</code>
</a>
when migrating or writing new code.
</p>
</div>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">SUBSTR key start end</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
1.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@string
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Returns the substring of the string value stored at
<code>
key
</code>
, determined by the
offsets
<code>
start
</code>
and
<code>
end
</code>
(both are inclusive).
Negative offsets can be used in order to provide an offset starting from the end
of the string.
So -1 means the last character, -2 the penultimate and so forth.
</p>
<p>
The function handles out of range requests by limiting the resulting range to
the actual length of the string.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> SET mykey "This is a string"
"OK"
redis> GETRANGE mykey 0 3
"This"
redis> GETRANGE mykey -3 -1
"ing"
redis> GETRANGE mykey 0 -1
"This is a string"
redis> GETRANGE mykey 10 100
"string"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
: the substring of the string value stored at key, determined by the offsets start and end (both are inclusive).
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/substr/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.dictdump.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.DICTDUMP
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.DICTDUMP dict
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.4.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N), where N is the size of the dictionary
</dd>
</dl>
<p>
Dump all terms in the given dictionary
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-argumemts">
Required argumemts
</h2>
<details open="">
<summary>
<code>
dict
</code>
</summary>
<p>
is dictionary name.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.DICTDUMP returns an array, where each element is term (string).
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Dump all terms in the dictionary
</b>
</summary>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.DICTDUMP dict
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="s2">"foo"</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"bar"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="s2">"hello world"</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.dictadd/">
<code>
FT.DICTADD
</code>
</a>
|
<a href="/docs/latest/commands/ft.dictdel/">
<code>
FT.DICTDEL
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.dictdump/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/data-types/timeseries/reference/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Reference
</h1>
<p class="text-lg -mt-5 mb-10">
Reference
</p>
<nav>
<a href="/docs/latest/develop/data-types/timeseries/reference/out-of-order_performance_considerations/">
Out-of-order / backfilled ingestion performance considerations
</a>
<p>
Out-of-order / backfilled ingestion performance considerations
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/data-types/timeseries/reference/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/installing-upgrading/configuring/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Additional configuration
</h1>
<p>
This section describes additional configuration options for Redis Enterprise Software installation.
</p>
<nav>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall/">
Configure CentOS/RHEL firewall
</a>
<p>
Configure firewall rules for Redis Enterprise Software on CentOS or Red Hat Enterprise Linux (RHEL).
</p>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/configuring/linux-swap/">
Configure swap for Linux
</a>
<p>
Turn off Linux swap space.
</p>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files/">
Change socket file locations
</a>
<p>
Change socket file locations.
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/installing-upgrading/configuring/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/module-capabilities/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster module capabilities requests
</h1>
<p class="text-lg -mt-5 mb-10">
Redis module capabilities requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-cluster-module-capabilities">
GET
</a>
</td>
<td>
<code>
/v1/cluster/module-capabilities
</code>
</td>
<td>
List possible Redis module capabilities
</td>
</tr>
</tbody>
</table>
<h2 id="get-cluster-module-capabilities">
List Redis module capabilities
</h2>
<pre><code>GET /v1/cluster/module-capabilities
</code></pre>
<p>
List possible Redis module capabilities.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_cluster_modules">
view_cluster_modules
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /cluster/module-capabilities
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
*/*
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a JSON object that contains a list of capability names and descriptions.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"all_capabilities"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="nt">"name"</span><span class="p">:</span> <span class="s2">"types"</span><span class="p">,</span> <span class="nt">"desc"</span><span class="p">:</span> <span class="s2">"module has its own types and not only operate on existing redis types"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="nt">"name"</span><span class="p">:</span> <span class="s2">"no_multi_key"</span><span class="p">,</span> <span class="nt">"desc"</span><span class="p">:</span> <span class="s2">"module has no methods that operate on multiple keys"</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"// additional capabilities..."</span>
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/module-capabilities/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/tools/insight/release-notes/v2.8.0/.html | <section class="prose w-full py-12">
<h1>
RedisInsight v2.8.0, August 2022
</h1>
<p class="text-lg -mt-5 mb-10">
RedisInsight v2.8.0
</p>
<h2 id="280-august-2022">
2.8.0 (August 2022)
</h2>
<p>
This is the General Availability (GA) release of RedisInsight 2.8.0
</p>
<h3 id="headlines">
Headlines
</h3>
<ul>
<li>
Formatters: See formatted key values in JSON, MessagePack, Hex, Unicode, or ASCII in Browser/Tree view for an improved experience of working with different data formats.
</li>
<li>
Clone existing database connection or connection details: Clone the database connection you previously added to have the same one, but with a different database index, username, or password.
</li>
<li>
Raw mode in Workbench: Added support for the raw mode in Workbench results
</li>
</ul>
<h3 id="details">
Details
</h3>
<p>
<strong>
Features and improvements
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/978">
#978
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/959">
#959
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/984">
#984
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/996">
#996
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/992">
#992
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/1030">
#1030
</a>
Added support for different data formats in Browser/Tree view, including JSON, MessagePack, Hex, and ASCII. If selected, formatter is applied to the entire key value and is available for any data type supported in Browser/Tree view. If any non-printable characters are detected, data editing is available only in Workbench and CLI to avoid data loss.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/965">
#955
</a>
Quickly clone a database connection to have the same one, but with a different database index, username, or password. Open a database connection in the edit mode, request to clone it, and make the changes needed. The original database connection remains the same.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/1012">
#1012
</a>
Added support for the raw mode (--raw) in Workbench. Enable it to see the results of commands executed in the raw mode.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/987">
#987
</a>
<a href="https://redis.io/commands/dbsize/">
DBSIZE
</a>
command is no longer required to connect to a database.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/971">
#971
</a>
Updated icon for the
<a href="https://redis.io/docs/stack/search/">
RediSearch
</a>
Light module.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/1011">
#1011
</a>
Enhanced navigation in the Command Helper allowing you to return to previous actions.
</li>
</ul>
<p>
<strong>
Bugs fixed
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/1009">
#1009
</a>
Fixed an
<a href="(https://github.com/RedisInsight/RedisInsight/issues/804)">
error
</a>
on automatic discovery of Sentinel databases.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/978">
#978
</a>
Work with
<a href="https://github.com/RedisInsight/RedisInsight/issues/873">
non-printable characters
</a>
. To avoid data loss, when non-printable characters are detected, key and value are editable in Workbench and CLI only.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/tools/insight/release-notes/v2.8.0/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise REST API objects
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the objects used with Redis Enterprise Software REST API calls.
</p>
<p>
Certain
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/">
REST API requests
</a>
require you to include specific objects in the request body. Many requests also return objects in the response body.
</p>
<p>
Both REST API requests and responses represent these objects as
<a href="https://www.json.org">
JSON
</a>
.
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Object
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/action/">
action
</a>
</td>
<td style="text-align:left">
An object that represents cluster actions
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/alert/">
alert
</a>
</td>
<td style="text-align:left">
An object that contains alert info
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bdb/">
bdb
</a>
</td>
<td style="text-align:left">
An object that represents a database
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bdb_group/">
bdb_group
</a>
</td>
<td style="text-align:left">
An object that represents a group of databases with a shared memory pool
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bootstrap/">
bootstrap
</a>
</td>
<td style="text-align:left">
An object for bootstrap configuration
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/check_result/">
check_result
</a>
</td>
<td style="text-align:left">
An object that contains the results of a cluster check
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/">
cluster
</a>
</td>
<td style="text-align:left">
An object that represents a cluster
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster_settings/">
cluster_settings
</a>
</td>
<td style="text-align:left">
An object for cluster resource management settings
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/references/rest-api/objects/cm_settings/">
cm_settings
</a>
</td>
<td style="text-align:left">
A REST API object that represents Cluster Manager UI settings
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/crdb/">
crdb
</a>
</td>
<td style="text-align:left">
An object that represents an Active-Active database
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/crdb_task/">
crdb_task
</a>
</td>
<td style="text-align:left">
An object that represents a CRDB task
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/">
db_alerts_settings
</a>
</td>
<td style="text-align:left">
An object for database alerts configuration
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config/">
db_conns_auditing_config
</a>
</td>
<td style="text-align:left">
An object for database connection auditing settings
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/job_scheduler/">
job_scheduler
</a>
</td>
<td style="text-align:left">
An object for job scheduler settings
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/jwt_authorize/">
jwt_authorize
</a>
</td>
<td style="text-align:left">
An object for user authentication or a JW token refresh request
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ldap/">
ldap
</a>
</td>
<td style="text-align:left">
An object that contains the cluster's LDAP configuration
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ldap_mapping/">
ldap_mapping
</a>
</td>
<td style="text-align:left">
An object that represents a mapping between an LDAP group and roles
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/module/">
module
</a>
</td>
<td style="text-align:left">
An object that represents a Redis module
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/node/">
node
</a>
</td>
<td style="text-align:left">
An object that represents a node in the cluster
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ocsp/">
ocsp
</a>
</td>
<td style="text-align:left">
An object that represents the cluster's OCSP configuration
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ocsp_status/">
ocsp_status
</a>
</td>
<td style="text-align:left">
An object that represents the cluster's OCSP status
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/proxy/">
proxy
</a>
</td>
<td style="text-align:left">
An object that represents a proxy in the cluster
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/redis_acl/">
redis_acl
</a>
</td>
<td style="text-align:left">
An object that represents a Redis access control list (ACL)
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/role/">
role
</a>
</td>
<td style="text-align:left">
An object that represents a role
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/services_configuration/">
services_configuration
</a>
</td>
<td style="text-align:left">
An object for optional cluster services settings
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/shard/">
shard
</a>
</td>
<td style="text-align:left">
An object that represents a database shard
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/state-machine/">
state-machine
</a>
</td>
<td style="text-align:left">
An object that represents a state machine.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/statistics/">
statistics
</a>
</td>
<td style="text-align:left">
An object that contains metrics for clusters, databases, nodes, or shards
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/suffix/">
suffix
</a>
</td>
<td style="text-align:left">
An object that represents a DNS suffix
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/user/">
user
</a>
</td>
<td style="text-align:left">
An object that represents a Redis Enterprise user
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/commands/rg-jdumpsessions/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RG.JDUMPSESSIONS
</h1>
<p class="text-lg -mt-5 mb-10">
Outputs information about existing Java sessions.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">RG.JDUMPSESSIONS <span class="o">[</span>VERBOSE<span class="o">]</span> <span class="o">[</span>SESSIONS s1 s2 ...<span class="o">]</span>
</span></span></code></pre>
</div>
<p>
Outputs information about existing Java sessions.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
When you run the
<code>
RG.JEXECUTE
</code>
command, it creates a Java session.
</div>
</div>
<h2 id="arguments">
Arguments
</h2>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
VERBOSE
</td>
<td>
Output more details about registrations.
</td>
</tr>
<tr>
<td>
SESSIONS
</td>
<td>
Only output information about sessions that appears in the given list. Can only be the last argument.
</td>
</tr>
</tbody>
</table>
<h2 id="returns">
Returns
</h2>
<p>
Returns information about existing Java sessions.
</p>
<h2 id="examples">
Examples
</h2>
<p>
Get information for all sessions:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">> redis-cli RG.JDUMPSESSIONS
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"mainClass"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"gears_experiments.test"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"version"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> <span class="s2">"description"</span>
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> <span class="s2">"foo"</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> <span class="s2">"upgradeData"</span>
</span></span><span class="line"><span class="cl"> 8<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl"> 9<span class="o">)</span> <span class="s2">"jar"</span>
</span></span><span class="line"><span class="cl"> 10<span class="o">)</span> <span class="s2">"/home/user/work/RedisGears/plugins/jvmplugin/-jars/6876b8b78ccfc2ad764edc7ede590f573bd7260b.jar"</span>
</span></span><span class="line"><span class="cl"> 11<span class="o">)</span> <span class="s2">"refCount"</span>
</span></span><span class="line"><span class="cl"> 12<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl"> 13<span class="o">)</span> <span class="s2">"linked"</span>
</span></span><span class="line"><span class="cl"> 14<span class="o">)</span> <span class="s2">"true"</span>
</span></span><span class="line"><span class="cl"> 15<span class="o">)</span> <span class="s2">"ts"</span>
</span></span><span class="line"><span class="cl"> 16<span class="o">)</span> <span class="s2">"false"</span>
</span></span><span class="line"><span class="cl"> 17<span class="o">)</span> <span class="s2">"registrations"</span>
</span></span><span class="line"><span class="cl"> 18<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"0000000000000000000000000000000000000000-1"</span>
</span></span></code></pre>
</div>
<p>
Get more detailed information about a specific session:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">> redis-cli RG.JDUMPSESSIONS VERBOSE SESSIONS gears_experiments.test
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"mainClass"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"gears_experiments.test"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"version"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> <span class="s2">"description"</span>
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> <span class="s2">"foo"</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> <span class="s2">"upgradeData"</span>
</span></span><span class="line"><span class="cl"> 8<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl"> 9<span class="o">)</span> <span class="s2">"jar"</span>
</span></span><span class="line"><span class="cl"> 10<span class="o">)</span> <span class="s2">"/home/user/work/RedisGears/plugins/jvmplugin/-jars/6876b8b78ccfc2ad764edc7ede590f573bd7260b.jar"</span>
</span></span><span class="line"><span class="cl"> 11<span class="o">)</span> <span class="s2">"refCount"</span>
</span></span><span class="line"><span class="cl"> 12<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl"> 13<span class="o">)</span> <span class="s2">"linked"</span>
</span></span><span class="line"><span class="cl"> 14<span class="o">)</span> <span class="s2">"true"</span>
</span></span><span class="line"><span class="cl"> 15<span class="o">)</span> <span class="s2">"ts"</span>
</span></span><span class="line"><span class="cl"> 16<span class="o">)</span> <span class="s2">"false"</span>
</span></span><span class="line"><span class="cl"> 17<span class="o">)</span> <span class="s2">"registrations"</span>
</span></span><span class="line"><span class="cl"> 18<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"id"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"0000000000000000000000000000000000000000-1"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"reader"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"CommandReader"</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> <span class="s2">"desc"</span>
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> <span class="s2">"RegistrationData"</span>
</span></span><span class="line"><span class="cl"> 8<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"mode"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"async"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"numTriggered"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> <span class="s2">"numSuccess"</span>
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> <span class="s2">"numFailures"</span>
</span></span><span class="line"><span class="cl"> 8<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 9<span class="o">)</span> <span class="s2">"numAborted"</span>
</span></span><span class="line"><span class="cl"> 10<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 11<span class="o">)</span> <span class="s2">"lastRunDurationMS"</span>
</span></span><span class="line"><span class="cl"> 12<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 13<span class="o">)</span> <span class="s2">"totalRunDurationMS"</span>
</span></span><span class="line"><span class="cl"> 14<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 15<span class="o">)</span> <span class="s2">"avgRunDurationMS"</span>
</span></span><span class="line"><span class="cl"> 16<span class="o">)</span> <span class="s2">"-nan"</span>
</span></span><span class="line"><span class="cl"> 17<span class="o">)</span> <span class="s2">"lastError"</span>
</span></span><span class="line"><span class="cl"> 18<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl"> 19<span class="o">)</span> <span class="s2">"args"</span>
</span></span><span class="line"><span class="cl"> 20<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"trigger"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"test"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"inorder"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 9<span class="o">)</span> <span class="s2">"ExecutionThreadPool"</span>
</span></span><span class="line"><span class="cl"> 10<span class="o">)</span> <span class="s2">"JVMPool"</span>
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/commands/rg-jdumpsessions/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/security/recommended-security-practices/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Recommended security practices
</h1>
<h2 id="deployment-security">
Deployment security
</h2>
<p>
When deploying Redis Enterprise Software to production, we recommend the following practices:
</p>
<ul>
<li>
<p>
<strong>
Deploy Redis Enterprise inside a trusted network
</strong>
: Redis Enterprise is database software and should be deployed on a trusted network not accessible to the public internet. Deploying Redis Enterprise in a trusted network reduces the likelihood that someone can obtain unauthorized access to your data or the ability to manage your database configuration.
</p>
</li>
<li>
<p>
<strong>
Implement anti-virus exclusions
</strong>
: To ensure that anti-virus solutions that scan files or intercept processes to protect memory do not interfere with Redis Enterprise software, you should ensure that anti-virus exclusions are implemented across all nodes in their Redis Enterprise cluster in a consistent policy. This helps ensure that anti-virus software does not impact the availability of your Redis Enterprise cluster.
</p>
<p>
If you are replacing your existing antivirus solution or installing/supporting Redis Enterprise, make sure that the below paths are excluded:
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
For antivirus solutions that intercept processes, binary files may have to be excluded directly depending on the requirements of your anti-virus vendor.
</div>
</div>
<table>
<thead>
<tr>
<th>
<strong>
Path
</strong>
</th>
<th>
<strong>
Description
</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
/opt/redislabs
</td>
<td>
Main installation directory for all Redis Enterprise Software binaries
</td>
</tr>
<tr>
<td>
/opt/redislabs/bin
</td>
<td>
Binaries for all the utilities for command line access and managements such as "rladmin" or "redis-cli"
</td>
</tr>
<tr>
<td>
/opt/redislabs/config
</td>
<td>
System configuration files
</td>
</tr>
<tr>
<td>
/opt/redislabs/lib
</td>
<td>
System library files
</td>
</tr>
<tr>
<td>
/opt/redislabs/sbin
</td>
<td>
System binaries for tweaking provisioning
</td>
</tr>
</tbody>
</table>
</li>
<li>
<p>
<strong>
Send logs to a remote logging server
</strong>
: Redis Enterprise is configured to send logs by default to syslog. To send these logs to a remote logging server you must
<a href="/docs/latest/operate/rs/clusters/logging/log-security/">
configure syslog
</a>
based the requirements of the remote logging server vendor. Remote logging helps ensure that the logs are not deleted so that you can rotate the logs to prevent your server disk from filling up.
</p>
</li>
<li>
<p>
<strong>
Deploy clusters with an odd number of 3 or more nodes
</strong>
: Redis is an available and partition-tolerant database. We recommend that Redis Enterprise be deployed in a cluster of an odd number of 3 or more nodes so that you are able to successfully failover in the event of a failure.
</p>
</li>
<li>
<p>
<strong>
Reboot nodes in a sequence rather than all at once
</strong>
: It is best practice to frequently maintain reboot schedules. If you reboot too many servers at once, it is possible to cause a quorum failure that results in loss of availability of the database. We recommend that rebooting be done in a phased manner so that quorum is not lost. For example, to maintain quorum in a 3 node cluster, at least 2 nodes must be up at all times. Only one server should be rebooted at any given time to maintain quorum.
</p>
</li>
<li>
<p>
<strong>
Implement client-side encryption
</strong>
: Client-side encryption, or the practice of encrypting data within an application before storing it in a database, such as Redis, is the most widely adopted method to achieve encryption in memory. Redis is an in-memory database and stores data in-memory. If you require encryption in memory, better known as encryption in use, then client side encryption may be the right solution for you. Please be aware that database functions that need to operate on data — such as simple searching functions, comparisons, and incremental operations — don’t work with client-side encryption.
</p>
</li>
</ul>
<h2 id="cluster-security">
Cluster security
</h2>
<ul>
<li>
<p>
<strong>
Control the level of access to your system
</strong>
: Redis Enterprise lets you decide which users can access the cluster, which users can access databases, and which users can access both. We recommend preventing database users from accessing the cluster. See
<a href="/docs/latest/operate/rs/security/access-control/">
Access control
</a>
for more information.
</p>
</li>
<li>
<p>
<strong>
Enable LDAP authentication
</strong>
: If your organization uses the Lightweight Directory Access Protocol (LDAP), we recommend enabling Redis Enterprise Software support for role-based LDAP authentication.
</p>
</li>
<li>
<p>
<strong>
Require HTTPS for API endpoints
</strong>
: Redis Enterprise comes with a REST API to help automate tasks. This API is available in both an encrypted and unencrypted endpoint for backward compatibility. You can
<a href="/docs/latest/operate/rs/references/rest-api/encryption/#require-https-for-api-endpoints">
disable the unencrypted endpoint
</a>
with no loss in functionality.
</p>
</li>
</ul>
<h2 id="database-security">
Database security
</h2>
<p>
Redis Enterprise offers several database security controls to help protect your data against unauthorized access and to improve the operational security of your database. The following section details configurable security controls available for implementation.
</p>
<ul>
<li>
<p>
<strong>
Use strong Redis passwords
</strong>
: A frequent recommendation in the security industry is to use strong passwords to authenticate users. This helps to prevent brute force password guessing attacks against your database. Its important to check that your password aligns with your organizations security policy.
</p>
</li>
<li>
<p>
<strong>
Deactivate default user access
</strong>
: Redis Enterprise comes with a "default" user for backwards compatibility with applications designed with versions of Redis prior to Redis Enterprise 6. The default user is turned on by default. This allows you to access the database without specifying a username and only using a shared secret. For applications designed to use access control lists, we recommend that you
<a href="/docs/latest/operate/rs/security/access-control/manage-users/default-user/#deactivate-default-user">
deactivate default user access
</a>
.
</p>
</li>
<li>
<p>
<strong>
Configure Transport Layer Security (TLS)
</strong>
: Similar to the control plane, you can also
<a href="/docs/latest/operate/rs/security/encryption/tls/tls-protocols/">
configure TLS protocols
</a>
to help support your security and compliance needs.
</p>
</li>
<li>
<p>
<strong>
Enable client certificate authentication
</strong>
: To prevent unauthorized access to your data, Redis Enterprise databases support the
<a href="/docs/latest/operate/rs/security/encryption/tls/#client-certificate-authentication">
TLS protocol
</a>
, which includes authentication and encryption. Client certificate authentication can be used to ensure only authorized hosts can access the database.
</p>
</li>
<li>
<p>
<strong>
Install trusted certificates
</strong>
: Redis implements self-signed certificates for the database proxy and replication service, but many organizations prefer to
<a href="/docs/latest/operate/rs/security/certificates/create-certificates/">
use their own certificates
</a>
.
</p>
</li>
<li>
<p>
<strong>
Configure and verify database backups
</strong>
: Implementing a disaster recovery strategy is an important part of data security. Redis Enterprise supports
<a href="/docs/latest/operate/rs/databases/import-export/schedule-backups/">
database backups to many destinations
</a>
.
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/security/recommended-security-practices/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/spring-framework-cache/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Spring Data Redis
</h1>
<p class="text-lg -mt-5 mb-10">
Plug Redis into your Spring application with minimal effort
</p>
<p>
Spring Data Redis implements the Spring framework's cache abstraction for Redis, which allows you to plug Redis into your Spring application with minimal effort.
</p>
<p>
Spring's cache abstraction applies cache-aside to methods, reducing executions by storing and reusing results. When a method is invoked, the abstraction checks if it's been called with the same arguments before. If so, it returns the cached result. If not, it invokes the method, caches the result, and returns it. This way, costly methods are invoked less often. Further details are in the
<a href="https://docs.spring.io/spring-framework/reference/integration/cache.html">
Spring cache abstraction documentation
</a>
.
</p>
<h2 id="get-started">
Get started
</h2>
<p>
In a nutshell, you need to perform the following steps to use Redis as your cache storage:
</p>
<ol>
<li>
<a href="https://docs.spring.io/spring-framework/reference/integration/cache/store-configuration.html">
Configure the cache storage
</a>
by using the
<a href="https://docs.spring.io/spring-data/redis/reference/redis/redis-cache.html">
Redis cache manager
</a>
that is part of Spring Data.
</li>
<li>
Annotate a repository with your
<code>
@CacheConfig
</code>
.
</li>
<li>
Use the
<code>
@Cachable
</code>
annotation on a repository method to cache the results of that method.
</li>
</ol>
<p>
Here is an example:
</p>
<pre tabindex="0"><code>@CacheConfig("books")
public class BookRepositoryImpl implements BookRepository {
@Cacheable
public Book findBook(ISBN isbn) {...}
}
</code></pre>
<h2 id="further-readings">
Further readings
</h2>
<p>
Please read the Spring framework's documentation to learn more about how to use the Redis cache abstraction for Spring:
</p>
<ul>
<li>
<a href="https://docs.spring.io/spring-framework/reference/integration/cache.html">
Spring cache abstraction
</a>
</li>
<li>
<a href="https://docs.spring.io/spring-framework/reference/integration/cache/store-configuration.html">
Spring cache store configuration
</a>
</li>
<li>
<a href="https://docs.spring.io/spring-data/redis/reference/redis/redis-cache.html">
Spring Data Redis Cache
</a>
</li>
</ul>
<nav>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/spring-framework-cache/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/ocsp/test/.html | <section class="prose w-full py-12 max-w-none">
<h1>
OCSP test requests
</h1>
<p class="text-lg -mt-5 mb-10">
OCSP test requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#post-test">
POST
</a>
</td>
<td>
<code>
/v1/ocsp/test
</code>
</td>
<td>
Test OCSP
</td>
</tr>
</tbody>
</table>
<h2 id="post-test">
Test OCSP
</h2>
<pre><code>POST /v1/ocsp/test
</code></pre>
<p>
Queries the OCSP server for the proxy certificate’s latest status and returns the response as JSON. It caches the response if the OCSP feature is enabled.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#test_ocsp_status">
test_ocsp_status
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="post-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>POST /ocsp/test
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="post-response">
Response
</h3>
<p>
Returns an
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ocsp_status/">
OCSP status object
</a>
.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"responder_url"</span><span class="p">:</span> <span class="s2">"http://responder.ocsp.url.com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cert_status"</span><span class="p">:</span> <span class="s2">"REVOKED"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"produced_at"</span><span class="p">:</span> <span class="s2">"Wed, 22 Dec 2021 12:50:11 GMT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"this_update"</span><span class="p">:</span> <span class="s2">"Wed, 22 Dec 2021 12:50:11 GMT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"next_update"</span><span class="p">:</span> <span class="s2">"Wed, 22 Dec 2021 14:50:00 GMT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"revocation_time"</span><span class="p">:</span> <span class="s2">"Wed, 22 Dec 2021 12:50:04 GMT"</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="post-error-codes">
Error codes
</h3>
<p>
When errors occur, the server returns a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
fields that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
no_responder_url
</td>
<td>
Tried to test OCSP status with no responder URL configured
</td>
</tr>
<tr>
<td>
ocsp_unsupported_by_capability
</td>
<td>
Not all nodes support OCSP capability
</td>
</tr>
<tr>
<td>
task_queued_for_too_long
</td>
<td>
OCSP polling task was in status “queued” for over 5 seconds
</td>
</tr>
<tr>
<td>
invalid_ocsp_response
</td>
<td>
The server returned a response that is not compatible with OCSP
</td>
</tr>
</tbody>
</table>
<h3 id="post-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success querying the OCSP server
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">
406 Not Acceptable
</a>
</td>
<td>
Feature is not supported in all nodes
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">
500 Internal Server Error
</a>
</td>
<td>
<code>
responder_url
</code>
is not configured or polling task failed
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/ocsp/test/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/zrevrangebylex/.html | <section class="prose w-full py-12">
<h1 class="command-name">
ZREVRANGEBYLEX
<span class="text-base">
(deprecated)
</span>
</h1>
<div class="border-l-8 pl-4">
<p>
As of Redis version 6.2.0, this command is regarded as deprecated.
</p>
<p>
It can be replaced by
<a href="/docs/latest/commands/zrange/">
<code>
ZRANGE
</code>
</a>
with the
<code>
REV
</code>
and
<code>
BYLEX
</code>
arguments when migrating or writing new code.
</p>
</div>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">ZREVRANGEBYLEX key max min [LIMIT offset count]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.8.9
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@sortedset
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at
<code>
key
</code>
with a value between
<code>
max
</code>
and
<code>
min
</code>
.
</p>
<p>
Apart from the reversed ordering,
<code>
ZREVRANGEBYLEX
</code>
is similar to
<a href="/docs/latest/commands/zrangebylex/">
<code>
ZRANGEBYLEX
</code>
</a>
.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> ZADD myzset 0 a 0 b 0 c 0 d 0 e 0 f 0 g
(integer) 7
redis> ZREVRANGEBYLEX myzset [c -
1) "c"
2) "b"
3) "a"
redis> ZREVRANGEBYLEX myzset (c -
1) "b"
2) "a"
redis> ZREVRANGEBYLEX myzset (g [aaa
1) "f"
2) "e"
3) "d"
4) "c"
5) "b"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of members in the specified score range.
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: List of the elements in the specified score range.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/zrevrangebylex/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Deprecated Redis Stack features and modules
</h1>
<p class="text-lg -mt-5 mb-10">
Features (modules) that have been deprecated or replaced with a new version.
</p>
<p>
The following features (modules) have been deprecated or replaced with a new version:
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Feature
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/">
Triggers and functions
</a>
</td>
<td style="text-align:left">
Trigger and execute JavaScript functions in the Redis process
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/">
Graph
</a>
</td>
<td style="text-align:left">
RedisGraph is a queryable graph database built on Redis.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update/.html | <section class="prose w-full py-12 max-w-none">
<h1>
crdb-cli crdb update
</h1>
<p class="text-lg -mt-5 mb-10">
Updates the configuration of an Active-Active database.
</p>
<p>
Updates the configuration of an Active-Active database.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">crdb-cli crdb update --crdb-guid <guid>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--no-wait<span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--force<span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--default-db-config <configuration> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--default-db-config-file <filename><span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--compression <0-6><span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--causal-consistency <span class="o">{</span> <span class="nb">true</span> <span class="p">|</span> <span class="nb">false</span> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--credentials <span class="nv">id</span><span class="o">=</span><id>,username<span class="o">=</span><username>,password<span class="o">=</span><password> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--encryption <span class="o">{</span> <span class="nb">true</span> <span class="p">|</span> <span class="nb">false</span> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--oss-cluster <span class="o">{</span> <span class="nb">true</span> <span class="p">|</span> <span class="nb">false</span> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--featureset-version <span class="o">{</span> <span class="nb">true</span> <span class="p">|</span> <span class="nb">false</span> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--memory-size <maximum_memory><span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--bigstore-ram-size <maximum_memory><span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>--update-module <span class="nv">name</span><span class="o">=</span><name>,featureset_version<span class="o">=</span><version><span class="o">]</span>
</span></span></code></pre>
</div>
<p>
If you want to change the configuration of the local instance only, use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/">
<code>
rladmin
</code>
</a>
instead.
</p>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
crdb-guid <guid>
</td>
<td>
string
</td>
<td>
GUID of the Active-Active database (required)
</td>
</tr>
<tr>
<td>
bigstore-ram-size <maximum_memory>
</td>
<td>
size in bytes, kilobytes (KB), or gigabytes (GB)
</td>
<td>
Maximum RAM limit for the databases with Auto Tiering enabled, if activated
</td>
</tr>
<tr>
<td>
memory-size <maximum_memory>
</td>
<td>
size in bytes, kilobytes (KB), or gigabytes (GB)
</td>
<td>
Maximum database memory (required)
</td>
</tr>
<tr>
<td>
causal-consistency
</td>
<td>
true
<br/>
false
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/databases/active-active/causal-consistency/">
Causal consistency
</a>
applies updates to all instances in the order they were received
</td>
</tr>
<tr>
<td>
compression
</td>
<td>
0-6
</td>
<td>
The level of data compression:
<br/>
<br/>
0 = No compression
<br/>
<br/>
6 = High compression and resource load (Default: 3)
</td>
</tr>
<tr>
<td>
credentials id=<id>,username=<username>,password=<password>
</td>
<td>
strings
</td>
<td>
Updates the credentials for access to the instance
</td>
</tr>
<tr>
<td>
default-db-config <configuration>
</td>
<td>
</td>
<td>
Default database configuration from stdin
</td>
</tr>
<tr>
<td>
default-db-config-file <filename>
</td>
<td>
filepath
</td>
<td>
Default database configuration from file
</td>
</tr>
<tr>
<td>
encryption
</td>
<td>
true
<br/>
false
</td>
<td>
Activates or deactivates encryption
</td>
</tr>
<tr>
<td>
force
</td>
<td>
</td>
<td>
Force an update even if there are no changes
</td>
</tr>
<tr>
<td>
no-wait
</td>
<td>
</td>
<td>
Do not wait for the command to finish
</td>
</tr>
<tr>
<td>
oss-cluster
</td>
<td>
true
<br/>
false
</td>
<td>
Activates or deactivates OSS Cluster mode
</td>
</tr>
<tr>
<td>
eviction-policy
</td>
<td>
noeviction
<br/>
allkeys-lru
<br/>
allkeys-lfu
<br/>
allkeys-random
<br/>
volatile-lru
<br/>
volatile-lfu
<br/>
volatile-random
<br/>
volatile-ttl
</td>
<td>
Updates
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/eviction-policy/">
eviction policy
</a>
</td>
</tr>
<tr>
<td>
featureset-version
</td>
<td>
true
<br/>
false
</td>
<td>
Updates to latest FeatureSet version
</td>
</tr>
<tr>
<td>
update-module name=<name>,featureset_version=<version>
</td>
<td>
strings
</td>
<td>
Update a module to the specified version
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns the task ID of the task that is updating the database.
</p>
<p>
If
<code>
--no-wait
</code>
is specified, the command exits. Otherwise, it will wait for the database to be updated and then return "finished."
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ crdb-cli crdb update --crdb-guid 968d586c-e12d-4b8f-8473-42eb88d0a3a2 --memory-size 2GBTask 7e98efc1-8233-4578-9e0c-cdc854b8af9e created
</span></span><span class="line"><span class="cl"> ---> Status changed: queued -> started
</span></span><span class="line"><span class="cl"> ---> Status changed: started -> finished
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Transformation examples
</h1>
<p class="text-lg -mt-5 mb-10">
Explore some examples of common RDI transformations
</p>
<nav>
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/redis-hash-example/">
Write to a Redis hash
</a>
<br/>
<br/>
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/redis-json-example/">
Write to a Redis JSON document
</a>
<br/>
<br/>
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/redis-set-example/">
Write to a Redis set
</a>
<br/>
<br/>
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/redis-sorted-set-example/">
Write to a Redis sorted set
</a>
<br/>
<br/>
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/redis-stream-example/">
Write to a Redis stream
</a>
<br/>
<br/>
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/redis-string-example/">
Write to a Redis string
</a>
<br/>
<br/>
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/redis-opcode-example/">
Add the opcode to the Redis output
</a>
<br/>
<br/>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/quick_start_ri/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Quick start using Redis Insight
</h1>
<p class="text-lg -mt-5 mb-10">
Get started with triggers and functions using Redis Insight
</p>
<div class="banner-article rounded-md">
<p>
The Redis Stack triggers and functions feature preview has ended and it will not be promoted to GA.
</p>
</div>
<p>
Make sure that you have
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/">
Redis Stack installed
</a>
and running. Alternatively, you can create a
<a href="https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users">
free Redis Cloud account
</a>
.
</p>
<p>
If you haven't already installed Redis Insight, you can download the latest version
<a href="https://redis.com/redis-enterprise/redis-insight/?_ga=2.232184223.127667221.1704724457-86137583.1685485233&_gl=1*1gygred*_ga*ODYxMzc1ODMuMTY4NTQ4NTIzMw..*_ga_8BKGRQKRPV*MTcwNDkyMzExMC40MDEuMS4xNzA0OTI3MjQ2LjUyLjAuMA..*_gcl_au*MTQzODY1OTU4OS4xNzAxMTg0MzY0">
here
</a>
. If this is your first time using Redis Insight, you may wish to read through the
<a href="/docs/latest/develop/tools/insight/">
Redis Insight guide
</a>
before continuing with this guide.
</p>
<h2 id="connect-to-redis-stack">
Connect to Redis Stack
</h2>
<p>
Open the Redis Insight application, and connect to your database by clicking on its database alias.
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-0.png" sdata-lightbox="/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-0.png">
<img src="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-0.png"/>
</a>
<h2 id="load-a-library">
Load a library
</h2>
<p>
Click on the triggers and functions icon and then on
<strong>
+ Library
</strong>
as shown below.
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-1.png" sdata-lightbox="/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-1.png">
<img src="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-1.png"/>
</a>
<p>
Add your code to the
<strong>
Library Code
</strong>
section of the right-hand panel and then click
<strong>
Add Library
</strong>
.
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-2.png" sdata-lightbox="/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-2.png">
<img src="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-2.png"/>
</a>
<p>
You'll see the following when the library was added:
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-3.png" sdata-lightbox="/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-3.png">
<img src="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-3.png"/>
</a>
<p>
The
<code>
TFCALL
</code>
command is used to execute the JavaScript Function. If the command fails, an error will be returned. Click on the
<strong>
>_ CLI
</strong>
button in the lower left-hand corner to open a console window and then run the command shown below.
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-3a.png" sdata-lightbox="/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-3a.png">
<img src="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-3a.png"/>
</a>
<p>
To update a library you can edit the library code directly in the interface by clicking on the edit (pencil) icon. When you save your changes, the libary will be reloaded.
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-4.png" sdata-lightbox="/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-4.png">
<img src="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-4.png"/>
</a>
<h2 id="uploading-an-external-file">
Uploading an external file
</h2>
<p>
Click on the
<strong>
+ Add Library
</strong>
button as before and, instead of adding the code directly into the editor, click on the
<strong>
Upload
</strong>
button, select the file from your file browser, and then click on
<strong>
Add Library
</strong>
. The file needs to contain the header, which contains the engine identifier, the API version, and the library name:
<code>
#!js api_version=1.0 name=myFirstLibrary
</code>
.
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-5.png" sdata-lightbox="/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-5.png">
<img src="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/images/tf-rdi-5.png"/>
</a>
<h2 id="creating-triggers">
Creating triggers
</h2>
<p>
Functions within Redis can respond to events using keyspace triggers. While the majority of these events are initiated by command invocations, they also include events that occur when a key expires or is removed from the database.
</p>
<p>
For the full list of supported events, please refer to the
<a href="/docs/latest/develop/use/keyspace-notifications#events-generated-by-different-commands/?utm_source=redis&utm_medium=app&utm_campaign=redisinsight_triggers_and_functions_guide">
Redis keyspace notifications page
</a>
.
</p>
<p>
The following code creates a new keyspace trigger that adds a new field to a new or updated hash with the latest update time.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="err">#</span><span class="o">!</span><span class="nx">js</span> <span class="nx">name</span><span class="o">=</span><span class="nx">myFirstLibrary</span> <span class="nx">api_version</span><span class="o">=</span><span class="mf">1.0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">addLastUpdatedField</span><span class="p">(</span><span class="nx">client</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">if</span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">event</span> <span class="o">==</span> <span class="s1">'hset'</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">currentDateTime</span> <span class="o">=</span> <span class="nb">Date</span><span class="p">.</span><span class="nx">now</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s1">'hset'</span><span class="p">,</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span><span class="p">,</span> <span class="s1">'last_updated'</span><span class="p">,</span> <span class="nx">currentDateTime</span><span class="p">.</span><span class="nx">toString</span><span class="p">());</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">// Register the KeySpaceTrigger 'AddLastUpdated' for keys with the prefix 'fellowship'
</span></span></span><span class="line"><span class="cl"><span class="c1">// with the callback function 'addLastUpdatedField'.
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="nx">redis</span><span class="p">.</span><span class="nx">registerKeySpaceTrigger</span><span class="p">(</span><span class="s1">'addLastUpdated'</span><span class="p">,</span> <span class="s1">'fellowship:'</span><span class="p">,</span> <span class="nx">addLastUpdatedField</span><span class="p">);</span><span class="err">"</span>
</span></span></code></pre>
</div>
<p>
Update the existing library as before and then, using the Redis Insight console, add a new hash with the required prefix to trigger the function.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-Shell" data-lang="Shell"><span class="line"><span class="cl">> HSET fellowship:1 name <span class="s2">"Frodo Baggins"</span> title <span class="s2">"The One Ring Bearer"</span>
</span></span></code></pre>
</div>
<p>
Run the
<a href="/docs/latest/commands/hgetall/">
<code>
HGETALL
</code>
</a>
command to check if the last updated time is added to the example.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-Shell" data-lang="Shell"><span class="line"><span class="cl">> HGETALL fellowship:1
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="s2">"name"</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"Frodo Baggins"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="s2">"title"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"The One Ring Bearer"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> <span class="s2">"last_updated"</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> <span class="s2">"1693238681822"</span>
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/quick_start_ri/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster_settings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster settings object
</h1>
<p class="text-lg -mt-5 mb-10">
An object for cluster resource management settings
</p>
<p>
Cluster resources management policy
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
acl_pubsub_default
</td>
<td>
<code>
resetchannels
</code>
<br/>
<code>
allchannels
</code>
</td>
<td>
Default pub/sub ACL rule for all databases in the cluster:
<br/>
•
<code>
resetchannels
</code>
blocks access to all channels (restrictive)
<br/>
•
<code>
allchannels
</code>
allows access to all channels (permissive)
</td>
</tr>
<tr>
<td>
auto_recovery
</td>
<td>
boolean (default: false)
</td>
<td>
Defines whether to use automatic recovery after shard failure
</td>
</tr>
<tr>
<td>
automatic_node_offload
</td>
<td>
boolean (default: true)
</td>
<td>
Defines whether the cluster will automatically migrate shards from a node, in case the node is overbooked
</td>
</tr>
<tr>
<td>
bigstore_migrate_node_threshold
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory
</td>
</tr>
<tr>
<td>
bigstore_migrate_node_threshold_p
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory
</td>
</tr>
<tr>
<td>
bigstore_provision_node_threshold
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it
</td>
</tr>
<tr>
<td>
bigstore_provision_node_threshold_p
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it
</td>
</tr>
<tr>
<td>
data_internode_encryption
</td>
<td>
boolean
</td>
<td>
Enable/deactivate encryption of the data plane internode communication
</td>
</tr>
<tr>
<td>
db_conns_auditing
</td>
<td>
boolean
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/security/audit-events/">
Audit connections
</a>
for new databases by default if set to true.
</td>
</tr>
<tr>
<td>
default_concurrent_restore_actions
</td>
<td>
integer
</td>
<td>
Default number of restore actions allowed at the same time. Set to 0 to allow any number of simultaneous restore actions.
</td>
</tr>
<tr>
<td>
default_fork_evict_ram
</td>
<td>
boolean
</td>
<td>
If true, the bdbs should evict data from RAM to ensure successful replication or persistence
</td>
</tr>
<tr>
<td>
default_non_sharded_proxy_policy
</td>
<td>
<code>
single
</code>
<br/>
<br/>
<code>
all-master-shards
</code>
<br/>
<br/>
<code>
all-nodes
</code>
</td>
<td>
Default proxy_policy for newly created non-sharded databases' endpoints
</td>
</tr>
<tr>
<td>
default_provisioned_redis_version
</td>
<td>
string
</td>
<td>
Default Redis version
</td>
</tr>
<tr>
<td>
default_sharded_proxy_policy
</td>
<td>
<code>
single
</code>
<br/>
<br/>
<code>
all-master-shards
</code>
<br/>
<br/>
<code>
all-nodes
</code>
</td>
<td>
Default proxy_policy for newly created sharded databases' endpoints
</td>
</tr>
<tr>
<td>
default_shards_placement
</td>
<td>
<code>
dense
</code>
<br/>
<code>
sparse
</code>
</td>
<td>
Default shards_placement for a newly created databases
</td>
</tr>
<tr>
<td>
endpoint_rebind_propagation_grace_time
</td>
<td>
integer
</td>
<td>
Time to wait between the addition and removal of a proxy
</td>
</tr>
<tr>
<td>
failure_detection_sensitivity
</td>
<td>
<code>
high
</code>
<br/>
<code>
low
</code>
</td>
<td>
Predefined thresholds and timeouts for failure detection (previously known as
<span class="break-all">
<code>
watchdog_profile
</code>
</span>
)
<br/>
•
<code>
high
</code>
(previously
<code>
local-network
</code>
) – high failure detection sensitivity, lower thresholds, faster failure detection and failover
<br/>
•
<code>
low
</code>
(previously
<code>
cloud
</code>
) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter)
</td>
</tr>
<tr>
<td>
hide_user_data_from_log
</td>
<td>
boolean (default: false)
</td>
<td>
Set to
<code>
true
</code>
to enable the
<code>
hide-user-data-from-log
</code>
Redis configuration setting, which avoids logging user data
</td>
</tr>
<tr>
<td>
login_lockout_counter_reset_after
</td>
<td>
integer
</td>
<td>
Number of seconds that must elapse between failed sign in attempts before the lockout counter is reset to 0.
</td>
</tr>
<tr>
<td>
login_lockout_duration
</td>
<td>
integer
</td>
<td>
Duration (in secs) of account lockout. If set to 0, the account lockout will persist until released by an admin.
</td>
</tr>
<tr>
<td>
login_lockout_threshold
</td>
<td>
integer
</td>
<td>
Number of failed sign in attempts allowed before locking a user account
</td>
</tr>
<tr>
<td>
max_saved_events_per_type
</td>
<td>
integer
</td>
<td>
Maximum saved events per event type
</td>
</tr>
<tr>
<td>
max_simultaneous_backups
</td>
<td>
integer (default: 4)
</td>
<td>
Maximum number of backup processes allowed at the same time
</td>
</tr>
<tr>
<td>
parallel_shards_upgrade
</td>
<td>
integer
</td>
<td>
Maximum number of shards to upgrade in parallel
</td>
</tr>
<tr>
<td>
persistence_cleanup_scan_interval
</td>
<td>
string
</td>
<td>
<a href="https://en.wikipedia.org/wiki/Cron#CRON_expression">
CRON expression
</a>
that defines the Redis cleanup schedule
</td>
</tr>
<tr>
<td>
persistent_node_removal
</td>
<td>
boolean
</td>
<td>
When removing a node, wait for persistence files to be created for all migrated shards
</td>
</tr>
<tr>
<td>
rack_aware
</td>
<td>
boolean
</td>
<td>
Cluster operates in a rack-aware mode
</td>
</tr>
<tr>
<td>
redis_migrate_node_threshold
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory
</td>
</tr>
<tr>
<td>
redis_migrate_node_threshold_p
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory
</td>
</tr>
<tr>
<td>
redis_provision_node_threshold
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it
</td>
</tr>
<tr>
<td>
redis_provision_node_threshold_p
</td>
<td>
integer
</td>
<td>
Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it
</td>
</tr>
<tr>
<td>
redis_upgrade_policy
</td>
<td>
<strong>
<code>
major
</code>
</strong>
<br/>
<code>
latest
</code>
</td>
<td>
Create/upgrade Redis Enterprise software on databases in the cluster by compatibility with major versions or latest versions of Redis Community Edition
</td>
</tr>
<tr>
<td>
resp3_default
</td>
<td>
boolean (default: true)
</td>
<td>
Determines the default value of the
<code>
resp3
</code>
option upon upgrading a database to version 7.2
</td>
</tr>
<tr>
<td>
shards_overbooking
</td>
<td>
boolean
</td>
<td>
If true, all databases' memory_size is ignored during shards placement
</td>
</tr>
<tr>
<td>
show_internals
</td>
<td>
boolean
</td>
<td>
Show internal databases (and their shards and endpoints) REST APIs
</td>
</tr>
<tr>
<td>
slave_ha
</td>
<td>
boolean
</td>
<td>
Enable the replica high-availability mechanism. Deprecated as of Redis Enterprise Software v7.2.4.
</td>
</tr>
<tr>
<td>
slave_ha_bdb_cooldown_period
</td>
<td>
integer
</td>
<td>
Time in seconds between runs of the replica high-availability mechanism on different nodes on the same database
</td>
</tr>
<tr>
<td>
slave_ha_cooldown_period
</td>
<td>
integer
</td>
<td>
Time in seconds between runs of the replica high-availability mechanism on different nodes on the same database
</td>
</tr>
<tr>
<td>
slave_ha_grace_period
</td>
<td>
integer
</td>
<td>
Time in seconds between a node failure and when the replica high-availability mechanism starts relocating shards
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster_settings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/objects/services_configuration/crdb_coordinator/.html | <section class="prose w-full py-12 max-w-none">
<h1>
CRDB coordinator object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the crdb_coordinator object used with Redis Enterprise Software REST API calls.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
operating_mode
</td>
<td>
'disabled'
<br/>
'enabled'
</td>
<td>
Enable/disable the CRDB coordinator process
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/objects/services_configuration/crdb_coordinator/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/write-behind/reference/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Write-behind reference
</h1>
<p class="text-lg -mt-5 mb-10">
Collects reference material for Write-behind
</p>
<nav>
<a href="/docs/latest/integrate/write-behind/reference/cli/">
CLI
</a>
<p>
Write-behind CLI reference
</p>
<a href="/docs/latest/integrate/write-behind/reference/data-types-conversion/">
Data type conversion
</a>
<p>
Data type conversion reference
</p>
<a href="/docs/latest/integrate/write-behind/reference/config-yaml-reference/">
Write-behind configuration file
</a>
<p>
Write-behind configuration file reference
</p>
<a href="/docs/latest/integrate/write-behind/reference/data-transformation-block-types/">
Data transformation block types
</a>
<p>
Data transformation block type reference
</p>
<a href="/docs/latest/integrate/write-behind/reference/jmespath-custom-functions/">
JMESPath custom functions
</a>
<p>
JMESPath custom function reference
</p>
<a href="/docs/latest/integrate/write-behind/reference/debezium/">
Debezium Server configuration file
</a>
<p>
Application properties settings used to configure Debezim Server for source database servers
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/write-behind/reference/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/riot/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RIOT
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Input/Output Tools
</p>
<p>
Redis Input/Output Tools (RIOT) is a command-line utility designed to help you get data in and out of Redis.
</p>
<p>
It supports many different sources and targets:
</p>
<ul>
<li>
<a href="https://redis.github.io/riot/#_file">
Files
</a>
(CSV, JSON, XML)
</li>
<li>
<a href="https://redis.github.io/riot/#_datagen">
Data generators
</a>
(Redis data structures, Faker)
</li>
<li>
<a href="https://redis.github.io/riot/#_db">
Relational databases
</a>
</li>
<li>
<a href="https://redis.github.io/riot/#_replication">
Redis itself
</a>
(snapshot and live replication)
</li>
</ul>
<p>
Full documentation is available at
<a href="https://redis.github.io/riot/">
redis.github.io/riot
</a>
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/riot/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/xsetid/.html | <section class="prose w-full py-12">
<h1 class="command-name">
XSETID
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">XSETID key last-id [ENTRIESADDED entries-added]
[MAXDELETEDID max-deleted-id]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
5.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@stream
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The
<code>
XSETID
</code>
command is an internal command.
It is used by a Redis master to replicate the last delivered ID of streams.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
.
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 7.0.0: Added the
<code>
entries_added
</code>
and
<code>
max_deleted_entry_id
</code>
arguments.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/xsetid/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/cloud-integrations/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Manage marketplace integrations
</h1>
<p class="text-lg -mt-5 mb-10">
Describes how to integrate Redis Cloud subscriptions into existing cloud provider services, whether existing subscriptions or through vendor marketplaces.
</p>
<p>
By default, Redis Cloud subscriptions are hosted in cloud vendor accounts owned and managed by Redis, Inc.
</p>
<p>
To integrate Redis Cloud into an existing cloud vendor account, you can:
</p>
<ul>
<li>
<p>
Subscribe to Redis Cloud through
<a href="/docs/latest/operate/rc/cloud-integrations/aws-marketplace/">
AWS Marketplace
</a>
.
</p>
</li>
<li>
<p>
Subscribe to Redis Cloud through
<a href="/docs/latest/operate/rc/cloud-integrations/gcp-marketplace/">
Google Cloud Marketplace
</a>
.
</p>
</li>
</ul>
<p>
When you subscribe to Redis Cloud through a cloud vendor marketplace, billing is handled through the marketplace.
</p>
<h2 id="marketplace-billing-considerations">
Marketplace billing considerations
</h2>
<p>
Cloud vendor marketplaces provide a convenient way to handle multiple subscription fees. However, this also means that billing issues impact multiple subscriptions, including Redis Cloud.
</p>
<p>
When billing details change, you should verify that each service is operating normally and reflects the updated billing details. Otherwise, you might experience unexpected consequences, such as data loss or subscription removal.
</p>
<p>
For best results, we recommend:
</p>
<ul>
<li>
<p>
Backing up all data
<em>
before
</em>
updating billing details.
</p>
</li>
<li>
<p>
Verifying that all accounts operate normally after updating billing details, especially after updating payment methods.
</p>
</li>
<li>
<p>
Making sure that billing alerts are sent to actively monitored accounts.
</p>
</li>
</ul>
<h2 id="update-marketplace-billing-details">
Update marketplace billing details
</h2>
<h3 id="aws-marketplace">
AWS Marketplace
</h3>
<p>
To change billing details for an AWS marketplace subscription, we recommend creating a second subscription using the updated billing details and then migrating your existing data to the new subscription.
</p>
<h3 id="google-cloud">
Google Cloud
</h3>
<p>
You can migrate a Google Cloud project to a new billing account without creating a new subscription. To do so:
</p>
<ol>
<li>
Create a second project and associate with it your new billing account.
</li>
<li>
With your second project, purchase Redis Enterprise via the Google Cloud Marketplace.
</li>
<li>
Activate the service by signing in to Redis Enterprise console using your original SSO credentials.
</li>
<li>
Change the billing account for your original project to the new billing account.
</li>
<li>
(Optional) Remove your second project.
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/cloud-integrations/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/uptrace-with-redis-enterprise/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Uptrace with Redis Enterprise
</h1>
<p class="text-lg -mt-5 mb-10">
To collect, view, and monitor metrics data from your databases and other cluster components, you can connect Uptrace to your Redis Enterprise cluster using OpenTelemetry Collector.
</p>
<p>
Uptrace is an
<a href="https://uptrace.dev/get/open-source-apm.html">
open source APM tool
</a>
that supports distributed tracing, metrics, and logs. You can use it to monitor applications and set up automatic alerts to receive notifications.
</p>
<p>
Uptrace uses OpenTelemetry to collect and export telemetry data from software applications such as Redis. OpenTelemetry is an open source observability framework that aims to provide a single standard for all types of observability signals such as traces, metrics, and logs.
</p>
<p>
With OpenTelemetry Collector, you can receive, process, and export telemetry data to any
<a href="https://uptrace.dev/blog/opentelemetry-backend.html">
OpenTelemetry backend
</a>
. You can also use Collector to scrape Prometheus metrics provided by Redis and then export those metrics to Uptrace.
</p>
<p>
You can use Uptrace to:
</p>
<ul>
<li>
Collect and display data metrics not available in the
<a href="/docs/latest/operate/rs/references/metrics/">
admin console
</a>
.
</li>
<li>
Use prebuilt dashboard templates maintained by the Uptrace community.
</li>
<li>
Set up automatic alerts and receive notifications via email, Slack, Telegram, and others.
</li>
<li>
Monitor your app performance and logs using
<a href="https://uptrace.dev/opentelemetry/distributed-tracing.html">
OpenTelemetry tracing
</a>
.
</li>
</ul>
<a href="/docs/latest/images/rs/uptrace-redis-nodes.png" sdata-lightbox="/images/rs/uptrace-redis-nodes.png">
<img src="/docs/latest/images/rs/uptrace-redis-nodes.png"/>
</a>
<h2 id="install-collector-and-uptrace">
Install Collector and Uptrace
</h2>
<p>
Because installing OpenTelemetry Collector and Uptrace can take some time, you can use the
<a href="https://github.com/uptrace/uptrace/tree/master/example/redis-enterprise">
docker-compose
</a>
example that also comes with Redis Enterprise cluster.
</p>
<p>
After you download the Docker example, you can edit the following configuration files in the
<code>
uptrace/example/redis-enterprise
</code>
directory before you start the Docker containers:
</p>
<ul>
<li>
<code>
otel-collector.yaml
</code>
- Configures
<code>
/etc/otelcol-contrib/config.yaml
</code>
in the OpenTelemetry Collector container.
</li>
<li>
<code>
uptrace.yml
</code>
- Configures
<code>
/etc/uptrace/uptrace.yml
</code>
in the Uptrace container.
</li>
</ul>
<p>
You can also install OpenTelemetry and Uptrace from scratch using the following guides:
</p>
<ul>
<li>
<a href="https://uptrace.dev/opentelemetry/collector.html">
Getting started with OpenTelemetry Collector
</a>
</li>
<li>
<a href="https://uptrace.dev/get/get-started.html">
Getting started with Uptrace
</a>
</li>
</ul>
<p>
After you install Uptrace, you can access the Uptrace UI at
<a href="http://localhost:14318/">
http://localhost:14318/
</a>
.
</p>
<h2 id="scrape-prometheus-metrics">
Scrape Prometheus metrics
</h2>
<p>
Redis Enterprise cluster exposes a Prometheus scraping endpoint on
<code>
http://localhost:8070/
</code>
. You can scrape that endpoint by adding the following lines to the OpenTelemetry Collector config:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="c"># /etc/otelcol-contrib/config.yaml</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">prometheus_simple/cluster1</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">collection_interval</span><span class="p">:</span><span class="w"> </span><span class="l">10s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">endpoint</span><span class="p">:</span><span class="w"> </span><span class="s2">"localhost:8070"</span><span class="w"> </span><span class="c"># Redis Cluster endpoint</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">metrics_path</span><span class="p">:</span><span class="w"> </span><span class="s2">"/"</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">insecure</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">insecure_skip_verify</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">min_version</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.0"</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
Next, you can export the collected metrics to Uptrace using OpenTelemetry protocol (OTLP):
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="c"># /etc/otelcol-contrib/config.yaml</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">receivers</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">otlp</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">protocols</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">grpc</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">http</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">exporters</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">otlp/uptrace</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="c"># Uptrace is accepting metrics on this port</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">endpoint</span><span class="p">:</span><span class="w"> </span><span class="l">localhost:14317</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> </span>{<span class="w"> </span><span class="nt">"uptrace-dsn": </span><span class="s2">"http://project1_secret_token@localhost:14317/1"</span><span class="w"> </span>}<span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w"> </span>{<span class="w"> </span><span class="nt">insecure</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span>}<span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">service</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pipelines</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">traces</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">receivers</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">otlp]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">processors</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">batch]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">exporters</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">otlp/uptrace]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">metrics</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">receivers</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">otlp, prometheus_simple/cluster1]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">processors</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">batch]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">exporters</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">otlp/uptrace]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">logs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">receivers</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">otlp]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">processors</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">batch]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">exporters</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="l">otlp/uptrace]</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
Don't forget to restart the Collector and then check logs for any errors:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">docker-compose logs otel-collector
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># or</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">sudo journalctl -u otelcol-contrib -f
</span></span></code></pre>
</div>
<p>
You can also check the full OpenTelemetry Collector config
<a href="https://github.com/uptrace/uptrace/blob/master/example/redis-enterprise/otel-collector.yaml">
here
</a>
.
</p>
<h2 id="view-metrics">
View metrics
</h2>
<p>
When metrics start arriving to Uptrace, you should see a couple of dashboards in the Metrics tab. In total, Uptrace should create 3 dashboards for Redis Enterprise metrics:
</p>
<ul>
<li>
<p>
"Redis: Nodes" dashboard displays a list of cluster nodes. You can select a node to view its metrics.
</p>
</li>
<li>
<p>
"Redis: Databases" displays a list of Redis databases in all cluster nodes. To find a specific database, you can use filters or sort the table by columns.
</p>
</li>
<li>
<p>
"Redis: Shards" contains a list of shards that you have in all cluster nodes. You can filter or sort shards and select a shard for more details.
</p>
</li>
</ul>
<h2 id="monitor-metrics">
Monitor metrics
</h2>
<p>
To start monitoring metrics, you need to create metrics monitors using Uptrace UI:
</p>
<ul>
<li>
Open "Alerts" -> "Monitors".
</li>
<li>
Click "Create monitor" -> "Create metrics monitor".
</li>
</ul>
<p>
For example, the following monitor uses the
<code>
group by node
</code>
expression to create an alert whenever an individual Redis shard is down:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">monitors</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Redis shard is down</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">metrics</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">redis_up as $redis_up</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">query</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by cluster</span><span class="w"> </span><span class="c"># monitor each cluster,</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by bdb</span><span class="w"> </span><span class="c"># each database,</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by node</span><span class="w"> </span><span class="c"># and each shard</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">$redis_up</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">min_allowed_value</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="c"># shard should be down for 5 minutes to trigger an alert</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">for_duration</span><span class="p">:</span><span class="w"> </span><span class="l">5m</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
You can also create queries with more complex expressions.
</p>
<p>
For example, the following monitors create an alert when the keyspace hit rate is lower than 75% or memory fragmentation is too high:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">monitors</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Redis read hit rate < 75%</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">metrics</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">redis_keyspace_read_hits as $hits</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">redis_keyspace_read_misses as $misses</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">query</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by cluster</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by bdb</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by node</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">$hits / ($hits + $misses) as hit_rate</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">min_allowed_value</span><span class="p">:</span><span class="w"> </span><span class="m">0.75</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">for_duration</span><span class="p">:</span><span class="w"> </span><span class="l">5m</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">Memory fragmentation is too high</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">metrics</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">redis_used_memory as $mem_used</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">redis_mem_fragmentation_ratio as $fragmentation</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">query</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by cluster</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by bdb</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">group by node</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">where $mem_used > 32mb</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">$fragmentation</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">max_allowed_value</span><span class="p">:</span><span class="w"> </span><span class="m">3</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">for_duration</span><span class="p">:</span><span class="w"> </span><span class="l">5m</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
You can learn more about the query language
<a href="https://uptrace.dev/get/querying-metrics.html">
here
</a>
.
</p>
<nav>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/uptrace-with-redis-enterprise/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync/.html | <section class="prose w-full py-12 max-w-none">
<h1>
BDB replica sync field
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the bdb replica_sync field used with Redis Enterprise Software REST API calls.
</p>
<p>
The BDB
<code>
replica_sync
</code>
field relates to the
<a href="/docs/latest/operate/rs/7.4/databases/import-export/replica-of/create/">
Replica Of
</a>
feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard).
</p>
<p>
You can use the
<code>
replica_sync
</code>
field to enable, disable, or pause the
<a href="/docs/latest/operate/rs/7.4/databases/import-export/replica-of/create/">
Replica Of
</a>
sync process. The BDB
<code>
crdt_sync
</code>
field has a similar purpose for the Redis CRDB.
</p>
<p>
Possible BDB sync values:
</p>
<table>
<thead>
<tr>
<th>
Status
</th>
<th>
Description
</th>
<th>
Possible next status
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
'disabled'
</td>
<td>
(default value) Disables the sync process and represents that no sync is currently configured or running.
</td>
<td>
'enabled'
</td>
</tr>
<tr>
<td>
'enabled'
</td>
<td>
Enables the sync process and represents that the process is currently active.
</td>
<td>
'stopped'
<br/>
'paused'
</td>
</tr>
<tr>
<td>
'paused'
</td>
<td>
Pauses the sync process. The process is configured but is not currently executing any sync commands.
</td>
<td>
'enabled'
<br/>
'stopped'
</td>
</tr>
<tr>
<td>
'stopped'
</td>
<td>
An unrecoverable error occurred during the sync process, which caused the system to stop the sync.
</td>
<td>
'enabled'
</td>
</tr>
</tbody>
</table>
<a href="/docs/latest/images/rs/rest-api-bdb-sync.png#no-click" sdata-lightbox="/images/rs/rest-api-bdb-sync.png#no-click">
<img alt="BDB sync" src="/docs/latest/images/rs/rest-api-bdb-sync.png#no-click"/>
</a>
<p>
When the sync is in the 'stopped' or 'paused' state, then the
<code>
last_error
</code>
field in the relevant source entry in the
<code>
sync_sources
</code>
"status" field contains the detailed error message.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster services configuration requests
</h1>
<p class="text-lg -mt-5 mb-10">
Cluster services configuration requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-cluster-services_config">
GET
</a>
</td>
<td>
<code>
/v1/cluster/services_configuration
</code>
</td>
<td>
Get cluster services settings
</td>
</tr>
<tr>
<td>
<a href="#put-cluster-services_config">
PUT
</a>
</td>
<td>
<code>
/v1/cluster/services_configuration
</code>
</td>
<td>
Update cluster services settings
</td>
</tr>
</tbody>
</table>
<h2 id="get-cluster-services_config">
Get cluster services configuration
</h2>
<pre><code>GET /v1/cluster/services_configuration
</code></pre>
<p>
Get cluster services settings.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_cluster_info">
view_cluster_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /cluster/services_configuration
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/services_configuration/">
services configuration object
</a>
.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cm_server"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"operating_mode"</span><span class="p">:</span> <span class="s2">"disabled"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"mdns_server"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"operating_mode"</span><span class="p">:</span> <span class="s2">"enabled"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional services..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
</tbody>
</table>
<h2 id="put-cluster-services_config">
Update cluster services configuration
</h2>
<pre><code>PUT /v1/cluster/services_configuration
</code></pre>
<p>
Update the cluster services settings.
</p>
<h4 id="required-permissions-1">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#update_cluster">
update_cluster
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="put-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>PUT /cluster/services_configuration
</code></pre>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cm_server"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"operating_mode"</span><span class="p">:</span> <span class="s2">"disabled"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional services..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="request-headers-1">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="request-body">
Request body
</h4>
<p>
Include a
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/services_configuration/">
services configuration object
</a>
with updated fields in the request body.
</p>
<h3 id="put-response">
Response
</h3>
<p>
Returns the updated
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/services_configuration/">
services configuration object
</a>
.
</p>
<h4 id="example-json-body-2">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cm_server"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"operating_mode"</span><span class="p">:</span> <span class="s2">"disabled"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"mdns_server"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"operating_mode"</span><span class="p">:</span> <span class="s2">"enabled"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional services..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="put-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/compatibility/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Cloud compatibility with Redis Community Edition
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Cloud compatibility with Redis Community Edition.
</p>
<p>
Both
<a href="/docs/latest/operate/rs/">
Redis Enterprise Software
</a>
and Redis Cloud are compatible with Redis Community Edition.
</p>
<p>
Redis contributes extensively to the Redis project and uses it inside of Redis Enterprise Software and Redis Cloud. As a rule, we adhere to the project's specifications and update both products with the latest version of Redis.
</p>
<h2 id="redis-commands">
Redis commands
</h2>
<p>
See
<a href="/docs/latest/operate/rs/references/compatibility/commands/">
Compatibility with Redis commands
</a>
to learn which Redis commands are compatible with Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="configuration-settings">
Configuration settings
</h2>
<p>
<a href="/docs/latest/operate/rs/references/compatibility/config-settings/">
Compatibility with Redis configuration settings
</a>
lists the Redis configuration settings supported by Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="redis-clients">
Redis clients
</h2>
<p>
You can use any standard
<a href="/docs/latest/develop/clients/">
Redis client
</a>
with Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="resp-compatibility">
RESP compatibility
</h2>
<p>
Redis Enterprise Software and Redis Cloud support RESP2 and RESP3. In Redis Cloud, you can choose between RESP2 and RESP3 when you
<a href="/docs/latest/operate/rc/databases/create-database/">
create a database
</a>
and you can change it when you
<a href="/docs/latest/operate/rc/databases/view-edit-database/">
edit a database
</a>
. For more information about the different RESP versions, see the
<a href="/docs/latest/develop/reference/protocol-spec/#resp-versions">
Redis serialization protocol specification
</a>
.
</p>
<h2 id="client-side-caching-compatibility">
Client-side caching compatibility
</h2>
<p>
Redis Software and Redis Cloud support
<a href="/docs/latest/develop/clients/client-side-caching/">
client-side caching
</a>
for databases with Redis versions 7.4 or later. See
<a href="/docs/latest/operate/rs/references/compatibility/client-side-caching/">
Client-side caching compatibility with Redis Software and Redis Cloud
</a>
for more information about compatibility.
</p>
<h2 id="compatibility-with-redis-cluster-api">
Compatibility with Redis Cluster API
</h2>
<p>
Redis Cloud supports
<a href="/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api">
Redis Cluster API
</a>
on Redis Cloud Pro if it is enabled for a database. Review
<a href="/docs/latest/operate/rs/clusters/optimize/oss-cluster-api/">
Redis Cluster API architecture
</a>
to determine if you should enable this feature for your database.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/compatibility/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/api/examples/manage-cloud-accounts/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Create and manage cloud accounts
</h1>
<p class="text-lg -mt-5 mb-10">
Cloud accounts specify which account to use when creating and modifying infrastructure resources.
</p>
<p>
You can use the Redis Cloud REST API to create and manage cloud accounts.
</p>
<p>
These examples use the
<a href="/docs/latest/operate/rc/api/get-started/use-rest-api/#use-the-curl-http-client">
<code>
cURL
</code>
utility
</a>
; you can use any REST client to work with the Redis Cloud REST API.
</p>
<h2 id="create-a-cloud-account">
Create a cloud account
</h2>
<p>
To create a cloud account, use the
<code>
POST /v1/cloud-accounts
</code>
endpoint.
</p>
<p>
The created cloud account is defined by a JSON document that is sent as the body of the request.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">POST https://<span class="o">[</span>host<span class="o">]</span>/v1/cloud-accounts
</span></span><span class="line"><span class="cl"><span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"accessKeyId"</span>: <span class="s2">"</span><span class="nv">$ACCESS_KEY_ID</span><span class="s2">"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"accessSecretKey"</span>: <span class="s2">"</span><span class="nv">$ACCESS_SECRET_KEY</span><span class="s2">"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"consolePassword"</span>: <span class="s2">"</span><span class="nv">$CONSOLE_PASSWORD</span><span class="s2">"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"consoleUsername"</span>: <span class="s2">"</span><span class="nv">$CONSOLE_USERNAME</span><span class="s2">"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"name"</span>: <span class="s2">"My new Cloud Account"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"provider"</span>: <span class="s2">"AWS"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"signInLoginUrl"</span>: <span class="s2">"https://</span><span class="nv">$AWS_ACCOUNT_IDENTIFIER</span><span class="s2">.signin.aws.amazon.com/console"</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span></code></pre>
</div>
<p>
The POST response is a JSON document that contains the
<code>
taskId
</code>
. You can use
<code>
GET /v1/tasks/<taskId>
</code>
to track the status of the cloud account creation.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/api/examples/manage-cloud-accounts/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/databases/create-database/create-active-active-database/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Create an Active-Active database
</h1>
<p class="text-lg -mt-5 mb-10">
Shows how to create an Active-Active database
</p>
<p>
Active-Active databases store data across multiple regions and availability zones. This improves scalability, performance, and availability, especially when compared to standalone databases. See
<a href="/docs/latest/operate/rc/databases/configuration/active-active-redis/">
Active-Active Redis
</a>
for more information.
</p>
<p>
To deploy Active-Active databases in Redis Cloud, you need a Redis Cloud Pro plan that enables Active-Active Redis and defines the regions for each copy of your databases.
</p>
<p>
Active-Active databases consist of multiple copies (also called
<em>
instances
</em>
) deployed to different regions throughout the world.
</p>
<p>
This reduces latency for local users and improves availability should a region fail.
</p>
<p>
Redis Cloud maintains consistency among instances in the background; that is, each copy eventually includes updates from every region. As a result, memory limit and throughput increase.
</p>
<h2 id="create-an-active-active-database">
Create an Active-Active database
</h2>
<p>
Before creating a Redis Cloud database, you need to
<a href="/docs/latest/operate/rc/rc-quickstart/">
create an account
</a>
.
</p>
<p>
To create a database in your Redis Cloud account:
</p>
<ol>
<li>
<p>
Sign in to the
<a href="https://cloud.redis.io">
Redis Cloud console
</a>
.
</p>
</li>
<li>
<p>
Select the
<strong>
New database
</strong>
button.
</p>
<a href="/docs/latest/images/rc/button-database-new.png" sdata-lightbox="/images/rc/button-database-new.png">
<img alt="The New Database button creates a new database." src="/docs/latest/images/rc/button-database-new.png" width="120px"/>
</a>
<p>
This displays the
<strong>
Create database
</strong>
screen.
</p>
</li>
<li>
<p>
Select your Redis use case. There are four pre-defined use cases:
</p>
<a href="/docs/latest/images/rc/create-database-redis-use-cases.png" sdata-lightbox="/images/rc/create-database-redis-use-cases.png">
<img alt="The Redis Use case panel" src="/docs/latest/images/rc/create-database-redis-use-cases.png"/>
</a>
<ul>
<li>
<strong>
Cache
</strong>
: Stores short-term or volatile data. Can be used for session management, semantic cache, session store, and other uses where data is short-lived.
</li>
<li>
<strong>
Database
</strong>
: Stores durable and consistent data. Can be used for document databases, feature storage, gaming leaderboards, durable caches, and other uses where your data needs to be highly available and persistent.
</li>
<li>
<strong>
Vector search
</strong>
: Manages and manipulates vector data. Can be used for Generative AI, recommendation systems, visual search, and other uses where you can search and query your data.
</li>
<li>
<strong>
Custom
</strong>
: If your Redis use case doesn't match any of the other use cases, you can choose this option to customize all of your settings.
</li>
</ul>
<p>
Select the use case that best matches your Redis use case. You can always change the settings later.
</p>
</li>
</ol>
<ol start="4">
<li>
<p>
Select the type of
<a href="/docs/latest/operate/rc/subscriptions/">
subscription
</a>
you need. For this guide, select
<strong>
Pro
</strong>
.
</p>
<a href="/docs/latest/images/rc/create-database-subscription-pro-new.png" sdata-lightbox="/images/rc/create-database-subscription-pro-new.png">
<img alt="The Subscription selection panel with Pro selected." src="/docs/latest/images/rc/create-database-subscription-pro-new.png"/>
</a>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
This guide shows how to create an Active-Active database with a new Pro subscription. If you already have an Active-Active subscription and want to add a database to it, see
<a href="/docs/latest/operate/rc/databases/create-database/create-pro-database-existing/">
Create a Pro database in an existing subscription
</a>
.
</div>
</div>
</li>
</ol>
<p>
After you select
<strong>
Pro
</strong>
, you need to:
</p>
<ol>
<li>
<p>
Set up the deployment options, including cloud vendor and region details for each instance.
</p>
</li>
<li>
<p>
Define the database size requirements.
</p>
</li>
<li>
<p>
Review your choices, provide payment details, and then create your databases.
</p>
</li>
</ol>
<p>
The following sections provide more information.
</p>
<h3 id="set-up-deployment-details">
Set up deployment details
</h3>
<p>
The
<strong>
Setup
</strong>
tab specifies general settings for your Redis deployment.
</p>
<a href="/docs/latest/images/rc/subscription-new-flexible-tabs-setup.png" sdata-lightbox="/images/rc/subscription-new-flexible-tabs-setup.png">
<img alt="The Setup tab of the new Pro Database process." src="/docs/latest/images/rc/subscription-new-flexible-tabs-setup.png" width="75%"/>
</a>
<p>
There are three sections on this tab:
</p>
<ul>
<li>
<a href="#general-settings">
General settings
</a>
include the cloud provider details and specific configuration options.
</li>
<li>
<a href="#version">
Version
</a>
lets you choose the Redis version of your databases.
</li>
<li>
<a href="#advanced-options">
Advanced options
</a>
define settings for high availability and security. Configurable settings vary according to cloud provider.
</li>
</ul>
<h4 id="general-settings">
General settings
</h4>
<p>
Select
<strong>
Active-Active Redis
</strong>
to turn on Active-Active.
</p>
<a href="/docs/latest/images/rc/create-flexible-sub-active-active-on.png" sdata-lightbox="/images/rc/create-flexible-sub-active-active-on.png">
<img alt="When you enable Active-Actve, you need to specify the regions for each database instance." src="/docs/latest/images/rc/create-flexible-sub-active-active-on.png" width="75%"/>
</a>
<p>
When you enable Active-Active Redis, two regions are selected by default. Select the drop-down arrow to display a list of provider regions that support Active-Active databases.
</p>
<a href="/docs/latest/images/rc/create-sub-active-active-regions.png" sdata-lightbox="/images/rc/create-sub-active-active-regions.png">
<img alt="Use the Region drop-down to select the regions for your Active-Active database." src="/docs/latest/images/rc/create-sub-active-active-regions.png" width="50%"/>
</a>
<p>
Use the checkboxes in the list to select or remove regions. The Search box lets you locate specific regions.
</p>
<p>
You can use a region's Remove button to remove it from the list.
</p>
<a href="/docs/latest/images/rc/icon-region-delete.png" sdata-lightbox="/images/rc/icon-region-delete.png">
<img alt="Select the Delete button to remove a region from the list." src="/docs/latest/images/rc/icon-region-delete.png" width="30px"/>
</a>
<h4 id="version">
Version
</h4>
<a href="/docs/latest/images/rc/subscription-new-flexible-version-section.png" sdata-lightbox="/images/rc/subscription-new-flexible-version-section.png">
<img alt="Version selection between Redis 6.2 and 7.2" src="/docs/latest/images/rc/subscription-new-flexible-version-section.png" width="75%"/>
</a>
<p>
The
<strong>
Version
</strong>
section lets you choose the Redis version of your databases. Choose
<strong>
Redis 7.2
</strong>
if you want to use the latest advanced features of Redis.
</p>
<h4 id="advanced-options">
Advanced options
</h4>
<a href="/docs/latest/images/rc/create-sub-active-active-cidr.png" sdata-lightbox="/images/rc/create-sub-active-active-cidr.png">
<img alt="Each region needs a unique CIDR address block to communicate securely with other instances." src="/docs/latest/images/rc/create-sub-active-active-cidr.png" width="75%"/>
</a>
<p>
In the
<strong>
Advanced options
</strong>
section, you can:
</p>
<ul>
<li>
<p>
Define CIDR addresses for each region in the
<strong>
VPC configuration
</strong>
section.
</p>
<p>
Every CIDR should be unique to properly route network traffic between each Active-Active database instance and your consumer VPCs. The CIDR block regions should
<em>
not
</em>
overlap between the Redis server and your app consumer VPCs. In addition, CIDR blocks should not overlap between cluster instances.
</p>
<p>
When all
<strong>
Deployment CIDR
</strong>
regions display a green checkmark, you're ready to continue.
</p>
<a href="/docs/latest/images/rc/icon-cidr-address-ok.png" sdata-lightbox="/images/rc/icon-cidr-address-ok.png">
<img alt="Greem chackmarks indicate valid CIDR address values." src="/docs/latest/images/rc/icon-cidr-address-ok.png" width="30px"/>
</a>
<p>
Red exclamation marks indicate error conditions; the tooltip provides additional details.
</p>
<a href="/docs/latest/images/rc/icon-cidr-address-error.png" sdata-lightbox="/images/rc/icon-cidr-address-error.png">
<img alt="Red exclamation points indicate CIDR address problems." src="/docs/latest/images/rc/icon-cidr-address-error.png" width="30px"/>
</a>
</li>
<li>
<p>
Set your
<a href="/docs/latest/operate/rc/subscriptions/maintenance/">
maintenance
</a>
settings in the
<strong>
Maintenance windows
</strong>
section. Select
<strong>
Manual
</strong>
if you want to set
<a href="/docs/latest/operate/rc/subscriptions/maintenance/set-maintenance-windows/">
manual maintenance windows
</a>
.
</p>
</li>
</ul>
<p>
When finished, choose
<strong>
Continue
</strong>
to determine your size requirements.
</p>
<a href="/docs/latest/images/rc/button-subscription-continue.png" sdata-lightbox="/images/rc/button-subscription-continue.png">
<img alt="Select the Continue button to continue to the next step." src="/docs/latest/images/rc/button-subscription-continue.png" width="100px"/>
</a>
<h3 id="sizing-tab">
Sizing tab
</h3>
<p>
The
<strong>
Sizing
</strong>
tab helps you specify the database, memory, and throughput requirements for your subscription.
</p>
<a href="/docs/latest/images/rc/subscription-new-flexible-sizing-tab.png" sdata-lightbox="/images/rc/subscription-new-flexible-sizing-tab.png">
<img alt="The Sizing tab when creating a new Pro subscription." src="/docs/latest/images/rc/subscription-new-flexible-sizing-tab.png" width="75%"/>
</a>
<p>
When you first visit the
<strong>
Sizing
</strong>
tab, there are no databases defined. Select the
<strong>
Add
</strong>
button to create one.
</p>
<a href="/docs/latest/images/rc/icon-add-database.png" sdata-lightbox="/images/rc/icon-add-database.png">
<img alt="Use the Add button to define a new database for your subscription." src="/docs/latest/images/rc/icon-add-database.png" width="30px"/>
</a>
<p>
This opens the
<strong>
New Database
</strong>
dialog, which lets you define the requirements for your new database.
</p>
<a href="/docs/latest/images/rc/create-database-active-active.png" sdata-lightbox="/images/rc/create-database-active-active.png">
<img alt="New database dialog for Active-Active database." src="/docs/latest/images/rc/create-database-active-active.png" width="75%"/>
</a>
<p>
By default, you're shown basic settings, which include:
</p>
<ul>
<li>
<p>
<strong>
Name
</strong>
: A custom name for your database.
</p>
</li>
<li>
<p>
<strong>
Advanced Capabilities
</strong>
: Advanced data types or capabilities used by the database. Active-Active databases support the
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/json/">
JSON
</a>
data type and
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/search/">
Search and query
</a>
capabilities.
</p>
<a href="/docs/latest/images/rc/active-active-json-detail.png" sdata-lightbox="/images/rc/active-active-json-detail.png">
<img alt="When you create an Active-Active database, you can select the JSON and Search and query advanced capabilities." src="/docs/latest/images/rc/active-active-json-detail.png" width="75%"/>
</a>
<p>
We select both capabilities for you automatically. You can remove a capability by selecting it. Selected capabilities will be available in all regions, including those added in the future.
</p>
<p>
See
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/search/search-active-active/">
Search and query Active-Active databases
</a>
to learn how to use Search and query on Active-Active databases.
</p>
</li>
<li>
<p>
<strong>
Dataset size
</strong>
: The amount of data needed for your dataset in GB.
</p>
<p>
For Search and query databases, use the
<a href="https://redis.io/redisearch-sizing-calculator/">
Sizing calculator
</a>
to estimate your index size and throughput requirements. When you're entering the dataset size for your database, add the estimated index size from the Sizing calculator to your expected dataset size.
</p>
</li>
<li>
<p>
<strong>
Throughput
</strong>
: When you create an Active-Active database, you define the throughput for each instance. The total operations per second combines the total read ops/sec and applies the write ops/sec for each region across every region.
</p>
<a href="/docs/latest/images/rc/active-active-throughput-detail.png" sdata-lightbox="/images/rc/active-active-throughput-detail.png">
<img alt="When you create an Active-Active database, you define throughput for each region." src="/docs/latest/images/rc/active-active-throughput-detail.png" width="75%"/>
</a>
<p>
Because each instance needs the ability to write to every other instance, write operations significantly affect the total, as shown in the following table:
</p>
<table>
<thead>
<tr>
<th style="text-align:center">
Number of regions
</th>
<th style="text-align:center">
Read operations
</th>
<th style="text-align:center">
Write operations
</th>
<th style="text-align:center">
Total operations
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">
Two
</td>
<td style="text-align:center">
1,000 each
</td>
<td style="text-align:center">
1,000 each
</td>
<td style="text-align:center">
6,000
<br/>
(2,000 reads; 4,000 writes)
</td>
</tr>
<tr>
<td style="text-align:center">
Two
</td>
<td style="text-align:center">
1,500 each
</td>
<td style="text-align:center">
1,000 each
</td>
<td style="text-align:center">
7,000
<br/>
(3,000 reads; 4,000 writes)
</td>
</tr>
<tr>
<td style="text-align:center">
Two
</td>
<td style="text-align:center">
1,000 each
</td>
<td style="text-align:center">
1,500 each
</td>
<td style="text-align:center">
8,000
<br/>
(2,000 reads; 6,000 writes)
</td>
</tr>
<tr>
<td style="text-align:center">
Three
</td>
<td style="text-align:center">
1,000 each
</td>
<td style="text-align:center">
1,000 each
</td>
<td style="text-align:center">
12,000
<br/>
(3,000 reads; 9,000 writes)
</td>
</tr>
</tbody>
</table>
<p>
For Search and query databases, the estimated throughput from the
<a href="https://redis.io/redisearch-sizing-calculator/">
Sizing calculator
</a>
is the total amount of throughput you need. When setting throughput for your Active-Active database, use the total amount for each region and divide it depending on your read (query) and write (update) needs for each region. For example, if the total amount of throughput needed is 50000 ops/sec, you could set each region to have 20000 ops/sec for reads (queries) and 30000 ops/sec for writes (updates).
</p>
</li>
<li>
<p>
<strong>
Data Persistence
</strong>
: Defines the data persistence policy, if any. See
<a href="/docs/latest/operate/rs/databases/configure/database-persistence/">
Database persistence
</a>
.
</p>
</li>
<li>
<p>
<strong>
Supported Protocol(s)
</strong>
: Choose between RESP2 and RESP3
<em>
(Redis 7.2 only)
</em>
. See
<a href="/docs/latest/develop/reference/protocol-spec/#resp-versions">
Redis serialization protocol
</a>
for details.
</p>
</li>
<li>
<p>
<strong>
Quantity
</strong>
: Number of databases to create with these settings.
</p>
</li>
</ul>
<p>
When finished, select
<strong>
Save configuration
</strong>
to save your database configuration.
</p>
<a href="/docs/latest/images/rc/button-configuration-save.png" sdata-lightbox="/images/rc/button-configuration-save.png">
<img alt="Select the Save configuration button to define your new database." src="/docs/latest/images/rc/button-configuration-save.png" width="140px"/>
</a>
<p>
Use the
<strong>
Add database
</strong>
button to define additional databases or select the
<strong>
Continue button
</strong>
to display the
<strong>
Review and create
</strong>
tab.
</p>
<p>
Hover over a database to see the
<strong>
Edit
</strong>
and
<strong>
Delete
</strong>
icons. You can use the
<strong>
Edit
</strong>
icon to change a database or the
<strong>
Delete
</strong>
icon to remove a database from the list.
</p>
<p>
<a href="/docs/latest/images/rc/icon-database-edit.png#no-click" sdata-lightbox="/images/rc/icon-database-edit.png#no-click">
<img alt="Use the Edit button to change database settings." class="inline" src="/docs/latest/images/rc/icon-database-edit.png#no-click" width="30px"/>
</a>
<a href="/docs/latest/images/rc/icon-database-delete.png#no-click" sdata-lightbox="/images/rc/icon-database-delete.png#no-click">
<img alt="Use the Delete button to remove a database." class="inline" src="/docs/latest/images/rc/icon-database-delete.png#no-click" width="30px"/>
</a>
</p>
<h3 id="review-and-create-tab">
Review and Create tab
</h3>
<p>
The
<strong>
Review and Create
</strong>
tab provides a cost estimate for your Redis Cloud Pro plan:
</p>
<a href="/docs/latest/images/rc/create-pro-aa-review.png" sdata-lightbox="/images/rc/create-pro-aa-review.png">
<img alt="The Review & Create tab of the New Flexible subscription screen." src="/docs/latest/images/rc/create-pro-aa-review.png" width="75%"/>
</a>
<p>
Redis breaks down your databases to Redis Billing Units (RBUs), each with their own size and throughput requirements. For more info, see
<a href="/docs/latest/operate/rc/databases/create-database/create-pro-database-new/#billing-unit-types">
Billing unit types
</a>
.
</p>
<p>
Select
<strong>
Back to Sizing
</strong>
to make changes or
<strong>
Confirm & Pay
</strong>
to create your databases.
</p>
<a href="/docs/latest/images/rc/button-create-db-confirm-pay.png" sdata-lightbox="/images/rc/button-create-db-confirm-pay.png">
<img alt="Select Confirm & pay to create your database." src="/docs/latest/images/rc/button-create-db-confirm-pay.png" width="140px"/>
</a>
<p>
Note that databases are created in the background. While they are provisioning, you aren't allowed to make changes. This process generally takes 10-15 minutes.
</p>
<p>
Use the
<strong>
Database list
</strong>
to check the status of your databases.
</p>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
<a href="/docs/latest/operate/rc/databases/create-database/create-pro-database-new/">
Create a Pro database with a new subscription
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/databases/configuration/active-active-redis/">
Active-Active Redis
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/databases/active-active/develop/">
Develop applications with Active-Active databases
</a>
</li>
<li>
Database
<a href="/docs/latest/operate/rc/databases/configuration/clustering/#dataset-size">
memory limit
</a>
</li>
<li>
Redis Cloud
<a href="/docs/latest/operate/rc/subscriptions/">
subscription plans
</a>
</li>
<li>
<a href="https://redis.io/pricing/#monthly">
Redis Cloud pricing
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/databases/create-database/create-active-active-database/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/auditing-db-conns/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Auditing database connections requests
</h1>
<p class="text-lg -mt-5 mb-10">
Auditing database connections requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-cluster-audit-db-conns">
GET
</a>
</td>
<td>
<code>
/v1/cluster/auditing/db_conns
</code>
</td>
<td>
Get database connection auditing settings
</td>
</tr>
<tr>
<td>
<a href="#put-cluster-audit-db-conns">
PUT
</a>
</td>
<td>
<code>
/v1/cluster/auditing/db_conns
</code>
</td>
<td>
Update database connection auditing settings
</td>
</tr>
<tr>
<td>
<a href="#delete-cluster-audit-db-conns">
DELETE
</a>
</td>
<td>
<code>
/v1/cluster/auditing/db_conns
</code>
</td>
<td>
Delete database connection auditing settings
</td>
</tr>
</tbody>
</table>
<h2 id="get-cluster-audit-db-conns">
Get database auditing settings
</h2>
<pre><code>GET /v1/cluster/auditing/db_conns
</code></pre>
<p>
Gets the configuration settings for
<a href="/docs/latest/operate/rs/security/audit-events/">
auditing database connections
</a>
.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_cluster_info">
view_cluster_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /cluster/auditing/db_conns
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a
<a href="/docs/latest/operate/rs/references/rest-api/objects/db-conns-auditing-config/">
database connection auditing configuration object
</a>
.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_address"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_port"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_protocol"</span><span class="p">:</span> <span class="s2">"TCP"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_interval"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_max_attempts"</span><span class="p">:</span> <span class="mi">0</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-error-codes">
Error codes
</h3>
<p>
When errors are reported, the server may return a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
fields that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db_conns_auditing_unsupported_by_capability
</td>
<td>
Not all nodes support DB Connections Auditing capability
</td>
</tr>
</tbody>
</table>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
Success
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable">
406 Not Acceptable
</a>
</td>
<td>
Feature not supported for all nodes
</td>
</tr>
</tbody>
</table>
<h2 id="put-cluster-audit-db-conns">
Update database auditing
</h2>
<pre><code>PUT /v1/cluster/auditing/db_conns
</code></pre>
<p>
Updates the configuration settings for
<a href="/docs/latest/operate/rs/security/audit-events/">
auditing database connections
</a>
.
</p>
<h4 id="required-permissions-1">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#update_cluster">
update_cluster
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="put-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>PUT /cluster/auditing/db_conns
</code></pre>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_protocol"</span><span class="p">:</span> <span class="s2">"TCP"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_address"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_port"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_interval"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_max_attempts"</span><span class="p">:</span> <span class="mi">0</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="request-headers-1">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="request-body">
Request body
</h4>
<p>
Include a
<a href="/docs/latest/operate/rs/references/rest-api/objects/db-conns-auditing-config/">
database connection auditing configuration object
</a>
with updated fields in the request body.
</p>
<h3 id="put-response">
Response
</h3>
<p>
Returns the updated
<a href="/docs/latest/operate/rs/references/rest-api/objects/db-conns-auditing-config/">
database connection auditing configuration object
</a>
.
</p>
<h4 id="example-json-body-2">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_address"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_port"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_protocol"</span><span class="p">:</span> <span class="s2">"TCP"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_interval"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_max_attempts"</span><span class="p">:</span> <span class="mi">0</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="put-error-codes">
Error codes
</h3>
<p>
When errors are reported, the server may return a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
fields that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db_conns_auditing_unsupported_by_capability
</td>
<td>
Not all nodes support DB Connections Auditing capability
</td>
</tr>
</tbody>
</table>
<h3 id="put-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
Success
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable">
406 Not Acceptable
</a>
</td>
<td>
Feature not supported for all nodes
</td>
</tr>
</tbody>
</table>
<h2 id="delete-cluster-audit-db-conns">
Delete database auditing settings
</h2>
<pre><code>DELETE /v1/cluster/auditing/db_conns
</code></pre>
<p>
Resets the configuration settings for
<a href="/docs/latest/operate/rs/security/audit-events/">
auditing database connections
</a>
.
</p>
<h4 id="required-permissions-2">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#update_cluster">
update_cluster
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="delete-request">
Request
</h3>
<h4 id="example-http-request-2">
Example HTTP request
</h4>
<pre><code>DELETE /cluster/auditing/db_conns
</code></pre>
<h4 id="request-headers-2">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="delete-response">
Response
</h3>
<p>
Returns a status code that indicates whether the database connection auditing settings reset successfully or failed to reset.
</p>
<h3 id="delete-error-codes">
Error codes
</h3>
<p>
When errors are reported, the server may return a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
fields that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db_conns_audit_config_not_found
</td>
<td>
Unable to find the auditing configuration
</td>
</tr>
<tr>
<td>
cannot_delete_audit_config_when_policy_enabled
</td>
<td>
Auditing cluster policy is 'enabled' when trying to delete the auditing configuration
</td>
</tr>
<tr>
<td>
cannot_delete_audit_config_when_bdb_enabled
</td>
<td>
One of the databases has auditing configuration 'enabled' when trying to delete the auditing configuration
</td>
</tr>
</tbody>
</table>
<h3 id="delete-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
Success
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found">
404 Not Found
</a>
</td>
<td>
Configuration not found
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable">
406 Not Acceptable
</a>
</td>
<td>
Feature not supported for all nodes
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/auditing-db-conns/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/compatibility/commands/scripting/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Scripting commands compatibility
</h1>
<p class="text-lg -mt-5 mb-10">
Scripting and function commands compatibility.
</p>
<p>
The following table shows which Redis Community Edition
<a href="/docs/latest/commands/?group=scripting">
scripting and function commands
</a>
are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="function-commands">
Function commands
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Command
</th>
<th style="text-align:left">
Redis
<br/>
Enterprise
</th>
<th style="text-align:left">
Redis
<br/>
Cloud
</th>
<th style="text-align:left">
Notes
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/fcall/">
FCALL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/fcall_ro/">
FCALL_RO
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-delete/">
FUNCTION DELETE
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-dump/">
FUNCTION DUMP
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-flush/">
FUNCTION FLUSH
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-help/">
FUNCTION HELP
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-kill/">
FUNCTION KILL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-list/">
FUNCTION LIST
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-load/">
FUNCTION LOAD
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-restore/">
FUNCTION RESTORE
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-stats/">
FUNCTION STATS
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
</tbody>
</table>
<h2 id="scripting-commands">
Scripting commands
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Command
</th>
<th style="text-align:left">
Redis
<br/>
Enterprise
</th>
<th style="text-align:left">
Redis
<br/>
Cloud
</th>
<th style="text-align:left">
Notes
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/eval/">
EVAL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/eval_ro/">
EVAL_RO
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/evalsha/">
EVALSHA
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/evalsha_ro/">
EVALSHA_RO
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-debug/">
SCRIPT DEBUG
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-exists/">
SCRIPT EXISTS
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-flush/">
SCRIPT FLUSH
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-kill/">
SCRIPT KILL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-load/">
SCRIPT LOAD
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/compatibility/commands/scripting/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/cluster-count-failure-reports/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLUSTER COUNT-FAILURE-REPORTS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLUSTER COUNT-FAILURE-REPORTS node-id</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
3.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the number of failure reports
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@admin
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@dangerous
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The command returns the number of
<em>
failure reports
</em>
for the specified node.
Failure reports are the way Redis Cluster uses in order to promote a
<code>
PFAIL
</code>
state, that means a node is not reachable, to a
<code>
FAIL
</code>
state,
that means that the majority of masters in the cluster agreed within
a window of time that the node is not reachable.
</p>
<p>
A few more details:
</p>
<ul>
<li>
A node flags another node with
<code>
PFAIL
</code>
when the node is not reachable for a time greater than the configured
<em>
node timeout
</em>
, which is a fundamental configuration parameter of a Redis Cluster.
</li>
<li>
Nodes in
<code>
PFAIL
</code>
state are provided in gossip sections of heartbeat packets.
</li>
<li>
Every time a node processes gossip packets from other nodes, it creates (and refreshes the TTL if needed)
<strong>
failure reports
</strong>
, remembering that a given node said another given node is in
<code>
PFAIL
</code>
condition.
</li>
<li>
Each failure report has a time to live of two times the
<em>
node timeout
</em>
time.
</li>
<li>
If at a given time a node has another node flagged with
<code>
PFAIL
</code>
, and at the same time collected the majority of other master nodes
<em>
failure reports
</em>
about this node (including itself if it is a master), then it elevates the failure state of the node from
<code>
PFAIL
</code>
to
<code>
FAIL
</code>
, and broadcasts a message forcing all the nodes that can be reached to flag the node as
<code>
FAIL
</code>
.
</li>
</ul>
<p>
This command returns the number of failure reports for the current node which are currently not expired (so received within two times the
<em>
node timeout
</em>
time). The count does not include what the node we are asking this count believes about the node ID we pass as argument, the count
<em>
only
</em>
includes the failure reports the node received from other nodes.
</p>
<p>
This command is mainly useful for debugging, when the failure detector of
Redis Cluster is not operating as we believe it should.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the number of active failure reports for the node.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/cluster-count-failure-reports/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/active-active/develop/data-types/streams/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Streams in Active-Active databases
</h1>
<p class="text-lg -mt-5 mb-10">
Information about using streams with an Active-Active database.
</p>
<p>
A
<a href="/docs/latest/develop/data-types/streams/">
Redis Stream
</a>
is a data structure that acts like an append-only log.
Each stream entry consists of:
</p>
<ul>
<li>
A unique, monotonically increasing ID
</li>
<li>
A payload consisting of a series key-value pairs
</li>
</ul>
<p>
You add entries to a stream with the XADD command. You access stream entries using the XRANGE, XREADGROUP, and XREAD commands (however, see the caveat about XREAD below).
</p>
<h2 id="streams-and-active-active">
Streams and Active-Active
</h2>
<p>
Active-Active databases allow you to write to the same logical stream from more than one region.
Streams are synchronized across the regions of an Active-Active database.
</p>
<p>
In the example below, we write to a stream concurrently from two regions. Notice that after syncing, both regions have identical streams:
</p>
<table style="width: auto;">
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD messages * text hello
</code>
</td>
<td>
<code>
XADD messages * text goodbye
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929246795-2]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1, 1589929246795-2]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1, 1589929246795-2]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
Notice also that the synchronized streams contain no duplicate IDs. As long as you allow the database to generate your stream IDs, you'll never have more than one stream entry with the same ID.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Redis Community Edition uses one radix tree (referred to as
<code>
rax
</code>
in the code base) to implement each stream. However, Active-Active databases implement a single logical stream using one
<code>
rax
</code>
per region.
Each region adds entries only to its associated
<code>
rax
</code>
(but can remove entries from all
<code>
rax
</code>
trees).
This means that XREAD and XREADGROUP iterate simultaneously over all
<code>
rax
</code>
trees and return the appropriate entry by comparing the entry IDs from each
<code>
rax
</code>
.
</div>
</div>
<h3 id="conflict-resolution">
Conflict resolution
</h3>
<p>
Active-Active databases use an "observed-remove" approach to automatically resolve potential conflicts.
</p>
<p>
With this approach, a delete only affects the locally observable data.
</p>
<p>
In the example below, a stream,
<code>
x
</code>
, is created at
<em>
t1
</em>
. At
<em>
t3
</em>
, the stream exists in two regions.
</p>
<table style="width: 100%;">
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD messages * text hello
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
DEL messages
</code>
</td>
<td>
<code>
XADD messages * text goodbye
</code>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929246795-2]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929246795-2]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
At
<em>
t4
</em>
, the stream is deleted from Region 1. At the same time, an entry with ID ending in
<code>
3700
</code>
is added to the same stream at Region 2. After the sync, at
<em>
t6
</em>
, the entry with ID ending in
<code>
3700
</code>
exists in both regions. This is because that entry was not visible when the local stream was deleted at
<em>
t4
</em>
.
</p>
<h3 id="id-generation-modes">
ID generation modes
</h3>
<p>
Usually, you should allow Redis streams generate its own stream entry IDs. You do this by specifying
<code>
*
</code>
as the ID in calls to XADD. However, you
<em>
can
</em>
provide your own custom ID when adding entries to a stream.
</p>
<p>
Because Active-Active databases replicate asynchronously, providing your own IDs can create streams with duplicate IDs. This can occur when you write to the same stream from multiple regions.
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD x 100-1 f1 v1
</code>
</td>
<td>
<code>
XADD x 100-1 f1 v1
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XRANGE x - +
</code>
<br/>
<strong>
→ [100-1, 100-1]
</strong>
</td>
<td>
<code>
XRANGE x - +
</code>
<br/>
<strong>
→ [100-1, 100-1]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
In this scenario, two entries with the ID
<code>
100-1
</code>
are added at
<em>
t1
</em>
. After syncing, the stream
<code>
x
</code>
contains two entries with the same ID.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Stream IDs in Redis Community Edition consist of two integers separated by a dash ('-'). When the server generates the ID, the first integer is the current time in milliseconds, and the second integer is a sequence number. So, the format for stream IDs is MS-SEQ.
</div>
</div>
<p>
To prevent duplicate IDs and to comply with the original Redis streams design, Active-Active databases provide three ID modes for XADD:
</p>
<ol>
<li>
<strong>
Strict
</strong>
: In
<em>
strict
</em>
mode, XADD allows server-generated IDs (using the '
<code>
*
</code>
' ID specifier) or IDs consisting only of the millisecond (MS) portion. When the millisecond portion of the ID is provided, the ID's sequence number is calculated using the database's region ID. This prevents duplicate IDs in the stream. Strict mode rejects full IDs (that is, IDs containing both milliseconds and a sequence number).
</li>
<li>
<strong>
Semi-strict
</strong>
:
<em>
Semi-strict
</em>
mode is just like
<em>
strict
</em>
mode except that it allows full IDs (MS-SEQ). Because it allows full IDs, duplicate IDs are possible in this mode.
</li>
<li>
<strong>
Liberal
</strong>
: XADD allows any monotonically ascending ID. When given the millisecond portion of the ID, the sequence number will be set to
<code>
0
</code>
. This mode may also lead to duplicate IDs.
</li>
</ol>
<p>
The default and recommended mode is
<em>
strict
</em>
, which prevents duplicate IDs.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Why do you want to prevent duplicate IDs? First, XDEL, XCLAIM, and other commands can affect more than one entry when duplicate IDs are present in a stream. Second, duplicate entries may be removed if a database is exported or renamed.
</div>
</div>
<p>
To change XADD's ID generation mode, use the
<code>
rladmin
</code>
command-line utility:
</p>
<p>
Set
<em>
strict
</em>
mode:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db crdb crdt_xadd_id_uniqueness_mode strict
</span></span></code></pre>
</div>
<p>
Set
<em>
semi-strict
</em>
mode:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db crdb crdt_xadd_id_uniqueness_mode semi-strict
</span></span></code></pre>
</div>
<p>
Set
<em>
liberal
</em>
mode:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db crdb crdt_xadd_id_uniqueness_mode liberal
</span></span></code></pre>
</div>
<h3 id="iterating-a-stream-with-xread">
Iterating a stream with XREAD
</h3>
<p>
In Redis Community Edition and in non-Active-Active databases, you can use XREAD to iterate over the entries in a Redis Stream. However, with an Active-Active database, XREAD may skip entries. This can happen when multiple regions write to the same stream.
</p>
<p>
In the example below, XREAD skips entry
<code>
115-2
</code>
.
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD x 110 f1 v1
</code>
</td>
<td>
<code>
XADD x 115 f1 v1
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XADD x 120 f1 v1
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XADD x 130 f1 v1
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XREAD COUNT 2 STREAMS x 0
</code>
<br/>
<strong>
→ [110-1, 120-1]
</strong>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XREAD COUNT 2 STREAMS x 120-1
</code>
<br/>
<strong>
→ [130-1]
</strong>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t7
</em>
</td>
<td>
<code>
XREAD STREAMS x 0
</code>
<br/>
<strong>
→[110-1, 115-2, 120-1, 130-1]
</strong>
</td>
<td>
<code>
XREAD STREAMS x 0
</code>
<br/>
<strong>
→[110-1, 115-2, 120-1, 130-1]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
You can use XREAD to reliably consume a stream only if all writes to the stream originate from a single region. Otherwise, you should use XREADGROUP, which always guarantees reliable stream consumption.
</p>
<h2 id="consumer-groups">
Consumer groups
</h2>
<p>
Active-Active databases fully support consumer groups with Redis Streams. Here is an example of creating two consumer groups concurrently:
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
<code>
XGROUP CREATE x group2 0
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group2]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
— Sync —
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1, group2]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1, group2]
</strong>
</td>
</tr>
</tbody>
</table>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<p>
Redis Community Edition uses one radix tree (
<code>
rax
</code>
) to hold the global pending entries list and another
<code>
rax
</code>
for each consumer's PEL.
The global PEL is a unification of all consumer PELs, which are disjoint.
</p>
<p>
An Active-Active database stream maintains a global PEL and a per-consumer PEL for each region.
</p>
<p>
When given an ID different from the special ">" ID, XREADGROUP iterates simultaneously over all of the PELs for all consumers.
It returns the next entry by comparing entry IDs from the different PELs.
</p>
</div>
</div>
<h3 id="conflict-resolution-1">
Conflict resolution
</h3>
<p>
The "delete wins" approach is a way to automatically resolve conflicts with consumer groups.
In case of concurrent consumer group operations, a delete will "win" over other concurrent operations on the same group.
</p>
<p>
In this example, the DEL at
<em>
t4
</em>
deletes both the observed
<code>
group1
</code>
and the non-observed
<code>
group2
</code>
:
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
DEL x
</code>
</td>
<td>
<code>
XGROUP CREATE x group2 0
</code>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
</tr>
</tbody>
</table>
<p>
In this example, the XGROUP DESTROY at
<em>
t4
</em>
affects both the observed
<code>
group1
</code>
created in Region 1 and the non-observed
<code>
group1
</code>
created in Region 3:
</p>
<table>
<thead>
<tr>
<th>
time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
<th>
Region 3
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ []
</strong>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
</td>
<td>
<code>
XGROUP DESTROY x group1
</code>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
_— Sync —
</td>
<td>
— Sync —
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
</tr>
</tbody>
</table>
<h3 id="group-replication">
Group replication
</h3>
<p>
Calls to XREADGROUP and XACK change the state of a consumer group or consumer. However, it's not efficient to replicate every change to a consumer or consumer group.
</p>
<p>
To maintain consumer groups in Active-Active databases with optimal performance:
</p>
<ol>
<li>
Group existence (CREATE/DESTROY) is replicated.
</li>
<li>
Most XACK operations are replicated.
</li>
<li>
Other operations, such as XGROUP, SETID, DELCONSUMER, are not replicated.
</li>
</ol>
<p>
For example:
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD messages 110 text hello
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XGROUP CREATE messages group1 0
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XREADGROUP GROUP group1 Alice STREAMS messages >
</code>
<br/>
<strong>
→ [110-1]
</strong>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [110-1]
</strong>
</td>
<td>
XRANGE messages - +
<br/>
<strong>
→ [110-1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XINFO GROUPS messages
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
XINFO GROUPS messages
<br/>
<strong>
→ [group1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t7
</em>
</td>
<td>
<code>
XINFO CONSUMERS messages group1
</code>
<br/>
<strong>
→ [Alice]
</strong>
</td>
<td>
XINFO CONSUMERS messages group1
<br/>
<strong>
→ []
</strong>
</td>
</tr>
<tr>
<td>
<em>
t8
</em>
</td>
<td>
<code>
XPENDING messages group1 - + 1
</code>
<br/>
<strong>
→ [110-1]
</strong>
</td>
<td>
XPENDING messages group1 - + 1
<br/>
<strong>
→ []
</strong>
</td>
</tr>
</tbody>
</table>
<p>
Using XREADGROUP across regions can result in regions reading the same entries.
This is due to the fact that Active-Active Streams is designed for at-least-once reads or a single consumer.
As shown in the previous example, Region 2 is not aware of any consumer group activity, so redirecting the XREADGROUP traffic from Region 1 to Region 2 results in reading entries that have already been read.
</p>
<h3 id="replication-performance-optimizations">
Replication performance optimizations
</h3>
<p>
Consumers acknowledge messages using the XACK command. Each ack effectively records the last consumed message. This can result in a lot of cross-region traffic. To reduce this traffic, we replicate XACK messages only when all of the read entries are acknowledged.
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
<th>
Explanation
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD x 110-0 f1 v1
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XADD x 120-0 f1 v1
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XADD x 130-0 f1 v1
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<code>
XREADGROUP GROUP group1 Alice STREAMS x >
</code>
<br/>
<strong>
→ [110-0, 120-0, 130-0]
</strong>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XACK x group1 110-0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t7
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
110-0 and its preceding entries (none) were acknowledged. We replicate an XACK effect for 110-0.
</td>
</tr>
<tr>
<td>
<em>
t8
</em>
</td>
<td>
<code>
XACK x group1 130-0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t9
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
130-0 was acknowledged, but not its preceding entries (120-0). We DO NOT replicate an XACK effect for 130-0
</td>
</tr>
<tr>
<td>
<em>
t10
</em>
</td>
<td>
<code>
XACK x group1 120-0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t11
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
120-0 and its preceding entries (110-0 through 130-0) were acknowledged. We replicate an XACK effect for 130-0.
</td>
</tr>
</tbody>
</table>
<p>
In this scenario, if we redirect the XREADGROUP traffic from Region 1 to Region 2 we do not re-read entries 110-0, 120-0 and 130-0.
This means that the XREADGROUP does not return already-acknowledged entries.
</p>
<h3 id="guarantees">
Guarantees
</h3>
<p>
Unlike XREAD, XREADGOUP will never skip stream entries.
In traffic redirection, XREADGROUP may return entries that have been read but not acknowledged. It may also even return entries that have already been acknowledged.
</p>
<h2 id="summary">
Summary
</h2>
<p>
With Active-Active streams, you can write to the same logical stream from multiple regions. As a result, the behavior of Active-Active streams differs somewhat from the behavior you get with Redis Community Edition. This is summarized below:
</p>
<h3 id="stream-commands">
Stream commands
</h3>
<ol>
<li>
When using the
<em>
strict
</em>
ID generation mode, XADD does not permit full stream entry IDs (that is, an ID containing both MS and SEQ).
</li>
<li>
XREAD may skip entries when iterating a stream that is concurrently written to from more than one region. For reliable stream iteration, use XREADGROUP instead.
</li>
<li>
XSETID fails when the new ID is less than current ID.
</li>
</ol>
<h3 id="consumer-group-notes">
Consumer group notes
</h3>
<p>
The following consumer group operations are replicated:
</p>
<ol>
<li>
Consecutive XACK operations
</li>
<li>
Consumer group creation and deletion (that is, XGROUP CREATE and XGROUP DESTROY)
</li>
</ol>
<p>
All other consumer group metadata is not replicated.
</p>
<p>
A few other notes:
</p>
<ol>
<li>
XGROUP SETID and DELCONSUMER are not replicated.
</li>
<li>
Consumers exist locally (XREADGROUP creates a consumer implicitly).
</li>
<li>
Renaming a stream (using RENAME) deletes all consumer group information.
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/active-active/develop/data-types/streams/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/databases/connect/troubleshooting-guide/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Troubleshooting pocket guide for Redis Enterprise Software
</h1>
<p class="text-lg -mt-5 mb-10">
Troubleshoot issues with Redis Enterprise Software, including connectivity issues between the database and clients or applications.
</p>
<p>
If your client or application cannot connect to your database, verify the following.
</p>
<h2 id="identify-redis-host-issues">
Identify Redis host issues
</h2>
<h4 id="check-resource-usage">
Check resource usage
</h4>
<ul>
<li>
<p>
Used disk space should be less than
<code>
90%
</code>
. To check the host machine's disk usage, run the
<a href="https://man7.org/linux/man-pages/man1/df.1.html">
<code>
df
</code>
</a>
command:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ df -h
</span></span><span class="line"><span class="cl">Filesystem Size Used Avail Use% Mounted on
</span></span><span class="line"><span class="cl">overlay 59G 23G 33G 41% /
</span></span><span class="line"><span class="cl">/dev/vda1 59G 23G 33G 41% /etc/hosts
</span></span></code></pre>
</div>
</li>
<li>
<p>
RAM and CPU utilization should be less than
<code>
80%
</code>
, and host resources must be available exclusively for Redis Enterprise Software. You should also make sure that swap memory is not being used or is not configured.
</p>
<ol>
<li>
<p>
Run the
<a href="https://man7.org/linux/man-pages/man1/free.1.html">
<code>
free
</code>
</a>
command to check memory usage:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ free
</span></span><span class="line"><span class="cl"> total used free shared buff/cache available
</span></span><span class="line"><span class="cl">Mem: <span class="m">6087028</span> <span class="m">1954664</span> <span class="m">993756</span> <span class="m">409196</span> <span class="m">3138608</span> <span class="m">3440856</span>
</span></span><span class="line"><span class="cl">Swap: <span class="m">1048572</span> <span class="m">0</span> <span class="m">1048572</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Used CPU should be less than
<code>
80%
</code>
. To check CPU usage, use
<code>
top
</code>
or
<code>
vmstat
</code>
.
</p>
<p>
Run
<a href="https://man7.org/linux/man-pages/man1/top.1.html">
<code>
top
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ top
</span></span><span class="line"><span class="cl">Tasks: <span class="m">54</span> total, <span class="m">1</span> running, <span class="m">53</span> sleeping, <span class="m">0</span> stopped, <span class="m">0</span> zombie
</span></span><span class="line"><span class="cl">%Cpu<span class="o">(</span>s<span class="o">)</span>: 1.7 us, 1.4 sy, 0.0 ni, 96.8 id, 0.0 wa, 0.0 hi, 0.1 si, 0.0 st
</span></span><span class="line"><span class="cl">KiB Mem : <span class="m">6087028</span> total, <span class="m">988672</span> free, <span class="m">1958060</span> used, <span class="m">3140296</span> buff/cache
</span></span><span class="line"><span class="cl">KiB Swap: <span class="m">1048572</span> total, <span class="m">1048572</span> free, <span class="m">0</span> used. <span class="m">3437460</span> avail Mem
</span></span></code></pre>
</div>
<p>
Run
<a href="https://man7.org/linux/man-pages/man8/vmstat.8.html">
<code>
vmstat
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ vmstat
</span></span><span class="line"><span class="cl">procs -----------memory---------- ---swap-- -----io---- -system-- ------cpu-----
</span></span><span class="line"><span class="cl">r b swpd free buff cache si so bi bo in cs us sy id wa st
</span></span><span class="line"><span class="cl"><span class="m">2</span> <span class="m">0</span> <span class="m">0</span> <span class="m">988868</span> <span class="m">177588</span> <span class="m">2962876</span> <span class="m">0</span> <span class="m">0</span> <span class="m">0</span> <span class="m">6</span> <span class="m">7</span> <span class="m">12</span> <span class="m">1</span> <span class="m">1</span> <span class="m">99</span> <span class="m">0</span> <span class="m">0</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If CPU or RAM usage is greater than 80%, ask your system administrator which process is the culprit. If the process is not related to Redis, terminate it.
</p>
</li>
</ol>
</li>
</ul>
<h4 id="sync-clock-with-time-server">
Sync clock with time server
</h4>
<p>
It is recommended to sync the host clock with a time server.
</p>
<p>
Verify that time is synchronized with the time server using one of the following commands:
</p>
<ul>
<li>
<p>
<code>
ntpq -p
</code>
</p>
</li>
<li>
<p>
<code>
chronyc sources
</code>
</p>
</li>
<li>
<p>
<a href="https://man7.org/linux/man-pages/man1/timedatectl.1.html">
<code>
timedatectl
</code>
</a>
</p>
</li>
</ul>
<h4 id="remove-https_proxy-and-http_proxy-variables">
Remove https_proxy and http_proxy variables
</h4>
<ol>
<li>
<p>
Run
<a href="https://man7.org/linux/man-pages/man1/printenv.1.html">
<code>
printenv
</code>
</a>
and check if
<code>
https_proxy
</code>
and
<code>
http_proxy
</code>
are configured as environment variables:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">printenv <span class="p">|</span> grep -i proxy
</span></span></code></pre>
</div>
</li>
<li>
<p>
If
<code>
https_proxy
</code>
or
<code>
http_proxy
</code>
exist, remove them:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"><span class="nb">unset</span> https_proxy
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"><span class="nb">unset</span> http_proxy
</span></span></code></pre>
</div>
</li>
</ol>
<h4 id="review-system-logs">
Review system logs
</h4>
<p>
Review system logs including the syslog or journal for any error messages, warnings, or critical events. See
<a href="/docs/latest/operate/rs/clusters/logging/">
Logging
</a>
for more information.
</p>
<h2 id="identify-issues-caused-by-security-hardening">
Identify issues caused by security hardening
</h2>
<ul>
<li>
<p>
Temporarily deactivate any security hardening tools (such as selinux, cylance, McAfee, or dynatrace), and check if the problem is resolved.
</p>
</li>
<li>
<p>
The user
<code>
redislabs
</code>
must have read and write access to
<code>
/tmp
</code>
directory. Run the following commands to verify.
</p>
<ol>
<li>
<p>
Create a test file in
<code>
/tmp
</code>
as the
<code>
redislabs
</code>
user:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ su - redislabs -s /bin/bash -c <span class="s1">'touch /tmp/test'</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Verify the file was created successfully:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ ls -l /tmp/test
</span></span><span class="line"><span class="cl">-rw-rw-r-- <span class="m">1</span> redislabs redislabs <span class="m">0</span> Aug <span class="m">12</span> 02:06 /tmp/test
</span></span></code></pre>
</div>
</li>
</ol>
</li>
<li>
<p>
Using a non-permissive file mode creation mask (
<code>
umask
</code>
) can cause issues.
</p>
<ol>
<li>
<p>
Check the output of
<code>
umask
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ <span class="nb">umask</span>
</span></span><span class="line"><span class="cl"><span class="m">0022</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If
<code>
umask
</code>
's output differs from the default value
<code>
0022
</code>
, it might prevent normal operation. Consult your system administrator and revert to the default
<code>
umask
</code>
setting.
</p>
</li>
</ol>
</li>
</ul>
<h2 id="identify-cluster-issues">
Identify cluster issues
</h2>
<ul>
<li>
<p>
Use
<code>
supervisorctl status
</code>
to verify all processes are in a
<code>
RUNNING
</code>
state:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">supervisorctl status
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<code>
rlcheck
</code>
and verify no errors appear:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rlcheck
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/">
<code>
rladmin status issues_only
</code>
</a>
and verify that no issues appear:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status issues_only
</span></span><span class="line"><span class="cl">CLUSTER NODES:
</span></span><span class="line"><span class="cl">NODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION STATUS
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">DATABASES:
</span></span><span class="line"><span class="cl">DB:ID NAME TYPE STATUS SHARDS PLACEMENT REPLICATION PERSISTENCE ENDPOINT
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/#status-shards">
<code>
rladmin status shards
</code>
</a>
. For each shard,
<code>
USED_MEMORY
</code>
should be less than 25 GB.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status shards
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:1 db1 redis:1 node:1 master 0-16383 2.13MB OK
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/running_actions/">
<code>
rladmin cluster running_actions
</code>
</a>
and confirm that no tasks are currently running (active):
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin cluster running_actions
</span></span><span class="line"><span class="cl">No active tasks
</span></span></code></pre>
</div>
</li>
</ul>
<h2 id="troubleshoot-connectivity">
Troubleshoot connectivity
</h2>
<h4 id="database-endpoint-resolution">
Database endpoint resolution
</h4>
<ol>
<li>
<p>
On the client machine, check if the database endpoint can be resolved:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">dig <endpoint>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If endpoint resolution fails on the client machine, check on one of the cluster nodes:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">dig @localhost <endpoint>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If endpoint resolution succeeds on the cluster node but fails on the client machine, review the DNS configuration and fix any errors.
</p>
</li>
<li>
<p>
If the endpoint can’t be resolved on the cluster node,
<a href="https://redis.com/company/support/">
contact support
</a>
.
</p>
</li>
</ol>
<h4 id="client-application-issues">
Client application issues
</h4>
<ol>
<li>
<p>
To identify possible client application issues, test connectivity from the client machine to the database using
<a href="/docs/latest/operate/rs/references/cli-utilities/redis-cli/">
<code>
redis-cli
</code>
</a>
:
</p>
<p>
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> INFO
</span></span></code></pre>
</div>
<p>
<a href="/docs/latest/commands/ping/">
<code>
PING
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> PING
</span></span></code></pre>
</div>
<p>
or if TLS is enabled:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> --tls --insecure --cert --key PING
</span></span></code></pre>
</div>
</li>
<li>
<p>
If the client machine cannot connect, try to connect to the database from one of the cluster nodes:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <node IP or hostname> -p <port> -a <password> PING
</span></span></code></pre>
</div>
</li>
<li>
<p>
If the cluster node is also unable to connect to the database,
<a href="https://redis.com/company/support/">
contact Redis support
</a>
.
</p>
</li>
<li>
<p>
If the client fails to connect, but the cluster node succeeds, perform health checks on the client and network.
</p>
</li>
</ol>
<h4 id="firewall-access">
Firewall access
</h4>
<ol>
<li>
<p>
Run one of the following commands to verify that database access is not blocked by a firewall on the client machine or cluster:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">iptables -L
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">ufw status
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">firewall-cmd –list-all
</span></span></code></pre>
</div>
</li>
<li>
<p>
To resolve firewall issues:
</p>
<ol>
<li>
<p>
If a firewall is configured for your database, add the client IP address to the firewall rules.
</p>
</li>
<li>
<p>
Configure third-party firewalls and external proxies to allow the cluster FQDN, database endpoint IP address, and database ports.
</p>
</li>
</ol>
</li>
</ol>
<h2 id="troubleshoot-latency">
Troubleshoot latency
</h2>
<h4 id="server-side-latency">
Server-side latency
</h4>
<ul>
<li>
<p>
Make sure the database's used memory does not reach the configured database max memory limit. For more details, see
<a href="/docs/latest/operate/rs/databases/memory-performance/memory-limit/">
Database memory limits
</a>
.
</p>
</li>
<li>
<p>
Try to correlate the time of the latency with any surge in the following metrics:
</p>
<ul>
<li>
<p>
Number of connections
</p>
</li>
<li>
<p>
Used memory
</p>
</li>
<li>
<p>
Evicted keys
</p>
</li>
<li>
<p>
Expired keys
</p>
</li>
</ul>
</li>
<li>
<p>
Run
<a href="/docs/latest/commands/slowlog-get/">
<code>
SLOWLOG GET
</code>
</a>
using
<a href="/docs/latest/operate/rs/references/cli-utilities/redis-cli/">
<code>
redis-cli
</code>
</a>
to identify slow commands such as
<a href="/docs/latest/commands/keys/">
<code>
KEYS
</code>
</a>
or [
<code>
HGETALL
</code>
](/docs/latest/commands/hgetall/:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> SLOWLOG GET <number of entries>
</span></span></code></pre>
</div>
<p>
Consider using alternative commands such as
<a href="/docs/latest/commands/scan/">
<code>
SCAN
</code>
</a>
,
<a href="/docs/latest/commands/sscan/">
<code>
SSCAN
</code>
</a>
,
<a href="/docs/latest/commands/hscan/">
<code>
HSCAN
</code>
</a>
and
<a href="/docs/latest/commands/zscan/">
<code>
ZSCAN
</code>
</a>
</p>
</li>
<li>
<p>
Keys with large memory footprints can cause latency. To identify such keys, compare the keys returned by
<a href="/docs/latest/commands/slowlog-get/">
<code>
SLOWLOG GET
</code>
</a>
with the output of the following commands:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> --memkeys
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> --bigkeys
</span></span></code></pre>
</div>
</li>
<li>
<p>
For additional diagnostics, see:
</p>
<ul>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/management/optimization/latency/">
Diagnosing latency issues
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/clusters/logging/redis-slow-log/">
View Redis slow log
</a>
</p>
</li>
</ul>
</li>
</ul>
<h4 id="client-side-latency">
Client-side latency
</h4>
<p>
Verify the following:
</p>
<ul>
<li>
<p>
There is no memory or CPU pressure on the client host.
</p>
</li>
<li>
<p>
The client uses a connection pool instead of frequently opening and closing connections.
</p>
</li>
<li>
<p>
The client does not erroneously open multiple connections that can pressure the client or server.
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/databases/connect/troubleshooting-guide/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ts.add.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.ADD
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.ADD key timestamp value
[RETENTION retentionPeriod]
[ENCODING <COMPRESSED|UNCOMPRESSED>]
[CHUNK_SIZE size]
[DUPLICATE_POLICY policy]
[ON_DUPLICATE policy_ovr]
[IGNORE ignoreMaxTimediff ignoreMaxValDiff]
[LABELS [label value ...]]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/timeseries">
TimeSeries 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(M) when M is the amount of compaction rules or O(1) with no compaction
</dd>
</dl>
<p>
Append a sample to a time series
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is key name for the time series.
</p>
</details>
<details open="">
<summary>
<code>
timestamp
</code>
</summary>
<p>
is Unix time (integer, in milliseconds) specifying the sample timestamp or
<code>
*
</code>
to set the sample timestamp to the Unix time of the server's clock.
</p>
<p>
Unix time is the number of milliseconds that have elapsed since 00:00:00 UTC on 1 January 1970, the Unix epoch, without adjustments made due to leap seconds.
</p>
</details>
<details open="">
<summary>
<code>
value
</code>
</summary>
<p>
is (double) numeric data value of the sample. The double number should follow
<a href="https://tools.ietf.org/html/rfc7159">
RFC 7159
</a>
(JSON standard). In particular, the parser rejects overly large values that do not fit in binary64. It does not accept NaN or infinite values.
</p>
</details>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
<p>
When specified key does not exist, a new time series is created.
</p>
<p>
if a
<a href="/docs/latest/develop/data-types/timeseries/configuration#compaction_policy">
COMPACTION_POLICY
</a>
configuration parameter is defined, compacted time series would be created as well.
</p>
</li>
<li>
<p>
If
<code>
timestamp
</code>
is older than the retention period compared to the maximum existing timestamp, the sample is discarded and an error is returned.
</p>
</li>
<li>
<p>
When adding a sample to a time series for which compaction rules are defined:
</p>
<ul>
<li>
If all the original samples for an affected aggregated time bucket are available, the compacted value is recalculated based on the reported sample and the original samples.
</li>
<li>
If only a part of the original samples for an affected aggregated time bucket is available due to trimming caused in accordance with the time series RETENTION policy, the compacted value is recalculated based on the reported sample and the available original samples.
</li>
<li>
If the original samples for an affected aggregated time bucket are not available due to trimming caused in accordance with the time series RETENTION policy, the compacted value bucket is not updated.
</li>
</ul>
</li>
<li>
<p>
Explicitly adding samples to a compacted time series (using
<code>
TS.ADD
</code>
,
<a href="/docs/latest/commands/ts.madd/">
<code>
TS.MADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
, or
<a href="/docs/latest/commands/ts.decrby/">
<code>
TS.DECRBY
</code>
</a>
) may result in inconsistencies between the raw and the compacted data. The compaction process may override such samples.
</p>
</li>
</ul>
<h2 id="optional-arguments">
Optional arguments
</h2>
<p>
The following arguments are optional because they can be set by
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
<details open="">
<summary>
<code>
RETENTION retentionPeriod
</code>
</summary>
<p>
is maximum retention period, compared to the maximum existing timestamp, in milliseconds.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
RETENTION
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
ENCODING enc
</code>
</summary>
<p>
specifies the series sample encoding format.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
ENCODING
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
CHUNK_SIZE size
</code>
</summary>
<p>
is memory size, in bytes, allocated for each data chunk.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
CHUNK_SIZE
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
DUPLICATE_POLICY policy
</code>
</summary>
<p>
is policy for handling insertion (
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
and
<a href="/docs/latest/commands/ts.madd/">
<code>
TS.MADD
</code>
</a>
) of multiple samples with identical timestamps.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
DUPLICATE_POLICY
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
ON_DUPLICATE policy_ovr
</code>
</summary>
<p>
is overwrite key and database configuration for
<a href="/docs/latest/develop/data-types/timeseries/configuration#duplicate_policy">
DUPLICATE_POLICY
</a>
, the policy for handling samples with identical timestamps.
This override is effective only for this single command and does not set the time series duplication policy (which can be set with
<a href="/docs/latest/commands/ts.alter/">
<code>
TS.ALTER
</code>
</a>
).
</p>
<p>
<code>
policy_ovr
</code>
can be one of the following values:
</p>
<ul>
<li>
<code>
BLOCK
</code>
: ignore any newly reported value and reply with an error
</li>
<li>
<code>
FIRST
</code>
: ignore any newly reported value
</li>
<li>
<code>
LAST
</code>
: override with the newly reported value
</li>
<li>
<code>
MIN
</code>
: only override if the value is lower than the existing value
</li>
<li>
<code>
MAX
</code>
: only override if the value is higher than the existing value
</li>
<li>
<code>
SUM
</code>
: If a previous sample exists, add the new sample to it so that the updated value is set to (previous + new). If no previous sample exists, the value is set to the new value.
</li>
</ul>
<p>
This argument has no effect when a new time series is created by this command.
</p>
</details>
<details open="">
<summary>
<code>
IGNORE ignoreMaxTimediff ignoreMaxValDiff
</code>
</summary>
<p>
is the policy for handling duplicate samples. A new sample is considered a duplicate and is ignored if the following conditions are met:
</p>
<ul>
<li>
The time series is not a compaction;
</li>
<li>
The time series'
<code>
DUPLICATE_POLICY
</code>
IS
<code>
LAST
</code>
;
</li>
<li>
The sample is added in-order (
<code>
timestamp ≥ max_timestamp
</code>
);
</li>
<li>
The difference of the current timestamp from the previous timestamp (
<code>
timestamp - max_timestamp
</code>
) is less than or equal to
<code>
IGNORE_MAX_TIME_DIFF
</code>
;
</li>
<li>
The absolute value difference of the current value from the value at the previous maximum timestamp (
<code>
abs(value - value_at_max_timestamp
</code>
) is less than or equal to
<code>
IGNORE_MAX_VAL_DIFF
</code>
.
</li>
</ul>
<p>
where
<code>
max_timestamp
</code>
is the timestamp of the sample with the largest timestamp in the time series, and
<code>
value_at_max_timestamp
</code>
is the value at
<code>
max_timestamp
</code>
.
</p>
<p>
When not specified: set to the global
<a href="/docs/latest/develop/data-types/timeseries/configuration#ignore_max_time_diff-and-ignore_max_val_diff">
IGNORE_MAX_TIME_DIFF
</a>
and
<a href="/docs/latest/develop/data-types/timeseries/configuration#ignore_max_time_diff-and-ignore_max_val_diff">
IGNORE_MAX_VAL_DIFF
</a>
, which are, by default, both set to 0.
</p>
<p>
These parameters are used when creating a new time series to set the per-key parameters, and are ignored when called with an existing time series (the existing per-key configuration parameters is used).
</p>
</details>
<details open="">
<summary>
<code>
LABELS {label value}...
</code>
</summary>
<p>
is set of label-value pairs that represent metadata labels of the time series.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
LABELS
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
You can use this command to create a new time series and add data to it in a single command.
<code>
RETENTION
</code>
,
<code>
ENCODING
</code>
,
<code>
CHUNK_SIZE
</code>
,
<code>
DUPLICATE_POLICY
</code>
,
<code>
IGNORE
</code>
, and
<code>
LABELS
</code>
are used only when creating a new time series, and ignored when adding samples to an existing time series.
</li>
<li>
Setting
<code>
RETENTION
</code>
and
<code>
LABELS
</code>
introduces additional time complexity.
</li>
</ul>
<h2 id="return-value">
Return value
</h2>
<p>
Returns one of these replies:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
- the timestamp of the upserted sample. If the sample is ignored (See
<code>
IGNORE
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
), the reply will be the largest timestamp in the time series.
</li>
<li>
[] on error (invalid arguments, wrong key type, etc.), when duplication policy is
<code>
BLOCK
</code>
, or when
<code>
timestamp
</code>
is older than the retention period compared to the maximum existing timestamp
</li>
</ul>
<h2 id="complexity">
Complexity
</h2>
<p>
If a compaction rule exists on a time series, the performance of
<code>
TS.ADD
</code>
can be reduced.
The complexity of
<code>
TS.ADD
</code>
is always
<code>
O(M)
</code>
, where
<code>
M
</code>
is the number of compaction rules or
<code>
O(1)
</code>
with no compaction.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Append a sample to a temperature time series
</b>
</summary>
<p>
Create a temperature time series, set its retention to 1 year, and append a sample.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD temperature:3:11 <span class="m">1548149183000</span> <span class="m">27</span> RETENTION <span class="m">31536000000</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149183000</span></span></span></code></pre>
</div>
<p>
<note>
<b>
Note:
</b>
If a time series with such a name already exists, the sample is added, but the retention does not change.
</note>
</p>
<p>
Add a sample to the time series, setting the sample's timestamp to the current Unix time of the server's clock.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD temperature:3:11 * <span class="m">30</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1662042954573</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/data-types/timeseries/">
RedisTimeSeries
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ts.add/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/objects/bootstrap/cluster_identity/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster identity object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the cluster_identity object used with Redis Enterprise Software REST API calls.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
name
</td>
<td>
string
</td>
<td>
Fully qualified cluster name. Limited to 64 characters and must comply with the IETF's RFC 952 standard and section 2.1 of the RFC 1123 standard.
</td>
</tr>
<tr>
<td>
nodes
</td>
<td>
array of strings
</td>
<td>
Array of IP addresses of existing cluster nodes
</td>
</tr>
<tr>
<td>
wait_command
</td>
<td>
boolean (default: true)
</td>
<td>
Supports Redis wait command
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/objects/bootstrap/cluster_identity/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/stats/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster stats requests
</h1>
<p class="text-lg -mt-5 mb-10">
Cluster statistics requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-cluster-stats">
GET
</a>
</td>
<td>
<code>
/v1/cluster/stats
</code>
</td>
<td>
Get cluster stats
</td>
</tr>
</tbody>
</table>
<h2 id="get-cluster-stats">
Get cluster stats
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/cluster/stats
</span></span></code></pre>
</div>
<p>
Get cluster statistics.
</p>
<h3 id="permissions">
Permissions
</h3>
<table>
<thead>
<tr>
<th>
Permission name
</th>
<th>
Roles
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_cluster_stats">
view_cluster_stats
</a>
</td>
<td>
admin
<br/>
cluster_member
<br/>
cluster_viewer
<br/>
db_member
<br/>
db_viewer
<br/>
user_manager
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /cluster/stats/1?interval<span class="o">=</span>1hour<span class="p">&</span><span class="nv">stime</span><span class="o">=</span>2014-08-28T10:00:00Z
</span></span></code></pre>
</div>
<h4 id="headers">
Headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="query-parameters">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
interval
</td>
<td>
string
</td>
<td>
Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional)
</td>
</tr>
<tr>
<td>
stime
</td>
<td>
ISO_8601
</td>
<td>
Start time from which we want the stats. Should comply with the
<a href="https://en.wikipedia.org/wiki/ISO_8601">
ISO_8601
</a>
format (optional)
</td>
</tr>
<tr>
<td>
etime
</td>
<td>
ISO_8601
</td>
<td>
End time after which we don't want the stats. Should comply with the
<a href="https://en.wikipedia.org/wiki/ISO_8601">
ISO_8601
</a>
format (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns
<a href="/docs/latest/operate/rs/references/rest-api/objects/statistics/">
statistics
</a>
for the cluster.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1hour"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-27T12:00:00Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T12:59:59Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"conns"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_idle"</span><span class="p">:</span> <span class="mf">0.8533959401503577</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_system"</span><span class="p">:</span> <span class="mf">0.01602159448549579</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cpu_user"</span><span class="p">:</span> <span class="mf">0.08721123782294203</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"egress_bytes"</span><span class="p">:</span> <span class="mf">1111.2184745131947</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_avail"</span><span class="p">:</span> <span class="mf">3406676307.1449075</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_free"</span><span class="p">:</span> <span class="mf">4455091440.360014</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"free_memory"</span><span class="p">:</span> <span class="mf">2745470765.673594</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ingress_bytes"</span><span class="p">:</span> <span class="mf">220.84083194769272</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1week"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_avail"</span><span class="p">:</span> <span class="mf">3406676307.1533995</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_free"</span><span class="p">:</span> <span class="mf">4455091440.088265</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_req"</span><span class="p">:</span> <span class="mf">0.0</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"interval"</span><span class="p">:</span> <span class="s2">"1hour"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-27T13:00:00Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T13:59:59Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional fields..."</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="example-requests">
Example requests
</h3>
<h4 id="curl">
cURL
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ curl -k -u <span class="s2">"[username]:[password]"</span> -X GET
</span></span><span class="line"><span class="cl"> https://<span class="o">[</span>host<span class="o">][</span>:port<span class="o">]</span>/v1/cluster/stats?interval<span class="o">=</span>1hour
</span></span></code></pre>
</div>
<h4 id="python">
Python
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">url</span> <span class="o">=</span> <span class="s2">"https://[host][:port]/v1/cluster/stats?interval=1hour"</span>
</span></span><span class="line"><span class="cl"><span class="n">auth</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"[username]"</span><span class="p">,</span> <span class="s2">"[password]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">"GET"</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="n">auth</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">
500 Internal Server Error
</a>
</td>
<td>
Internal server error
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/stats/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/topk.info/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TOPK.INFO
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TOPK.INFO key</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/probabilistic">
Bloom 2.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
</dl>
<p>
Returns number of required items (k), width, depth and decay values.
</p>
<h3 id="parameters">
Parameters
</h3>
<ul>
<li>
<strong>
key
</strong>
: Name of sketch.
</li>
</ul>
<h2 id="return">
Return
</h2>
<p>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
with information of the filter.
</p>
<h2 id="examples">
Examples
</h2>
<pre tabindex="0"><code>TOPK.INFO topk
1) k
2) (integer) 50
3) width
4) (integer) 2000
5) depth
6) (integer) 7
7) decay
8) "0.92500000000000004"
</code></pre>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/topk.info/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/previous-releases/k8s-6-0-8-1/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes Release Notes 6.0.8-1 (October 2020)
</h1>
<p class="text-lg -mt-5 mb-10">
Support for RS 6.0.8-28, OpenShift 4.5, K8s 1.18, and Gesher admission controller proxy.
</p>
<p>
The Redis Enterprise K8s 6.0.8-1 release is a
<em>
major release
</em>
on top of
<a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases/tag/v6.0.6-24">
6.0.6-24
</a>
providing support for the latest
<a href="https://docs.redislabs.com/latest/rs/release-notes/rs-6-0-8-september-2020/">
Redis Enterprise Software release 6.0.8-28
</a>
and includes several enhancements (including OpenShift 4.5 and Kubernetes 1.18 support) and bug fixes.
</p>
<h2 id="overview">
Overview
</h2>
<p>
This release of the operator provides:
</p>
<ul>
<li>
New features
</li>
<li>
New support K8s distributions and platforms
</li>
<li>
Various bug fixes
</li>
</ul>
<p>
To upgrade your deployment to this latest release, see
<a href="/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster/">
"Upgrade a Redis Enterprise cluster (REC) on Kubernetes"
</a>
.
</p>
<h2 id="images">
Images
</h2>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
- redislabs/redis:6.0.8-28 or redislabs/redis:6.0.8-28.rhel7-openshift
</li>
<li>
<strong>
Operator
</strong>
- redislabs/operator:6.0.8-1
</li>
<li>
<strong>
Services Rigger
</strong>
- redislabs/k8s-controller:6.0.8-1 or redislabs/services-manager:6.0.8-1 (Red Hat registry)
</li>
</ul>
<h2 id="new-features">
New features
</h2>
<ul>
<li>
Redis
<a href="https://redislabs.com/redis-enterprise/modules/">
Modules
</a>
can now be
<a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#dbmodule">
configured
</a>
in the database custom resource.
</li>
<li>
Support was added for
<strong>
<a href="https://docs.openshift.com/container-platform/4.5/release_notes/ocp-4-5-release-notes.html">
OpenShift 4.5
</a>
</strong>
</li>
<li>
Support was added for
<strong>
Kubernetes 1.18
</strong>
</li>
<li>
Added support for the Gesher admission control proxy to provide an administrator the ability to setup delegation to avoid the need for administrator intervention on every namespaced deployed operator.
</li>
</ul>
<h2 id="important-fixes">
Important fixes
</h2>
<ul>
<li>
Added the missing Services Rigger health check (RED47062)
</li>
<li>
Fixed failures when updating the ui service type (RED45771)
</li>
</ul>
<h2 id="known-limitations">
Known limitations
</h2>
<h3 id="crashloopbackoff-causes-cluster-recovery-to-be-incomplete--red33713">
CrashLoopBackOff causes cluster recovery to be incomplete (RED33713)
</h3>
<p>
When a pod status is CrashLoopBackOff and we run the cluster recovery, the process will not complete. The workaround is to delete the crashing pods manually and recovery process will continue.
</p>
<h3 id="long-cluster-names-cause-routes-to-be-rejected--red25871">
Long cluster names cause routes to be rejected (RED25871)
</h3>
<p>
A cluster name longer than 20 characters will result in a rejected route configuration as the host part of the domain name exceeds 63 characters. The workaround is to limit cluster name to 20 characters or less.
</p>
<h3 id="cluster-cr-rec-errors-are-not-reported-after-invalid-updates-red25542">
Cluster CR (REC) errors are not reported after invalid updates (RED25542)
</h3>
<p>
A cluster CR specification error is not reported if two or more invalid CR resources are updated in sequence.
</p>
<h3 id="an-unreachable-cluster-has-status-running-red32805">
An unreachable cluster has status running (RED32805)
</h3>
<p>
When a cluster is in an unreachable state the state is still running instead of being reported as an error.
</p>
<h3 id="readiness-probe-incorrect-on-failures-red39300">
Readiness probe incorrect on failures (RED39300)
</h3>
<p>
STS Readiness probe doesn't mark a node as not ready when rladmin status on the node fails.
</p>
<h3 id="role-missing-on-replica-sets-red39002">
Role missing on replica sets (RED39002)
</h3>
<p>
The redis-enterprise-operator role is missing permission on replica sets.
</p>
<h3 id="private-registries-are-not-supported-on-openshift-311-red38579">
Private registries are not supported on OpenShift 3.11 (RED38579)
</h3>
<p>
Openshift 3.11 doesn't support dockerhub private registry. This is a known OpenShift issue.
</p>
<h3 id="internal-dns-and-kubernetes-dns-may-have-conflicts-red37462">
Internal DNS and Kubernetes DNS may have conflicts (RED37462)
</h3>
<p>
DNS conflicts are possible between the cluster mdns_server and the K8s DNS. This only impacts DNS resolution from within cluster nodes for Kubernetes DNS names.
</p>
<h3 id="5410-negatively-impacts-546-red37233">
5.4.10 negatively impacts 5.4.6 (RED37233)
</h3>
<p>
Kubernetes-based 5.4.10 deployments seem to negatively impact existing 5.4.6 deployments that share a Kubernetes cluster.
</p>
<h3 id="node-cpu-usage-is-reported-instead-of-pod-cpu-usage-red36884">
Node CPU usage is reported instead of pod CPU usage (RED36884)
</h3>
<p>
In Kubernetes, the node CPU usage we report on is the usage of the Kubernetes worker node hosting the REC pod.
</p>
<h3 id="master-pod-label-in-rancher-red42896">
Master pod label in Rancher (RED42896)
</h3>
<p>
Master pod is not always labeled in Rancher.
</p>
<h3 id="cluster-fail-to-start-for-clusters-with-unsynchronized-clocks-red47254">
Cluster fail to start for clusters with unsynchronized clocks (RED47254)
</h3>
<p>
When REC clusters are deployed on clusters with unsynchronized clocks, the cluster does not start correctly. The fix is to use NTP to synchronize the underlying K8s nodes.
</p>
<h3 id="errors-in-operator-log-for-redb-status-red44919">
Errors in operator log for REDB status (RED44919)
</h3>
<p>
Benign errors are reported in the operator log when using database controller (REDB) (e.g., “failed to update database status". These errors can be ignored.
</p>
<h2 id="compatibility-notes">
Compatibility Notes
</h2>
<ul>
<li>
Support for
<strong>
OpenShift 4.5
</strong>
was
<strong>
added
</strong>
,
</li>
<li>
Support for
<strong>
Kubernetes 1.18
</strong>
was
<strong>
added
</strong>
,
</li>
<li>
Support for the previous deprecated
<strong>
Kubernetes 1.11 and 1.12
</strong>
has been
<strong>
removed
</strong>
.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/previous-releases/k8s-6-0-8-1/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ts.mrange/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.MRANGE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.MRANGE fromTimestamp toTimestamp
[LATEST]
[FILTER_BY_TS ts...]
[FILTER_BY_VALUE min max]
[WITHLABELS | <SELECTED_LABELS label...>]
[COUNT count]
[[ALIGN align] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]
FILTER filterExpr...
[GROUPBY label REDUCE reducer]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/timeseries">
TimeSeries 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(n/m+k) where n = Number of data points, m = Chunk size (data points per chunk), k = Number of data points that are in the requested ranges
</dd>
</dl>
<p>
Query a range across multiple time series by filters in the forward direction
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
fromTimestamp
</code>
</summary>
<p>
is the start timestamp for the range query (integer Unix timestamp in milliseconds) or
<code>
-
</code>
to denote the timestamp of the earliest sample among all the time series that passes
<code>
FILTER filterExpr...
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
toTimestamp
</code>
</summary>
<p>
is the end timestamp for the range query (integer Unix timestamp in milliseconds) or
<code>
+
</code>
to denote the timestamp of the latest sample among all the time series that passes
<code>
FILTER filterExpr...
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
FILTER filterExpr...
</code>
</summary>
<p>
filters time series based on their labels and label values. Each filter expression has one of the following syntaxes:
</p>
<ul>
<li>
<code>
label!=
</code>
- the time series has a label named
<code>
label
</code>
</li>
<li>
<code>
label=value
</code>
- the time series has a label named
<code>
label
</code>
with a value equal to
<code>
value
</code>
</li>
<li>
<code>
label=(value1,value2,...)
</code>
- the time series has a label named
<code>
label
</code>
with a value equal to one of the values in the list
</li>
<li>
<code>
label=
</code>
- the time series does not have a label named
<code>
label
</code>
</li>
<li>
<code>
label!=value
</code>
- the time series does not have a label named
<code>
label
</code>
with a value equal to
<code>
value
</code>
</li>
<li>
<code>
label!=(value1,value2,...)
</code>
- the time series does not have a label named
<code>
label
</code>
with a value equal to any of the values in the list
</li>
</ul>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
At least one filter expression with a syntax
<code>
label=value
</code>
or
<code>
label=(value1,value2,...)
</code>
is required.
</li>
<li>
Filter expressions are conjunctive. For example, the filter
<code>
type=temperature room=study
</code>
means that a time series is a temperature time series of a study room.
</li>
<li>
Whitespaces are unallowed in a filter expression except between quotes or double quotes in values - e.g.,
<code>
x="y y"
</code>
or
<code>
x='(y y,z z)'
</code>
.
</li>
</ul>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
LATEST
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
is used when a time series is a compaction. With
<code>
LATEST
</code>
, TS.MRANGE also reports the compacted value of the latest (possibly partial) bucket, given that this bucket's start time falls within
<code>
[fromTimestamp, toTimestamp]
</code>
. Without
<code>
LATEST
</code>
, TS.MRANGE does not report the latest (possibly partial) bucket. When a time series is not a compaction,
<code>
LATEST
</code>
is ignored.
</p>
<p>
The data in the latest bucket of a compaction is possibly partial. A bucket is
<em>
closed
</em>
and compacted only upon the arrival of a new sample that
<em>
opens
</em>
a new
<em>
latest
</em>
bucket. There are cases, however, when the compacted value of the latest (possibly partial) bucket is also required. In such a case, use
<code>
LATEST
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
FILTER_BY_TS ts...
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
filters samples by a list of specific timestamps. A sample passes the filter if its exact timestamp is specified and falls within
<code>
[fromTimestamp, toTimestamp]
</code>
.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: samples are filtered before being aggregated.
</p>
</details>
<details open="">
<summary>
<code>
FILTER_BY_VALUE min max
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
filters samples by minimum and maximum values.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: samples are filtered before being aggregated.
</p>
</details>
<details open="">
<summary>
<code>
WITHLABELS
</code>
</summary>
<p>
includes in the reply all label-value pairs representing metadata labels of the time series.
If
<code>
WITHLABELS
</code>
or
<code>
SELECTED_LABELS
</code>
are not specified, by default, an empty list is reported as label-value pairs.
</p>
</details>
<details open="">
<summary>
<code>
SELECTED_LABELS label...
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
returns a subset of the label-value pairs that represent metadata labels of the time series.
Use when a large number of labels exists per series, but only the values of some of the labels are required.
If
<code>
WITHLABELS
</code>
or
<code>
SELECTED_LABELS
</code>
are not specified, by default, an empty list is reported as label-value pairs.
</p>
</details>
<details open="">
<summary>
<code>
COUNT count
</code>
</summary>
<p>
When used without
<code>
AGGREGATION
</code>
: limits the number of reported samples per time series.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: limits the number of reported buckets.
</p>
</details>
<details open="">
<summary>
<code>
ALIGN align
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
is a time bucket alignment control for
<code>
AGGREGATION
</code>
. It controls the time bucket timestamps by changing the reference timestamp on which a bucket is defined.
</p>
<p>
Values include:
</p>
<ul>
<li>
<code>
start
</code>
or
<code>
-
</code>
: The reference timestamp will be the query start interval time (
<code>
fromTimestamp
</code>
) which can't be
<code>
-
</code>
</li>
<li>
<code>
end
</code>
or
<code>
+
</code>
: The reference timestamp will be the query end interval time (
<code>
toTimestamp
</code>
) which can't be
<code>
+
</code>
</li>
<li>
A specific timestamp: align the reference timestamp to a specific time
</li>
</ul>
<p>
<note>
<b>
Note:
</b>
When not provided, alignment is set to
<code>
0
</code>
.
</note>
</p>
</details>
<details open="">
<summary>
<code>
AGGREGATION aggregator bucketDuration
</code>
</summary>
<p>
per time series, aggregates samples into time buckets, where:
</p>
<ul>
<li>
<p>
<code>
aggregator
</code>
takes one of the following aggregation types:
</p>
<table>
<thead>
<tr>
<th>
<code>
aggregator
</code>
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
avg
</code>
</td>
<td>
Arithmetic mean of all values
</td>
</tr>
<tr>
<td>
<code>
sum
</code>
</td>
<td>
Sum of all values
</td>
</tr>
<tr>
<td>
<code>
min
</code>
</td>
<td>
Minimum value
</td>
</tr>
<tr>
<td>
<code>
max
</code>
</td>
<td>
Maximum value
</td>
</tr>
<tr>
<td>
<code>
range
</code>
</td>
<td>
Difference between maximum value and minimum value
</td>
</tr>
<tr>
<td>
<code>
count
</code>
</td>
<td>
Number of values
</td>
</tr>
<tr>
<td>
<code>
first
</code>
</td>
<td>
Value with lowest timestamp in the bucket
</td>
</tr>
<tr>
<td>
<code>
last
</code>
</td>
<td>
Value with highest timestamp in the bucket
</td>
</tr>
<tr>
<td>
<code>
std.p
</code>
</td>
<td>
Population standard deviation of the values
</td>
</tr>
<tr>
<td>
<code>
std.s
</code>
</td>
<td>
Sample standard deviation of the values
</td>
</tr>
<tr>
<td>
<code>
var.p
</code>
</td>
<td>
Population variance of the values
</td>
</tr>
<tr>
<td>
<code>
var.s
</code>
</td>
<td>
Sample variance of the values
</td>
</tr>
<tr>
<td>
<code>
twa
</code>
</td>
<td>
Time-weighted average over the bucket's timeframe (since RedisTimeSeries v1.8)
</td>
</tr>
</tbody>
</table>
</li>
<li>
<p>
<code>
bucketDuration
</code>
is duration of each bucket, in milliseconds.
</p>
</li>
</ul>
<p>
Without
<code>
ALIGN
</code>
, bucket start times are multiples of
<code>
bucketDuration
</code>
.
</p>
<p>
With
<code>
ALIGN align
</code>
, bucket start times are multiples of
<code>
bucketDuration
</code>
with remainder
<code>
align % bucketDuration
</code>
.
</p>
<p>
The first bucket start time is less than or equal to
<code>
fromTimestamp
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
[BUCKETTIMESTAMP bt]
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
controls how bucket timestamps are reported.
</p>
<table>
<thead>
<tr>
<th>
<code>
bt
</code>
</th>
<th>
Timestamp reported for each bucket
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
-
</code>
or
<code>
start
</code>
</td>
<td>
the bucket's start time (default)
</td>
</tr>
<tr>
<td>
<code>
+
</code>
or
<code>
end
</code>
</td>
<td>
the bucket's end time
</td>
</tr>
<tr>
<td>
<code>
~
</code>
or
<code>
mid
</code>
</td>
<td>
the bucket's mid time (rounded down if not an integer)
</td>
</tr>
</tbody>
</table>
</details>
<details open="">
<summary>
<code>
[EMPTY]
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
is a flag, which, when specified, reports aggregations also for empty buckets.
</p>
<table>
<thead>
<tr>
<th>
<code>
aggregator
</code>
</th>
<th>
Value reported for each empty bucket
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
sum
</code>
,
<code>
count
</code>
</td>
<td>
<code>
0
</code>
</td>
</tr>
<tr>
<td>
<code>
last
</code>
</td>
<td>
The value of the last sample before the bucket's start.
<code>
NaN
</code>
when no such sample.
</td>
</tr>
<tr>
<td>
<code>
twa
</code>
</td>
<td>
Average value over the bucket's timeframe based on linear interpolation of the last sample before the bucket's start and the first sample after the bucket's end.
<code>
NaN
</code>
when no such samples.
</td>
</tr>
<tr>
<td>
<code>
min
</code>
,
<code>
max
</code>
,
<code>
range
</code>
,
<code>
avg
</code>
,
<code>
first
</code>
,
<code>
std.p
</code>
,
<code>
std.s
</code>
</td>
<td>
<code>
NaN
</code>
</td>
</tr>
</tbody>
</table>
<p>
Regardless of the values of
<code>
fromTimestamp
</code>
and
<code>
toTimestamp
</code>
, no data is reported for buckets that end before the earliest sample or begin after the latest sample in the time series.
</p>
</details>
<details open="">
<summary>
<code>
GROUPBY label REDUCE reducer
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
splits time series into groups, each group contains time series that share the same value for the provided label name, then aggregates results in each group.
</p>
<p>
When combined with
<code>
AGGREGATION
</code>
the
<code>
GROUPBY
</code>
/
<code>
REDUCE
</code>
is applied post aggregation stage.
</p>
<ul>
<li>
<p>
<code>
label
</code>
is label name. A group is created for all time series that share the same value for this label.
</p>
</li>
<li>
<p>
<code>
reducer
</code>
is an aggregation type used to aggregate the results in each group.
</p>
<table>
<thead>
<tr>
<th>
<code>
reducer
</code>
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
avg
</code>
</td>
<td>
Arithmetic mean of all non-NaN values (since RedisTimeSeries v1.8)
</td>
</tr>
<tr>
<td>
<code>
sum
</code>
</td>
<td>
Sum of all non-NaN values
</td>
</tr>
<tr>
<td>
<code>
min
</code>
</td>
<td>
Minimum non-NaN value
</td>
</tr>
<tr>
<td>
<code>
max
</code>
</td>
<td>
Maximum non-NaN value
</td>
</tr>
<tr>
<td>
<code>
range
</code>
</td>
<td>
Difference between maximum non-NaN value and minimum non-NaN value (since RedisTimeSeries v1.8)
</td>
</tr>
<tr>
<td>
<code>
count
</code>
</td>
<td>
Number of non-NaN values (since RedisTimeSeries v1.8)
</td>
</tr>
<tr>
<td>
<code>
std.p
</code>
</td>
<td>
Population standard deviation of all non-NaN values (since RedisTimeSeries v1.8)
</td>
</tr>
<tr>
<td>
<code>
std.s
</code>
</td>
<td>
Sample standard deviation of all non-NaN values (since RedisTimeSeries v1.8)
</td>
</tr>
<tr>
<td>
<code>
var.p
</code>
</td>
<td>
Population variance of all non-NaN values (since RedisTimeSeries v1.8)
</td>
</tr>
<tr>
<td>
<code>
var.s
</code>
</td>
<td>
Sample variance of all non-NaN values (since RedisTimeSeries v1.8)
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
The produced time series is named
<code>
<label>=<value>
</code>
</li>
<li>
The produced time series contains two labels with these label array structures:
<ul>
<li>
<code>
__reducer__
</code>
, the reducer used (e.g.,
<code>
"count"
</code>
)
</li>
<li>
<code>
__source__
</code>
, the list of time series keys used to compute the grouped series (e.g.,
<code>
"key1,key2,key3"
</code>
)
</li>
</ul>
</li>
</ul>
</details>
<p>
<note>
<b>
Note:
</b>
An
<code>
MRANGE
</code>
command cannot be part of a transaction when running on a Redis cluster.
</note>
</p>
<h2 id="return-value">
Return value
</h2>
<p>
If
<code>
GROUPBY label REDUCE reducer
</code>
is not specified:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: for each time series matching the specified filters, the following is reported:
<ul>
<li>
bulk-string-reply: The time series key name
</li>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: label-value pairs (
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
)
<ul>
<li>
By default, an empty array is reported
</li>
<li>
If
<code>
WITHLABELS
</code>
is specified, all labels associated with this time series are reported
</li>
<li>
If
<code>
SELECTED_LABELS label...
</code>
is specified, the selected labels are reported (null value when no such label defined)
</li>
</ul>
</li>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: timestamp-value pairs (
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#simple-strings">
Simple string reply
</a>
(double)): all samples/aggregations matching the range
</li>
</ul>
</li>
</ul>
<p>
If
<code>
GROUPBY label REDUCE reducer
</code>
is specified:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: for each group of time series matching the specified filters, the following is reported:
<ul>
<li>
bulk-string-reply with the format
<code>
label=value
</code>
where
<code>
label
</code>
is the
<code>
GROUPBY
</code>
label argument
</li>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: label-value pairs (
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
):
<ul>
<li>
By default, an empty array is reported
</li>
<li>
If
<code>
WITHLABELS
</code>
is specified, the
<code>
GROUPBY
</code>
label argument and value are reported
</li>
<li>
If
<code>
SELECTED_LABELS label...
</code>
is specified, the selected labels are reported (null value when no such label defined or label does not have the same value for all grouped time series)
</li>
</ul>
</li>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: either a single pair (
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
): the
<code>
GROUPBY
</code>
label argument and value, or empty array if
</li>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: a single pair (
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
): the string
<code>
__reducer__
</code>
and the reducer argument
</li>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: a single pair (
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Bulk string reply
</a>
): the string
<code>
__source__
</code>
and the time series key names separated by
<code>
,
</code>
</li>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
: timestamp-value pairs (
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#simple-strings">
Simple string reply
</a>
(double)): all samples/aggregations matching the range
</li>
</ul>
</li>
</ul>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Retrieve maximum stock price per timestamp
</b>
</summary>
<p>
Create two stocks and add their prices at three different timestamps.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:A LABELS <span class="nb">type</span> stock name A
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:B LABELS <span class="nb">type</span> stock name B
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">1000</span> <span class="m">100</span> stock:A <span class="m">1010</span> <span class="m">110</span> stock:A <span class="m">1020</span> <span class="m">120</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:B <span class="m">1000</span> <span class="m">120</span> stock:B <span class="m">1010</span> <span class="m">110</span> stock:B <span class="m">1020</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span></span></span></code></pre>
</div>
<p>
You can now retrieve the maximum stock price per timestamp.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.MRANGE - + WITHLABELS FILTER <span class="nv">type</span><span class="o">=</span>stock GROUPBY <span class="nb">type</span> REDUCE max
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"type=stock"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"type"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"stock"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__reducer__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"max"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__source__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"stock:A,stock:B"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">120</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">110</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">120</span></span></span></code></pre>
</div>
<p>
The
<code>
FILTER type=stock
</code>
clause returns a single time series representing stock prices. The
<code>
GROUPBY type REDUCE max
</code>
clause splits the time series into groups with identical type values, and then, for each timestamp, aggregates all series that share the same type value using the max aggregator.
</p>
</details>
<details open="">
<summary>
<b>
Calculate average stock price and retrieve maximum average
</b>
</summary>
<p>
Create two stocks and add their prices at nine different timestamps.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:A LABELS <span class="nb">type</span> stock name A
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:B LABELS <span class="nb">type</span> stock name B
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">1000</span> <span class="m">100</span> stock:A <span class="m">1010</span> <span class="m">110</span> stock:A <span class="m">1020</span> <span class="m">120</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:B <span class="m">1000</span> <span class="m">120</span> stock:B <span class="m">1010</span> <span class="m">110</span> stock:B <span class="m">1020</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">2000</span> <span class="m">200</span> stock:A <span class="m">2010</span> <span class="m">210</span> stock:A <span class="m">2020</span> <span class="m">220</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:B <span class="m">2000</span> <span class="m">220</span> stock:B <span class="m">2010</span> <span class="m">210</span> stock:B <span class="m">2020</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">3000</span> <span class="m">300</span> stock:A <span class="m">3010</span> <span class="m">310</span> stock:A <span class="m">3020</span> <span class="m">320</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:B <span class="m">3000</span> <span class="m">320</span> stock:B <span class="m">3010</span> <span class="m">310</span> stock:B <span class="m">3020</span> <span class="m">300</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3020</span></span></span></code></pre>
</div>
<p>
Now, for each stock, calculate the average stock price per a 1000-millisecond timeframe, and then retrieve the stock with the maximum average for that timeframe.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.MRANGE - + WITHLABELS AGGREGATION avg <span class="m">1000</span> FILTER <span class="nv">type</span><span class="o">=</span>stock GROUPBY <span class="nb">type</span> REDUCE max
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"type=stock"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"type"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"stock"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__reducer__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"max"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__source__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"stock:A,stock:B"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">110</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">210</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">310</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Group query results
</b>
</summary>
<p>
Query all time series with the metric label equal to
<code>
cpu
</code>
, then group the time series by the value of their
<code>
metric_name
</code>
label value and for each group return the maximum value and the time series keys (
<em>
source
</em>
) with that value.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts1 <span class="m">1548149180000</span> <span class="m">90</span> labels metric cpu metric_name system
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts1 <span class="m">1548149185000</span> <span class="m">45</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149185000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts2 <span class="m">1548149180000</span> <span class="m">99</span> labels metric cpu metric_name user
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MRANGE - + WITHLABELS FILTER <span class="nv">metric</span><span class="o">=</span>cpu GROUPBY metric_name REDUCE max
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric_name=system"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric_name"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"system"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__reducer__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"max"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__source__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"ts1"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">90</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149185000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">45</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric_name=user"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric_name"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"user"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__reducer__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"max"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"__source__"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"ts2"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">99</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Filter query by value
</b>
</summary>
<p>
Query all time series with the metric label equal to
<code>
cpu
</code>
, then filter values larger or equal to 90.0 and smaller or equal to 100.0.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts1 <span class="m">1548149180000</span> <span class="m">90</span> labels metric cpu metric_name system
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts1 <span class="m">1548149185000</span> <span class="m">45</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149185000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts2 <span class="m">1548149180000</span> <span class="m">99</span> labels metric cpu metric_name user
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MRANGE - + FILTER_BY_VALUE <span class="m">90</span> <span class="m">100</span> WITHLABELS FILTER <span class="nv">metric</span><span class="o">=</span>cpu
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"ts1"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"cpu"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric_name"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"system"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">90</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"ts2"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"cpu"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"metric_name"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"user"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">99</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Query using a label
</b>
</summary>
<p>
Query all time series with the metric label equal to
<code>
cpu
</code>
, but only return the team label.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts1 <span class="m">1548149180000</span> <span class="m">90</span> labels metric cpu metric_name system team NY
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts1 <span class="m">1548149185000</span> <span class="m">45</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149185000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.ADD ts2 <span class="m">1548149180000</span> <span class="m">99</span> labels metric cpu metric_name user team SF
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MRANGE - + SELECTED_LABELS team FILTER <span class="nv">metric</span><span class="o">=</span>cpu
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"ts1"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"team"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"NY"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">90</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149185000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">45</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"ts2"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"team"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"SF"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">99</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.range/">
<code>
TS.RANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.mrevrange/">
<code>
TS.MREVRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.revrange/">
<code>
TS.REVRANGE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/data-types/timeseries/">
RedisTimeSeries
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ts.mrange/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Configure CentOS/RHEL firewall
</h1>
<p class="text-lg -mt-5 mb-10">
Configure firewall rules for Redis Enterprise Software on CentOS or Red Hat Enterprise Linux (RHEL).
</p>
<p>
CentOS and Red Hat Enterprise Linux (RHEL) distributions use
<a href="https://firewalld.org/">
<strong>
firewalld
</strong>
</a>
by default to manage the firewall and configure
<a href="https://en.wikipedia.org/wiki/Iptables">
iptables
</a>
.
The default configuration assigns the network interfaces to the
<strong>
public
</strong>
zone and blocks all ports except port 22, which is used for
<a href="https://en.wikipedia.org/wiki/Secure_Shell">
SSH
</a>
.
</p>
<p>
When you install Redis Enterprise Software on CentOS or RHEL, it automatically creates two firewalld system services:
</p>
<ul>
<li>
A service named
<strong>
redislabs
</strong>
, which includes all ports and protocols needed for communication between cluster nodes.
</li>
<li>
A service named
<strong>
redislabs-clients
</strong>
, which includes the ports and protocols needed for external communication (outside of the cluster).
</li>
</ul>
<p>
These services are defined but not allowed through the firewall by default.
During Redis Enterprise Software installation, the
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/manage-installation-questions/">
installer prompts
</a>
you to confirm auto-configuration of a default (public) zone
to allow the
<strong>
redislabs
</strong>
service.
</p>
<p>
Although automatic firewall configuration simplifies installation, your deployment might not be secure if you did not use other methods to secure the host machine's network, such as external firewall rules or security groups.
You can use firewalld configuration tools such as
<strong>
firewall-cmd
</strong>
(command line) or
<strong>
firewall-config
</strong>
(UI)
to create more specific firewall policies that allow these two services through the firewall, as necessary.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
If databases are created with non-standard
<a href="/docs/latest/operate/rs/7.4/networking/port-configurations/">
Redis Enterprise Software ports
</a>
,
you need to explicitly configure firewalld to make sure those ports are not blocked.
</div>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ts.decrby/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.DECRBY
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.DECRBY key subtrahend
[TIMESTAMP timestamp]
[RETENTION retentionPeriod]
[ENCODING <COMPRESSED|UNCOMPRESSED>]
[CHUNK_SIZE size]
[DUPLICATE_POLICY policy]
[IGNORE ignoreMaxTimediff ignoreMaxValDiff]
[LABELS [label value ...]]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/timeseries">
TimeSeries 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(M) when M is the amount of compaction rules or O(1) with no compaction
</dd>
</dl>
<p>
Decrease the value of the sample with the maximum existing timestamp, or create a new sample with a value equal to the value of the sample with the maximum existing timestamp with a given decrement
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is key name for the time series.
</p>
</details>
<details open="">
<summary>
<code>
subtrahend
</code>
</summary>
<p>
is numeric value of the subtrahend (double).
</p>
</details>
<p>
<note>
<b>
Notes
</b>
</note>
</p>
<ul>
<li>
When specified key does not exist, a new time series is created.
</li>
<li>
You can use this command as a counter or gauge that automatically gets history as a time series.
</li>
<li>
If a policy for handling duplicate samples (
<code>
IGNORE
</code>
) is defined for this time series -
<code>
TS.DECRBY
</code>
operations are affected as well (sample additions/modifications can be filtered).
</li>
<li>
Explicitly adding samples to a compacted time series (using
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.madd/">
<code>
TS.MADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
, or
<code>
TS.DECRBY
</code>
) may result in inconsistencies between the raw and the compacted data. The compaction process may override such samples.
</li>
</ul>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
TIMESTAMP timestamp
</code>
</summary>
<p>
is Unix time (integer, in milliseconds) specifying the sample timestamp or
<code>
*
</code>
to set the sample timestamp to the Unix time of the server's clock.
</p>
<p>
Unix time is the number of milliseconds that have elapsed since 00:00:00 UTC on 1 January 1970, the Unix epoch, without adjustments made due to leap seconds.
</p>
<p>
<code>
timestamp
</code>
must be equal to or higher than the maximum existing timestamp. When equal, the value of the sample with the maximum existing timestamp is decreased. If it is higher, a new sample with a timestamp set to
<code>
timestamp
</code>
is created, and its value is set to the value of the sample with the maximum existing timestamp minus
<code>
subtrahend
</code>
.
</p>
<p>
If the time series is empty, the value is set to
<code>
subtrahend
</code>
.
</p>
<p>
When not specified, the timestamp is set to the Unix time of the server's clock.
</p>
</details>
<details open="">
<summary>
<code>
RETENTION retentionPeriod
</code>
<p>
is maximum retention period, compared to the maximum existing timestamp, in milliseconds.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
RETENTION
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</summary>
</details>
<details open="">
<summary>
<code>
ENCODING enc
</code>
</summary>
<p>
specifies the series sample encoding format.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
ENCODING
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
CHUNK_SIZE size
</code>
</summary>
<p>
is memory size, in bytes, allocated for each data chunk.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
CHUNK_SIZE
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
DUPLICATE_POLICY policy
</code>
</summary>
<p>
is policy for handling insertion (
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
and
<a href="/docs/latest/commands/ts.madd/">
<code>
TS.MADD
</code>
</a>
) of multiple samples with identical timestamps.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
DUPLICATE_POLICY
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
IGNORE ignoreMaxTimediff ignoreMaxValDiff
</code>
</summary>
<p>
is the policy for handling duplicate samples. A new sample is considered a duplicate and is ignored if the following conditions are met:
</p>
<ul>
<li>
The time series is not a compaction;
</li>
<li>
The time series'
<code>
DUPLICATE_POLICY
</code>
IS
<code>
LAST
</code>
;
</li>
<li>
The sample is added in-order (
<code>
timestamp ≥ max_timestamp
</code>
);
</li>
<li>
The difference of the current timestamp from the previous timestamp (
<code>
timestamp - max_timestamp
</code>
) is less than or equal to
<code>
IGNORE_MAX_TIME_DIFF
</code>
;
</li>
<li>
The absolute value difference of the current value from the value at the previous maximum timestamp (
<code>
abs(value - value_at_max_timestamp
</code>
) is less than or equal to
<code>
IGNORE_MAX_VAL_DIFF
</code>
.
</li>
</ul>
<p>
where
<code>
max_timestamp
</code>
is the timestamp of the sample with the largest timestamp in the time series, and
<code>
value_at_max_timestamp
</code>
is the value at
<code>
max_timestamp
</code>
.
</p>
<p>
When not specified: set to the global
<a href="/docs/latest/develop/data-types/timeseries/configuration#ignore_max_time_diff-and-ignore_max_val_diff">
IGNORE_MAX_TIME_DIFF
</a>
and
<a href="/docs/latest/develop/data-types/timeseries/configuration#ignore_max_time_diff-and-ignore_max_val_diff">
IGNORE_MAX_VAL_DIFF
</a>
, which are, by default, both set to 0.
</p>
<p>
These parameters are used when creating a new time series to set the per-key parameters, and are ignored when called with an existing time series (the existing per-key configuration parameters are used).
</p>
</details>
<details open="">
<summary>
<code>
LABELS [{label value}...]
</code>
</summary>
<p>
is set of label-value pairs that represent metadata labels of the key and serve as a secondary index.
</p>
<p>
Use it only if you are creating a new time series. It is ignored if you are adding samples to an existing time series. See
<code>
LABELS
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
.
</p>
</details>
<p>
<note>
<b>
Notes
</b>
</note>
</p>
<ul>
<li>
You can use this command to create a new time series and add a sample to it in a single command.
<code>
RETENTION
</code>
,
<code>
ENCODING
</code>
,
<code>
CHUNK_SIZE
</code>
,
<code>
DUPLICATE_POLICY
</code>
,
<code>
IGNORE
</code>
, and
<code>
LABELS
</code>
are used only when creating a new time series, and ignored when adding or modifying samples in an existing time series.
</li>
<li>
Setting
<code>
RETENTION
</code>
and
<code>
LABELS
</code>
introduces additional time complexity.
</li>
</ul>
<h2 id="return-value">
Return value
</h2>
<p>
Returns one of these replies:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
- the timestamp of the upserted sample. If the sample is ignored (See
<code>
IGNORE
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
), the reply will be the largest timestamp in the time series.
</li>
<li>
[] on error (invalid arguments, wrong key type, etc.), or when
<code>
timestamp
</code>
is not equal to or higher than the maximum existing timestamp
</li>
</ul>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
|
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/data-types/timeseries/">
RedisTimeSeries
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ts.decrby/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/cluster-addslots/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLUSTER ADDSLOTS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLUSTER ADDSLOTS slot [slot ...]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
3.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the total number of hash slot arguments
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@admin
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@dangerous
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
This command is useful in order to modify a node's view of the cluster
configuration. Specifically it assigns a set of hash slots to the node
receiving the command. If the command is successful, the node will map
the specified hash slots to itself, and will start broadcasting the new
configuration.
</p>
<p>
However note that:
</p>
<ol>
<li>
The command only works if all the specified slots are, from the point of view of the node receiving the command, currently not assigned. A node will refuse to take ownership for slots that already belong to some other node (including itself).
</li>
<li>
The command fails if the same slot is specified multiple times.
</li>
<li>
As a side effect of the command execution, if a slot among the ones specified as argument is set as
<code>
importing
</code>
, this state gets cleared once the node assigns the (previously unbound) slot to itself.
</li>
</ol>
<h2 id="example">
Example
</h2>
<p>
For example the following command assigns slots 1 2 3 to the node receiving
the command:
</p>
<pre><code>> CLUSTER ADDSLOTS 1 2 3
OK
</code></pre>
<p>
However trying to execute it again results into an error since the slots
are already assigned:
</p>
<pre><code>> CLUSTER ADDSLOTS 1 2 3
ERR Slot 1 is already busy
</code></pre>
<h2 id="usage-in-redis-cluster">
Usage in Redis Cluster
</h2>
<p>
This command only works in cluster mode and is useful in the following
Redis Cluster operations:
</p>
<ol>
<li>
To create a new
<code>
cluster ADDSLOTS
</code>
is used in order to initially setup master nodes splitting the available hash slots among them.
</li>
<li>
In order to fix a broken cluster where certain slots are unassigned.
</li>
</ol>
<h2 id="information-about-slots-propagation-and-warnings">
Information about slots propagation and warnings
</h2>
<p>
Note that once a node assigns a set of slots to itself, it will start
propagating this information in heartbeat packet headers. However the
other nodes will accept the information only if they have the slot as
not already bound with another node, or if the configuration epoch of the
node advertising the new hash slot, is greater than the node currently listed
in the table.
</p>
<p>
This means that this command should be used with care only by applications
orchestrating Redis Cluster, like
<code>
redis-cli
</code>
, and the command if used
out of the right context can leave the cluster in a wrong state or cause
data loss.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
if the command was successful. Otherwise an error is returned.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/cluster-addslots/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.4-release-notes.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisJSON 2.4 release notes
</h1>
<p class="text-lg -mt-5 mb-10">
Low-level API changes in order to support the multi-value indexing and querying support that comes with RediSearch 2.6. RediSearch 2.6 comes with multi-value indexing and querying of attributes for any attribute type (Text, Tag, Numeric, Geo and Vector) defined by a JSONPath leading to an array or to multiple scalar values.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RedisJSON v2.4.9 requires:
</p>
<ul>
<li>
Minimum Redis compatibility version (database): 6.0.16
</li>
<li>
Minimum Redis Enterprise Software version (cluster): 6.2.18
</li>
</ul>
<h2 id="v249-april-2024">
v2.4.9 (April 2024)
</h2>
<p>
This is a maintenance release for RedisJSON 2.4.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/1192">
#1192
</a>
Crashes with numeric values greater than i64::MAX (MOD-6501, MOD-4551, MOD-4856, MOD-5714)
</li>
<li>
HDT#228 (Redis Enterprise A-A only) Incorrect error when processing escaped characters (MOD-6645)
</li>
</ul>
</li>
</ul>
<h2 id="v248-january-2024">
v2.4.8 (January 2024)
</h2>
<p>
This is a maintenance release for RedisJSON 2.4.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Ubuntu 16.04 and RHEL 7 are no longer supported as of v2.4.8.
</div>
</div>
<p>
Details:
</p>
<ul>
<li>
<p>
Improvements:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/1149">
#1149
</a>
Added support for CBL-Mariner 2
</li>
</ul>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/1025">
#1025
</a>
<code>
JSON.TOGGLE
</code>
- missing keyspace notification
</li>
</ul>
</li>
</ul>
<h2 id="v247-april-2023">
v2.4.7 (April 2023)
</h2>
<p>
This is a maintenance release for RedisJSON 2.4.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/issues/947">
#947
</a>
Crash when using array slice operator (
<code>
[start🔚step]
</code>
) with step
<code>
0
</code>
</li>
</ul>
</li>
</ul>
<h2 id="v246-march-2023">
v2.4.6 (March 2023)
</h2>
<p>
This is a maintenance release for RedisJSON 2.4.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/912">
#912
</a>
Fix actual memory usage calculation (MOD-4787)
</li>
</ul>
</li>
</ul>
<h2 id="v245-february-2023">
v2.4.5 (February 2023)
</h2>
<p>
This is a maintenance release for RedisJSON 2.4.
</p>
<p>
Update urgency:
<code>
LOW
</code>
: No need to upgrade unless there are new features you want to use.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Improvements:
</p>
<ul>
<li>
Adds support to Redis Enterprise on Ubuntu Linux 20.04 LTS (Focal Fossa)
</li>
</ul>
</li>
</ul>
<h2 id="v244-february-2023">
v2.4.4 (February 2023)
</h2>
<p>
This is a maintenance release for RedisJSON 2.4.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/919">
#919
</a>
Possible failure loading RDB files (MOD-4822)
</li>
</ul>
</li>
<li>
<p>
Improvements:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/issues/725">
#725
</a>
Improve error messages
</li>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/918">
#918
</a>
Add IPv6 to the capabilities list
</li>
</ul>
</li>
</ul>
<h2 id="v243-december-2022">
v2.4.3 (December 2022)
</h2>
<p>
This is a maintenance release for RedisJSON 2.4.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/890">
#890
</a>
JSONPath ignores any filter condition beyond the second (MOD-4602)
</li>
</ul>
</li>
<li>
<p>
Improvements:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/892">
#892
</a>
Allow
<code>
JSON.ARRINDEX
</code>
with nonscalar values
</li>
</ul>
</li>
</ul>
<h2 id="v24-ga-v242-november-2022">
v2.4 GA (v2.4.2) (November 2022)
</h2>
<p>
This is the General Availability release of RedisJSON 2.4.
</p>
<h3 id="highlights">
Highlights
</h3>
<p>
RedisJSON 2.4 contains several low-level API changes in order to support the multi-value indexing and querying support that comes with RediSearch 2.6. RediSearch 2.6 comes with multi-value indexing and querying of attributes for any attribute type (Text, Tag, Numeric, Geo and Vector) defined by a JSONPath leading to an array or to multiple scalar values.
</p>
<h3 id="whats-new-in-24">
What's new in 2.4
</h3>
<ul>
<li>
<p>
Features:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/848">
#848
</a>
Add JSONPath filter the regexp match operator (MOD-4432)
</li>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/861">
#861
</a>
Support legacy JSONPath with the dollar sign $ (MOD-4436)
</li>
</ul>
</li>
<li>
<p>
Performance enhancements:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/699">
#699
</a>
A new JSONPath library which enhances the performance of parsing any JSONPath expression in RedisJSON.
</li>
</ul>
</li>
<li>
<p>
Changing behaviour:
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/699">
#699
</a>
Floating point numbers which become round numbers due to some operation, such as
<code>
JSON.NUMINCRBY
</code>
, will now return as a floating point with a trailing
<code>
.0
</code>
, e.g., instead of just
<code>
42
</code>
, now
<code>
42.0
</code>
will be returned.
</li>
</ul>
</li>
<li>
<p>
Bugs fixes (since 2.4-RC1/ v2.4.0):
</p>
<ul>
<li>
<a href="https://github.com/RedisJSON/RedisJSON/pull/850">
#850
</a>
Allow repetition of filter relation instead of optional (MOD-4431)
</li>
</ul>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.4-release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/cluster-replicas/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLUSTER REPLICAS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLUSTER REPLICAS node-id</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
5.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the number of replicas.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@admin
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@dangerous
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The command provides a list of replica nodes replicating from the specified
master node. The list is provided in the same format used by
<a href="/docs/latest/commands/cluster-nodes/">
<code>
CLUSTER NODES
</code>
</a>
(please refer to its documentation for the specification of the format).
</p>
<p>
The command will fail if the specified node is not known or if it is not
a master according to the node table of the node receiving the command.
</p>
<p>
Note that if a replica is added, moved, or removed from a given master node,
and we ask
<code>
CLUSTER REPLICAS
</code>
to a node that has not yet received the
configuration update, it may show stale information. However eventually
(in a matter of seconds if there are no network partitions) all the nodes
will agree about the set of nodes associated with a given master.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of replica nodes replicating from the specified master node provided in the same format used by
<code>
CLUSTER NODES
</code>
.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/cluster-replicas/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-trace/.html | <section class="prose w-full py-12">
<h1>
redis-di trace
</h1>
<p class="text-lg -mt-5 mb-10">
Starts a trace session for troubleshooting data transformation
</p>
<h2 id="usage">
Usage
</h2>
<pre tabindex="0"><code>Usage: redis-di trace [OPTIONS]
</code></pre>
<h2 id="options">
Options
</h2>
<ul>
<li>
<p>
<code>
log_level
</code>
:
</p>
<ul>
<li>
Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
</li>
<li>
Default:
<code>
info
</code>
</li>
<li>
Usage:
<code>
--log-level -l
</code>
</li>
</ul>
</li>
<li>
<p>
<code>
rdi_host
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-host
</code>
</li>
</ul>
<p>
Host/IP of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_port
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: <IntRange 1<=x<=65535>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-port
</code>
</li>
</ul>
<p>
Port of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_user
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-user
</code>
</li>
</ul>
<p>
RDI Database Username
</p>
</li>
<li>
<p>
<code>
rdi_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-password
</code>
</li>
</ul>
<p>
RDI Database Password
</p>
</li>
<li>
<p>
<code>
rdi_key
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key
</code>
</li>
</ul>
<p>
Private key file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cert
</code>
</li>
</ul>
<p>
Client certificate file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cacert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cacert
</code>
</li>
</ul>
<p>
CA certificate file to verify with
</p>
</li>
<li>
<p>
<code>
rdi_key_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key-password
</code>
</li>
</ul>
<p>
Password for unlocking an encrypted private key
</p>
</li>
<li>
<p>
<code>
max_change_records
</code>
:
</p>
<ul>
<li>
Type:
<intrange x="">
=1>
</intrange>
</li>
<li>
Default:
<code>
10
</code>
</li>
<li>
Usage:
<code>
--max-change-records
</code>
</li>
</ul>
<p>
Maximum traced change records
</p>
</li>
<li>
<p>
<code>
timeout
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: <IntRange 1<=x<=600>
</li>
<li>
Default:
<code>
20
</code>
</li>
<li>
Usage:
<code>
--timeout
</code>
</li>
</ul>
<p>
Stops the trace after exceeding this timeout (in seconds)
</p>
</li>
<li>
<p>
<code>
trace_only_rejected
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--trace-only-rejected
</code>
</li>
</ul>
<p>
Trace only rejected change records
</p>
</li>
<li>
<p>
<code>
help
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--help
</code>
</li>
</ul>
<p>
Show this message and exit.
</p>
</li>
</ul>
<h2 id="cli-help">
CLI help
</h2>
<pre tabindex="0"><code>Usage: redis-di trace [OPTIONS]
Starts a trace session for troubleshooting data transformation
Options:
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--rdi-host TEXT Host/IP of RDI Database [required]
--rdi-port INTEGER RANGE Port of RDI Database [1<=x<=65535;
required]
--rdi-user TEXT RDI Database Username
--rdi-password TEXT RDI Database Password
--rdi-key TEXT Private key file to authenticate with
--rdi-cert TEXT Client certificate file to authenticate with
--rdi-cacert TEXT CA certificate file to verify with
--rdi-key-password TEXT Password for unlocking an encrypted private
key
--max-change-records INTEGER RANGE
Maximum traced change records [x>=1]
--timeout INTEGER RANGE Stops the trace after exceeding this timeout
(in seconds) [default: 20; 1<=x<=600;
required]
--trace-only-rejected Trace only rejected change records
--help Show this message and exit.
</code></pre>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-trace/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/compatibility/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise compatibility with Redis Community Edition
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Enterprise compatibility with Redis Community Edition.
</p>
<p>
Both Redis Enterprise Software and
<a href="/docs/latest/operate/rc/">
Redis Cloud
</a>
are compatible with Redis Community Edition.
</p>
<p>
Redis contributes extensively to the Redis project and uses it inside of Redis Enterprise Software and Redis Cloud. As a rule, we adhere to the project's specifications and update both products with the latest version of Redis.
</p>
<h2 id="redis-commands">
Redis commands
</h2>
<p>
See
<a href="/docs/latest/operate/rs/references/compatibility/commands/">
Compatibility with Redis commands
</a>
to learn which Redis commands are compatible with Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="configuration-settings">
Configuration settings
</h2>
<p>
<a href="/docs/latest/operate/rs/references/compatibility/config-settings/">
Compatibility with Redis configuration settings
</a>
lists the Redis configuration settings supported by Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="redis-clients">
Redis clients
</h2>
<p>
You can use any standard
<a href="/docs/latest/develop/clients/">
Redis client
</a>
with Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="resp-compatibility">
RESP compatibility
</h2>
<p>
Redis Enterprise Software and Redis Cloud support RESP2 and RESP3. See
<a href="/docs/latest/operate/rs/references/compatibility/resp/">
RESP compatibility with Redis Enterprise
</a>
for more information.
</p>
<h2 id="client-side-caching-compatibility">
Client-side caching compatibility
</h2>
<p>
Redis Software and Redis Cloud support
<a href="/docs/latest/develop/clients/client-side-caching/">
client-side caching
</a>
for databases with Redis versions 7.4 or later. See
<a href="/docs/latest/operate/rs/references/compatibility/client-side-caching/">
Client-side caching compatibility with Redis Software and Redis Cloud
</a>
for more information about compatibility and configuration options.
</p>
<h2 id="compatibility-with-open-source-redis-cluster-api">
Compatibility with open source Redis Cluster API
</h2>
<p>
Redis Enterprise supports
<a href="/docs/latest/operate/rs/clusters/optimize/oss-cluster-api/">
Redis OSS Cluster API
</a>
if it is enabled for a database. For more information, see
<a href="/docs/latest/operate/rs/databases/configure/oss-cluster-api/">
Enable OSS Cluster API
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/compatibility/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/help/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin help
</h1>
<p class="text-lg -mt-5 mb-10">
Shows available commands or specific command usage.
</p>
<p>
Lists all options and parameters for
<code>
rladmin
</code>
commands.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">help</span> <span class="o">[</span>command<span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
command
</td>
<td>
Display help for this
<code>
rladmin
</code>
command (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns a list of available
<code>
rladmin
</code>
commands.
</p>
<p>
If a
<code>
command
</code>
is specified, returns a list of all the options and parameters for that
<code>
rladmin
</code>
command.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin <span class="nb">help</span>
</span></span><span class="line"><span class="cl">usage: rladmin <span class="o">[</span>options<span class="o">]</span> <span class="o">[</span>command<span class="o">]</span> <span class="o">[</span><span class="nb">command</span> args<span class="o">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Options:
</span></span><span class="line"><span class="cl"> -y Assume Yes <span class="k">for</span> all required user confirmations.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Commands:
</span></span><span class="line"><span class="cl"> <span class="nb">bind</span> Bind an endpoint
</span></span><span class="line"><span class="cl"> cluster Cluster management commands
</span></span><span class="line"><span class="cl"> <span class="nb">exit</span> Exit admin shell
</span></span><span class="line"><span class="cl"> failover Fail-over master to slave
</span></span><span class="line"><span class="cl"> <span class="nb">help</span> Show available commands, or use <span class="nb">help</span> <command> <span class="k">for</span> a specific <span class="nb">command</span>
</span></span><span class="line"><span class="cl"> info Show information about tunable parameters
</span></span><span class="line"><span class="cl"> migrate Migrate elements between nodes
</span></span><span class="line"><span class="cl"> node Node management commands
</span></span><span class="line"><span class="cl"> placement Configure shards placement policy
</span></span><span class="line"><span class="cl"> recover Recover databases
</span></span><span class="line"><span class="cl"> restart Restart database shards
</span></span><span class="line"><span class="cl"> status Show status information
</span></span><span class="line"><span class="cl"> suffix Suffix management
</span></span><span class="line"><span class="cl"> tune Tune system parameters
</span></span><span class="line"><span class="cl"> upgrade Upgrade entity version
</span></span><span class="line"><span class="cl"> verify Cluster verification reports
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Use <span class="s2">"rladmin help [command]"</span> to get more information on a specific command.
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/help/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/module/.html | <section class="prose w-full py-12">
<h1 class="command-name">
MODULE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">MODULE</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
4.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
Depends on subcommand.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
This is a container command for module management commands.
</p>
<p>
To see the list of available commands you can call
<a href="/docs/latest/commands/module-help/">
<code>
MODULE HELP
</code>
</a>
.
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/module/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/cloud-integrations/vercel/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Create a Redis Cloud database with the Vercel integration.
</h1>
<p class="text-lg -mt-5 mb-10">
Shows how to create a Redis Cloud database with Vercel integration.
</p>
<p>
The
<a href="https://vercel.com/marketplace/redis-cloud">
Redis Cloud Vercel integration
</a>
lets you create a new Redis database from your Vercel account and connect it to your Vercel project(s).
</p>
<h2 id="create-database">
Create database
</h2>
<ol>
<li>
<p>
Log in to your Vercel account (or create a new one).
</p>
</li>
<li>
<p>
Navigate to the
<strong>
Storage
</strong>
tab and select
<strong>
Create database
</strong>
.
<a href="/docs/latest/images/rc/vercel-storage-create-database-button.png" sdata-lightbox="/images/rc/vercel-storage-create-database-button.png">
<img alt="Storage - Create Database" src="/docs/latest/images/rc/vercel-storage-create-database-button.png"/>
</a>
</p>
</li>
<li>
<p>
Under
<strong>
Storage partners
</strong>
, select
<strong>
View all partners
</strong>
.
<a href="/docs/latest/images/rc/vercel-redis-cloud-partners.png" sdata-lightbox="/images/rc/vercel-redis-cloud-partners.png">
<img alt="Browse storage" src="/docs/latest/images/rc/vercel-redis-cloud-partners.png" width="400px"/>
</a>
</p>
</li>
<li>
<p>
Find
<strong>
Redis Cloud
</strong>
and select
<strong>
Continue
</strong>
.
</p>
</li>
<li>
<p>
In the
<strong>
Create Database
</strong>
dialog, select your plan and
<strong>
Continue
</strong>
.
</p>
<a href="/docs/latest/images/rc/vercel-create-db-select-plan.png" sdata-lightbox="/images/rc/vercel-create-db-select-plan.png">
<img alt="Create database" src="/docs/latest/images/rc/vercel-create-db-select-plan.png"/>
</a>
<p>
More configuration options are coming soon, such as region selection and multi-zone high availability.
</p>
</li>
<li>
<p>
Enter your database name or use the automatically generated name.
</p>
</li>
<li>
<p>
Select
<strong>
Create
</strong>
.
</p>
</li>
</ol>
<h2 id="connect-to-your-database">
Connect to your database
</h2>
<p>
After creation, you will see your database details. After provisioning is complete, the status will change from
<code>
Initializing
</code>
to
<code>
Available
</code>
(you may need to refresh your browser).
</p>
<a href="/docs/latest/images/rc/vercel-status-available.png" sdata-lightbox="/images/rc/vercel-status-available.png">
<img alt="Vercel database details" src="/docs/latest/images/rc/vercel-status-available.png"/>
</a>
<p>
You can use the connection string shown under
<strong>
Quickstart
</strong>
to
<a href="/docs/latest/operate/rc/databases/connect/">
connect to your database
</a>
.
</p>
<h2 id="link-database-to-your-project">
Link database to your project
</h2>
<ol>
<li>
Navigate to the
<strong>
Storage
</strong>
tab.
</li>
<li>
Find your new database in the list of your team's databases.
</li>
<li>
Select
<strong>
Connect Project
</strong>
.
<a href="/docs/latest/images/rc/vercel-connect-project-button.png" sdata-lightbox="/images/rc/vercel-connect-project-button.png">
<img alt="Connect Project button" src="/docs/latest/images/rc/vercel-connect-project-button.png"/>
</a>
</li>
<li>
Choose your project and environments and select
<strong>
Connect
</strong>
.
<a href="/docs/latest/images/rc/vercel-connect-project.png" sdata-lightbox="/images/rc/vercel-connect-project.png">
<img alt="Connect project" src="/docs/latest/images/rc/vercel-connect-project.png"/>
</a>
</li>
</ol>
<h2 id="manage-your-database">
Manage your database
</h2>
<p>
From the database details page, you can make edits to your database under
<strong>
Settings
</strong>
.
</p>
<p>
More configuration options are coming soon, including plan changes, multi-zone high availability, and region selection.
</p>
<h3 id="configure-from-redis-cloud">
Configure from Redis Cloud
</h3>
<p>
You can also edit some configuration options in Redis Cloud.
</p>
<p>
From the database detail page, select
<strong>
Open in Redis Cloud
</strong>
.
</p>
<a href="/docs/latest/images/rc/vercel-open-in-redis-cloud.png" sdata-lightbox="/images/rc/vercel-open-in-redis-cloud.png">
<img alt="Open in Redis" src="/docs/latest/images/rc/vercel-open-in-redis-cloud.png"/>
</a>
<p>
Your Redis Cloud account is linked to your Vercel account. All your team's Redis databases will be listed under
<strong>
Databases
</strong>
in Redis Cloud.
</p>
<p>
Select your new database to make configuration changes such as passwords or the eviction policy.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
The
<a href="/docs/latest/operate/rc/databases/configuration/data-eviction-policies/">
eviction policy
</a>
defaults to
<code>
no eviction
</code>
for new databases. You can change this by
<a href="/docs/latest/operate/rc/databases/view-edit-database/">
editing the database details
</a>
.
</div>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/cloud-integrations/vercel/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/tools/insight/release-notes/v.2.54.0/.html | <section class="prose w-full py-12">
<h1>
Redis Insight v2.54.0, August 2024
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Insight v2.54
</p>
<h2 id="254-august-2024">
2.54 (August 2024)
</h2>
<p>
This is the General Availability (GA) release of Redis Insight 2.54.
</p>
<h3 id="highlights">
Highlights
</h3>
<p>
Support for
<a href="https://redis.io/data-integration/?utm_source=redisinsight&utm_medium=repository&utm_campaign=release_notes">
Redis Data Integration (RDI)
</a>
- a powerful tool designed to seamlessly synchronize data from your existing database to Redis in near real-time. RDI establishes a data streaming pipeline that mirrors data from your existing database to Redis Software, so if a record is added or updated, those changes automatically flow into Redis. This no-code solution enables seamless data integration and faster data access so you can build real-time apps at any scale. And now you can seamlessly create, validate, deploy, and monitor your data pipelines directly from Redis Insight.
</p>
<h3 id="details">
Details
</h3>
<p>
<strong>
Features and improvements
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2839">
#2839
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/2853">
#2853
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/3101">
#3101
</a>
Redis Insight now comes with the support for
<a href="https://redis.io/data-integration/?utm_source=redisinsight&utm_medium=repository&utm_campaign=release_notes">
Redis Data Integration (RDI)
</a>
- a powerful tool designed to seamlessly synchronize data from your existing database to Redis in near real-time. RDI establishes a data streaming pipeline that mirrors data from your existing database to Redis Software, so if a record is added or updated, those changes automatically flow into Redis. This no-code solution enables seamless data integration and faster data access so you can build real-time apps at any scale. Use RDI version 1.2.7 or later to seamlessly create, validate, deploy, and monitor your data pipelines within Redis Insight. To get started, switch to the "Redis Data Integration" tab on the page with the list of Redis databases and add your RDI endpoint to Redis Insight.
</li>
</ul>
<p>
<strong>
Bugs
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3577">
#3577
</a>
Show
<a href="https://github.com/RedisInsight/RedisInsight/issues/3157">
information about OSS cluster
</a>
when connected using TLS.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3575">
#3575
</a>
Return
<a href="https://github.com/RedisInsight/RedisInsight/issues/3465">
results instead of an empty list
</a>
for commands written in lowercase.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3613">
#3613
</a>
Prevent repetitive buffer overflow by avoiding the resending of unfulfilled commands.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/tools/insight/release-notes/v.2.54.0/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-0/.html | <section class="prose w-full py-12">
<h1>
Redis Data Integration release notes 1.0 (June 2024)
</h1>
<p class="text-lg -mt-5 mb-10">
Changes to the processing mode. Simple installation. Silent installation. Pipeline orchestration. Logging. Monitoring. High availability mechanism.
</p>
<p>
This is the first General Availability version of Redis Data Integration (RDI).
</p>
<p>
RDI’s mission is to help Redis customers sync Redis Enterprise with live data from their slow disk-based databases to:
</p>
<ul>
<li>
Meet the required speed and scale of read queries and provide an excellent and predictable user experience.
</li>
<li>
Save resources and time when building pipelines and coding data transformations.
</li>
<li>
Reduce the total cost of ownership by saving money on expensive database read replicas.
</li>
</ul>
<p>
RDI keeps the Redis cache up to date with changes in the primary database, using a
<a href="https://en.wikipedia.org/wiki/Change_data_capture">
<em>
Change Data Capture (CDC)
</em>
</a>
mechanism.
It also lets you
<em>
transform
</em>
the data from relational tables into convenient
and fast data structures that match your app's requirements. You specify the
transformations using a configuration system, so no coding is required.
</p>
<h2 id="headlines">
Headlines
</h2>
<ul>
<li>
Changes to the processing mode: The preview versions of RDI processed data inside the Redis Enterprise database using the shard CPU. The GA version moves the processing of data outside the cluster. RDI is now deployed on VMs or on Kubernetes (K8s).
</li>
<li>
Simple installation: RDI ships with all of its dependencies. A simple interactive installer provides a streamlined process that takes a few minutes.
</li>
<li>
Silent installation: RDI can be installed by software using a script and an input file.
</li>
<li>
Pipeline orchestration: The preview versions of RDI required you to manually install and configure the Debezium server. In this version, we add support for source database configuration to the pipeline configuration and orchestration of all pipeline components including the Debezium server (RDI Collector).
</li>
<li>
Logging: All RDI component logs are now shipped to a central folder and get rotated by RDI's logging mechanism.
</li>
<li>
Monitoring: RDI comes with two Prometheus exporters, one For Debezium Server and one for RDI's pipeline data processing.
</li>
<li>
High availability mechanism: The preview versions of RDI used an external clustering dependency to provide active-passive deployment of the Debezium server. The GA version has a Redis-based built-in fail-over mechanism between an active VM and a passive VM. Kubernetes deployments rely on K8s probes that are included in RDI components.
</li>
</ul>
<h2 id="limitations">
Limitations
</h2>
<ul>
<li>
RDI can write data to a Redis Active-Active database. However, it doesn't support writing data to two or more Active-Active replicas. Writing data from RDI to several Active-Active replicas could easily harm data integrity as RDI is not synchronous with the source database commits.
</li>
<li>
RDI write-behind (which is currently in preview) should not be used on the same data set that RDI ingest is writing to Redis. This would either cause an infinite loop or would harm the data integrity, since both ingest and write-behind are asynchronous, eventually-consistent processes.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-0/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-64/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise Software release notes 7.2.4-64 (September 2023)
</h1>
<p class="text-lg -mt-5 mb-10">
Improved cluster recovery with manually uploaded modules. Support package contains supervisorctl status. Configure port range using rladmin and REST API. License API returns the number of used shards (RAM & flash).
</p>
<p>
This is a maintenance release for
<a href="https://redis.com/redis-enterprise-software/download-center/software/">
Redis Enterprise Software version 7.2.4
</a>
.
</p>
<h2 id="highlights">
Highlights
</h2>
<p>
This version offers:
</p>
<ul>
<li>
<p>
Improved cluster recovery with manually uploaded modules
</p>
</li>
<li>
<p>
Support package enhancements
</p>
</li>
<li>
<p>
Configurable port range
</p>
</li>
<li>
<p>
License API enhancements
</p>
</li>
</ul>
<h2 id="new-in-this-release">
New in this release
</h2>
<h3 id="enhancements">
Enhancements
</h3>
<ul>
<li>
<p>
Cluster recovery with manually uploaded modules
</p>
<ul>
<li>
For clusters containing databases with manually uploaded modules,
<a href="/docs/latest/operate/rs/clusters/cluster-recovery/">
cluster recovery
</a>
is now seamlessly integrated.
</li>
</ul>
</li>
<li>
<p>
Support package now contains
<code>
supervisorctl
</code>
status when created by the
<a href="/docs/latest/operate/rs/installing-upgrading/creating-support-package/#command-line-method">
<code>
rladmin
</code>
command
</a>
(RS107879).
</p>
</li>
<li>
<p>
Port range (
<code>
reserved_ports
</code>
) is now configurable using
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/config/">
<code>
rladmin
</code>
</a>
or the
<a href="/docs/latest/operate/rs/references/rest-api/requests/cluster/#put-cluster">
REST API
</a>
.
</p>
<ul>
<li>
Removed
<code>
rlutil reserved_ports
</code>
, which was deprecated in Redis Enterprise Software
<a href="/docs/latest/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-52/#api-deprecations">
version 7.2.4-52
</a>
.
</li>
</ul>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/references/rest-api/requests/license/">
License REST API requests
</a>
return the number of used shards (RAM & flash).
</p>
</li>
</ul>
<h4 id="redis-modules">
Redis modules
</h4>
<p>
Redis Enterprise Software version 7.2.4-64 includes the following Redis Stack modules (no changes since
<a href="/docs/latest/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-52/">
Redis Enterprise Software version 7.2.4-52
</a>
:
</p>
<ul>
<li>
<p>
<a href="https://github.com/RediSearch/RediSearch/releases/tag/v2.8.4">
RediSearch 2.8.4
</a>
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisJSON/RedisJSON/releases/tag/v2.6.6">
RedisJSON 2.6.6
</a>
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/releases/tag/v1.10.4">
RedisTimeSeries 1.10.4
</a>
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisBloom/RedisBloom/releases/tag/v2.6.3">
RedisBloom 2.6.3
</a>
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/releases/tag/v2.0.11-m12">
RedisGears 2.0.11
</a>
</p>
</li>
</ul>
<h3 id="resolved-issues">
Resolved issues
</h3>
<ul>
<li>
<p>
RS107986 - Allow ports lower than 1024 when configuring
<a href="/docs/latest/operate/rs/security/audit-events/">
auditing
</a>
using
<code>
rladmin
</code>
.
</p>
</li>
<li>
<p>
RS105335 - Added error handling to
<a href="/docs/latest/commands/client-no-touch/">
<code>
CLIENT NO-TOUCH
</code>
</a>
to return an error if the Redis database version is earlier than 7.2.0 or the command is restricted by ACL rules (handles
<code>
CLIENT NO-TOUCH
</code>
<a href="https://docs.redis.com/latest/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-52/#command-limitations">
command limitations
</a>
).
</p>
</li>
<li>
<p>
RS105137 - Fixed audit reconnect issue: sometimes the proxy failed to reconnect to a restarted audit listener.
</p>
</li>
<li>
<p>
RS108394 - Added API validation to prevent configuring Replica Of with TLS without providing a server certificate.
</p>
</li>
<li>
<p>
RS108233 - Proceed with the upgrade even if an empty
<code>
saslauthd
</code>
configuration exists.
</p>
</li>
<li>
<p>
RS107730 - Fixed a bug where the
<code>
failed_authentication_attempt
</code>
event log always contained 127.0.0.1 instead of the real client IP address.
</p>
</li>
<li>
<p>
RS107727 - Fixed permission issue for
<code>
/etc/cron.d/redislabs
</code>
file in Red Hat.
</p>
</li>
<li>
<p>
RS108230 - Removed unused test certificate and key files from the
<code>
redis-enterprise
</code>
package.
</p>
</li>
<li>
<p>
RS107718 - When
<code>
cm_server
</code>
is disabled through
<code>
optional_services
</code>
, envoy (the cluster’s reverse proxy) now stops listening on the
<code>
cm_server
</code>
port.
</p>
</li>
<li>
<p>
RS107909 - Added
<code>
os_family
</code>
, which groups operating systems into categories, to node properties and upgrade logic. Fixed the
<a href="/docs/latest/operate/rs/release-notes/rs-7-2-4-releases/#modules-cannot-load-in-oracle-linux-7--8">
known limitation
</a>
for upgrades and module uploads for the following operating systems: Rocky Linux, Oracle Linux 7, Oracle Linux 8, CentOS 7, and CentOS 8.
</p>
</li>
</ul>
<h2 id="version-changes">
Version changes
</h2>
<h3 id="supported-platforms">
Supported platforms
</h3>
<p>
The following table provides a snapshot of supported platforms as of this Redis Enterprise Software release. See the
<a href="/docs/latest/operate/rs/references/supported-platforms/">
supported platforms reference
</a>
for more details about operating system compatibility.
</p>
<p>
<span title="Check mark icon">
✅
</span>
Supported – The platform is supported for this version of Redis Enterprise Software.
</p>
<p>
<span title="Warning icon">
⚠️
</span>
Deprecated – The platform is still supported for this version of Redis Enterprise Software, but support will be removed in a future release.
</p>
<p>
<span title="X icon">
❌
</span>
End of life – Platform support ended in this version of Redis Enterprise Software.
</p>
<table>
<thead>
<tr>
<th>
Redis Enterprise
</th>
<th>
7.2.4
</th>
<th>
6.4.2
</th>
<th>
6.2.18
</th>
<th>
6.2.12
</th>
<th>
6.2.10
</th>
<th>
6.2.8
</th>
<th>
6.2.4
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
Ubuntu
</strong>
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
20.04
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
<sup>
<a href="#table-note-6">
6
</a>
</sup>
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
</tr>
<tr>
<td>
18.04
</td>
<td>
<span title="Deprecated">
⚠️
</span>
</td>
<td>
<span title="Supported">
<span title="Supported">
✅
</span>
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
16.04
</td>
<td>
<span title="End of life">
❌
</span>
</td>
<td>
<span title="Deprecated">
⚠️
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
<strong>
RHEL & CentOS
</strong>
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
8.8
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
</tr>
<tr>
<td>
8.7
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
</tr>
<tr>
<td>
8.5-8.6
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
–
</td>
<td>
–
</td>
</tr>
<tr>
<td>
8.0-8.4
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
–
</td>
</tr>
<tr>
<td>
7.0-7.9
</td>
<td>
<span title="Deprecated">
⚠️
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
<strong>
Oracle Linux
</strong>
<sup>
<a href="#table-note-3">
3
</a>
</sup>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
8
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
–
</td>
<td>
–
</td>
</tr>
<tr>
<td>
7
</td>
<td>
<span title="Deprecated">
⚠️
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
<strong>
Rocky Linux
</strong>
<sup>
<a href="#table-note-3">
3
</a>
</sup>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
8
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
</tr>
<tr>
<td>
<strong>
Amazon Linux
</strong>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
2
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
<sup>
<a href="#table-note-7">
7
</a>
</sup>
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
<td>
–
</td>
</tr>
<tr>
<td>
1
</td>
<td>
<span title="Deprecated">
⚠️
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
<strong>
Docker
</strong>
<sup>
<a href="#table-note-4">
4
</a>
</sup>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
<strong>
Kubernetes
</strong>
<sup>
<a href="#table-note-5">
5
</a>
</sup>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
<td>
<span title="Supported">
✅
</span>
</td>
</tr>
</tbody>
</table>
<ol>
<li>
<p>
<a name="table-note-1" style="display: block; height: 80px; margin-top: -80px;">
</a>
The server version of Ubuntu is recommended for production installations. The desktop version is only recommended for development deployments.
</p>
</li>
<li>
<p>
<a name="table-note-2" style="display: block; height: 80px; margin-top: -80px;">
</a>
RHEL and CentOS deployments require OpenSSL 1.0.2 and
<a href="/docs/latest/operate/rs/installing-upgrading/configuring/centos-rhel-firewall/">
firewall configuration
</a>
.
</p>
</li>
<li>
<p>
<a name="table-note-3" style="display: block; height: 80px; margin-top: -80px;">
</a>
Based on the corresponding RHEL version.
</p>
</li>
<li>
<p>
<a name="table-note-4" style="display: block; height: 80px; margin-top: -80px;">
</a>
<a href="/docs/latest/operate/rs/installing-upgrading/quickstarts/docker-quickstart/">
Docker images
</a>
of Redis Enterprise Software are certified for development and testing only.
</p>
</li>
<li>
<p>
<a name="table-note-5" style="display: block; height: 80px; margin-top: -80px;">
</a>
See the
<a href="/docs/latest/operate/kubernetes/">
Redis Enterprise for Kubernetes documentation
</a>
.
</p>
</li>
<li>
<p>
<a name="table-note-6" style="display: block; height: 80px; margin-top: -80px;">
</a>
Ubuntu 20.04 support was added in Redis Enterprise Software
<a href="/docs/latest/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-43/">
6.4.2-43
</a>
.
</p>
</li>
<li>
<p>
<a name="table-note-7" style="display: block; height: 80px; margin-top: -80px;">
</a>
A release candidate for Amazon Linux 2 support was added in Redis Enterprise Software
<a href="/docs/latest/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-61/">
6.4.2-61
</a>
. Official support for Amazon Linux 2 was added in Redis Enterprise Software
<a href="/docs/latest/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-69/">
6.4.2-69
</a>
.
</p>
</li>
</ol>
<h2 id="downloads">
Downloads
</h2>
<p>
The following table shows the MD5 checksums for the available packages:
</p>
<table>
<thead>
<tr>
<th>
Package
</th>
<th>
MD5 checksum (7.2.4-64 September release)
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Ubuntu 18
</td>
<td>
eed1a8ba22a9eb2ae6e23d557961e9a7
</td>
</tr>
<tr>
<td>
Ubuntu 20
</td>
<td>
49b29512123fcd9dd402b53b380e8c78
</td>
</tr>
<tr>
<td>
RedHat Enterprise Linux (RHEL) 7
<br/>
Oracle Enterprise Linux (OL) 7
</td>
<td>
d90a75b56fe1bc628d2ac27bc137af41
</td>
</tr>
<tr>
<td>
RedHat Enterprise Linux (RHEL) 8
<br/>
Oracle Enterprise Linux (OL) 8
<br/>
Rocky Enterprise Linux
</td>
<td>
d9d98b0859b2d6fe8a7802cb6f44f132
</td>
</tr>
<tr>
<td>
Amazon Linux 2
</td>
<td>
b9f1c99b39bb8084583b10d1546f80e1
</td>
</tr>
</tbody>
</table>
<h2 id="security">
Security
</h2>
<h4 id="open-source-redis-security-fixes-compatibility">
Open source Redis security fixes compatibility
</h4>
<p>
As part of Redis's commitment to security, Redis Enterprise Software implements the latest
<a href="https://github.com/redis/redis/releases">
security fixes
</a>
available with
<a href="https://github.com/redis/redis">
open source Redis
</a>
. Redis Enterprise has already included the fixes for the relevant CVEs.
</p>
<p>
Some CVEs announced for open source Redis do not affect Redis Enterprise due to different or additional functionality available in Redis Enterprise that is not available in open source Redis.
</p>
<p>
Redis Enterprise 7.2.4-64 supports open source Redis 7.2, 6.2, and 6.0. Below is the list of open source Redis CVEs fixed by version.
</p>
<p>
Redis 7.2.x:
</p>
<ul>
<li>
<p>
(CVE-2023-41056) In some cases, Redis may incorrectly handle resizing of memory buffers, which can result in incorrect accounting of buffer sizes and lead to heap overflow and potential remote code execution.
</p>
</li>
<li>
<p>
(CVE-2023-41053) Redis does not correctly identify keys accessed by
<code>
SORT_RO
</code>
and, as a result, may grant users executing this command access to keys that are not explicitly authorized by the ACL configuration. (Redis 7.2.1)
</p>
</li>
</ul>
<p>
Redis 7.0.x:
</p>
<ul>
<li>
<p>
(CVE-2023-41056) In some cases, Redis may incorrectly handle resizing of memory buffers, which can result in incorrect accounting of buffer sizes and lead to heap overflow and potential remote code execution.
</p>
</li>
<li>
<p>
(CVE-2023-41053) Redis does not correctly identify keys accessed by
<code>
SORT_RO
</code>
and, as a result, may grant users executing this command access to keys that are not explicitly authorized by the ACL configuration. (Redis 7.0.13)
</p>
</li>
<li>
<p>
(CVE-2023-36824) Extracting key names from a command and a list of arguments may, in some cases, trigger a heap overflow and result in reading random heap memory, heap corruption, and potentially remote code execution. Specifically: using
<code>
COMMAND GETKEYS*
</code>
and validation of key names in ACL rules. (Redis 7.0.12)
</p>
</li>
<li>
<p>
(CVE-2023-28856) Authenticated users can use the
<code>
HINCRBYFLOAT
</code>
command to create an invalid hash field that will crash Redis on access. (Redis 7.0.11)
</p>
</li>
<li>
<p>
(CVE-2023-28425) Specially crafted
<code>
MSETNX
</code>
command can lead to assertion and denial-of-service. (Redis 7.0.10)
</p>
</li>
<li>
<p>
(CVE-2023-25155) Specially crafted
<code>
SRANDMEMBER
</code>
,
<code>
ZRANDMEMBER
</code>
, and
<code>
HRANDFIELD
</code>
commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 7.0.9)
</p>
</li>
<li>
<p>
(CVE-2023-22458) Integer overflow in the Redis
<code>
HRANDFIELD
</code>
and
<code>
ZRANDMEMBER
</code>
commands can lead to denial-of-service. (Redis 7.0.8)
</p>
</li>
<li>
<p>
(CVE-2022-36021) String matching commands (like
<code>
SCAN
</code>
or
<code>
KEYS
</code>
) with a specially crafted pattern to trigger a denial-of-service attack on Redis, causing it to hang and consume 100% CPU time. (Redis 7.0.9)
</p>
</li>
<li>
<p>
(CVE-2022-35977) Integer overflow in the Redis
<code>
SETRANGE
</code>
and
<code>
SORT
</code>
/
<code>
SORT_RO
</code>
commands can drive Redis to OOM panic. (Redis 7.0.8)
</p>
</li>
<li>
<p>
(CVE-2022-35951) Executing an
<code>
XAUTOCLAIM
</code>
command on a stream key in a specific state, with a specially crafted
<code>
COUNT
</code>
argument, may cause an integer overflow, a subsequent heap overflow, and potentially lead to remote code execution. The problem affects Redis versions 7.0.0 or newer. (Redis 7.0.5)
</p>
</li>
<li>
<p>
(CVE-2022-31144) A specially crafted
<code>
XAUTOCLAIM
</code>
command on a stream key in a specific state may result in heap overflow and potentially remote code execution. The problem affects Redis versions 7.0.0 or newer. (Redis 7.0.4)
</p>
</li>
<li>
<p>
(CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 7.0.12)
</p>
</li>
<li>
<p>
(CVE-2022-24736) An attacker attempting to load a specially crafted Lua script can cause NULL pointer dereference which will result in a crash of the
<code>
redis-server
</code>
process. This issue affects all versions of Redis. (Redis 7.0.0)
</p>
</li>
<li>
<p>
(CVE-2022-24735) By exploiting weaknesses in the Lua script execution environment, an attacker with access to Redis can inject Lua code that will execute with the (potentially higher) privileges of another Redis user. (Redis 7.0.0)
</p>
</li>
</ul>
<p>
Redis 6.2.x:
</p>
<ul>
<li>
<p>
(CVE-2023-28856) Authenticated users can use the
<code>
HINCRBYFLOAT
</code>
command to create an invalid hash field that will crash Redis on access. (Redis 6.2.12)
</p>
</li>
<li>
<p>
(CVE-2023-25155) Specially crafted
<code>
SRANDMEMBER
</code>
,
<code>
ZRANDMEMBER
</code>
, and
<code>
HRANDFIELD
</code>
commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 6.2.11)
</p>
</li>
<li>
<p>
(CVE-2023-22458) Integer overflow in the Redis
<code>
HRANDFIELD
</code>
and
<code>
ZRANDMEMBER
</code>
commands can lead to denial-of-service. (Redis 6.2.9)
</p>
</li>
<li>
<p>
(CVE-2022-36021) String matching commands (like
<code>
SCAN
</code>
or
<code>
KEYS
</code>
) with a specially crafted pattern to trigger a denial-of-service attack on Redis, causing it to hang and consume 100% CPU time. (Redis 6.2.11)
</p>
</li>
<li>
<p>
(CVE-2022-35977) Integer overflow in the Redis
<code>
SETRANGE
</code>
and
<code>
SORT
</code>
/
<code>
SORT_RO
</code>
commands can drive Redis to OOM panic. (Redis 6.2.9)
</p>
</li>
<li>
<p>
(CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 6.2.13)
</p>
</li>
<li>
<p>
(CVE-2022-24736) An attacker attempting to load a specially crafted Lua script can cause NULL pointer dereference which will result in a crash of the
<code>
redis-server
</code>
process. This issue affects all versions of Redis. (Redis 6.2.7)
</p>
</li>
<li>
<p>
(CVE-2022-24735) By exploiting weaknesses in the Lua script execution environment, an attacker with access to Redis can inject Lua code that will execute with the (potentially higher) privileges of another Redis user. (Redis 6.2.7)
</p>
</li>
<li>
<p>
(CVE-2021-41099) Integer to heap buffer overflow handling certain string commands and network payloads, when
<code>
proto-max-bulk-len
</code>
is manually configured to a non-default, very large value. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32762) Integer to heap buffer overflow issue in
<code>
redis-cli
</code>
and
<code>
redis-sentinel
</code>
parsing large multi-bulk replies on some older and less common platforms. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32761) An integer overflow bug in Redis version 2.2 or newer can be exploited using the
<code>
BITFIELD
</code>
command to corrupt the heap and potentially result with remote code execution. (Redis 6.2.5)
</p>
</li>
<li>
<p>
(CVE-2021-32687) Integer to heap buffer overflow with intsets, when
<code>
set-max-intset-entries
</code>
is manually configured to a non-default, very large value. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32675) Denial Of Service when processing RESP request payloads with a large number of elements on many connections. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32672) Random heap reading issue with Lua Debugger. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32628) Integer to heap buffer overflow handling ziplist-encoded data types, when configuring a large, non-default value for
<code>
hash-max-ziplist-entries
</code>
,
<code>
hash-max-ziplist-value
</code>
,
<code>
zset-max-ziplist-entries
</code>
or
<code>
zset-max-ziplist-value
</code>
. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32627) Integer to heap buffer overflow issue with streams, when configuring a non-default, large value for
<code>
proto-max-bulk-len
</code>
and
<code>
client-query-buffer-limit
</code>
. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32626) Specially crafted Lua scripts may result with Heap buffer overflow. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32625) An integer overflow bug in Redis version 6.0 or newer can be exploited using the STRALGO LCS command to corrupt the heap and potentially result with remote code execution. This is a result of an incomplete fix by CVE-2021-29477. (Redis 6.2.4)
</p>
</li>
<li>
<p>
(CVE-2021-29478) An integer overflow bug in Redis 6.2 could be exploited to corrupt the heap and potentially result with remote code execution. The vulnerability involves changing the default set-max-intset-entries configuration value, creating a large set key that consists of integer values and using the COPY command to duplicate it. The integer overflow bug exists in all versions of Redis starting with 2.6, where it could result with a corrupted RDB or DUMP payload, but not exploited through COPY (which did not exist before 6.2). (Redis 6.2.3)
</p>
</li>
<li>
<p>
(CVE-2021-29477) An integer overflow bug in Redis version 6.0 or newer could be exploited using the STRALGO LCS command to corrupt the heap and potentially result in remote code execution. The integer overflow bug exists in all versions of Redis starting with 6.0. (Redis 6.2.3)
</p>
</li>
</ul>
<p>
Redis 6.0.x:
</p>
<ul>
<li>
<p>
(CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 6.0.20)
</p>
</li>
<li>
<p>
(CVE-2023-28856) Authenticated users can use the
<code>
HINCRBYFLOAT
</code>
command to create an invalid hash field that will crash Redis on access. (Redis 6.0.19)
</p>
</li>
<li>
<p>
(CVE-2023-25155) Specially crafted
<code>
SRANDMEMBER
</code>
,
<code>
ZRANDMEMBER
</code>
, and
<code>
HRANDFIELD
</code>
commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 6.0.18)
</p>
</li>
<li>
<p>
(CVE-2022-36021) String matching commands (like
<code>
SCAN
</code>
or
<code>
KEYS
</code>
) with a specially crafted pattern to trigger a denial-of-service attack on Redis, causing it to hang and consume 100% CPU time. (Redis 6.0.18)
</p>
</li>
<li>
<p>
(CVE-2022-35977) Integer overflow in the Redis
<code>
SETRANGE
</code>
and
<code>
SORT
</code>
/
<code>
SORT_RO
</code>
commands can drive Redis to OOM panic. (Redis 6.0.17)
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-64/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/clients/nodejs/connect/.html | <section class="prose w-full py-12">
<h1>
Connect to the server
</h1>
<p class="text-lg -mt-5 mb-10">
Connect your Node.js application to a Redis database
</p>
<h2 id="basic-connection">
Basic connection
</h2>
<p>
Connect to localhost on port 6379.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">err</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span></code></pre>
</div>
<p>
Store and retrieve a simple string.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="s1">'key'</span><span class="p">,</span> <span class="s1">'value'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">value</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s1">'key'</span><span class="p">);</span>
</span></span></code></pre>
</div>
<p>
Store and retrieve a map.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">hSet</span><span class="p">(</span><span class="s1">'user-session:123'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">name</span><span class="o">:</span> <span class="s1">'John'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">surname</span><span class="o">:</span> <span class="s1">'Smith'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">company</span><span class="o">:</span> <span class="s1">'Redis'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">age</span><span class="o">:</span> <span class="mi">29</span>
</span></span><span class="line"><span class="cl"><span class="p">})</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">userSession</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">hGetAll</span><span class="p">(</span><span class="s1">'user-session:123'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">userSession</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "surname": "Smith",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "name": "John",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "company": "Redis",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "age": "29"
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm"> */</span>
</span></span></code></pre>
</div>
<p>
To connect to a different host or port, use a connection string in the format
<code>
redis[s]://[[username][:password]@][host][:port][/db-number]
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="nx">createClient</span><span class="p">({</span>
</span></span><span class="line"><span class="cl"> <span class="nx">url</span><span class="o">:</span> <span class="s1">'redis://alice:[email protected]:6380'</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span></code></pre>
</div>
<p>
To check if the client is connected and ready to send commands, use
<code>
client.isReady
</code>
, which returns a Boolean.
<code>
client.isOpen
</code>
is also available. This returns
<code>
true
</code>
when the client's underlying socket is open, and
<code>
false
</code>
when it isn't (for example, when the client is still connecting or reconnecting after a network error).
</p>
<h3 id="connect-to-a-redis-cluster">
Connect to a Redis cluster
</h3>
<p>
To connect to a Redis cluster, use
<code>
createCluster
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createCluster</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">cluster</span> <span class="o">=</span> <span class="nx">createCluster</span><span class="p">({</span>
</span></span><span class="line"><span class="cl"> <span class="nx">rootNodes</span><span class="o">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">url</span><span class="o">:</span> <span class="s1">'redis://127.0.0.1:16379'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">url</span><span class="o">:</span> <span class="s1">'redis://127.0.0.1:16380'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// ...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">cluster</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Cluster Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">cluster</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">cluster</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">,</span> <span class="s1">'bar'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">value</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">cluster</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">value</span><span class="p">);</span> <span class="c1">// returns 'bar'
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">cluster</span><span class="p">.</span><span class="nx">quit</span><span class="p">();</span>
</span></span></code></pre>
</div>
<h3 id="connect-to-your-production-redis-with-tls">
Connect to your production Redis with TLS
</h3>
<p>
When you deploy your application, use TLS and follow the
<a href="/docs/latest/operate/oss_and_stack/management/security/">
Redis security
</a>
guidelines.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">({</span>
</span></span><span class="line"><span class="cl"> <span class="nx">username</span><span class="o">:</span> <span class="s1">'default'</span><span class="p">,</span> <span class="c1">// use your Redis user. More info https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">password</span><span class="o">:</span> <span class="s1">'secret'</span><span class="p">,</span> <span class="c1">// use your password here
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">socket</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">host</span><span class="o">:</span> <span class="s1">'my-redis.cloud.redislabs.com'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">port</span><span class="o">:</span> <span class="mi">6379</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">tls</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">key</span><span class="o">:</span> <span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'./redis_user_private.key'</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="nx">cert</span><span class="o">:</span> <span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'./redis_user.crt'</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ca</span><span class="o">:</span> <span class="p">[</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'./redis_ca.pem'</span><span class="p">)]</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">,</span> <span class="s1">'bar'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">value</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">value</span><span class="p">)</span> <span class="c1">// returns 'bar'
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">disconnect</span><span class="p">();</span>
</span></span></code></pre>
</div>
<p>
You can also use discrete parameters and UNIX sockets. Details can be found in the
<a href="https://github.com/redis/node-redis/blob/master/docs/client-configuration.md">
client configuration guide
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/clients/nodejs/connect/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/cli-utilities/crdb-cli/task/cancel/.html | <section class="prose w-full py-12 max-w-none">
<h1>
crdb-cli task cancel
</h1>
<p class="text-lg -mt-5 mb-10">
Attempts to cancel a specified Active-Active database task.
</p>
<p>
Cancels the Active-Active database task specified by the task ID.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">crdb-cli task cancel <task_id>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
task-id <task_id>
</td>
<td>
string
</td>
<td>
An Active-Active database task ID (required)
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Attempts to cancel an Active-Active database task.
</p>
<p>
Be aware that tasks may complete before they can be cancelled.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ crdb-cli task cancel --task-id 2901c2a3-2828-4717-80c0-6f27f1dd2d7c
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/cli-utilities/crdb-cli/task/cancel/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/accounts/account-settings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Manage account settings
</h1>
<p class="text-lg -mt-5 mb-10">
Describes the settings for a Redis Cloud account.
</p>
<p>
To review or manage the settings associated with your Redis Cloud account, sign in to the
<a href="https://cloud.redis.io/">
Redis Cloud console
</a>
and then select
<strong>
Account Settings
</strong>
from the menu.
</p>
<p>
This displays the
<strong>
Account Settings
</strong>
screen:
</p>
<a href="/docs/latest/images/rc/account-settings-account-tab.png" sdata-lightbox="/images/rc/account-settings-account-tab.png">
<img alt="Use the Account tab of the Account Settings screen to review and update settings associated with your Redis Cloud account." src="/docs/latest/images/rc/account-settings-account-tab.png" width="75%"/>
</a>
<p>
The available tabs depend on your subscription type and may include:
</p>
<ul>
<li>
<p>
The
<strong>
Account
</strong>
tab displays basic information associated with your account, including general info, address details, time zone setting, security settings, and provider integration details.
</p>
</li>
<li>
<p>
The
<strong>
Cloud Account
</strong>
tab is displayed for Redis Cloud Pro subscriptions hosted on Amazon Web Services (AWS). To learn more, see
<a href="/docs/latest/operate/rc/cloud-integrations/aws-cloud-accounts/">
Manage AWS cloud accounts
</a>
.
</p>
</li>
<li>
<p>
The
<strong>
Integrations
</strong>
tab lets you manage certain integrations. For more information on the Confluent Cloud integration, see
<a href="/docs/latest/integrate/confluent-with-redis-cloud/">
Use the Redis Sink Confluent Connector
</a>
.
</p>
</li>
</ul>
<h2 id="account-info-settings">
Account info settings
</h2>
<p>
The
<strong>
Account Info
</strong>
section provides basic details about your account, including:
</p>
<table>
<thead>
<tr>
<th>
Setting
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
Account name
</em>
</td>
<td>
Organization associated with the Redis Cloud account
</td>
</tr>
<tr>
<td>
<em>
Account number
</em>
</td>
<td>
Internal ID of the owner's account
</td>
</tr>
<tr>
<td>
<em>
Date created
</em>
</td>
<td>
Date the user's Redis Cloud account was created, which may differ from the organization account creation date
</td>
</tr>
<tr>
<td>
<em>
Last updated
</em>
</td>
<td>
Date of the last administrative change to the owner's account, typically reflects access changes or other administrative updates
</td>
</tr>
</tbody>
</table>
<p>
You cannot change the email address associated with a Redis Cloud account. Instead, create a new account with the updated email address, assign it as an administrator to the organization account, and then use the new account to delete the account with the invalid email address.
</p>
<h2 id="account-address-settings">
Account address settings
</h2>
<p>
The
<strong>
Account address
</strong>
section shows the billing address associated with the current Redis Cloud account and the current time zone.
</p>
<p>
In addition, this section may include fields unique to your location. For example, certain regions require tax IDs or other regulatory details.
</p>
<p>
Select
<strong>
Edit
</strong>
to change the account's billing address. You must re-enter your payment method details to confirm your address change.
</p>
<a href="/docs/latest/images/rc/account-settings-edit-address-button.png" sdata-lightbox="/images/rc/account-settings-edit-address-button.png">
<img alt="Select the Edit button to change the account's billing address." src="/docs/latest/images/rc/account-settings-edit-address-button.png" width="400px"/>
</a>
<a href="/docs/latest/images/rc/account-settings-change-billing-address.png" sdata-lightbox="/images/rc/account-settings-change-billing-address.png">
<img alt="The Edit account billing address screen." src="/docs/latest/images/rc/account-settings-change-billing-address.png" width="75%"/>
</a>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Changing the billing address for your account will remove any payment methods associated with the old billing address. See
<a href="/docs/latest/operate/rc/billing-and-payments/#add-payment-method">
Add payment method
</a>
to learn how to add a payment method back to your account.
</div>
</div>
<h2 id="time-zone-settings">
Time zone settings
</h2>
<p>
To update the time zone, select the desired time zone from the
<strong>
Time zone
</strong>
drop-down.
</p>
<h2 id="security-settings">
Security settings
</h2>
<p>
The
<strong>
Security
</strong>
section lets you:
</p>
<ul>
<li>
<p>
Manage
<a href="/docs/latest/operate/rc/security/access-control/multi-factor-authentication/">
multi-factor authentication
</a>
(MFA) for your Redis Cloud account.
</p>
</li>
<li>
<p>
Download the
<a href="/docs/latest/operate/rc/security/database-security/tls-ssl/#download-certificates">
Redis Cloud certificate authority (CA) bundle
</a>
as a
<a href="https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail">
PEM
</a>
file, which contains the certificates associated with your Redis Cloud account.
</p>
</li>
</ul>
<h2 id="integration-settings">
Integration settings
</h2>
<p>
The
<strong>
Integration
</strong>
section includes settings that help you manage the integration of your Redis Cloud account with your underlying cloud provider. Specific settings vary according to the cloud provider.
</p>
<p>
If this section doesn't appear on the
<strong>
Account Settings
</strong>
screen, it generally means that there aren't any integration settings to manage.
</p>
<h2 id="save-or-discard-changes">
Save or discard changes
</h2>
<p>
Few account settings can be changed; however, you can update a few details, such as
<strong>
Time Zone
</strong>
and
<strong>
MFA enforcement
</strong>
. Available settings vary according to your subscription and the underlying cloud provider.
</p>
<p>
Use the
<strong>
Save changes
</strong>
button to save changes or
<strong>
Discard changes
</strong>
to revert them.
</p>
<a href="/docs/latest/images/rc/account-settings-buttons-save-discard.png" sdata-lightbox="/images/rc/account-settings-buttons-save-discard.png">
<img alt="Use the Discard Changes and the Save Changes buttons to manage changes to account settings." src="/docs/latest/images/rc/account-settings-buttons-save-discard.png" width="300px"/>
</a>
<p>
For help changing other settings,
<a href="https://redis.io/support/">
contact Support
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/accounts/account-settings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/script-kill/.html | <section class="prose w-full py-12">
<h1 class="command-name">
SCRIPT KILL
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">SCRIPT KILL</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.6.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@scripting
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Kills the currently executing
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
script, assuming no write operation was yet
performed by the script.
</p>
<p>
This command is mainly useful to kill a script that is running for too much
time(for instance, because it entered an infinite loop because of a bug).
The script will be killed, and the client currently blocked into EVAL will see
the command returning with an error.
</p>
<p>
If the script has already performed write operations, it can not be killed in this
way because it would violate Lua's script atomicity contract.
In such a case, only
<code>
SHUTDOWN NOSAVE
</code>
can kill the script, killing
the Redis process in a hard way and preventing it from persisting with half-written
information.
</p>
<p>
For more information about
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
scripts please refer to
<a href="/docs/latest/develop/interact/programmability/eval-intro/">
Introduction to Eval Scripts
</a>
.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/script-kill/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/ldap_mappings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
LDAP mappings requests
</h1>
<p class="text-lg -mt-5 mb-10">
LDAP mappings requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-ldap_mappings">
GET
</a>
</td>
<td>
<code>
/v1/ldap_mappings
</code>
</td>
<td>
Get all LDAP mappings
</td>
</tr>
<tr>
<td>
<a href="#get-ldap_mapping">
GET
</a>
</td>
<td>
<code>
/v1/ldap_mappings/{uid}
</code>
</td>
<td>
Get a single LDAP mapping
</td>
</tr>
<tr>
<td>
<a href="#put-ldap_mapping">
PUT
</a>
</td>
<td>
<code>
/v1/ldap_mappings/{uid}
</code>
</td>
<td>
Update an LDAP mapping
</td>
</tr>
<tr>
<td>
<a href="#post-ldap_mappings">
POST
</a>
</td>
<td>
<code>
/v1/ldap_mappings
</code>
</td>
<td>
Create a new LDAP mapping
</td>
</tr>
<tr>
<td>
<a href="#delete-ldap_mappings">
DELETE
</a>
</td>
<td>
<code>
/v1/ldap_mappings/{uid}
</code>
</td>
<td>
Delete an LDAP mapping
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-ldap_mappings">
Get all LDAP mappings
</h2>
<pre><code>GET /v1/ldap_mappings
</code></pre>
<p>
Get all LDAP mappings.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_all_ldap_mappings_info">
view_all_ldap_mappings_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /ldap_mappings
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns a JSON array of
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ldap_mapping/">
LDAP mapping objects
</a>
.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span></code></pre>
</div>
<h3 id="get-all-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
</tbody>
</table>
<h2 id="get-ldap_mapping">
Get LDAP mapping
</h2>
<pre><code>GET /v1/ldap_mappings/{int: uid}
</code></pre>
<p>
Get a specific LDAP mapping.
</p>
<h4 id="required-permissions-1">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_ldap_mapping_info">
view_ldap_mapping_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>GET /ldap_mappings/1
</code></pre>
<h4 id="request-headers-1">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The object's unique ID.
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns an
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ldap_mapping/">
LDAP mapping object
</a>
.
</p>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
ldap_mapping_not_exist
</td>
<td>
An object does not exist
</td>
</tr>
</tbody>
</table>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4">
403 Forbidden
</a>
</td>
<td>
Operation is forbidden.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
ldap_mapping does not exist.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mappings yet.
</td>
</tr>
</tbody>
</table>
<h2 id="put-ldap_mapping">
Update LDAP mapping
</h2>
<pre><code>PUT /v1/ldap_mappings/{int: uid}
</code></pre>
<p>
Update an existing ldap_mapping object.
</p>
<h4 id="required-permissions-2">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#update_ldap_mapping">
update_ldap_mapping
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="put-request">
Request
</h3>
<h4 id="example-http-request-2">
Example HTTP request
</h4>
<pre><code>PUT /ldap_mappings/17
</code></pre>
<h4 id="example-json-body-2">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="request-headers-2">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="request-body">
Request body
</h4>
<p>
Include an
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ldap_mapping/">
LDAP mapping object
</a>
with updated fields in the request body.
</p>
<h3 id="put-response">
Response
</h3>
<h4 id="example-json-body-3">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="put-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
name_already_exists
</td>
<td>
An object of the same type and name exists
</td>
</tr>
<tr>
<td>
ldap_mapping_not_exist
</td>
<td>
An object does not exist
</td>
</tr>
<tr>
<td>
invalid_dn_param
</td>
<td>
A dn parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_name_param
</td>
<td>
A name parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_role_uids_param
</td>
<td>
A role_uids parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_account_id_param
</td>
<td>
An account_id parameter has an illegal value
</td>
</tr>
</tbody>
</table>
<h3 id="put-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success, LDAP mapping is created.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">
400 Bad Request
</a>
</td>
<td>
Bad or missing configuration parameters.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Attempting to change a non-existing LDAP mapping.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mapping yet.
</td>
</tr>
</tbody>
</table>
<h2 id="post-ldap_mappings">
Create LDAP mapping
</h2>
<pre><code>POST /v1/ldap_mappings
</code></pre>
<p>
Create a new LDAP mapping.
</p>
<h4 id="required-permissions-3">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#create_ldap_mapping">
create_ldap_mapping
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="post-request">
Request
</h3>
<h4 id="example-http-request-3">
Example HTTP request
</h4>
<pre><code>POST /ldap_mappings
</code></pre>
<h4 id="example-json-body-4">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="request-headers-3">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="request-body-1">
Request body
</h4>
<p>
Include an
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/ldap_mapping/">
LDAP mapping object
</a>
in the request body.
</p>
<h3 id="post-response">
Response
</h3>
<h4 id="example-json-body-5">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="post-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
name_already_exists
</td>
<td>
An object of the same type and name exists
</td>
</tr>
<tr>
<td>
missing_field
</td>
<td>
A needed field is missing
</td>
</tr>
<tr>
<td>
invalid_dn_param
</td>
<td>
A dn parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_name_param
</td>
<td>
A name parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_role_uids_param
</td>
<td>
A role_uids parameter has an illegal value
</td>
</tr>
</tbody>
</table>
<h3 id="post-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success, an LDAP-mapping object is created.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">
400 Bad Request
</a>
</td>
<td>
Bad or missing configuration parameters.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mappings yet.
</td>
</tr>
</tbody>
</table>
<h2 id="delete-ldap_mappings">
Delete LDAP mapping
</h2>
<pre><code>DELETE /v1/ldap_mappings/{int: uid}
</code></pre>
<p>
Delete an LDAP mapping object.
</p>
<h4 id="required-permissions-4">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#delete_ldap_mapping">
delete_ldap_mapping
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="delete-request">
Request
</h3>
<h4 id="example-http-request-4">
Example HTTP request
</h4>
<pre><code>DELETE /ldap_mappings/1
</code></pre>
<h4 id="request-headers-4">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters-1">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The ldap_mapping unique ID.
</td>
</tr>
</tbody>
</table>
<h3 id="delete-response">
Response
</h3>
<p>
Returns a status code. If an error occurs, the response body may include a more specific error code and message.
</p>
<h3 id="delete-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
ldap_mapping_not_exist
</td>
<td>
An object does not exist
</td>
</tr>
</tbody>
</table>
<h3 id="delete-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success, the ldap_mapping is deleted.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">
406 Not Acceptable
</a>
</td>
<td>
The request is not acceptable.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mappings yet.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/ldap_mappings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/metrics/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Real-time metrics
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the metrics that are tracked with Redis Enterprise Software.
</p>
<p>
In the Redis Enterprise Cluster Manager UI, you can see real-time performance metrics for clusters, nodes, databases, and shards, and configure alerts that send notifications based on alert parameters. Select the
<strong>
Metrics
</strong>
tab to view the metrics for each component. For more information, see
<a href="/docs/latest/operate/rs/clusters/monitoring/">
Monitoring with metrics and alerts
</a>
.
</p>
<p>
See the following topics for metrics definitions:
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/references/metrics/database-operations/">
Database operations
</a>
for database metrics
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/resource-usage/">
Resource usage
</a>
for resource and database usage metrics
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/auto-tiering/">
Auto Tiering
</a>
for additional metrics for
<a href="/docs/latest/operate/rs/databases/auto-tiering/">
Auto Tiering
</a>
databases
</li>
</ul>
<h2 id="prometheus-metrics">
Prometheus metrics
</h2>
<p>
To collect and display metrics data from your databases and other cluster components,
you can connect your
<a href="https://prometheus.io/">
Prometheus
</a>
and
<a href="https://grafana.com/">
Grafana
</a>
server to your Redis Enterprise Software cluster. See
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions/">
Metrics in Prometheus
</a>
for a list of available metrics.
</p>
<p>
We recommend you use Prometheus and Grafana to view metrics history and trends.
</p>
<p>
See
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/">
Prometheus integration
</a>
to learn how to connect Prometheus and Grafana to your Redis Enterprise database.
</p>
<h2 id="limitations">
Limitations
</h2>
<h3 id="shard-limit">
Shard limit
</h3>
<p>
Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/">
Prometheus and Grafana
</a>
to view metrics.
</p>
<h3 id="metrics-not-shown-during-shard-migration">
Metrics not shown during shard migration
</h3>
<p>
The following metrics are not measured during
<a href="/docs/latest/operate/rs/databases/configure/replica-ha/">
shard migration
</a>
. If you view these metrics while resharding, the graph will be blank.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/references/metrics/database-operations/#evicted-objectssec">
Evicted objects/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/database-operations/#expired-objectssec">
Expired objects/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/database-operations/#read-missessec">
Read misses/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/database-operations/#write-missessec">
Write misses/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/database-operations/#total-keys">
Total keys
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/resource-usage/#incoming-traffic">
Incoming traffic
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/resource-usage/#outgoing-traffic">
Outgoing traffic
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/references/metrics/resource-usage/#used-memory">
Used memory
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/metrics/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.search/.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.SEARCH
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.SEARCH index query
[NOCONTENT]
[VERBATIM] [NOSTOPWORDS]
[WITHSCORES]
[WITHPAYLOADS]
[WITHSORTKEYS]
[FILTER numeric_field min max [ FILTER numeric_field min max ...]]
[GEOFILTER geo_field lon lat radius m | km | mi | ft [ GEOFILTER geo_field lon lat radius m | km | mi | ft ...]]
[INKEYS count key [key ...]] [ INFIELDS count field [field ...]]
[RETURN count identifier [AS property] [ identifier [AS property] ...]]
[SUMMARIZE [ FIELDS count field [field ...]] [FRAGS num] [LEN fragsize] [SEPARATOR separator]]
[HIGHLIGHT [ FIELDS count field [field ...]] [ TAGS open close]]
[SLOP slop]
[TIMEOUT timeout]
[INORDER]
[LANGUAGE language]
[EXPANDER expander]
[SCORER scorer]
[EXPLAINSCORE]
[PAYLOAD payload]
[SORTBY sortby [ ASC | DESC] [WITHCOUNT]]
[LIMIT offset num]
[PARAMS nargs name value [ name value ...]]
[DIALECT dialect]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N)
</dd>
</dl>
<p>
Search the index with a textual query, returning either documents or just ids
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
index
</code>
</summary>
<p>
is index name. You must first create the index using
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
query
</code>
</summary>
<p>
is text query to search. If it's more than a single word, put it in quotes. Refer to
<a href="/docs/latest/develop/interact/search-and-query/query/">
Query syntax
</a>
for more details.
</p>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
NOCONTENT
</code>
</summary>
<p>
returns the document ids and not the content. This is useful if RediSearch is only an index on an external document collection.
</p>
</details>
<details open="">
<summary>
<code>
VERBATIM
</code>
</summary>
<p>
does not try to use stemming for query expansion but searches the query terms verbatim.
</p>
</details>
<details open="">
<summary>
<code>
WITHSCORES
</code>
</summary>
<p>
also returns the relative internal score of each document. This can be used to merge results from multiple instances.
</p>
</details>
<details open="">
<summary>
<code>
WITHPAYLOADS
</code>
</summary>
<p>
retrieves optional document payloads. See
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
. The payloads follow the document id and, if
<code>
WITHSCORES
</code>
is set, the scores.
</p>
</details>
<details open="">
<summary>
<code>
WITHSORTKEYS
</code>
</summary>
<p>
returns the value of the sorting key, right after the id and score and/or payload, if requested. This is usually not needed, and exists for distributed search coordination purposes. This option is relevant only if used in conjunction with
<code>
SORTBY
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
FILTER numeric_attribute min max
</code>
</summary>
<p>
limits results to those having numeric values ranging between
<code>
min
</code>
and
<code>
max
</code>
, if numeric_attribute is defined as a numeric attribute in
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
.
<code>
min
</code>
and
<code>
max
</code>
follow
<a href="/docs/latest/commands/zrange/">
<code>
ZRANGE
</code>
</a>
syntax, and can be
<code>
-inf
</code>
,
<code>
+inf
</code>
, and use
<code>
(
</code>
for exclusive ranges. Multiple numeric filters for different attributes are supported in one query.
<strong>
Deprecated since v2.10
</strong>
:
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/#dialect-2">
Query dialect 2
</a>
explains the query syntax for numeric fields that replaces this argument.
</p>
</details>
<details open="">
<summary>
<code>
GEOFILTER {geo_attribute} {lon} {lat} {radius} m|km|mi|ft
</code>
</summary>
<p>
filter the results to a given
<code>
radius
</code>
from
<code>
lon
</code>
and
<code>
lat
</code>
. Radius is given as a number and units. See
<a href="/docs/latest/commands/georadius/">
<code>
GEORADIUS
</code>
</a>
for more details.
<strong>
Deprecated since v2.6
</strong>
:
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/#dialect-3">
Query dialect 3
</a>
explains the query syntax for geospatial fields that replaces this argument.
</p>
</details>
<details open="">
<summary>
<code>
INKEYS {num} {attribute} ...
</code>
</summary>
<p>
limits the result to a given set of keys specified in the list. The first argument must be the length of the list and greater than zero. Non-existent keys are ignored, unless all the keys are non-existent.
</p>
</details>
<details open="">
<summary>
<code>
INFIELDS {num} {attribute} ...
</code>
</summary>
<p>
filters the results to those appearing only in specific attributes of the document, like
<code>
title
</code>
or
<code>
URL
</code>
. You must include
<code>
num
</code>
, which is the number of attributes you're filtering by. For example, if you request
<code>
title
</code>
and
<code>
URL
</code>
, then
<code>
num
</code>
is 2.
</p>
</details>
<details open="">
<summary>
<code>
RETURN {num} {identifier} AS {property} ...
</code>
</summary>
<p>
limits the attributes returned from the document.
<code>
num
</code>
is the number of attributes following the keyword. If
<code>
num
</code>
is 0, it acts like
<code>
NOCONTENT
</code>
.
<code>
identifier
</code>
is either an attribute name (for hashes and JSON) or a JSON Path expression (for JSON).
<code>
property
</code>
is an optional name used in the result. If not provided, the
<code>
identifier
</code>
is used in the result.
</p>
</details>
<details open="">
<summary>
<code>
SUMMARIZE ...
</code>
</summary>
<p>
returns only the sections of the attribute that contain the matched text. See
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/highlight/">
Highlighting
</a>
for more information.
</p>
</details>
<details open="">
<summary>
<code>
HIGHLIGHT ...
</code>
</summary>
<p>
formats occurrences of matched text. See
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/highlight/">
Highlighting
</a>
for more information.
</p>
</details>
<details open="">
<summary>
<code>
SLOP {slop}
</code>
</summary>
<p>
is the number of intermediate terms allowed to appear between the terms of the query.
Suppose you're searching for a phrase
<em>
hello world
</em>
.
If some terms appear in-between
<em>
hello
</em>
and
<em>
world
</em>
, a
<code>
SLOP
</code>
greater than
<code>
0
</code>
allows for these text attributes to match.
By default, there is no
<code>
SLOP
</code>
constraint.
</p>
</details>
<details open="">
<summary>
<code>
INORDER
</code>
</summary>
<p>
requires the terms in the document to have the same order as the terms in the query, regardless of the offsets between them. Typically used in conjunction with
<code>
SLOP
</code>
. Default is
<code>
false
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
LANGUAGE {language}
</code>
</summary>
<p>
use a stemmer for the supplied language during search for query expansion. If querying documents in Chinese, set to
<code>
chinese
</code>
to
properly tokenize the query terms. Defaults to English. If an unsupported language is sent, the command returns an error.
See
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
for the list of languages. If
<code>
LANGUAGE
</code>
was specified as part of index
creation, it doesn't need to specified with
<code>
FT.SEARCH
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
EXPANDER {expander}
</code>
</summary>
<p>
uses a custom query expander instead of the stemmer. See
<a href="/docs/latest/develop/interact/search-and-query/administration/extensions/">
Extensions
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
SCORER {scorer}
</code>
</summary>
<p>
uses a
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/scoring/">
built-in
</a>
or a
<a href="/docs/latest/develop/interact/search-and-query/administration/extensions/">
user-provided
</a>
scoring function.
</p>
</details>
<details open="">
<summary>
<code>
EXPLAINSCORE
</code>
</summary>
<p>
returns a textual description of how the scores were calculated. Using this option requires
<code>
WITHSCORES
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
PAYLOAD {payload}
</code>
</summary>
<p>
adds an arbitrary, binary safe payload that is exposed to custom scoring functions. See
<a href="/docs/latest/develop/interact/search-and-query/administration/extensions/">
Extensions
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
SORTBY {attribute} [ASC|DESC] [WITHCOUNT]
</code>
</summary>
<p>
orders the results by the value of this attribute. This applies to both text and numeric attributes. Attributes needed for
<code>
SORTBY
</code>
should be declared as
<code>
SORTABLE
</code>
in the index, in order to be available with very low latency. Note that this adds memory overhead.
</p>
<p>
<strong>
Sorting Optimizations
</strong>
: performance is optimized for sorting operations on
<code>
DIALECT 4
</code>
in different scenarios:
</p>
<ul>
<li>
Skip Sorter - applied when there is no sort of any kind. The query can return after it reaches the
<code>
LIMIT
</code>
requested results.
</li>
<li>
Partial Range - applied when there is a
<code>
SORTBY
</code>
clause over a numeric field, with no filter or filter by the same numeric field, the query iterate on a range large enough to satisfy the
<code>
LIMIT
</code>
requested results.
</li>
<li>
Hybrid - applied when there is a
<code>
SORTBY
</code>
clause over a numeric field and another non-numeric filter. Some results will get filtered, and the initial range may not be large enough. The iterator is then rewinding with the following ranges, and an additional iteration takes place to collect the
<code>
LIMIT
</code>
requested results.
</li>
<li>
No optimization - If there is a sort by score or by non-numeric field, there is no other option but to retrieve all results and compare their values.
</li>
</ul>
<p>
<strong>
Counts behavior
</strong>
: optional
<code>
WITHCOUNT
</code>
argument returns accurate counts for the query results with sorting. This operation processes all results in order to get an accurate count, being less performant than the optimized option (default behavior on
<code>
DIALECT 4
</code>
)
</p>
</details>
<details open="">
<summary>
<code>
LIMIT first num
</code>
</summary>
<p>
limits the results to the offset and number of results given. Note that the offset is zero-indexed. The default is 0 10, which returns 10 items starting from the first result. You can use
<code>
LIMIT 0 0
</code>
to count the number of documents in the result set without actually returning them.
</p>
<p>
<strong>
<code>
LIMIT
</code>
behavior
</strong>
: If you use the
<code>
LIMIT
</code>
option without sorting, the results returned are non-deterministic, which means that subsequent queries may return duplicated or missing values. Add
<code>
SORTBY
</code>
with a unique field, or use
<code>
FT.AGGREGATE
</code>
with the
<code>
WITHCURSOR
</code>
option to ensure deterministic result set paging.
</p>
</details>
<details open="">
<summary>
<code>
TIMEOUT {milliseconds}
</code>
</summary>
<p>
overrides the timeout parameter of the module.
</p>
</details>
<details open="">
<summary>
<code>
PARAMS {nargs} {name} {value}
</code>
</summary>
<p>
defines one or more value parameters. Each parameter has a name and a value.
</p>
<p>
You can reference parameters in the
<code>
query
</code>
by a
<code>
$
</code>
, followed by the parameter name, for example,
<code>
$user
</code>
. Each such reference in the search query to a parameter name is substituted by the corresponding parameter value. For example, with parameter definition
<code>
PARAMS 4 lon 29.69465 lat 34.95126
</code>
, the expression
<code>
@loc:[$lon $lat 10 km]
</code>
is evaluated to
<code>
@loc:[29.69465 34.95126 10 km]
</code>
. You cannot reference parameters in the query string where concrete values are not allowed, such as in field names, for example,
<code>
@loc
</code>
. To use
<code>
PARAMS
</code>
, set
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/#dialect-2">
<code>
DIALECT
</code>
</a>
to
<code>
2
</code>
or greater than
<code>
2
</code>
(this requires
<a href="https://github.com/RediSearch/RediSearch/releases/tag/v2.4.3">
RediSearch v2.4
</a>
or above).
</p>
</details>
<details open="">
<summary>
<code>
DIALECT {dialect_version}
</code>
</summary>
<p>
selects the dialect version under which to execute the query. If not specified, the query will execute under the default dialect version set during module initial loading or via
<a href="/docs/latest/commands/ft.config-set/">
<code>
FT.CONFIG SET
</code>
</a>
command. See
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/">
Query dialects
</a>
for more information.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.SEARCH returns an array reply, where the first element is an integer reply of the total number of results, and then array reply pairs of document ids, and array replies of attribute/value pairs.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Notes:
</div>
<ul>
<li>
If
<code>
NOCONTENT
</code>
is given, an array is returned where the first element is the total number of results, and the rest of the members are document ids.
</li>
<li>
If a relevant key expires while a query is running, an attempt to load the key's value will return a null array. However, the key is still counted in the total number of results.
</li>
</ul>
</div>
</div>
<h3 id="return-multiple-values">
Return multiple values
</h3>
<p>
When the index is defined
<code>
ON JSON
</code>
, a reply for a single attribute or a single JSONPath may return multiple values when the JSONPath matches multiple values, or when the JSONPath matches an array.
</p>
<p>
Prior to RediSearch v2.6, only the first of the matched values was returned.
Starting with RediSearch v2.6, all values are returned, wrapped with a top-level array.
</p>
<p>
In order to maintain backward compatibility, the default behavior with RediSearch v2.6 is to return only the first value.
</p>
<p>
To return all the values, use
<code>
DIALECT
</code>
3 (or greater, when available).
</p>
<p>
The
<code>
DIALECT
</code>
can be specified as a parameter in the FT.SEARCH command. If it is not specified, the
<code>
DEFAULT_DIALECT
</code>
is used, which can be set using
<a href="/docs/latest/commands/ft.config-set/">
<code>
FT.CONFIG SET
</code>
</a>
or by passing it as an argument to the
<code>
redisearch
</code>
module when it is loaded.
</p>
<p>
For example, with the following document and index:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:6379> JSON.SET doc:1 $ <span class="s1">'[{"arr": [1, 2, 3]}, {"val": "hello"}, {"val": "world"}]'</span>
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> FT.CREATE idx ON JSON PREFIX <span class="m">1</span> doc: SCHEMA $..arr AS arr NUMERIC $..val AS val TEXT
</span></span><span class="line"><span class="cl">OK
</span></span></code></pre>
</div>
<p>
Notice the different replies, with and without
<code>
DIALECT 3
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH idx * RETURN <span class="m">2</span> arr val
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"doc:1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"arr"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"[1,2,3]"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"val"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"hello"</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH idx * RETURN <span class="m">2</span> arr val DIALECT <span class="m">3</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"doc:1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"arr"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"[[1,2,3]]"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"val"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"[\"hello\",\"world\"]"</span>
</span></span></code></pre>
</div>
<h2 id="complexity">
Complexity
</h2>
<p>
FT.SEARCH complexity is O(n) for single word queries.
<code>
n
</code>
is the number of the results in the result set. Finding all the documents that have a specific term is O(1), however, a scan on all those documents is needed to load the documents data from redis hashes and return them.
</p>
<p>
The time complexity for more complex queries varies, but in general it's proportional to the number of words, the number of intersection points between them and the number of results in the result set.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Search for a term in every text attribute
</b>
</summary>
<p>
Search for the term "wizard" in every TEXT attribute of an index containing book data.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"wizard"</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a term in title attribute
</b>
</summary>
<p>
Search for the term
<em>
dogs
</em>
in the
<code>
title
</code>
attribute.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"@title:dogs"</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for books from specific years
</b>
</summary>
<p>
Search for books published in 2020 or 2021.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"@published_at:[2020 2021]"</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a restaurant by distance from longitude/latitude
</b>
</summary>
<p>
Search for Chinese restaurants within 5 kilometers of longitude -122.41, latitude 37.77 (San Francisco).
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH restaurants-idx <span class="s2">"chinese @location:[-122.41 37.77 5 km]"</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a book by terms but boost specific term
</b>
</summary>
<p>
Search for the term
<em>
dogs
</em>
or
<em>
cats
</em>
in the
<code>
title
</code>
attribute, but give matches of
<em>
dogs
</em>
a higher relevance score (also known as
<em>
boosting
</em>
).
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"(@title:dogs | @title:cats) | (@title:dogs) => { </span><span class="nv">$weight</span><span class="s2">: 5.0; }"</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a book by a term and EXPLAINSCORE
</b>
</summary>
<p>
Search for books with
<em>
dogs
</em>
in any TEXT attribute in the index and request an explanation of scoring for each result.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"dogs"</span> WITHSCORES EXPLAINSCORE</span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a book by a term and TAG
</b>
</summary>
<p>
Search for books with
<em>
space
</em>
in the title that have
<code>
science
</code>
in the TAG attribute
<code>
categories
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"@title:space @categories:{science}"</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a book by a term but limit the number
</b>
</summary>
<p>
Search for books with
<em>
Python
</em>
in any
<code>
TEXT
</code>
attribute, returning 10 results starting with the 11th result in the entire result set (the offset parameter is zero-based), and return only the
<code>
title
</code>
attribute for each result.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"python"</span> LIMIT <span class="m">10</span> <span class="m">10</span> RETURN <span class="m">1</span> title</span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a book by a term and price
</b>
</summary>
<p>
Search for books with
<em>
Python
</em>
in any
<code>
TEXT
</code>
attribute, returning the price stored in the original JSON document.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"python"</span> RETURN <span class="m">3</span> $.book.price AS price</span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a book by title and distance
</b>
</summary>
<p>
Search for books with semantically similar title to
<em>
Planet Earth
</em>
. Return top 10 results sorted by distance.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH books-idx <span class="s2">"*=>[KNN 10 @title_embedding </span><span class="nv">$query_vec</span><span class="s2"> AS title_score]"</span> PARAMS <span class="m">2</span> query_vec <<span class="s2">"Planet Earth"</span> embedding BLOB> SORTBY title_score DIALECT <span class="m">2</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Search for a phrase using SLOP
</b>
</summary>
<p>
Search for a phrase
<em>
hello world
</em>
.
First, create an index.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.CREATE memes SCHEMA phrase TEXT
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<p>
Add variations of the phrase
<em>
hello world
</em>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> HSET s1 phrase <span class="s2">"hello world"</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> HSET s2 phrase <span class="s2">"hello simple world"</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> HSET s3 phrase <span class="s2">"hello somewhat less simple world"</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> HSET s4 phrase <span class="s2">"hello complicated yet encouraging problem solving world"</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> HSET s5 phrase <span class="s2">"hello complicated yet amazingly encouraging problem solving world"</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span></span></span></code></pre>
</div>
<p>
Then, search for the phrase
<em>
hello world
</em>
. The result returns all documents that contain the phrase.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(hello world)'</span> NOCONTENT
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">5</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="s2">"s2"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"s3"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> <span class="s2">"s4"</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> <span class="s2">"s5"</span></span></span></code></pre>
</div>
<p>
Now, return all documents that have one of fewer words between
<em>
hello
</em>
and
<em>
world
</em>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(hello world)'</span> NOCONTENT SLOP <span class="m">1</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="s2">"s2"</span></span></span></code></pre>
</div>
<p>
Now, return all documents with three or fewer words between
<em>
hello
</em>
and
<em>
world
</em>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(hello world)'</span> NOCONTENT SLOP <span class="m">3</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="s2">"s2"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"s3"</span></span></span></code></pre>
</div>
<p>
<code>
s5
</code>
needs a higher
<code>
SLOP
</code>
to match,
<code>
SLOP 6
</code>
or higher, to be exact. See what happens when you set
<code>
SLOP
</code>
to
<code>
5
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(hello world)'</span> NOCONTENT SLOP <span class="m">5</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">4</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="s2">"s2"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"s3"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> <span class="s2">"s4"</span></span></span></code></pre>
</div>
<p>
If you add additional terms (and stemming), you get these results.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(hello amazing world)'</span> NOCONTENT
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s5"</span></span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(hello encouraged world)'</span> NOCONTENT SLOP <span class="m">5</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s4"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="s2">"s5"</span></span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(hello encouraged world)'</span> NOCONTENT SLOP <span class="m">4</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s4"</span></span></span></code></pre>
</div>
<p>
If you swap the terms, you can still retrieve the correct phrase.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(amazing hello world)'</span> NOCONTENT
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"s5"</span></span></span></code></pre>
</div>
<p>
But, if you use
<code>
INORDER
</code>
, you get zero results.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(amazing hello world)'</span> NOCONTENT INORDER
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span></span></span></code></pre>
</div>
<p>
Likewise, if you use a query attribute
<code>
$inorder
</code>
set to
<code>
true
</code>
,
<code>
s5
</code>
is not retrieved.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH memes <span class="s1">'@phrase:(amazing hello world)=>{$inorder: true;}'</span> NOCONTENT
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span></span></span></code></pre>
</div>
<p>
To sum up, the
<code>
INORDER
</code>
argument or
<code>
$inorder
</code>
query attribute require the query terms to match terms with similar ordering.
</p>
</details>
<details open="">
<summary>
<b>
Polygon Search with WITHIN, CONTAINS, INTERSECTS, and DISJOINT operators
</b>
</summary>
<p>
Query for polygons which:
</p>
<ul>
<li>
contain a given geoshape
</li>
<li>
are within a given geoshape
</li>
<li>
intersect with a given geoshape
</li>
<li>
are disjoint (nothing in common) with a given shape
</li>
</ul>
<p>
<code>
INTERSECTS
</code>
and
<code>
DISJOINT
</code>
were introduced in v2.10.
</p>
<p>
First, create an index using
<code>
GEOSHAPE
</code>
type with a
<code>
FLAT
</code>
coordinate system:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.CREATE idx SCHEMA geom GEOSHAPE FLAT
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<p>
Adding a couple of geometries using
<a href="/docs/latest/commands/hset/">
<code>
HSET
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> HSET small geom <span class="s1">'POLYGON((1 1, 1 100, 100 100, 100 1, 1 1))'</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> HSET large geom <span class="s1">'POLYGON((1 1, 1 200, 200 200, 200 1, 1 1))'</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span></span></span></code></pre>
</div>
<p>
Query with
<code>
WITHIN
</code>
operator:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH idx <span class="s1">'@geom:[WITHIN $poly]'</span> PARAMS <span class="m">2</span> poly <span class="s1">'POLYGON((0 0, 0 150, 150 150, 150 0, 0 0))'</span> DIALECT <span class="m">3</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"small"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"geom"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"POLYGON((1 1, 1 100, 100 100, 100 1, 1 1))"</span></span></span></code></pre>
</div>
<p>
Query with
<code>
CONTAINS
</code>
operator:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SEARCH idx <span class="s1">'@geom:[CONTAINS $poly]'</span> PARAMS <span class="m">2</span> poly <span class="s1">'POLYGON((2 2, 2 50, 50 50, 50 2, 2 2))'</span> DIALECT <span class="m">3</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"small"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"geom"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"POLYGON((1 1, 1 100, 100 100, 100 1, 1 1))"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"large"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"geom"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"POLYGON((1 1, 1 200, 200 200, 200 1, 1 1))"</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
|
<a href="/docs/latest/commands/ft.aggregate/">
<code>
FT.AGGREGATE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/interact/search-and-query/administration/extensions/">
Extensions
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/highlight/">
Highlighting
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/query/">
Query syntax
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</li>
</ul>
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 2.0.0: Deprecated
<code>
WITHPAYLOADS
</code>
and
<code>
PAYLOAD
</code>
arguments
</li>
<li>
Starting with Redis version 2.6: Deprecated
<code>
GEOFILTER
</code>
argument
</li>
<li>
Starting with Redis version 2.10: Deprecated
<code>
FILTER
</code>
argument
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.search/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/networking/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Manage networks
</h1>
<p class="text-lg -mt-5 mb-10">
Networking features and considerations for designing your Redis Enterprise Software deployment.
</p>
<nav>
<a href="/docs/latest/operate/rs/networking/configuring-aws-route53-dns-redis-enterprise/">
AWS Route53 DNS management
</a>
<p>
How to configure AWS Route 53 DNS
</p>
<a href="/docs/latest/operate/rs/networking/cluster-lba-setup/">
Set up a Redis Enterprise cluster behind a load balancer
</a>
<p>
Set up a Redis Enterprise cluster using a load balancer instead of DNS to direct traffic to cluster nodes.
</p>
<a href="/docs/latest/operate/rs/networking/cluster-dns/">
Configure cluster DNS
</a>
<p>
Configure DNS to communicate between nodes in your cluster.
</p>
<a href="/docs/latest/operate/rs/networking/multi-ip-ipv6/">
Manage IP addresses
</a>
<p>
Information and requirements for using multiple IP addresses or IPv6 addresses with Redis Enterprise Software.
</p>
<a href="/docs/latest/operate/rs/networking/mdns/">
Client prerequisites for mDNS
</a>
<p>
Requirements for using the mDNS protocol in development and testing environments.
</p>
<a href="/docs/latest/operate/rs/networking/port-configurations/">
Network port configurations
</a>
<p>
This document describes the various network port ranges and their uses.
</p>
<a href="/docs/latest/operate/rs/networking/private-public-endpoints/">
Enable private and public database endpoints
</a>
<p>
Describes how to enable public and private endpoints for databases on a cluster.
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/networking/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/clusters/optimize/memtier-benchmark/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Benchmarking Redis Enterprise
</h1>
<p class="text-lg -mt-5 mb-10">
Use the
<code>
memtier_benchmark
</code>
tool to perform a performance benchmark of Redis Enterprise Software.
</p>
<p>
Use the
<code>
memtier_benchmark
</code>
tool to perform a performance benchmark of Redis Enterprise Software.
</p>
<p>
Prerequisites:
</p>
<ul>
<li>
Redis Enterprise Software installed
</li>
<li>
A cluster configured
</li>
<li>
A database created
</li>
</ul>
<p>
For help with the prerequisites, see the
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart/">
Redis Enterprise Software quickstart
</a>
.
</p>
<p>
It is recommended to run memtier_benchmark on a separate node that is
not part of the cluster being tested. If you run it on a node of the
cluster, be mindful that it affects the performance of both the
cluster and memtier_benchmark.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">/opt/redislabs/bin/memtier_benchmark -s <span class="nv">$DB_HOST</span> -p <span class="nv">$DB_PORT</span> -a <span class="nv">$DB_PASSWORD</span> -t <span class="m">4</span> -R --ratio<span class="o">=</span>1:1
</span></span></code></pre>
</div>
<p>
This command instructs memtier_benchmark to connect to your Redis
Enterprise database and generates a load doing the following:
</p>
<ul>
<li>
A 50/50 Set to Get ratio
</li>
<li>
Each object has random data in the value
</li>
</ul>
<h2 id="populate-a-database-with-testing-data">
Populate a database with testing data
</h2>
<p>
If you need to populate a database with some test data for a proof of
concept, or failover testing, etc. here is an example for you.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">/opt/redislabs/bin/memtier_benchmark -s <span class="nv">$DB_HOST</span> -p <span class="nv">$DB_PORT</span> -a <span class="nv">$DB_PASSWORD</span> -R -n allkeys -d <span class="m">500</span> --key-pattern<span class="o">=</span>P:P --ratio<span class="o">=</span>1:0
</span></span></code></pre>
</div>
<p>
This command instructs memtier_benchmark to connect to your Redis
Enterprise database and generates a load doing the following:
</p>
<ul>
<li>
Write objects only, no reads
</li>
<li>
A 500 byte object
</li>
<li>
Each object has random data in the value
</li>
<li>
Each key has a random pattern, then a colon, followed by a
random pattern.
</li>
</ul>
<p>
Run this command until it fills up your database to where you want it
for testing. The easiest way to check is on the database metrics page.
</p>
<a href="/docs/latest/images/rs/memtier_metrics_page.png" sdata-lightbox="/images/rs/memtier_metrics_page.png">
<img src="/docs/latest/images/rs/memtier_metrics_page.png"/>
</a>
<p>
Another use for memtier_benchmark is to populate a database with data
for failure testing.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/clusters/optimize/memtier-benchmark/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/previous-releases/k8s-6-0-6-24/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes Release Notes 6.0.6-24 (August 2020)
</h1>
<p class="text-lg -mt-5 mb-10">
Various bug fixes.
</p>
<p>
The Redis Enterprise K8s 6.0.6-24 release is a
<em>
maintenance release
</em>
on top of
<a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases/tag/v6.0.6-23">
6.0.6-23
</a>
providing support for the latest
<a href="https://docs.redislabs.com/latest/rs/release-notes/rs-6-0-may-2020/">
Redis Enterprise Software release 6.0.6-39
</a>
and includes several bug fixes.
</p>
<h2 id="overview">
Overview
</h2>
<p>
This release of the operator provides:
</p>
<ul>
<li>
Various bug fixes
</li>
</ul>
<p>
To upgrade your deployment to this latest release, see
<a href="/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster/">
"Upgrade a Redis Enterprise cluster (REC) on Kubernetes"
</a>
.
</p>
<h2 id="images">
Images
</h2>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
- redislabs/redis:6.0.6-39 or redislabs/redis:6.0.6-39.rhel7-openshift
</li>
<li>
<strong>
Operator
</strong>
- redislabs/operator:6.0.6-24
</li>
<li>
<strong>
Services Rigger
</strong>
- redislabs/k8s-controller:6.0.6-24 or redislabs/services-manager:6.0.6-24 (on the RedHat registry)
</li>
</ul>
<h2 id="important-fixes">
Important fixes
</h2>
<ul>
<li>
A fix for database observability where after 24 hours after creation or update, the controller was unable to observe the database (RED46149)
</li>
<li>
A fix for a log collector crash on Windows when pods were not running (RED45477)
</li>
</ul>
<h2 id="known-limitations">
Known limitations
</h2>
<h3 id="crashloopbackoff-causes-cluster-recovery-to-be-incomplete--red33713">
CrashLoopBackOff causes cluster recovery to be incomplete (RED33713)
</h3>
<p>
When a pod status is CrashLoopBackOff and we run the cluster recovery, the process will not complete. The workaround is to delete the crashing pods manually and recovery process will continue.
</p>
<h3 id="long-cluster-names-cause-routes-to-be-rejected--red25871">
Long cluster names cause routes to be rejected (RED25871)
</h3>
<p>
A cluster name longer than 20 characters will result in a rejected route configuration as the host part of the domain name exceeds 63 characters. The workaround is to limit cluster name to 20 characters or less.
</p>
<h3 id="cluster-cr-rec-errors-are-not-reported-after-invalid-updates-red25542">
Cluster CR (REC) errors are not reported after invalid updates (RED25542)
</h3>
<p>
A cluster CR specification error is not reported if two or more invalid CR resources are updated in sequence.
</p>
<h3 id="an-unreachable-cluster-has-status-running-red32805">
An unreachable cluster has status running (RED32805)
</h3>
<p>
When a cluster is in an unreachable state the state is still running instead of being reported as an error.
</p>
<h3 id="readiness-probe-incorrect-on-failures-red39300">
Readiness probe incorrect on failures (RED39300)
</h3>
<p>
STS Readiness probe doesn't mark a node as not ready when rladmin status on the node fails.
</p>
<h3 id="role-missing-on-replica-sets-red39002">
Role missing on replica sets (RED39002)
</h3>
<p>
The redis-enterprise-operator role is missing permission on replica sets.
</p>
<h3 id="private-registries-are-not-supported-on-openshift-311-red38579">
Private registries are not supported on OpenShift 3.11 (RED38579)
</h3>
<p>
Openshift 3.11 doesn't support dockerhub private registry. This is a known OpenShift issue.
</p>
<h3 id="internal-dns-and-kubernetes-dns-may-have-conflicts-red37462">
Internal DNS and Kubernetes DNS may have conflicts (RED37462)
</h3>
<p>
DNS conflicts are possible between the cluster mdns_server and the K8s DNS. This only impacts DNS resolution from within cluster nodes for Kubernetes DNS names.
</p>
<h3 id="5410-negatively-impacts-546-red37233">
5.4.10 negatively impacts 5.4.6 (RED37233)
</h3>
<p>
Kubernetes-based 5.4.10 deployments seem to negatively impact existing 5.4.6 deployments that share a Kubernetes cluster.
</p>
<h3 id="node-cpu-usage-is-reported-instead-of-pod-cpu-usage-red36884">
Node CPU usage is reported instead of pod CPU usage (RED36884)
</h3>
<p>
In Kubernetes, the node CPU usage we report on is the usage of the Kubernetes worker node hosting the REC pod.
</p>
<h3 id="clusters-must-be-named-rec-in-olm-based-deployments-red39825">
Clusters must be named "rec" in OLM-based deployments (RED39825)
</h3>
<p>
In OLM-deployed operators, the deployment of the cluster will fail if the name is not "rec". When the operator is deployed with the OLM, the security context constraints (scc) is bound to a specific service account name (i.e., "rec"). The workaround is to name the cluster "rec".
</p>
<h3 id="updating-ui-service-in-rancher-red45771">
Updating UI service in Rancher (RED45771)
</h3>
<p>
Updating the UI service type may fail in Rancher. When this happens, delete the service manually and the operator will recreate it correctly.
</p>
<h3 id="master-pod-label-in-rancher-red42896">
Master pod label in Rancher (RED42896)
</h3>
<p>
Master pod is not always labeled in Rancher.
</p>
<h2 id="deprecation-notice">
Deprecation notice
</h2>
<p>
Support for K8s version 1.11 and 1.12 is deprecated (excludes Openshift 3.11, which continues to be supported). Openshift 4.1 and 4.2 are deprecated (already End Of Life by Red Hat).
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/previous-releases/k8s-6-0-6-24/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/rename/.html | <section class="prose w-full py-12">
<h1 class="command-name">
RENAME
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">RENAME key newkey</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
1.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@keyspace
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Renames
<code>
key
</code>
to
<code>
newkey
</code>
.
It returns an error when
<code>
key
</code>
does not exist.
If
<code>
newkey
</code>
already exists it is overwritten, when this happens
<code>
RENAME
</code>
executes an implicit
<a href="/docs/latest/commands/del/">
<code>
DEL
</code>
</a>
operation, so if the deleted key contains a very big value it may cause high latency even if
<code>
RENAME
</code>
itself is usually a constant-time operation.
</p>
<p>
In Cluster mode, both
<code>
key
</code>
and
<code>
newkey
</code>
must be in the same
<strong>
hash slot
</strong>
, meaning that in practice only keys that have the same hash tag can be reliably renamed in cluster.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> SET mykey "Hello"
"OK"
redis> RENAME mykey myotherkey
"OK"
redis> GET myotherkey
"Hello"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="behavior-change-history">
Behavior change history
</h2>
<ul>
<li>
<code>
>= 3.2.0
</code>
: The command no longer returns an error when source and destination names are the same.
</li>
</ul>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/rename/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/prometheus-with-redis-enterprise/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Prometheus and Grafana with Redis Enterprise Software
</h1>
<p class="text-lg -mt-5 mb-10">
Use Prometheus and Grafana to collect and visualize Redis Enterprise Software metrics.
</p>
<p>
You can use Prometheus and Grafana to collect and visualize your Redis Enterprise Software metrics.
</p>
<p>
Metrics are exposed at the cluster, node, database, shard, and proxy levels.
</p>
<ul>
<li>
<a href="https://prometheus.io/">
Prometheus
</a>
is an open source systems monitoring and alerting toolkit that aggregates metrics from different sources.
</li>
<li>
<a href="https://grafana.com/">
Grafana
</a>
is an open source metrics visualization tool that processes Prometheus data.
</li>
</ul>
<p>
You can use Prometheus and Grafana to:
</p>
<ul>
<li>
<p>
Collect and display metrics not available in the
<a href="/docs/latest/operate/rs/references/metrics/">
admin console
</a>
</p>
</li>
<li>
<p>
Set up automatic alerts for node or cluster events
</p>
</li>
<li>
<p>
Display Redis Enterprise Software metrics alongside data from other systems
</p>
</li>
</ul>
<a href="/docs/latest/images/rs/grafana-prometheus.png" sdata-lightbox="/images/rs/grafana-prometheus.png">
<img alt="Graphic showing how Prometheus and Grafana collect and display data from a Redis Enterprise Cluster. Prometheus collects metrics from the Redis Enterprise cluster, and Grafana queries those metrics for visualization." src="/docs/latest/images/rs/grafana-prometheus.png"/>
</a>
<p>
In each cluster, the metrics_exporter process exposes Prometheus metrics on port 8070.
</p>
<h2 id="quick-start">
Quick start
</h2>
<p>
To get started with Prometheus and Grafana:
</p>
<ol>
<li>
<p>
Create a directory called 'prometheus' on your local machine.
</p>
</li>
<li>
<p>
Within that directory, create a configuration file called
<code>
prometheus.yml
</code>
.
</p>
</li>
<li>
<p>
Add the following contents to the configuration file and replace
<code>
<cluster_name>
</code>
with your Redis Enterprise cluster's FQDN:
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
We recommend running Prometheus in Docker only for development and testing.
</div>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-yml" data-lang="yml"><span class="line"><span class="cl"><span class="nt">global</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">scrape_interval</span><span class="p">:</span><span class="w"> </span><span class="l">15s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">evaluation_interval</span><span class="p">:</span><span class="w"> </span><span class="l">15s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c"># Attach these labels to any time series or alerts when communicating with</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c"># external systems (federation, remote storage, Alertmanager).</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">external_labels</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">monitor</span><span class="p">:</span><span class="w"> </span><span class="s2">"prometheus-stack-monitor"</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c"># Load and evaluate rules in this file every 'evaluation_interval' seconds.</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c">#rule_files:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c"># - "first.rules"</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c"># - "second.rules"</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">scrape_configs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c"># scrape Prometheus itself</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">job_name</span><span class="p">:</span><span class="w"> </span><span class="l">prometheus</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">scrape_interval</span><span class="p">:</span><span class="w"> </span><span class="l">10s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">scrape_timeout</span><span class="p">:</span><span class="w"> </span><span class="l">5s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">static_configs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">targets</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"localhost:9090"</span><span class="p">]</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c"># scrape Redis Enterprise</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">job_name</span><span class="p">:</span><span class="w"> </span><span class="l">redis-enterprise</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">scrape_interval</span><span class="p">:</span><span class="w"> </span><span class="l">30s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">scrape_timeout</span><span class="p">:</span><span class="w"> </span><span class="l">30s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">metrics_path</span><span class="p">:</span><span class="w"> </span><span class="l">/</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">scheme</span><span class="p">:</span><span class="w"> </span><span class="l">https</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">tls_config</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">insecure_skip_verify</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">static_configs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">targets</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"<cluster_name>:8070"</span><span class="p">]</span><span class="w">
</span></span></span></code></pre>
</div>
</li>
<li>
<p>
Set up your Prometheus and Grafana servers.
To set up Prometheus and Grafana on Docker:
</p>
<ol>
<li>
<p>
Create a
<em>
docker-compose.yml
</em>
file:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yml" data-lang="yml"><span class="line"><span class="cl"><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s1">'3'</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">services</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">prometheus-server</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l">prom/prometheus</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">ports</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="m">9090</span><span class="p">:</span><span class="m">9090</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">volumes</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">grafana-ui</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l">grafana/grafana</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">ports</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="m">3000</span><span class="p">:</span><span class="m">3000</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">environment</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">GF_SECURITY_ADMIN_PASSWORD=secret</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">links</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l">prometheus-server:prometheus</span><span class="w">
</span></span></span></code></pre>
</div>
</li>
<li>
<p>
To start the containers, run:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ docker compose up -d
</span></span></code></pre>
</div>
</li>
<li>
<p>
To check that all of the containers are up, run:
<code>
docker ps
</code>
</p>
</li>
<li>
<p>
In your browser, sign in to Prometheus at http://localhost:9090 to make sure the server is running.
</p>
</li>
<li>
<p>
Select
<strong>
Status
</strong>
and then
<strong>
Targets
</strong>
to check that Prometheus is collecting data from your Redis Enterprise cluster.
</p>
<a href="/docs/latest/images/rs/prometheus-target.png" sdata-lightbox="/images/rs/prometheus-target.png">
<img alt="The Redis Enterprise target showing that Prometheus is connected to the Redis Enterprise Cluster." src="/docs/latest/images/rs/prometheus-target.png"/>
</a>
<p>
If Prometheus is connected to the cluster, you can type
<strong>
node_up
</strong>
in the Expression field on the Prometheus home page to see the cluster metrics.
</p>
</li>
</ol>
</li>
<li>
<p>
Configure the Grafana datasource:
</p>
<ol>
<li>
<p>
Sign in to Grafana. If you installed Grafana locally, go to http://localhost:3000 and sign in with:
</p>
<ul>
<li>
Username: admin
</li>
<li>
Password: secret
</li>
</ul>
</li>
<li>
<p>
In the Grafana configuration menu, select
<strong>
Data Sources
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Add data source
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Prometheus
</strong>
from the list of data source types.
</p>
<a href="/docs/latest/images/rs/prometheus-datasource.png" sdata-lightbox="/images/rs/prometheus-datasource.png">
<img alt="The Prometheus data source in the list of data sources on Grafana." src="/docs/latest/images/rs/prometheus-datasource.png"/>
</a>
</li>
<li>
<p>
Enter the Prometheus configuration information:
</p>
<ul>
<li>
Name:
<code>
redis-enterprise
</code>
</li>
<li>
URL:
<code>
http://<your prometheus server name>:9090
</code>
</li>
</ul>
<a href="/docs/latest/images/rs/prometheus-connection.png" sdata-lightbox="/images/rs/prometheus-connection.png">
<img alt="The Prometheus connection form in Grafana." src="/docs/latest/images/rs/prometheus-connection.png"/>
</a>
</li>
</ol>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<ul>
<li>
If the network port is not accessible to the Grafana server, select the
<strong>
Browser
</strong>
option from the Access menu.
</li>
<li>
In a testing environment, you can select
<strong>
Skip TLS verification
</strong>
.
</li>
</ul>
</div>
</div>
</li>
<li>
<p>
Add dashboards for cluster, database, node, and shard metrics.
To add preconfigured dashboards:
</p>
<ol>
<li>
In the Grafana dashboards menu, select
<strong>
Manage
</strong>
.
</li>
<li>
Click
<strong>
Import
</strong>
.
</li>
<li>
Upload one or more
<a href="#grafana-dashboards-for-redis-enterprise">
Grafana dashboards
</a>
.
</li>
</ol>
</li>
</ol>
<h3 id="grafana-dashboards-for-redis-enterprise">
Grafana dashboards for Redis Enterprise
</h3>
<p>
Redis publishes four preconfigured dashboards for Redis Enterprise and Grafana:
</p>
<ul>
<li>
The
<a href="https://grafana.com/grafana/dashboards/18405-cluster-status-dashboard/">
cluster status dashboard
</a>
provides an overview of your Redis Enterprise clusters.
</li>
<li>
The
<a href="https://grafana.com/grafana/dashboards/18408-database-status-dashboard/">
database status dashboard
</a>
displays specific database metrics, including latency, memory usage, ops/second, and key count.
</li>
<li>
The
<a href="https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-node-dashboard_v9-11.json">
node metrics dashboard
</a>
provides metrics for each of the nodes hosting your cluster.
</li>
<li>
The
<a href="https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-shard-dashboard_v9-11.json">
shard metrics dashboard
</a>
displays metrics for the individual Redis processes running on your cluster nodes
</li>
<li>
The
<a href="https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana/dashboards/grafana_v9-11/software/basic/redis-software-active-active-dashboard_v9-11.json">
Active-Active dashboard
</a>
displays metrics specific to
<a href="/docs/latest/operate/rs/databases/active-active/">
Active-Active databases
</a>
.
</li>
</ul>
<p>
These dashboards are open source. For additional dashboard options, or to file an issue, see the
<a href="https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/grafana">
Redis Enterprise observability Github repository
</a>
.
</p>
<p>
For more information about configuring Grafana dashboards, see the
<a href="https://grafana.com/docs/">
Grafana documentation
</a>
.
</p>
<nav>
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions/">
Prometheus metrics v2 preview
</a>
<p>
V2 metrics available to Prometheus as of Redis Enterprise Software version 7.8.2.
</p>
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2/">
Transition from Prometheus v1 to Prometheus v2
</a>
<p>
Transition from v1 metrics to v2 PromQL equivalents.
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/prometheus-with-redis-enterprise/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/install/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Install RedisGears and the JVM plugin
</h1>
<p>
Before you can use RedisGears with the JVM, you need to install the RedisGears module and JVM plugin on your Redis Enterprise cluster and enable them for a database.
</p>
<h2 id="prerequisites">
Prerequisites
</h2>
<ol>
<li>
<p>
Redis Enterprise v6.0.12 or later
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/clusters/new-cluster-setup/">
Created a Redis Enterprise cluster
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/clusters/add-node/">
Added nodes to the cluster
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears/#install-redisgears">
Installed RedisGears and the JVM plugin
</a>
</p>
</li>
</ol>
<h2 id="enable-redisgears-for-a-database">
Enable RedisGears for a database
</h2>
<ol>
<li>
<p>
From the Redis Enterprise admin console's
<strong>
databases
</strong>
page, select the
<strong>
Add
</strong>
button to create a new database:
</p>
<a href="/docs/latest/images/rs/icon_add.png" sdata-lightbox="/images/rs/icon_add.png">
<img alt="The Add icon" src="/docs/latest/images/rs/icon_add.png" width="30px"/>
</a>
</li>
<li>
<p>
Confirm that you want to create a new Redis database with the
<strong>
Next
</strong>
button.
</p>
</li>
<li>
<p>
On the
<strong>
create database
</strong>
page, give your database a name.
</p>
</li>
<li>
<p>
For
<strong>
Redis Modules
</strong>
, select the
<strong>
Add
</strong>
button and choose RedisGears from the
<strong>
Module
</strong>
dropdown list.
</p>
</li>
<li>
<p>
Select
<strong>
Add Configuration
</strong>
, enter
<code>
Plugin gears_jvm
</code>
in the box, then select the
<strong>
OK
</strong>
button:
</p>
<a href="/docs/latest/images/rs/icon_save.png" sdata-lightbox="/images/rs/icon_save.png">
<img alt="The Save icon" src="/docs/latest/images/rs/icon_save.png" width="30px"/>
</a>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
You can configure additional JVM options in this box. For example:
<br/>
<br/>
<code>
Plugin gears_jvm JvmOptions
</code>
<nobr>
<code>
'-Dproperty1=value1
</code>
</nobr>
<nobr>
<code>
-Dproperty2=value2'
</code>
</nobr>
</div>
</div>
</li>
<li>
<p>
Select the
<strong>
Activate
</strong>
button.
</p>
</li>
</ol>
<h2 id="verify-the-install">
Verify the install
</h2>
<p>
Run the
<code>
RG.JSTATS
</code>
command from a database shard to view statistics and verify that you set up RedisGears and the JVM plugin correctly:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ shard-cli <span class="m">3</span>
</span></span><span class="line"><span class="cl">172.16.0.1:12345> RG.JSTATS
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/install/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisGraph release notes
</h1>
<p class="text-lg -mt-5 mb-10">
RedisGraph release notes for version 2.10 and earlier
</p>
<div class="banner-article rounded-md" style="background-color: ">
<p>
Redis, Inc. has announced the end of life for RedisGraph. We will carry out the process gradually and in accordance with our commitment to our customers. See
<a href="https://redis.com/blog/redisgraph-eol/">
details
</a>
.
</p>
</div>
<table>
<thead>
<tr>
<th style="text-align:left">
Version (Release date)
</th>
<th style="text-align:left">
Major changes
</th>
<th style="text-align:left">
Min Redis
<br/>
version
</th>
<th style="text-align:left">
Min cluster
<br/>
version
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.10-release-notes/">
v2.10 (November 2022)
</a>
</td>
<td style="text-align:left">
Introduces new path algorithms, additional expressivity (constructs and functions), performance improvements, and bug fixes.
</td>
<td style="text-align:left">
6.2.0
</td>
<td style="text-align:left">
6.2.8
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.8-release-notes/">
v2.8 (February 2022)
</a>
</td>
<td style="text-align:left">
Introduces multi-labeled nodes, indexes over relationship properties, and additional expressivity (Cypher construct, functions, and operators). Major performance enhancements. Many bug fixes.
</td>
<td style="text-align:left">
6.2.0
</td>
<td style="text-align:left">
6.2.8
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.4-release-notes/">
v2.4 (March 2021)
</a>
</td>
<td style="text-align:left">
Added Map and Geospatial Point data types.
</td>
<td style="text-align:left">
6.0.0
</td>
<td style="text-align:left">
6.0.8
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.2-release-notes/">
v2.2 (November 2020)
</a>
</td>
<td style="text-align:left">
Support for scaling reads, OPTIONAL MATCH, query caching, and GRAPH.SLOWLOG.
</td>
<td style="text-align:left">
5.0.7
</td>
<td style="text-align:left">
6.0.8
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.0-release-notes/">
v2.0 (January 2020)
</a>
</td>
<td style="text-align:left">
Enabled graph-aided search and graph visualisation. Cypher coverage. Performance improvements.
</td>
<td style="text-align:left">
5.0.7
</td>
<td style="text-align:left">
5.4.11
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-1.2-release-notes/">
v1.2 (April 2019)
</a>
</td>
<td style="text-align:left">
Support multiple relationships of the same type R connecting two nodes. Lexer elides escape characters in string creation. Performance improvements.
</td>
<td style="text-align:left">
4.0.0
</td>
<td style="text-align:left">
5.0.0
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-1.0-release-notes/">
v1.0 (November 2018)
</a>
</td>
<td style="text-align:left">
Fixed memory leaks. Support ‘*’ within RETURN clause. Added TYPE function. Initial support for UNWIND clause.
</td>
<td style="text-align:left">
4.0.0
</td>
<td style="text-align:left">
5.0.0
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/durability-ha/consistency/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Consistency during replication
</h1>
<p class="text-lg -mt-5 mb-10">
Explains the order write operations are communicated from app to proxy to shards for both non-blocking Redis write operations and blocking write operations on replication.
</p>
<p>
Redis Enterprise Software comes with the ability to replicate data
to another database instance for high availability and persist in-memory data on
disk permanently for durability. With the
<a href="/docs/latest/commands/wait/">
<code>
WAIT
</code>
</a>
command, you can
control the consistency and durability guarantees for the replicated and
persisted database.
</p>
<h2 id="non-blocking-redis-write-operation">
Non-blocking Redis write operation
</h2>
<p>
Any updates that are issued to the database are typically performed with the following flow:
</p>
<ol>
<li>
The application issues a write.
</li>
<li>
The proxy communicates with the correct primary (also known as master) shard in the system that contains the given key.
</li>
<li>
The shard writes the data and sends an acknowledgment to the proxy.
</li>
<li>
The proxy sends the acknowledgment back to the application.
</li>
<li>
The write is communicated from the primary shard to the replica.
</li>
<li>
The replica acknowledges the write back to the primary shard.
</li>
<li>
The write to a replica is persisted to disk.
</li>
<li>
The write is acknowledged within the replica.
</li>
</ol>
<a href="/docs/latest/images/rs/weak-consistency.png" sdata-lightbox="/images/rs/weak-consistency.png">
<img src="/docs/latest/images/rs/weak-consistency.png"/>
</a>
<h2 id="blocking-write-operation-on-replication">
Blocking write operation on replication
</h2>
<p>
With the
<a href="/docs/latest/commands/wait/">
<code>
WAIT
</code>
</a>
or
<a href="/docs/latest/commands/waitaof/">
<code>
WAITAOF
</code>
</a>
commands, applications can ask to wait for
acknowledgments only after replication or persistence is confirmed on
the replica. The flow of a write operation with
<code>
WAIT
</code>
or
<code>
WAITAOF
</code>
is:
</p>
<ol>
<li>
The application issues a write.
</li>
<li>
The proxy communicates with the correct primary shard in the system that contains the given key.
</li>
<li>
Replication communicates the update to the replica shard.
</li>
<li>
If using
<code>
WAITAOF
</code>
and the AOF every write setting, the replica persists the update to disk before sending the acknowledgment.
</li>
<li>
The acknowledgment is sent back from the replica all the way to the proxy with steps 5 to 8.
</li>
</ol>
<p>
The application only gets the acknowledgment from the write after durability is achieved with replication to the replica for
<code>
WAIT
</code>
or
<code>
WAITAOF
</code>
and to the persistent storage for
<code>
WAITAOF
</code>
only.
</p>
<a href="/docs/latest/images/rs/strong-consistency.png" sdata-lightbox="/images/rs/strong-consistency.png">
<img src="/docs/latest/images/rs/strong-consistency.png"/>
</a>
<p>
The
<code>
WAIT
</code>
command always returns the number of replicas that acknowledged the write commands sent by the current client before the
<code>
WAIT
</code>
command, both in the case where the specified number of replicas are reached, or when the timeout is reached. In Redis Enterprise Software, the number of replicas for HA enabled databases is always 1.
</p>
<p>
See the
<a href="/docs/latest/commands/waitaof/">
<code>
WAITAOF
</code>
</a>
command for details for enhanced data safety and durability capabilities introduced with Redis 7.2.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/durability-ha/consistency/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/time/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TIME
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TIME</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.6.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The
<code>
TIME
</code>
command returns the current server time as a two items lists: a Unix
timestamp and the amount of microseconds already elapsed in the current second.
Basically the interface is very similar to the one of the
<code>
gettimeofday
</code>
system
call.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> TIME
1) "1731581516"
2) "813341"
redis> TIME
1) "1731581516"
2) "813581"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: specifically, a two-element array consisting of the Unix timestamp in seconds and the microseconds' count.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/time/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/clusters/optimize/wait/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Use the WAIT command to improve data safety and durability
</h1>
<p class="text-lg -mt-5 mb-10">
Use the wait command to take full advantage of Redis Enterprise Software's replication-based durability.
</p>
<p>
Redis Enterprise Software comes with the ability to replicate data
to another replica for high availability and persist in-memory data on
disk permanently for durability. With the
<a href="/docs/latest/commands/wait/">
<code>
WAIT
</code>
</a>
command, you can
control the consistency and durability guarantees for the replicated and
persisted database.
</p>
<h2 id="non-blocking-redis-write-operation">
Non-blocking Redis write operation
</h2>
<p>
Any updates that are issued to the database are typically performed with the following flow:
</p>
<ol>
<li>
Application issues a write.
</li>
<li>
Proxy communicates with the correct primary shard in the system that contains the given key.
</li>
<li>
The acknowledgment is sent to proxy after the write operation completes.
</li>
<li>
The proxy sends the acknowledgment back to the application.
</li>
</ol>
<p>
Independently, the write is communicated from the primary shard to the replica, and
replication acknowledges the write back to the primary shard. These are steps 5 and 6.
</p>
<p>
Independently, the write to a replica is also persisted to disk and
acknowledged within the replica. These are steps 7 and 8.
</p>
<a href="/docs/latest/images/rs/weak-consistency.png" sdata-lightbox="/images/rs/weak-consistency.png">
<img src="/docs/latest/images/rs/weak-consistency.png"/>
</a>
<h2 id="blocking-write-operation-on-replication">
Blocking write operation on replication
</h2>
<p>
With the
<a href="/docs/latest/commands/wait/">
<code>
WAIT
</code>
</a>
or
<a href="/docs/latest/commands/waitaof/">
<code>
WAITAOF
</code>
</a>
commands, applications can ask to wait for
acknowledgments only after replication or persistence is confirmed on
the replica. The flow of a write operation with
<code>
WAIT
</code>
or
<code>
WAITAOF
</code>
is:
</p>
<ol>
<li>
The application issues a write.
</li>
<li>
The proxy communicates with the correct primary shard in the system that contains the given key.
</li>
<li>
Replication communicates the update to the replica shard.
</li>
<li>
If using
<code>
WAITAOF
</code>
and the AOF every write setting, the replica persists the update to disk before sending the acknowledgment.
</li>
<li>
The acknowledgment is sent back from the replica all the way to the proxy with steps 5 to 8.
</li>
</ol>
<p>
The application only gets the acknowledgment from the write after durability is achieved with replication to the replica for
<code>
WAIT
</code>
or
<code>
WAITAOF
</code>
and to the persistent storage for
<code>
WAITAOF
</code>
only.
</p>
<a href="/docs/latest/images/rs/strong-consistency.png" sdata-lightbox="/images/rs/strong-consistency.png">
<img src="/docs/latest/images/rs/strong-consistency.png"/>
</a>
<p>
The
<code>
WAIT
</code>
command always returns the number of replicas that acknowledged the write commands sent by the current client before the
<code>
WAIT
</code>
command, both in the case where the specified number of replicas are reached, or when the timeout is reached. In Redis Enterprise Software, the number of replicas is always 1 for databases with high availability enabled.
</p>
<p>
See the
<a href="/docs/latest/commands/waitaof/">
<code>
WAITAOF
</code>
</a>
command for details for enhanced data safety and durability capabilities introduced with Redis 7.2.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/clusters/optimize/wait/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/networking/ingressorroutespec/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Establish external routing on the RedisEnterpriseCluster
</h1>
<p>
An Ingress is an API resource that provides a standardized and flexible way to manage external access to services running within a Kubernetes cluster.
</p>
<h2 id="install-ingress-controller">
Install Ingress controller
</h2>
<p>
Redis Enterprise for Kubernetes supports the Ingress controllers below:
</p>
<ul>
<li>
<a href="https://haproxy-ingress.github.io/">
HAProxy
</a>
</li>
<li>
<a href="https://kubernetes.github.io/ingress-nginx/">
NGINX
</a>
</li>
<li>
<a href="https://istio.io/latest/docs/setup/getting-started/">
Istio
</a>
</li>
</ul>
<p>
OpenShift users can use
<a href="/docs/latest/operate/kubernetes/networking/routes/">
routes
</a>
instead of an Ingress.
</p>
<p>
Install your chosen Ingress controller, making sure
<code>
ssl-passthrough
</code>
is enabled.
<code>
ssl-passthrough
</code>
is turned off by default for NGINX but enabled by default for HAProxy.
</p>
<h2 id="configure-dns">
Configure DNS
</h2>
<ol>
<li>
<p>
Choose the hostname (FQDN) you will use to access your database according to the recommended naming conventions below, replacing
<code>
<placeholders>
</code>
with your own values.
</p>
<p>
REC API hostname:
<code>
api-<rec-name>-<rec-namespace>.<subdomain>
</code>
REAADB hostname:
<code>
-db-<rec-name>-<rec-namespace>.<subdomain>
</code>
</p>
<p>
We recommend using a wildcard (
<code>
*
</code>
) in place of the database name, followed by the hostname suffix.
</p>
</li>
<li>
<p>
Retrieve the
<code>
EXTERNAL-IP
</code>
of your Ingress controller's
<code>
LoadBalancer
</code>
service.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ kubectl get svc <haproxy-ingress <span class="p">|</span> ingress-ngnix-controller> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -n <ingress-ctrl-namespace>
</span></span></code></pre>
</div>
<p>
Below is example output for an HAProxy ingress controller running on a K8s cluster hosted by AWS.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">NAME TYPE CLUSTER-IP EXTERNAL-IP PORT<span class="o">(</span>S<span class="o">)</span> AGE
</span></span><span class="line"><span class="cl">haproxy-ingress LoadBalancer 10.43.62.53 a56e24df8c6173b79a63d5da54fd9cff-676486416.us-east-1.elb.amazonaws.com 80:30610/TCP,443:31597/TCP 21m
</span></span></code></pre>
</div>
</li>
<li>
<p>
Create DNS records to resolve your chosen REC API hostname and database hostname to the
<code>
EXTERNAL-IP
</code>
found in the previous step.
</p>
</li>
</ol>
<h2 id="edit-the-rec-spec">
Edit the REC spec
</h2>
<p>
Edit the RedisEnterpriseCluster (REC) spec to add the
<code>
ingressOrRouteSpec
</code>
field, replacing
<code>
<placeholders>
</code>
below with your own values.
</p>
<h3 id="nginx-or-haproxy-ingress-controllers">
NGINX or HAproxy ingress controllers
</h3>
<ul>
<li>
Define the REC API hostname (
<code>
apiFqdnUrl
</code>
) and database hostname suffix (
<code>
dbFqdnSuffix
</code>
) you chose when configuring DNS.
</li>
<li>
Set
<code>
method
</code>
to
<code>
ingress
</code>
.
</li>
<li>
Set
<code>
ssl-passthrough
</code>
to "true".
</li>
<li>
Add any additional annotations required for your ingress controller. See
<a href="https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/">
NGINX docs
</a>
or
<a href="https://haproxy-ingress.github.io/docs/configuration/keys/">
HAproxy docs
</a>
for more information.
</li>
</ul>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl patch rec <rec-name> --type merge --patch <span class="s2">"{\"spec\": \
</span></span></span><span class="line"><span class="cl"><span class="s2"> {\"ingressOrRouteSpec\": \
</span></span></span><span class="line"><span class="cl"><span class="s2"> {\"apiFqdnUrl\": \"api-<rec-name>-<rec-namespace>.example.com\", \
</span></span></span><span class="line"><span class="cl"><span class="s2"> \"dbFqdnSuffix\": \"-db-<rec-name>-<rec-namespace>.example.com\", \
</span></span></span><span class="line"><span class="cl"><span class="s2"> \"ingressAnnotations\": \
</span></span></span><span class="line"><span class="cl"><span class="s2"> {\"<kubernetes | github>.io/ingress.class\": \
</span></span></span><span class="line"><span class="cl"><span class="s2"> \"<ingress-controller>\", \
</span></span></span><span class="line"><span class="cl"><span class="s2"> \"<ingress-controller-annotation>/ssl-passthrough\": \ \"true\"}, \
</span></span></span><span class="line"><span class="cl"><span class="s2"> \"method\": \"ingress\"}}}"</span>
</span></span></code></pre>
</div>
<h3 id="openshift-routes">
OpenShift routes
</h3>
<ul>
<li>
Define the REC API hostname (
<code>
apiFqdnUrl
</code>
) and database hostname suffix (
<code>
dbFqdnSuffix
</code>
) you chose when configuring DNS.
</li>
<li>
Set
<code>
method
</code>
to
<code>
openShiftRoute
</code>
.
</li>
</ul>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl patch rec <rec-name> --type merge --patch <span class="s2">"{\"spec\": \
</span></span></span><span class="line"><span class="cl"><span class="s2"> {\"ingressOrRouteSpec\": \
</span></span></span><span class="line"><span class="cl"><span class="s2"> {\"apiFqdnUrl\": \"api-<rec-name>-<rec-namespace>.example.com\" \
</span></span></span><span class="line"><span class="cl"><span class="s2"> \"dbFqdnSuffix\": \"-db-<rec-name>-<rec-namespace>.example.com\", \
</span></span></span><span class="line"><span class="cl"><span class="s2"> \"method\": \"openShiftRoute\"}}}"</span>
</span></span></code></pre>
</div>
<p>
OpenShift routes do not require any
<code>
ingressAnnotations
</code>
in the
<code>
ingressOrRouteSpec
</code>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/networking/ingressorroutespec/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-115/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise Software release notes 6.4.2-115 (Oct 2024)
</h1>
<p class="text-lg -mt-5 mb-10">
RediSearch v2.6.23. RedisBloom v2.4.12. RedisTimeSeries v1.8.15.
</p>
<p>
This is a maintenance release for
<a href="https://redis.com/redis-enterprise-software/download-center/software/">
Redis Enterprise Software version 6.4.2
</a>
.
</p>
<h2 id="highlights">
Highlights
</h2>
<p>
This version offers:
</p>
<ul>
<li>
<p>
RediSearch v2.6.23
</p>
</li>
<li>
<p>
RedisBloom v2.4.12
</p>
</li>
<li>
<p>
RedisTimeSeries v1.8.15
</p>
</li>
</ul>
<h2 id="new-in-this-release">
New in this release
</h2>
<h3 id="enhancements">
Enhancements
</h3>
<h4 id="redis-modules">
Redis modules
</h4>
<p>
Redis Enterprise Software version 6.4.2-115 includes the following Redis Stack modules:
</p>
<ul>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.6-release-notes">
RediSearch v2.6.23
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.4-release-notes">
RedisJSON v2.4.7
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.4-release-notes">
RedisBloom v2.4.12
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.10-release-notes">
RedisGraph v2.10.15
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.8-release-notes">
RedisTimeSeries v1.8.15
</a>
</p>
</li>
</ul>
<h2 id="version-changes">
Version changes
</h2>
<h3 id="supported-platforms">
Supported platforms
</h3>
<p>
The following table provides a snapshot of supported platforms as of this Redis Enterprise Software release. See the
<a href="/docs/latest/operate/rs/references/supported-platforms/">
supported platforms reference
</a>
for more details about operating system compatibility.
</p>
<p>
<span title="Check mark icon">
✅
</span>
Supported – The platform is supported for this version of Redis Enterprise Software and Redis Stack modules.
</p>
<p>
<span class="font-serif" title="Warning icon">
⚠️
</span>
Deprecation warning – The platform is still supported for this version of Redis Enterprise Software, but support will be removed in a future release.
</p>
<table>
<thead>
<tr>
<th>
Redis Enterprise
<br/>
major versions
</th>
<th style="text-align:center">
7.4
</th>
<th style="text-align:center">
7.2
</th>
<th style="text-align:center">
6.4
</th>
<th style="text-align:center">
6.2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
Release date
</strong>
</td>
<td style="text-align:center">
Feb 2024
</td>
<td style="text-align:center">
Aug 2023
</td>
<td style="text-align:center">
Feb 2023
</td>
<td style="text-align:center">
Aug 2021
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/installing-upgrading/product-lifecycle/#endoflife-schedule">
<strong>
End-of-life date
</strong>
</a>
</td>
<td style="text-align:center">
Determined after
<br/>
next major release
</td>
<td style="text-align:center">
Feb 2026
</td>
<td style="text-align:center">
Aug 2025
</td>
<td style="text-align:center">
Feb 2025
</td>
</tr>
<tr>
<td>
<strong>
Platforms
</strong>
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
</td>
</tr>
<tr>
<td>
RHEL 9 &
<br/>
compatible distros
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
</tr>
<tr>
<td>
RHEL 8 &
<br/>
compatible distros
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
RHEL 7 &
<br/>
compatible distros
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
Ubuntu 20.04
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
–
</td>
</tr>
<tr>
<td>
Ubuntu 18.04
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</span>
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
Ubuntu 16.04
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
Amazon Linux 2
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
–
</td>
</tr>
<tr>
<td>
Amazon Linux 1
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
Kubernetes
<sup>
<a href="#table-note-3">
3
</a>
</sup>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
Docker
<sup>
<a href="#table-note-4">
4
</a>
</sup>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
</tbody>
</table>
<ol>
<li>
<p>
<a name="table-note-1" style="display: block; height: 80px; margin-top: -80px;">
</a>
The RHEL-compatible distributions CentOS, CentOS Stream, Alma, and Rocky are supported if they have full RHEL compatibility. Oracle Linux running the Red Hat Compatible Kernel (RHCK) is supported, but the Unbreakable Enterprise Kernel (UEK) is not supported.
</p>
</li>
<li>
<p>
<a name="table-note-2" style="display: block; height: 80px; margin-top: -80px;">
</a>
The server version of Ubuntu is recommended for production installations. The desktop version is only recommended for development deployments.
</p>
</li>
<li>
<p>
<a name="table-note-3" style="display: block; height: 80px; margin-top: -80px;">
</a>
See the
<a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/">
Redis Enterprise for Kubernetes documentation
</a>
for details about support per version and Kubernetes distribution.
</p>
</li>
<li>
<p>
<a name="table-note-4" style="display: block; height: 80px; margin-top: -80px;">
</a>
<a href="/docs/latest/operate/rs/installing-upgrading/quickstarts/docker-quickstart/">
Docker images
</a>
of Redis Enterprise Software are certified for development and testing only.
</p>
</li>
</ol>
<h2 id="downloads">
Downloads
</h2>
<p>
The following table shows the MD5 checksums for the available packages:
</p>
<table>
<thead>
<tr>
<th>
Package
</th>
<th>
MD5 checksum (6.4.2-115 Oct release)
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Ubuntu 16
</td>
<td>
5fb2186abb6c87efebd987ebf827b949
</td>
</tr>
<tr>
<td>
Ubuntu 18
</td>
<td>
e8a938c7125fbc7d7f85f0e19d4afafb
</td>
</tr>
<tr>
<td>
Red Hat Enterprise Linux (RHEL) 7
</td>
<td>
dc646920043bd888299726027d9e9216
</td>
</tr>
<tr>
<td>
Red Hat Enterprise Linux (RHEL) 8
</td>
<td>
54574ca69f2966f7361f281f1ea3b312
</td>
</tr>
<tr>
<td>
Amazon Linux 2
</td>
<td>
8315ba719f1549e8bf423a9db004d49c
</td>
</tr>
</tbody>
</table>
<h2 id="security">
Security
</h2>
<h4 id="open-source-redis-security-fixes-compatibility">
Open source Redis security fixes compatibility
</h4>
<p>
As part of Redis's commitment to security, Redis Enterprise Software implements the latest
<a href="https://github.com/redis/redis/releases">
security fixes
</a>
available with
<a href="https://github.com/redis/redis">
open source Redis
</a>
. Redis Enterprise has already included the fixes for the relevant CVEs.
</p>
<p>
Some CVEs announced for open source Redis do not affect Redis Enterprise due to different or additional functionality available in Redis Enterprise that is not available in open source Redis.
</p>
<p>
Redis Enterprise 6.4.2-115 supports open source Redis 6.2 and 6.0. Below is the list of open source Redis CVEs fixed by version.
</p>
<p>
Redis 6.2.x:
</p>
<ul>
<li>
<p>
(CVE-2024-31449) An authenticated user may use a specially crafted Lua script to trigger a stack buffer overflow in the bit library, which may potentially lead to remote code execution.
</p>
</li>
<li>
<p>
(CVE-2024-31228) An authenticated user can trigger a denial-of-service by using specially crafted, long string match patterns on supported commands such as
<code>
KEYS
</code>
,
<code>
SCAN
</code>
,
<code>
PSUBSCRIBE
</code>
,
<code>
FUNCTION LIST
</code>
,
<code>
COMMAND LIST
</code>
, and ACL definitions. Matching of extremely long patterns may result in unbounded recursion, leading to stack overflow and process crashes.
</p>
</li>
<li>
<p>
(CVE-2023-45145) The wrong order of listen(2) and chmod(2) calls creates a
race condition that can be used by another process to bypass desired Unix
socket permissions on startup. (Redis 6.2.14)
</p>
</li>
<li>
<p>
(CVE-2023-28856) Authenticated users can use the
<code>
HINCRBYFLOAT
</code>
command to create an invalid hash field that will crash Redis on access. (Redis 6.2.12)
</p>
</li>
<li>
<p>
(CVE-2023-25155) Specially crafted
<code>
SRANDMEMBER
</code>
,
<code>
ZRANDMEMBER
</code>
, and
<code>
HRANDFIELD
</code>
commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 6.2.11)
</p>
</li>
<li>
<p>
(CVE-2023-22458) Integer overflow in the Redis
<code>
HRANDFIELD
</code>
and
<code>
ZRANDMEMBER
</code>
commands can lead to denial-of-service. (Redis 6.2.9)
</p>
</li>
<li>
<p>
(CVE-2022-36021) String matching commands (like
<code>
SCAN
</code>
or
<code>
KEYS
</code>
) with a specially crafted pattern to trigger a denial-of-service attack on Redis, can cause it to hang and consume 100% CPU time. (Redis 6.2.11)
</p>
</li>
<li>
<p>
(CVE-2022-35977) Integer overflow in the Redis
<code>
SETRANGE
</code>
and
<code>
SORT
</code>
/
<code>
SORT_RO
</code>
commands can drive Redis to OOM panic. (Redis 6.2.9)
</p>
</li>
<li>
<p>
(CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 6.2.13)
</p>
</li>
<li>
<p>
(CVE-2022-24736) An attacker attempting to load a specially crafted Lua script can cause NULL pointer dereference which will result in a crash of the
<code>
redis-server
</code>
process. This issue affects all versions of Redis. (Redis 6.2.7)
</p>
</li>
<li>
<p>
(CVE-2022-24735) By exploiting weaknesses in the Lua script execution environment, an attacker with access to Redis can inject Lua code that will execute with the (potentially higher) privileges of another Redis user. (Redis 6.2.7)
</p>
</li>
<li>
<p>
(CVE-2021-41099) Integer to heap buffer overflow can occur when handling certain string commands and network payloads, when
<code>
proto-max-bulk-len
</code>
is manually configured to a non-default, very large value. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32762) Integer to heap buffer overflow issue in
<code>
redis-cli
</code>
and
<code>
redis-sentinel
</code>
can occur when parsing large multi-bulk replies on some older and less common platforms. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32761) An integer overflow bug in Redis version 2.2 or newer can be exploited using the
<code>
BITFIELD
</code>
command to corrupt the heap and potentially result with remote code execution. (Redis 6.2.5)
</p>
</li>
<li>
<p>
(CVE-2021-32687) Integer to heap buffer overflow with intsets, when
<code>
set-max-intset-entries
</code>
is manually configured to a non-default, very large value. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32675) Denial Of Service when processing RESP request payloads with a large number of elements on many connections. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32672) Random heap reading issue with Lua Debugger. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32628) Integer to heap buffer overflow handling ziplist-encoded data types, when configuring a large, non-default value for
<code>
hash-max-ziplist-entries
</code>
,
<code>
hash-max-ziplist-value
</code>
,
<code>
zset-max-ziplist-entries
</code>
or
<code>
zset-max-ziplist-value
</code>
. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32627) Integer to heap buffer overflow issue with streams, when configuring a non-default, large value for
<code>
proto-max-bulk-len
</code>
and
<code>
client-query-buffer-limit
</code>
. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32626) Specially crafted Lua scripts may result with Heap buffer overflow. (Redis 6.2.6)
</p>
</li>
<li>
<p>
(CVE-2021-32625) An integer overflow bug in Redis version 6.0 or newer can be exploited using the STRALGO LCS command to corrupt the heap and potentially result with remote code execution. This is a result of an incomplete fix by CVE-2021-29477. (Redis 6.2.4)
</p>
</li>
<li>
<p>
(CVE-2021-29478) An integer overflow bug in Redis 6.2 could be exploited to corrupt the heap and potentially result with remote code execution. The vulnerability involves changing the default set-max-intset-entries configuration value, creating a large set key that consists of integer values and using the COPY command to duplicate it. The integer overflow bug exists in all versions of Redis starting with 2.6, where it could result with a corrupted RDB or DUMP payload, but not exploited through COPY (which did not exist before 6.2). (Redis 6.2.3)
</p>
</li>
<li>
<p>
(CVE-2021-29477) An integer overflow bug in Redis version 6.0 or newer could be exploited using the STRALGO LCS command to corrupt the heap and potentially result in remote code execution. The integer overflow bug exists in all versions of Redis starting with 6.0. (Redis 6.2.3)
</p>
</li>
</ul>
<p>
Redis 6.0.x:
</p>
<ul>
<li>
<p>
(CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 6.0.20)
</p>
</li>
<li>
<p>
(CVE-2023-28856) Authenticated users can use the
<code>
HINCRBYFLOAT
</code>
command to create an invalid hash field that will crash Redis on access. (Redis 6.0.19)
</p>
</li>
<li>
<p>
(CVE-2023-25155) Specially crafted
<code>
SRANDMEMBER
</code>
,
<code>
ZRANDMEMBER
</code>
, and
<code>
HRANDFIELD
</code>
commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 6.0.18)
</p>
</li>
<li>
<p>
(CVE-2022-36021) String matching commands (like
<code>
SCAN
</code>
or
<code>
KEYS
</code>
) with a specially crafted pattern to trigger a denial-of-service attack on Redis, causing it to hang and consume 100% CPU time. (Redis 6.0.18)
</p>
</li>
<li>
<p>
(CVE-2022-35977) Integer overflow in the Redis
<code>
SETRANGE
</code>
and
<code>
SORT
</code>
/
<code>
SORT_RO
</code>
commands can drive Redis to OOM panic. (Redis 6.0.17)
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-115/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/.html | <section class="prose w-full py-12 max-w-none">
<h1>
REST API
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the REST API available to Redis Enterprise Software deployments.
</p>
<p>
Redis Enterprise Software provides a REST API to help you automate common tasks.
</p>
<p>
Here, you'll find the details of the API and how to use it.
</p>
<p>
For more info, see:
</p>
<ul>
<li>
Supported
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/">
request endpoints
</a>
, organized by path
</li>
<li>
Supported
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/">
objects
</a>
, both request and response
</li>
<li>
Built-in roles and associated
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/">
permissions
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/quick-start/">
Redis Enterprise Software REST API quick start
</a>
with examples
</li>
</ul>
<h2 id="authentication">
Authentication
</h2>
<p>
Authentication to the Redis Enterprise Software API occurs via
<a href="https://en.wikipedia.org/wiki/Basic_access_authentication">
Basic Auth
</a>
. Provide your username and password as the basic auth credentials.
</p>
<p>
If the username and password is incorrect or missing, the request will fail with a
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized">
<code>
401 Unauthorized
</code>
</a>
status code.
</p>
<p>
Example request using
<a href="https://curl.se/">
cURL
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">curl -u <span class="s2">"[email protected]:password"</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> https://localhost:9443/v1/bdbs
</span></span></code></pre>
</div>
<p>
For more examples, see the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/quick-start/">
Redis Enterprise Software REST API quick start
</a>
.
</p>
<h3 id="permissions">
Permissions
</h3>
<p>
By default, the admin user is authorized for access to all endpoints. Use
<a href="/docs/latest/operate/rs/7.4/security/access-control/">
role-based access controls
</a>
and
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/">
role permissions
</a>
to manage access.
</p>
<p>
If a user attempts to access an endpoint that is not allowed in their role, the request will fail with a
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden">
<code>
403 Forbidden
</code>
</a>
status code. For more details on which user roles can access certain endpoints, see
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/">
Permissions
</a>
.
</p>
<h3 id="certificates">
Certificates
</h3>
<p>
The Redis Enterprise Software REST API uses
<a href="/docs/latest/operate/rs/7.4/security/certificates/">
Self-signed certificates
</a>
to ensure the product is secure. When you use the default self-signed certificates, the HTTPS requests will fail with
<code>
SSL certificate problem: self signed certificate
</code>
unless you turn off SSL certificate verification.
</p>
<h2 id="ports">
Ports
</h2>
<p>
All calls must be made over SSL to port 9443. For the API to work, port 9443 must be exposed to incoming traffic or mapped to a different port.
</p>
<p>
If you are using a
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart/">
Redis Enterprise Software Docker image
</a>
, run the following command to start the Docker image with port 9443 exposed:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">docker run -p 9443:9443 redislabs/redis
</span></span></code></pre>
</div>
<h2 id="versions">
Versions
</h2>
<p>
All API requests are versioned in order to minimize the impact of backwards-incompatible API changes and to coordinate between different versions operating in parallel.
</p>
<p>
Specify the version in the request
<a href="https://en.wikipedia.org/wiki/Uniform_Resource_Identifier">
URI
</a>
, as shown in the following table:
</p>
<table>
<thead>
<tr>
<th>
Request path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
POST
<code>
/v1/bdbs
</code>
</td>
<td>
A version 1 request for the
<code>
/bdbs
</code>
endpoint.
</td>
</tr>
<tr>
<td>
POST
<code>
/v2/bdbs
</code>
</td>
<td>
A version 2 request for the
<code>
/bdbs
</code>
endpoint.
</td>
</tr>
</tbody>
</table>
<p>
When an endpoint supports multiple versions, each version is documented on the corresponding endpoint. For example, the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/">
bdbs request
</a>
page documents POST requests for
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/#post-bdbs-v1">
version 1
</a>
and
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/#post-bdbs-v2">
version 2
</a>
.
</p>
<h2 id="headers">
Headers
</h2>
<h3 id="requests">
Requests
</h3>
<p>
Redis Enterprise REST API requests support the following HTTP headers:
</p>
<table>
<thead>
<tr>
<th>
Header
</th>
<th>
Supported/Required Values
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Accept
</td>
<td>
<code>
application/json
</code>
</td>
</tr>
<tr>
<td>
Content-Length
</td>
<td>
Length (in bytes) of request message
</td>
</tr>
<tr>
<td>
Content-Type
</td>
<td>
<code>
application/json
</code>
(required for PUT or POST requests)
</td>
</tr>
</tbody>
</table>
<p>
If the client specifies an invalid header, the request will fail with a
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request">
<code>
400 Bad Request
</code>
</a>
status code.
</p>
<h3 id="responses">
Responses
</h3>
<p>
Redis Enterprise REST API responses support the following HTTP headers:
</p>
<table>
<thead>
<tr>
<th>
Header
</th>
<th>
Supported/Required Values
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Content-Type
</td>
<td>
<code>
application/json
</code>
</td>
</tr>
<tr>
<td>
Content-Length
</td>
<td>
Length (in bytes) of response message
</td>
</tr>
</tbody>
</table>
<h2 id="json-requests-and-responses">
JSON requests and responses
</h2>
<p>
The Redis Enterprise Software REST API uses
<a href="http://www.json.org">
JavaScript Object Notation (JSON)
</a>
for requests and responses. See the
<a href="http://www.ietf.org/rfc/rfc4627.txt">
RFC 4627 technical specifications
</a>
for additional information about JSON.
</p>
<p>
Some responses may have an empty body but indicate the response with standard
<a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">
HTTP codes
</a>
.
</p>
<p>
Both requests and responses may include zero or more objects.
</p>
<p>
If the request is for a single entity, the response returns a single JSON object or none. If the request is for a list of entities, the response returns a JSON array with zero or more elements.
</p>
<p>
If you omit certain JSON object fields from a request, they may be assigned default values, which often indicate that these fields are not in use.
</p>
<h2 id="response-types-and-error-codes">
Response types and error codes
</h2>
<p>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codes">
HTTP status codes
</a>
indicate the result of an API request. This can be
<code>
200 OK
</code>
if the server accepted the request, or it can be one of many error codes.
</p>
<p>
The most common responses for a Redis Enterprise API request are:
</p>
<table>
<thead>
<tr>
<th>
Response
</th>
<th>
Condition/Required handling
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
Success
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request">
400 Bad Request
</a>
</td>
<td>
The request failed, generally due to a typo or other mistake.
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized">
401 Unauthorized
</a>
</td>
<td>
The request failed because the authentication information was missing or incorrect.
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden">
403 Forbidden
</a>
</td>
<td>
The user cannot access the specified
<a href="https://en.wikipedia.org/wiki/Uniform_Resource_Identifier">
URI
</a>
.
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found">
404 Not Found
</a>
</td>
<td>
The
<a href="https://en.wikipedia.org/wiki/Uniform_Resource_Identifier">
URI
</a>
does not exist.
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable">
503 Service Unavailable
</a>
</td>
<td>
The node is not responding or is not a member of the cluster.
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-suppor">
505 HTTP Version Not Supported
</a>
</td>
<td>
An unsupported
<code>
x-api-version
</code>
was used. See
<a href="#versions">
versions
</a>
.
</td>
</tr>
</tbody>
</table>
<p>
Some endpoints return different response codes. The request references for these endpoints document these special cases.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/management/optimization/latency-monitor/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis latency monitoring
</h1>
<p class="text-lg -mt-5 mb-10">
Discovering slow server events in Redis
</p>
<p>
Redis is often used for demanding use cases, where it
serves a large number of queries per second per instance, but also has strict latency requirements for the average response
time and the worst-case latency.
</p>
<p>
While Redis is an in-memory system, it deals with the operating system in
different ways, for example, in the context of persisting to disk.
Moreover Redis implements a rich set of commands. Certain commands
are fast and run in constant or logarithmic time. Other commands are slower
O(N) commands that can cause latency spikes.
</p>
<p>
Finally, Redis is single threaded. This is usually an advantage
from the point of view of the amount of work it can perform per core, and in
the latency figures it is able to provide. However, it poses
a challenge for latency, since the single
thread must be able to perform certain tasks incrementally, for
example key expiration, in a way that does not impact the other clients
that are served.
</p>
<p>
For all these reasons, Redis 2.8.13 introduced a new feature called
<strong>
Latency Monitoring
</strong>
, that helps the user to check and troubleshoot possible
latency problems. Latency monitoring is composed of the following conceptual
parts:
</p>
<ul>
<li>
Latency hooks that sample different latency-sensitive code paths.
</li>
<li>
Time series recording of latency spikes, split by different events.
</li>
<li>
Reporting engine to fetch raw data from the time series.
</li>
<li>
Analysis engine to provide human-readable reports and hints according to the measurements.
</li>
</ul>
<p>
The rest of this document covers the latency monitoring subsystem
details. For more information about the general topic of Redis
and latency, see
<a href="/docs/latest/operate/oss_and_stack/management/optimization/latency/">
Redis latency problems troubleshooting
</a>
.
</p>
<h2 id="events-and-time-series">
Events and time series
</h2>
<p>
Different monitored code paths have different names and are called
<em>
events
</em>
.
For example,
<code>
command
</code>
is an event that measures latency spikes of possibly slow
command executions, while
<code>
fast-command
</code>
is the event name for the monitoring
of the O(1) and O(log N) commands. Other events are less generic and monitor
specific operations performed by Redis. For example, the
<code>
fork
</code>
event
only monitors the time taken by Redis to execute the
<code>
fork(2)
</code>
system call.
</p>
<p>
A latency spike is an event that takes more time to run than the configured latency
threshold. There is a separate time series associated with every monitored
event. This is how the time series work:
</p>
<ul>
<li>
Every time a latency spike happens, it is logged in the appropriate time series.
</li>
<li>
Every time series is composed of 160 elements.
</li>
<li>
Each element is a pair made of a Unix timestamp of the time the latency spike was measured and the number of milliseconds the event took to execute.
</li>
<li>
Latency spikes for the same event that occur in the same second are merged by taking the maximum latency. Even if continuous latency spikes are measured for a given event, which could happen with a low threshold, at least 160 seconds of history are available.
</li>
<li>
Records the all-time maximum latency for every element.
</li>
</ul>
<p>
The framework monitors and logs latency spikes in the execution time of these events:
</p>
<ul>
<li>
<code>
command
</code>
: regular commands.
</li>
<li>
<code>
fast-command
</code>
: O(1) and O(log N) commands.
</li>
<li>
<code>
fork
</code>
: the
<code>
fork(2)
</code>
system call.
</li>
<li>
<code>
rdb-unlink-temp-file
</code>
: the
<code>
unlink(2)
</code>
system call.
</li>
<li>
<code>
aof-fsync-always
</code>
: the
<code>
fsync(2)
</code>
system call when invoked by the
<code>
appendfsync allways
</code>
policy.
</li>
<li>
<code>
aof-write
</code>
: writing to the AOF - a catchall event for
<code>
write(2)
</code>
system calls.
</li>
<li>
<code>
aof-write-pending-fsync
</code>
: the
<code>
write(2)
</code>
system call when there is a pending fsync.
</li>
<li>
<code>
aof-write-active-child
</code>
: the
<code>
write(2)
</code>
system call when there are active child processes.
</li>
<li>
<code>
aof-write-alone
</code>
: the
<code>
write(2)
</code>
system call when no pending fsync and no active child process.
</li>
<li>
<code>
aof-fstat
</code>
: the
<code>
fstat(2)
</code>
system call.
</li>
<li>
<code>
aof-rename
</code>
: the
<code>
rename(2)
</code>
system call for renaming the temporary file after completing
<a href="/commands/bgrewriteaof">
<code>
BGREWRITEAOF
</code>
</a>
.
</li>
<li>
<code>
aof-rewrite-diff-write
</code>
: writing the differences accumulated while performing
<a href="/commands/bgrewriteaof">
<code>
BGREWRITEAOF
</code>
</a>
.
</li>
<li>
<code>
active-defrag-cycle
</code>
: the active defragmentation cycle.
</li>
<li>
<code>
expire-cycle
</code>
: the expiration cycle.
</li>
<li>
<code>
eviction-cycle
</code>
: the eviction cycle.
</li>
<li>
<code>
eviction-del
</code>
: deletes during the eviction cycle.
</li>
</ul>
<h2 id="how-to-enable-latency-monitoring">
How to enable latency monitoring
</h2>
<p>
What is high latency for one use case may not be considered high latency for another. Some applications may require that all queries be served in less than 1 millisecond. For other applications, it may be acceptable for a small amount of clients to experience a 2 second latency on occasion.
</p>
<p>
The first step to enable the latency monitor is to set a
<strong>
latency threshold
</strong>
in milliseconds. Only events that take longer than the specified threshold will be logged as latency spikes. The user should set the threshold according to their needs. For example, if the application requires a maximum acceptable latency of 100 milliseconds, the threshold should be set to log all the events blocking the server for a time equal or greater to 100 milliseconds.
</p>
<p>
Enable the latency monitor at runtime in a production server
with the following command:
</p>
<pre><code>CONFIG SET latency-monitor-threshold 100
</code></pre>
<p>
Monitoring is turned off by default (threshold set to 0), even if the actual cost of latency monitoring is near zero. While the memory requirements of latency monitoring are very small, there is no good reason to raise the baseline memory usage of a Redis instance that is working well.
</p>
<h2 id="report-information-with-the-latency-command">
Report information with the LATENCY command
</h2>
<p>
The user interface to the latency monitoring subsystem is the
<a href="/commands/latency">
<code>
LATENCY
</code>
</a>
command.
Like many other Redis commands,
<a href="/commands/latency">
<code>
LATENCY
</code>
</a>
accepts subcommands that modify its behavior. These subcommands are:
</p>
<ul>
<li>
<a href="/commands/latency-latest">
<code>
LATENCY LATEST
</code>
</a>
- returns the latest latency samples for all events.
</li>
<li>
<a href="/commands/latency-history">
<code>
LATENCY HISTORY
</code>
</a>
- returns latency time series for a given event.
</li>
<li>
<a href="/commands/latency-reset">
<code>
LATENCY RESET
</code>
</a>
- resets latency time series data for one or more events.
</li>
<li>
<a href="/commands/latency-graph">
<code>
LATENCY GRAPH
</code>
</a>
- renders an ASCII-art graph of an event's latency samples.
</li>
<li>
<a href="/commands/latency-doctor">
<code>
LATENCY DOCTOR
</code>
</a>
- replies with a human-readable latency analysis report.
</li>
</ul>
<p>
Refer to each subcommand's documentation page for further information.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/management/optimization/latency-monitor/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Eviction policy
</h1>
<p class="text-lg -mt-5 mb-10">
The eviction policy determines what happens when a database reaches its memory limit.
</p>
<p>
The eviction policy determines what happens when a database reaches its memory limit.
</p>
<p>
To make room for new data, older data is
<em>
evicted
</em>
(removed) according to the selected policy.
</p>
<p>
To prevent this from happening, make sure your database is large enough to hold all desired keys.
</p>
<table>
<thead>
<tr>
<th>
<strong>
Eviction Policy
</strong>
</th>
<th>
<strong>
Description
</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
noeviction
</td>
<td>
New values aren't saved when memory limit is reached
<br/>
<br/>
When a database uses replication, this applies to the primary database
</td>
</tr>
<tr>
<td>
allkeys-lru
</td>
<td>
Keeps most recently used keys; removes least recently used (LRU) keys
</td>
</tr>
<tr>
<td>
allkeys-lfu
</td>
<td>
Keeps frequently used keys; removes least frequently used (LFU) keys
</td>
</tr>
<tr>
<td>
allkeys-random
</td>
<td>
Randomly removes keys
</td>
</tr>
<tr>
<td>
volatile-lru
</td>
<td>
Removes least recently used keys with
<code>
expire
</code>
field set to true
</td>
</tr>
<tr>
<td>
volatile-lfu
</td>
<td>
Removes least frequently used keys with
<code>
expire
</code>
field set to true
</td>
</tr>
<tr>
<td>
volatile-random
</td>
<td>
Randomly removes keys with
<code>
expire
</code>
field set to true
</td>
</tr>
<tr>
<td>
volatile-ttl
</td>
<td>
Removes least frequently used keys with
<code>
expire
</code>
field set to true and the shortest remaining time-to-live (TTL) value
</td>
</tr>
</tbody>
</table>
<h2 id="eviction-policy-defaults">
Eviction policy defaults
</h2>
<p>
<code>
volatile-lru
</code>
is the default eviction policy for most databases.
</p>
<p>
The default policy for
<a href="/docs/latest/operate/rs/databases/active-active/">
Active-Active databases
</a>
is
<em>
noeviction
</em>
policy.
</p>
<h2 id="active-active-database-eviction">
Active-Active database eviction
</h2>
<p>
The eviction policy mechanism for Active-Active databases kicks in earlier than for standalone databases because it requires propagation to all participating clusters.
The eviction policy starts to evict keys when one of the Active-Active instances reaches 80% of its memory limit. If memory usage continues to rise while the keys are being evicted, the rate of eviction will increase to prevent reaching the Out-of-Memory state.
As with standalone Redis Enterprise databases, Active-Active eviction is calculated per shard.
To prevent over eviction, internal heuristics might prevent keys from being evicted when the shard reaches the 80% memory limit. In such cases, keys will get evicted only when shard memory reaches 100%.
</p>
<p>
In case of network issues between Active-Active instances, memory can be freed only when all instances are in sync. If there is no communication between participating clusters, it can result in eviction of all keys and the instance reaching an Out-of-Memory state.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Data eviction policies are not supported for Active-Active databases with Auto Tiering .
</div>
</div>
<h2 id="avoid-data-eviction">
Avoid data eviction
</h2>
<p>
To avoid data eviction, make sure your database is large enough to hold required values.
</p>
<p>
For larger databases, consider using
<a href="/docs/latest/operate/rs/databases/auto-tiering/">
Auto Tiering
</a>
.
</p>
<p>
Auto Tiering stores actively-used data (also known as
<em>
hot data
</em>
) in RAM and the remaining data in flash memory (SSD).
This lets you retain more data while ensuring the fastest access to the most critical data.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/tools/insight/release-notes/v.2.6.0/.html | <section class="prose w-full py-12">
<h1>
RedisInsight v2.6.0, July 2022
</h1>
<p class="text-lg -mt-5 mb-10">
RedisInsight v2.6.0
</p>
<h2 id="260-july-2022">
2.6.0 (July 2022)
</h2>
<p>
This is the General Availability (GA) release of RedisInsight 2.6.0
</p>
<h3 id="headlines">
Headlines:
</h3>
<ul>
<li>
Bulk actions: Delete the keys in bulk based on the filters set in Browser or Tree view
</li>
<li>
Multiline support for key values in Browser and Tree View: Click the key value to see it in full
</li>
<li>
<a href="https://redis.io/docs/manual/pipelining/">
Pipeline
</a>
support in Workbench: Batch Redis commands in Workbench to optimize round-trip times
</li>
<li>
In-app notifications: Receive messages about important changes, updates, or announcements inside the application. Notifications are always available in the Notification center, and can be displayed with or without preview.
</li>
</ul>
<h3 id="details">
Details
</h3>
<p>
<strong>
Features and improvements:
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/890">
#890
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/883">
#883
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/875">
#875
</a>
Delete keys in bulk from your Redis database in Browser and Tree view based on filters you set by key name or data type.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/878">
#878
</a>
Multiline support for key values in Browser and Tree View: Select the truncated value to expand the row and see the full value, select again to collapse it.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/837">
#837
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/838">
#838
</a>
Added
<a href="https://redis.io/docs/manual/pipelining/">
pipeline
</a>
support for commands run in Workbench to optimize round-trip times. Default number of commands sent in a pipeline is 5, and is configurable in Settings > Advanced.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/862">
#862
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/840">
#840
</a>
Added in-app notifications to inform you about any important changes, updates, or announcements. Notifications are always available in the Notification center, and can be displayed with or without preview.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/830">
#830
</a>
To more easily explore and work with stream data, always display stream entry ID and controls to remove the Stream entry regardless of the number of fields.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/928">
#928
</a>
Remember the sorting on the list of databases.
</li>
</ul>
<p>
<strong>
Bugs fixed:
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/932">
#932
</a>
Refresh the JSON value in Browser/Tree view.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/tools/insight/release-notes/v.2.6.0/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/nagios-with-redis-enterprise/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Nagios with Redis Enterprise
</h1>
<p class="text-lg -mt-5 mb-10">
The Redis Enterprise Software (RS) Nagios plugin enables you to monitor the status of RS related objects and alerts. The RS alerts can be related to the cluster, nodes, or databases.
</p>
<div class="banner-article rounded-md" style="background-color: ">
<p>
The Nagios plugin has been retired as of Redis Enterprise Software version 7.2.4.
</p>
</div>
<p>
The Redis Enterprise Software (RS) Nagios plugin enables you to monitor the status of RS related
objects and alerts. The RS alerts can be related to the cluster, nodes,
or databases.
</p>
<p>
The alerts that can be monitored via Nagios are the same alerts that can
be configured in the RS UI in the Settings > Alerts page, or the
specific Database > Configuration page.
</p>
<p>
All alert configurations (active / not active, setting thresholds, etc')
can only be done through the RS UI, they cannot be configured in Nagios.
Through Nagios you can only view the status and information of the
alerts.
</p>
<p>
The full list of alerts can be found in the plugin package itself (in
"/rlec_obj/rlec_services.cfg" file, more details below).
</p>
<p>
RS Nagios plugin support API password retrieval from Gnome keyring,
KWallet, Windows credential vault, Mac OS X Keychain, if present, or
otherwise Linux Secret Service compatible password store. With no
keyring service available, the password is saved with base64 encoding,
under the user home directory.
</p>
<h2 id="configuring-the-nagios-plugin">
Configuring the Nagios plugin
</h2>
<p>
In order to configure the Nagios plugin you need to copy the files that
come with the package into your Nagios environment and place them in a
Nagios configuration directory. Or, alternatively you can copy parts of
the package configuration into your existing Nagios configuration.
</p>
<p>
If Keyring capabilities are needed to store the password, python keyring
package should be installed and used by following the below steps from
the operating system CLI on Nagios machine:
</p>
<ol>
<li>
pip install keyring to install the package (See
<a href="https://pip.pypa.io/en/stable/installing/">
https://pip.pypa.io/en/stable/installing/
</a>
on how to install python
pip if needed).
</li>
<li>
keyring set RS-Nagios <RS user email> to set the password.
User email should be identical to the email used in Nagios
configuration and the password should be set using the same user
that run the Nagios server.
</li>
</ol>
<p>
Then, you need to update the local parameters, such as hostnames,
addresses, and object IDs, to the values relevant for your
RS deployment.
</p>
<p>
Finally, you need to set the configuration for each node and database
you would like to monitor. More details below.
</p>
<p>
The RS Nagios package includes two components:
</p>
<ul>
<li>
The plugin itself - with suffix "rlec_nagios_plugin"
</li>
<li>
Configuration files - with suffix "rlec_nagios_conf"
</li>
</ul>
<p>
Below is the list of files included in these packages and instructions
regarding what updates need to be made to these flies.
</p>
<p>
Note : The instructions below assume you are running on Ubuntu, have a
clean Nagios installation, and the base Nagios directory is
"/usr/local/nagios/"
</p>
<h3 id="step-1">
Step 1
</h3>
<p>
Copy the folder named "libexec" from the plugin folder and its contents
to "/usr/local/nagios/"
</p>
<p>
These files included in it are:
</p>
<ul>
<li>
check_rlec_alert
</li>
<li>
check_rlec_node
</li>
<li>
check_rlec_bdb
</li>
<li>
email_stub
</li>
<li>
rlecdigest.py
</li>
</ul>
<p>
Note : The check_rlec_alert, check_rlec_node, check_rlec_bdb files
are the actual plugin implementation. You can run each of them with a
"h" switch in order to retrieve their documentation and their expected
parameters.
</p>
<h3 id="step-2">
Step 2
</h3>
<p>
Add the following lines to your "nagios.cfg":
</p>
<ul>
<li>
cfg_dir=/usr/local/nagios/etc/rlec_obj
</li>
<li>
cfg_dir=/usr/local/nagios/etc/rlec_local
</li>
<li>
resource_file=/usr/local/nagios/etc/rlec_resource.cfg
</li>
</ul>
<h3 id="step-3">
Step 3
</h3>
<p>
Copy the configuration files along with their folders to
"/usr/local/nagios/etc" and make the required updates, as detailed
below.
</p>
<ol>
<li>
Under the "/etc" folder:
<ol>
<li>
"rlec_resource.cfg " holds global variables definitions for
the user and password to use to connect to RS. You should update
the variables to the relevant user and password for your
deployment.
</li>
<li>
"rlec_local " folder
</li>
<li>
"rlec_obj" folder
</li>
</ol>
</li>
<li>
Under the "/rlec_local" folder:
<ol>
<li>
"cluster.cfg " holds configuration details at the cluster
level. If you would like to monitor more than one cluster then
you need to duplicate the two existing entries in the file for
each cluster.
<ol>
<li>
The first "define host" section defines a variable for the
IP address of the cluster that is used in other
configuration files.
<ol>
<li>
Update the "address" to the Cluster Name (FQDN) as
defined in DNS, or the IP address of one of the nodes in
the cluster.
</li>
<li>
If you are configuring more than one RS then when
duplicating this section you should make sure:
<ol>
<li>
The "name" is unique.
</li>
</ol>
</li>
</ol>
</li>
<li>
In the second "define host" section:
<ol>
<li>
The "host_name " in each entry must be unique.
</li>
<li>
The "display_name" in each entry can be updated to a
user-friendly name that are shown in Nagios UI.
</li>
</ol>
</li>
</ol>
</li>
<li>
"contacts.cfg " holds configuration details who to send emails
to. It should be updated to values relevant for your deployment.
If this file already exists in your existing Nagios environment
then you should update it accordingly.
</li>
<li>
"databases.cfg" holds configuration details of the databases
to monitor. The "define host" section should be duplicated for
every database to monitor.
<ol>
<li>
"host_name" should be a unique value.
</li>
<li>
"display_name " should be updated to a user-friendly name
to show in the UI.
</li>
<li>
"_RLECID " should be the database's internal ID that can
be retrieved from
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/">
<code>
rladmin status
</code>
</a>
command output.
</li>
</ol>
</li>
<li>
"nodes.cfg " holds configuration details of the nodes in the
cluster. The "define host" section should be duplicated for
every node in the cluster.
<ol>
<li>
"host_name" should be a unique value.
</li>
<li>
"display_name " should be updated to a user-friendly name
to show in the UI.
</li>
<li>
"address" should be updated to the DNS name mapped to the
IP address of the node, or to the IP address itself.
</li>
<li>
"_RLECID " should be the node's internal ID that can be
retrieved
from
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/">
<code>
rladmin status
</code>
</a>
command output.
</li>
</ol>
</li>
<li>
Under the "/rlec_obj" folder:
<ol>
<li>
"rlec_cmd.cfg" holds configuration details of how to
activate the plugin. No need to make any updates to it.
</li>
<li>
"rlec_groups.cfg" holds definitions of host groups. No need
to make any updates to it.
</li>
<li>
"rlec_services.cfg" holds definitions of all alerts that
are monitored. No need to make any updates to it.
</li>
<li>
"rlec_templates.cfg" holds general RS Nagios definitions.
No need to make any updates to it.
</li>
</ol>
</li>
</ol>
</li>
</ol>
<nav>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/nagios-with-redis-enterprise/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/7-4-6-releases/7-4-6-2-october24/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes 7.4.6-2 (October 2024) release notes
</h1>
<p class="text-lg -mt-5 mb-10">
This is a maintenance release with a new version of Redis Enterprise Software 7.4.6.
</p>
<h2 id="highlights">
Highlights
</h2>
<p>
This is a maintenance release to support
<a href="/docs/latest/operate/rs/release-notes/rs-7-4-2-releases/">
Redis Enterprise Software version 7.4.6-102
</a>
. For version changes, supported distributions, and known limitations, see the
<a href="/docs/latest/operate/kubernetes/release-notes/7-4-6-releases/7-4-6-2/">
release notes for 7-4-6-2 (July 2024)
</a>
.
</p>
<h2 id="downloads">
Downloads
</h2>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
:
<code>
redislabs/redis:7.4.6-102
</code>
</li>
<li>
<strong>
Operator
</strong>
:
<code>
redislabs/operator:7.4.6-2
</code>
</li>
<li>
<strong>
Services Rigger
</strong>
:
<code>
redislabs/k8s-controller:7.4.6-2
</code>
</li>
</ul>
<h3 id="openshift-images">
OpenShift images
</h3>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
:
<code>
registry.connect.redhat.com/redislabs/redis-enterprise:7.4.6-102.rhel8-openshift
</code>
</li>
<li>
<strong>
Operator
</strong>
:
<code>
registry.connect.redhat.com/redislabs/redis-enterprise-operator:7.4.6-2
</code>
</li>
<li>
<strong>
Services Rigger
</strong>
:
<code>
registry.connect.redhat.com/redislabs/services-manager:7.4.6-2
</code>
</li>
</ul>
<h3 id="olm-bundle">
OLM bundle
</h3>
<p>
<strong>
Redis Enterprise operator bundle
</strong>
:
<code>
v7.4.6-2.4
</code>
</p>
<p>
The OLM version v7.4.6-2.4 replaces the earlier v7.4.6-2.3 release for the same Redis software version, providing only upgrade path fixes.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/7-4-6-releases/7-4-6-2-october24/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/security/access-control/saml-sso/utm_sourceredisinsight&utm_mediumrepository&utm_campaignrelease_notes.html | <section class="prose w-full py-12 max-w-none">
<h1>
SAML single sign-on
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Cloud supports both IdP-initiated and SP-initiated single sign-on (SSO) with SAML (Security Assertion Markup Language). You can use any identity provider to integrate with Redis Cloud as long as it supports the SAML protocol, or you can refer to integration guides for a few specific providers.
</p>
<p>
Redis Cloud supports both
<a href="#idp-initiated-sso">
IdP-initiated
</a>
and
<a href="#sp-initiated-sso">
SP-initiated
</a>
<a href="https://en.wikipedia.org/wiki/Single_sign-on">
single sign-on (SSO)
</a>
with
<a href="https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language">
SAML (Security Assertion Markup Language)
</a>
.
</p>
<p>
You cannot use
<a href="https://en.wikipedia.org/wiki/System_for_Cross-domain_Identity_Management">
SCIM (System for Cross-domain Identity Management)
</a>
to provision Redis Cloud users. However, Redis Cloud supports just-in-time (JIT) user provisioning, which means Redis Cloud automatically creates a user account the first time a new user signs in with SAML SSO.
</p>
<h2 id="saml-sso-overview">
SAML SSO overview
</h2>
<p>
When SAML SSO is enabled, the
<a href="https://en.wikipedia.org/wiki/Identity_provider">
identity provider (IdP)
</a>
admin handles SAML user management instead of the Redis Cloud account owner.
</p>
<p>
You can use any identity provider to integrate with Redis Cloud as long as it supports the SAML protocol. You can also refer to these integration guides for several popular identity providers:
</p>
<ul>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-auth0/">
Auth0 SAML integration
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-aws-identity-center/">
AWS IAM Identity Center SAML integration
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-azure-ad/">
Azure Active Directory SAML integration
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-google/">
Google Workspace integration
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-okta-generic/">
Okta SAML integration (Generic)
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-okta-org2org/">
Okta SAML integration (Org2Org)
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-ping-identity/">
PingIdentity SAML integration
</a>
</li>
</ul>
<p>
After you activate SAML SSO for a Redis Cloud account, all existing local users for the account, except for the user that set up SAML SSO, are converted to SAML users and are required to use SAML SSO to sign in. Before they can sign in to Redis Cloud, the identity provider admin needs to set up these users on the IdP side and configure the
<code>
redisAccountMapping
</code>
attribute to map them to the appropriate Redis Cloud accounts and
<a href="/docs/latest/operate/rc/security/access-control/access-management/#team-management-roles">
roles
</a>
.
</p>
<h3 id="idp-initiated-sso">
IdP-initiated SSO
</h3>
<p>
With IdP-initiated single sign-on, you can select the Redis Cloud application after you sign in to your
<a href="https://en.wikipedia.org/wiki/Identity_provider">
identity provider (IdP)
</a>
. This redirects you to the
<a href="https://cloud.redis.io/#/login">
Redis Cloud console
</a>
and signs you in to your SAML user account.
</p>
<h3 id="sp-initiated-sso">
SP-initiated SSO
</h3>
<p>
You can also initiate single sign-on from the
<a href="https://cloud.redis.io/#/login">
Redis Cloud console
</a>
. This process is known as
<a href="https://en.wikipedia.org/wiki/Service_provider">
service provider (SP)
</a>
-initiated single sign-on.
</p>
<ol>
<li>
<p>
From the Redis Cloud console's
<a href="https://cloud.redis.io/#/login">
sign-in screen
</a>
, select
<strong>
SSO
</strong>
.
</p>
<a href="/docs/latest/images/rc/button-sign-in-sso.png" sdata-lightbox="/images/rc/button-sign-in-sso.png">
<img alt="Sign in with SSO button" src="/docs/latest/images/rc/button-sign-in-sso.png" width="150px"/>
</a>
</li>
<li>
<p>
Enter the email address associated with your SAML user account.
</p>
</li>
<li>
<p>
Select the
<strong>
Login
</strong>
button.
</p>
<ul>
<li>
<p>
If you already have an active SSO session with your identity provider, this signs you in to your SAML user account.
</p>
</li>
<li>
<p>
Otherwise, the SSO flow redirects you to your identity provider's sign in screen. Enter your IdP user credentials to sign in. This redirects you back to the Redis Cloud console and automatically signs in to your SAML user account.
</p>
</li>
</ul>
</li>
</ol>
<h3 id="multi-factor-authentication">
Multi-factor authentication
</h3>
<p>
The account owner remains a local user and should set up
<a href="/docs/latest/operate/rc/security/access-control/multi-factor-authentication/">
multi-factor authentication (MFA)
</a>
to help secure their account. After SAML activation, the account owner can set up additional local bypass users with MFA enabled.
</p>
<p>
If MFA enforcement is enabled, note that Redis Cloud does not enforce MFA for SAML users since the identity provider handles MFA management and enforcement.
</p>
<h2 id="set-up-saml-sso">
Set up SAML SSO
</h2>
<p>
To set up SAML single sign-on for a Redis Cloud account:
</p>
<ol>
<li>
<p>
<a href="#verify-domain">
Verify domain ownership in Redis Cloud
</a>
.
</p>
</li>
<li>
<p>
<a href="#set-up-app">
Set up a SAML app
</a>
to integrate Redis Cloud with your identity provider.
</p>
</li>
<li>
<p>
<a href="#configure-idp">
Configure SAML identity provider in Redis Cloud
</a>
.
</p>
</li>
<li>
<p>
<a href="#download-sp">
Download service provider metadata
</a>
and upload it to your identity provider.
</p>
</li>
<li>
<p>
<a href="#activate-saml-sso">
Activate SAML SSO
</a>
.
</p>
</li>
</ol>
<h3 id="verify-domain">
Verify domain ownership in Redis Cloud
</h3>
<p>
Before you set up SAML SSO in Redis Cloud, you must verify that you own the domain(s) associated with your SAML setup.
</p>
<ol>
<li>
<p>
Sign in to
<a href="https://cloud.redis.io/#/login">
Redis Cloud
</a>
with the email address associated with the SAML user you set up with your identity provider.
</p>
</li>
<li>
<p>
Select
<strong>
Access Management
</strong>
from the
<a href="https://cloud.redis.io">
Redis Cloud console
</a>
menu.
</p>
</li>
<li>
<p>
Select
<strong>
Single Sign-On
</strong>
.
</p>
</li>
<li>
<p>
Select the
<strong>
Setup SAML SSO
</strong>
button:
</p>
<a href="/docs/latest/images/rc/button-access-management-sso-setup.png" sdata-lightbox="/images/rc/button-access-management-sso-setup.png">
<img alt="Setup SSO button" src="/docs/latest/images/rc/button-access-management-sso-setup.png" width="120px"/>
</a>
</li>
<li>
<p>
From the
<strong>
SAML
</strong>
screen of the
<a href="https://cloud.redis.io">
Redis Cloud console
</a>
, you must verify you own the domains associated with your SAML configuration. Select
<strong>
Add domain
</strong>
to open the
<strong>
Manage domain bindings
</strong>
panel.
</p>
<a href="/docs/latest/images/rc/saml-button-add-domain.png" sdata-lightbox="/images/rc/saml-button-add-domain.png">
<img alt="Add domain button" src="/docs/latest/images/rc/saml-button-add-domain.png" width="120px"/>
</a>
<a href="/docs/latest/images/rc/saml-manage-domain-bindings.png" sdata-lightbox="/images/rc/saml-manage-domain-bindings.png">
<img alt="The Manage domain bindings panel" src="/docs/latest/images/rc/saml-manage-domain-bindings.png" width="80%"/>
</a>
</li>
<li>
<p>
Select
<strong>
Copy
</strong>
to copy the provided TXT DNS record. For each domain you want to associate with your SAML setup, add the copied TXT record to its DNS records.
</p>
</li>
<li>
<p>
Select
<strong>
Add domain
</strong>
to add a domain.
</p>
<a href="/docs/latest/images/rc/saml-button-add-domain.png" sdata-lightbox="/images/rc/saml-button-add-domain.png">
<img alt="Add domain button" src="/docs/latest/images/rc/saml-button-add-domain.png" width="120px"/>
</a>
</li>
<li>
<p>
Enter the domain name and select
<a href="/docs/latest/images/rc/saml-button-confirm.png#no-click" sdata-lightbox="/images/rc/saml-button-confirm.png#no-click">
<img alt="The confirm domain button" class="inline" src="/docs/latest/images/rc/saml-button-confirm.png#no-click" width="20px"/>
</a>
to save it, or select
<a href="/docs/latest/images/rc/saml-button-cancel.png#no-click" sdata-lightbox="/images/rc/saml-button-cancel.png#no-click">
<img alt="The cancel button" class="inline" src="/docs/latest/images/rc/saml-button-cancel.png#no-click" width="20px"/>
</a>
to cancel.
</p>
<a href="/docs/latest/images/rc/saml-enter-domain.png" sdata-lightbox="/images/rc/saml-enter-domain.png">
<img alt="Enter domain name in the Domain field." src="/docs/latest/images/rc/saml-enter-domain.png" width="80%"/>
</a>
</li>
<li>
<p>
After you save the domain name, its status is
<strong>
Pending
</strong>
. Select
<strong>
Verify
</strong>
to verify it.
</p>
<a href="/docs/latest/images/rc/saml-domain-pending.png" sdata-lightbox="/images/rc/saml-domain-pending.png">
<img alt="The Manage domain bindings panel, with a pending domain" src="/docs/latest/images/rc/saml-domain-pending.png" width="80%"/>
</a>
<p>
We'll check the domain's DNS records for the provided TXT record. If the TXT record does not exist or we can't resolve your domain, we won't be able to verify the domain and users with that domain won't be able to sign in using SAML SSO.
</p>
<p>
Select
<a href="/docs/latest/images/rc/saml-button-delete-domain.png#no-click" sdata-lightbox="/images/rc/saml-button-delete-domain.png#no-click">
<img alt="The delete domain button" class="inline" src="/docs/latest/images/rc/saml-button-delete-domain.png#no-click" width="25px"/>
</a>
to delete a domain if it was added by mistake.
</p>
<p>
If we find the TXT record, the domain's status will change to
<strong>
Verified
</strong>
.
</p>
<a href="/docs/latest/images/rc/saml-domain-verified.png" sdata-lightbox="/images/rc/saml-domain-verified.png">
<img alt="The Manage domain bindings panel, with a verified domain" src="/docs/latest/images/rc/saml-domain-verified.png" width="80%"/>
</a>
<p>
You can select
<strong>
Add domain
</strong>
to add another domain.
</p>
</li>
<li>
<p>
Select
<strong>
Close
</strong>
to close the domain binding panel.
</p>
<a href="/docs/latest/images/rc/saml-button-close.png" sdata-lightbox="/images/rc/saml-button-close.png">
<img alt="Close button" src="/docs/latest/images/rc/saml-button-close.png" width="100px"/>
</a>
</li>
</ol>
<p>
After you verify at least one domain, you can select
<strong>
Manage domains
</strong>
to open the
<strong>
Manage domain bindings
</strong>
panel again and add or verify more domains.
</p>
<h3 id="set-up-app">
Set up SAML app
</h3>
<p>
Set up a SAML app to integrate Redis Cloud with your identity provider:
</p>
<ol>
<li>
<p>
Sign in to your identity provider's admin console.
</p>
</li>
<li>
<p>
Create or add a SAML integration app for the service provider Redis Cloud.
</p>
</li>
<li>
<p>
Set up your SAML service provider app so the SAML assertion contains the following attributes:
</p>
<table>
<thead>
<tr>
<th>
Attribute name
<br/>
(case-sensitive)
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
FirstName
</td>
<td>
User's first name
</td>
</tr>
<tr>
<td>
LastName
</td>
<td>
User's last name
</td>
</tr>
<tr>
<td>
Email
</td>
<td>
User's email address (used as the username in the Redis Cloud console)
</td>
</tr>
<tr>
<td>
redisAccountMapping
</td>
<td>
Key-value pair of a lowercase
<a href="/docs/latest/operate/rc/security/access-control/access-management/#team-management-roles">
role name
</a>
(owner, member, manager, billing_admin, or viewer) and the user's Redis Cloud
<strong>
Account number
</strong>
found in the
<a href="/docs/latest/operate/rc/accounts/account-settings/">
account settings
</a>
</td>
</tr>
</tbody>
</table>
<p>
For
<code>
redisAccountMapping
</code>
, you can add the same user to multiple SAML-enabled accounts using one of these options:
</p>
<ul>
<li>
<p>
A single string that contains a comma-separated list of account/role pairs
</p>
<div class="highlight">
<pre class="chroma"><code class="language-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt"><saml2:Attribute</span> <span class="na">Name=</span><span class="s">"redisAccountMapping"</span> <span class="na">NameFormat=</span><span class="s">"urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"</span><span class="nt">></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><saml2:AttributeValue</span> <span class="na">xsi:type=</span><span class="s">"xs:string"</span> <span class="na">xmlns:xs=</span><span class="s">"http://www.w3.org/2001/XMLSchema"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span><span class="nt">></span>
</span></span><span class="line"><span class="cl"> 12345=owner,54321=manager
</span></span><span class="line"><span class="cl"> <span class="nt"></saml2:AttributeValue></span>
</span></span><span class="line"><span class="cl"><span class="nt"></saml2:Attribute></span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Multiple strings, where each represents a single account/role pair
</p>
<div class="highlight">
<pre class="chroma"><code class="language-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt"><saml2:Attribute</span> <span class="na">Name=</span><span class="s">"redisAccountMapping"</span> <span class="na">NameFormat=</span><span class="s">"urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"</span><span class="nt">></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><saml2:AttributeValue</span> <span class="na">xsi:type=</span><span class="s">"xs:string"</span> <span class="na">xmlns:xs=</span><span class="s">"http://www.w3.org/2001/XMLSchema"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span><span class="nt">></span>
</span></span><span class="line"><span class="cl"> 12345=owner
</span></span><span class="line"><span class="cl"> <span class="nt"></saml2:AttributeValue></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><saml2:AttributeValue</span> <span class="na">xsi:type=</span><span class="s">"xs:string"</span> <span class="na">xmlns:xs=</span><span class="s">"http://www.w3.org/2001/XMLSchema"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span><span class="nt">></span>
</span></span><span class="line"><span class="cl"> 54321=manager
</span></span><span class="line"><span class="cl"> <span class="nt"></saml2:AttributeValue></span>
</span></span><span class="line"><span class="cl"><span class="nt"></saml2:Attribute></span>
</span></span></code></pre>
</div>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
To confirm the identity provider's SAML assertions contain the required attributes, you can use a SAML-tracer web developer tool to inspect them.
</div>
</div>
</li>
<li>
<p>
Set up any additional configuration required by your identity provider to ensure you can configure the
<code>
redisAccountMapping
</code>
attribute for SAML users.
</p>
<p>
If your identity provider lets you configure custom attributes with workflows or group rules, you can set up automation to configure the
<code>
redisAccountMapping
</code>
field automatically instead of manually.
</p>
</li>
</ol>
<h3 id="configure-idp">
Configure SAML in Redis Cloud
</h3>
<p>
After you set up the SAML integration app and create a SAML user in your identity provider, you need to configure your Redis Cloud account to set up SAML SSO.
</p>
<ol>
<li>
<p>
Sign in to
<a href="https://cloud.redis.io/#/login">
Redis Cloud
</a>
with the email address associated with the SAML user you set up with your identity provider.
</p>
</li>
<li>
<p>
Select
<strong>
Access Management
</strong>
from the
<a href="https://cloud.redis.io">
Redis Cloud console
</a>
menu.
</p>
</li>
<li>
<p>
Select
<strong>
Single Sign-On
</strong>
.
</p>
</li>
<li>
<p>
<a href="#verify-domain">
Verify at least one domain
</a>
if you haven't.
</p>
</li>
<li>
<p>
Configure the
<strong>
Identity Provider metadata
</strong>
settings.
</p>
<a href="/docs/latest/images/rc/access-management-saml-config.png" sdata-lightbox="/images/rc/access-management-saml-config.png">
<img alt="SAML Single Sign-On configuration screen." src="/docs/latest/images/rc/access-management-saml-config.png"/>
</a>
<p>
To do so, you need the following metadata values from your identity provider:
</p>
<table>
<thead>
<tr>
<th>
Setting
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
Issuer (IdP entity ID)
</strong>
</td>
<td>
The unique entity ID for the identity provider
</td>
</tr>
<tr>
<td>
<strong>
IdP server URL
</strong>
</td>
<td>
The identity provider's HTTPS URL for SAML SSO
</td>
</tr>
<tr>
<td>
<strong>
Single logout URL
</strong>
</td>
<td>
The URL used to sign out of the identity provider and connected apps (optional)
</td>
</tr>
<tr>
<td>
<strong>
Assertion signing certificate
</strong>
</td>
<td>
Public SHA-256 certificate used to validate SAML assertions from the identity provider
</td>
</tr>
</tbody>
</table>
<p>
To find these metadata values, see your identity provider's documentation.
</p>
</li>
<li>
<p>
Select
<strong>
Enable
</strong>
.
</p>
<a href="/docs/latest/images/rc/saml-enable-button.png" sdata-lightbox="/images/rc/saml-enable-button.png">
<img alt="Enable button" src="/docs/latest/images/rc/saml-enable-button.png" width="100px"/>
</a>
</li>
<li>
<p>
From the
<strong>
SAML activation
</strong>
dialog box, select
<strong>
Continue
</strong>
.
</p>
</li>
</ol>
<h3 id="download-sp">
Download service provider metadata
</h3>
<p>
Next, you need to download the service provider metadata for Redis Cloud and use it to finish configuring the SAML integration app for your identity provider:
</p>
<ol>
<li>
<p>
Select the
<strong>
Download
</strong>
button to download the service provider
<a href="https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf">
metadata
</a>
in XML format.
</p>
</li>
<li>
<p>
Sign in to your identity provider's admin console.
</p>
</li>
<li>
<p>
Configure the Redis Cloud service provider app with the downloaded XML.
</p>
<ul>
<li>
<p>
Some identity providers let you upload the XML file directly.
</p>
</li>
<li>
<p>
Others require you to manually configure the service provider app with specific metadata fields, such as:
</p>
<table>
<thead>
<tr>
<th>
XML attribute
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
EntityDescriptor's
<strong>
entityID
</strong>
</td>
<td>
https://
<nobr>
auth.redis.com
</nobr>
/saml2/
<nobr>
service-provider
</nobr>
/<ID>
</td>
<td>
Unique URL that identifies the Redis Cloud service provider
</td>
</tr>
<tr>
<td>
AssertionConsumerService's
<strong>
Location
</strong>
</td>
<td>
<nobr>
https://
</nobr>
<nobr>
auth.redis.com
</nobr>
/sso/saml2/<ID>
</td>
<td>
The service provider endpoint where the identity provider sends a SAML assertion that authenticates a user
</td>
</tr>
</tbody>
</table>
</li>
<li>
<p>
To use
<a href="#idp-initiated-sso">
IdP-initiated SSO
</a>
with certain identity providers, you also need to set the RelayState parameter to the following URL:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">https://cloud.redis.io/#/login/?idpId<span class="o">=</span><ID>
</span></span></code></pre>
</div>
<blockquote>
<p>
Replace
<code>
<ID>
</code>
so it matches the
<code>
AssertionConsumerService Location
</code>
URL's ID.
</p>
</blockquote>
</li>
</ul>
<p>
To learn more about how to configure service provider apps, see your identity provider's documentation.
</p>
</li>
</ol>
<h3 id="activate-saml-sso">
Activate SAML SSO
</h3>
<p>
After you finish the required SAML SSO configuration between your identity provider and Redis Cloud account, you can test and activate SAML SSO.
</p>
<p>
All users associated with the account, excluding the local user you used to set up SAML SSO, are converted to SAML users on successful activation. They can no longer sign in with their previous sign-in method and must use SAML SSO instead. However, you can add local bypass users after SAML SSO activation to allow access to the account in case of identity provider downtime or other issues with SAML SSO.
</p>
<p>
To activate SAML SSO:
</p>
<ol>
<li>
<p>
Sign out of any active SSO sessions with your identity provider.
</p>
</li>
<li>
<p>
For
<strong>
Activate SAML integration
</strong>
, select the
<strong>
Activate
</strong>
button.
</p>
</li>
<li>
<p>
From the
<strong>
Logout notification
</strong>
dialog, select
<strong>
Continue
</strong>
. This redirects you to your configured identity provider's sign-in screen.
</p>
</li>
<li>
<p>
Sign in with your identity provider.
</p>
</li>
<li>
<p>
When redirected to the Redis Cloud sign-in screen, you can either:
</p>
<ul>
<li>
<p>
Sign in with your local credentials as usual.
</p>
</li>
<li>
<p>
Select
<strong>
SSO
</strong>
and enter the email address associated with the SAML user configured in your identity provider. Your user converts to a SAML user in Redis Cloud. Don't use this method if you want your user account to remain a local bypass user.
</p>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
If you see a
<strong>
SAML activation failed
</strong>
notification when redirected to the Redis Cloud sign-in screen, sign in with your local user credentials and review the SAML configuration for issues.
</div>
</div>
</li>
</ol>
<p>
After you activate SAML SSO,
<a href="/docs/latest/operate/rc/security/access-control/access-management/#manage-team-access">
add a few local bypass users
</a>
from the
<strong>
Team
</strong>
tab. Local bypass users should
<a href="/docs/latest/operate/rc/security/access-control/multi-factor-authentication/">
set up MFA
</a>
for additional security.
</p>
<h2 id="update-config">
Update configuration
</h2>
<p>
If you change certain metadata or configuration settings after you set up SAML SSO, such as the assertion signing certificate, remember to do the following:
</p>
<ol>
<li>
<p>
<a href="#configure-idp">
Update the SAML SSO configuration
</a>
with the new values.
</p>
</li>
<li>
<p>
<a href="#download-sp">
Download the updated service provider metadata
</a>
and use it to update the Redis Cloud service provider app.
</p>
</li>
</ol>
<h2 id="link-other-accounts">
Link other accounts
</h2>
<p>
After you set up SAML SSO for one account, you can link other accounts you own to the existing SAML configuration. This lets you use the same SAML configuration for SSO across multiple accounts.
</p>
<p>
To link other accounts to an existing SAML SSO configuration:
</p>
<ol>
<li>
<p>
Sign in to the
<a href="cloud.redis.io">
Redis Cloud console
</a>
with the account that has an existing SAML configuration.
</p>
</li>
<li>
<p>
Go to
<strong>
Access Management > Single Sign-On
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Get token
</strong>
.
</p>
<a href="/docs/latest/images/rc/saml/popup-saml-get-token.png" sdata-lightbox="/images/rc/saml/popup-saml-get-token.png">
<img alt="Get Token popup" src="/docs/latest/images/rc/saml/popup-saml-get-token.png"/>
</a>
<p>
Select
<strong>
Copy
</strong>
to copy the linking token.
</p>
</li>
<li>
<p>
Sign in to the account that you want to link to the SAML configuration. Go to
<strong>
Access Management > Single Sign-On
</strong>
and then enter the copied token into the
<strong>
Join an existing SAML configuration
</strong>
text box. Select the arrow to confirm.
</p>
<p>
After you do this, the owner of the original account will receive a request to link the new account to the SAML configuration.
</p>
</li>
<li>
<p>
Sign in with the original account and select
<strong>
Access Management > Single Sign-On
</strong>
. You should see the new account in the
<strong>
Unlinked accounts
</strong>
list.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
To see and interact with the Redis Cloud account in the
<strong>
Unlinked accounts
</strong>
list, you must be an owner of the account. If you are not an owner, the account will not be displayed in the section.
</div>
</div>
</li>
<li>
<p>
Select
<strong>
Link account
</strong>
.
</p>
<a href="/docs/latest/images/rc/saml/button-saml-link-account.png" sdata-lightbox="/images/rc/saml/button-saml-link-account.png">
<img alt="The Link Account button" src="/docs/latest/images/rc/saml/button-saml-link-account.png"/>
</a>
</li>
<li>
<p>
In the
<strong>
Convert existing users
</strong>
dialog, select
<strong>
Confirm conversion
</strong>
to finish linking the accounts.
</p>
<a href="/docs/latest/images/rc/saml/popup-saml-convert-users.png" sdata-lightbox="/images/rc/saml/popup-saml-convert-users.png">
<img alt="The Convert users popup" src="/docs/latest/images/rc/saml/popup-saml-convert-users.png"/>
</a>
</li>
</ol>
<h2 id="deactivate-saml-sso">
Deactivate SAML SSO
</h2>
<p>
Before you can deactivate SAML SSO for an account, you must sign in to the account as a local (non-SAML) user with the owner role assigned.
</p>
<p>
Deactivating SAML SSO for an account also removes any existing SAML-type users associated with the account.
</p>
<p>
To deactivate SAML SSO for a specific account:
</p>
<ol>
<li>
<p>
In the
<a href="https://cloud.redis.io">
Redis Cloud console
</a>
, select your name to display your available accounts.
</p>
</li>
<li>
<p>
If the relevant account is not already selected, select it from the
<strong>
Switch account
</strong>
list.
</p>
</li>
<li>
<p>
Go to
<strong>
Access Management > Single Sign-On
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Deactivate SAML
</strong>
. This only deactivates SAML SSO for the current account. Other linked accounts continue to use this SAML SSO configuration.
</p>
</li>
<li>
<p>
Select
<strong>
Deactivate
</strong>
to confirm deactivation.
</p>
</li>
</ol>
<h2 id="deprovision-saml-users">
Deprovision SAML users
</h2>
<p>
When a user is removed from your identity provider, their access to Redis Cloud should also be removed.
</p>
<p>
When you have revoked a user’s access to Redis Cloud, they cannot access the Redis Cloud console, but their API keys remain active. You can
<a href="/docs/latest/operate/rc/api/get-started/manage-api-keys/#delete-a-user-key">
delete an API key
</a>
to remove access.
</p>
<p>
To deprovision SAML users upon deletion, the identity provider admin can set up a webhook to automatically make the appropriate Cloud API requests. For more information about managing users with API requests, see
<a href="https://api.redislabs.com/v1/swagger-ui.html#/Users">
Users
</a>
in the Redis Cloud API documentation.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/security/access-control/saml-sso/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/databases/active-active/develop/data-types/streams/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Streams in Active-Active databases
</h1>
<p class="text-lg -mt-5 mb-10">
Information about using streams with an Active-Active database.
</p>
<p>
A
<a href="/docs/latest/develop/data-types/streams/">
Redis Stream
</a>
is a data structure that acts like an append-only log.
Each stream entry consists of:
</p>
<ul>
<li>
A unique, monotonically increasing ID
</li>
<li>
A payload consisting of a series key-value pairs
</li>
</ul>
<p>
You add entries to a stream with the XADD command. You access stream entries using the XRANGE, XREADGROUP, and XREAD commands (however, see the caveat about XREAD below).
</p>
<h2 id="streams-and-active-active">
Streams and Active-Active
</h2>
<p>
Active-Active databases allow you to write to the same logical stream from more than one region.
Streams are synchronized across the regions of an Active-Active database.
</p>
<p>
In the example below, we write to a stream concurrently from two regions. Notice that after syncing, both regions have identical streams:
</p>
<table style="width: auto;">
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD messages * text hello
</code>
</td>
<td>
<code>
XADD messages * text goodbye
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929246795-2]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1, 1589929246795-2]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1, 1589929246795-2]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
Notice also that the synchronized streams contain no duplicate IDs. As long as you allow the database to generate your stream IDs, you'll never have more than one stream entry with the same ID.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Redis Community Edition uses one radix tree (referred to as
<code>
rax
</code>
in the code base) to implement each stream. However, Active-Active databases implement a single logical stream using one
<code>
rax
</code>
per region.
Each region adds entries only to its associated
<code>
rax
</code>
(but can remove entries from all
<code>
rax
</code>
trees).
This means that XREAD and XREADGROUP iterate simultaneously over all
<code>
rax
</code>
trees and return the appropriate entry by comparing the entry IDs from each
<code>
rax
</code>
.
</div>
</div>
<h3 id="conflict-resolution">
Conflict resolution
</h3>
<p>
Active-Active databases use an "observed-remove" approach to automatically resolve potential conflicts.
</p>
<p>
With this approach, a delete only affects the locally observable data.
</p>
<p>
In the example below, a stream,
<code>
x
</code>
, is created at
<em>
t1
</em>
. At
<em>
t3
</em>
, the stream exists in two regions.
</p>
<table style="width: 100%;">
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD messages * text hello
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929244828-1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
DEL messages
</code>
</td>
<td>
<code>
XADD messages * text goodbye
</code>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929246795-2]
</strong>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [1589929246795-2]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
At
<em>
t4
</em>
, the stream is deleted from Region 1. At the same time, an entry with ID ending in
<code>
3700
</code>
is added to the same stream at Region 2. After the sync, at
<em>
t6
</em>
, the entry with ID ending in
<code>
3700
</code>
exists in both regions. This is because that entry was not visible when the local stream was deleted at
<em>
t4
</em>
.
</p>
<h3 id="id-generation-modes">
ID generation modes
</h3>
<p>
Usually, you should allow Redis streams generate its own stream entry IDs. You do this by specifying
<code>
*
</code>
as the ID in calls to XADD. However, you
<em>
can
</em>
provide your own custom ID when adding entries to a stream.
</p>
<p>
Because Active-Active databases replicate asynchronously, providing your own IDs can create streams with duplicate IDs. This can occur when you write to the same stream from multiple regions.
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD x 100-1 f1 v1
</code>
</td>
<td>
<code>
XADD x 100-1 f1 v1
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XRANGE x - +
</code>
<br/>
<strong>
→ [100-1, 100-1]
</strong>
</td>
<td>
<code>
XRANGE x - +
</code>
<br/>
<strong>
→ [100-1, 100-1]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
In this scenario, two entries with the ID
<code>
100-1
</code>
are added at
<em>
t1
</em>
. After syncing, the stream
<code>
x
</code>
contains two entries with the same ID.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Stream IDs in Redis Community Edition consist of two integers separated by a dash ('-'). When the server generates the ID, the first integer is the current time in milliseconds, and the second integer is a sequence number. So, the format for stream IDs is MS-SEQ.
</div>
</div>
<p>
To prevent duplicate IDs and to comply with the original Redis streams design, Active-Active databases provide three ID modes for XADD:
</p>
<ol>
<li>
<strong>
Strict
</strong>
: In
<em>
strict
</em>
mode, XADD allows server-generated IDs (using the '
<code>
*
</code>
' ID specifier) or IDs consisting only of the millisecond (MS) portion. When the millisecond portion of the ID is provided, the ID's sequence number is calculated using the database's region ID. This prevents duplicate IDs in the stream. Strict mode rejects full IDs (that is, IDs containing both milliseconds and a sequence number).
</li>
<li>
<strong>
Semi-strict
</strong>
:
<em>
Semi-strict
</em>
mode is just like
<em>
strict
</em>
mode except that it allows full IDs (MS-SEQ). Because it allows full IDs, duplicate IDs are possible in this mode.
</li>
<li>
<strong>
Liberal
</strong>
: XADD allows any monotonically ascending ID. When given the millisecond portion of the ID, the sequence number will be set to
<code>
0
</code>
. This mode may also lead to duplicate IDs.
</li>
</ol>
<p>
The default and recommended mode is
<em>
strict
</em>
, which prevents duplicate IDs.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Why do you want to prevent duplicate IDs? First, XDEL, XCLAIM, and other commands can affect more than one entry when duplicate IDs are present in a stream. Second, duplicate entries may be removed if a database is exported or renamed.
</div>
</div>
<p>
To change XADD's ID generation mode, use the
<code>
rladmin
</code>
command-line utility:
</p>
<p>
Set
<em>
strict
</em>
mode:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db crdb crdt_xadd_id_uniqueness_mode strict
</span></span></code></pre>
</div>
<p>
Set
<em>
semi-strict
</em>
mode:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db crdb crdt_xadd_id_uniqueness_mode semi-strict
</span></span></code></pre>
</div>
<p>
Set
<em>
liberal
</em>
mode:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db crdb crdt_xadd_id_uniqueness_mode liberal
</span></span></code></pre>
</div>
<h3 id="iterating-a-stream-with-xread">
Iterating a stream with XREAD
</h3>
<p>
In Redis Community Edition and in non-Active-Active databases, you can use XREAD to iterate over the entries in a Redis Stream. However, with an Active-Active database, XREAD may skip entries. This can happen when multiple regions write to the same stream.
</p>
<p>
In the example below, XREAD skips entry
<code>
115-2
</code>
.
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD x 110 f1 v1
</code>
</td>
<td>
<code>
XADD x 115 f1 v1
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XADD x 120 f1 v1
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XADD x 130 f1 v1
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XREAD COUNT 2 STREAMS x 0
</code>
<br/>
<strong>
→ [110-1, 120-1]
</strong>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XREAD COUNT 2 STREAMS x 120-1
</code>
<br/>
<strong>
→ [130-1]
</strong>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t7
</em>
</td>
<td>
<code>
XREAD STREAMS x 0
</code>
<br/>
<strong>
→[110-1, 115-2, 120-1, 130-1]
</strong>
</td>
<td>
<code>
XREAD STREAMS x 0
</code>
<br/>
<strong>
→[110-1, 115-2, 120-1, 130-1]
</strong>
</td>
</tr>
</tbody>
</table>
<p>
You can use XREAD to reliably consume a stream only if all writes to the stream originate from a single region. Otherwise, you should use XREADGROUP, which always guarantees reliable stream consumption.
</p>
<h2 id="consumer-groups">
Consumer groups
</h2>
<p>
Active-Active databases fully support consumer groups with Redis Streams. Here is an example of creating two consumer groups concurrently:
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
<code>
XGROUP CREATE x group2 0
</code>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group2]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
— Sync —
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1, group2]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1, group2]
</strong>
</td>
</tr>
</tbody>
</table>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<p>
Redis Community Edition uses one radix tree (
<code>
rax
</code>
) to hold the global pending entries list and another
<code>
rax
</code>
for each consumer's PEL.
The global PEL is a unification of all consumer PELs, which are disjoint.
</p>
<p>
An Active-Active database stream maintains a global PEL and a per-consumer PEL for each region.
</p>
<p>
When given an ID different from the special ">" ID, XREADGROUP iterates simultaneously over all of the PELs for all consumers.
It returns the next entry by comparing entry IDs from the different PELs.
</p>
</div>
</div>
<h3 id="conflict-resolution-1">
Conflict resolution
</h3>
<p>
The "delete wins" approach is a way to automatically resolve conflicts with consumer groups.
In case of concurrent consumer group operations, a delete will "win" over other concurrent operations on the same group.
</p>
<p>
In this example, the DEL at
<em>
t4
</em>
deletes both the observed
<code>
group1
</code>
and the non-observed
<code>
group2
</code>
:
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
DEL x
</code>
</td>
<td>
<code>
XGROUP CREATE x group2 0
</code>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
</tr>
</tbody>
</table>
<p>
In this example, the XGROUP DESTROY at
<em>
t4
</em>
affects both the observed
<code>
group1
</code>
created in Region 1 and the non-observed
<code>
group1
</code>
created in Region 3:
</p>
<table>
<thead>
<tr>
<th>
time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
<th>
Region 3
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
<code>
XINFO GROUPS x
</code>
<br/>
<strong>
→ []
</strong>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
</td>
<td>
<code>
XGROUP DESTROY x group1
</code>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
_— Sync —
</td>
<td>
— Sync —
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
<td>
<code>
EXISTS x
</code>
<br/>
<strong>
→ 0
</strong>
</td>
</tr>
</tbody>
</table>
<h3 id="group-replication">
Group replication
</h3>
<p>
Calls to XREADGROUP and XACK change the state of a consumer group or consumer. However, it's not efficient to replicate every change to a consumer or consumer group.
</p>
<p>
To maintain consumer groups in Active-Active databases with optimal performance:
</p>
<ol>
<li>
Group existence (CREATE/DESTROY) is replicated.
</li>
<li>
Most XACK operations are replicated.
</li>
<li>
Other operations, such as XGROUP, SETID, DELCONSUMER, are not replicated.
</li>
</ol>
<p>
For example:
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD messages 110 text hello
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XGROUP CREATE messages group1 0
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XREADGROUP GROUP group1 Alice STREAMS messages >
</code>
<br/>
<strong>
→ [110-1]
</strong>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<code>
XRANGE messages - +
</code>
<br/>
<strong>
→ [110-1]
</strong>
</td>
<td>
XRANGE messages - +
<br/>
<strong>
→ [110-1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XINFO GROUPS messages
</code>
<br/>
<strong>
→ [group1]
</strong>
</td>
<td>
XINFO GROUPS messages
<br/>
<strong>
→ [group1]
</strong>
</td>
</tr>
<tr>
<td>
<em>
t7
</em>
</td>
<td>
<code>
XINFO CONSUMERS messages group1
</code>
<br/>
<strong>
→ [Alice]
</strong>
</td>
<td>
XINFO CONSUMERS messages group1
<br/>
<strong>
→ []
</strong>
</td>
</tr>
<tr>
<td>
<em>
t8
</em>
</td>
<td>
<code>
XPENDING messages group1 - + 1
</code>
<br/>
<strong>
→ [110-1]
</strong>
</td>
<td>
XPENDING messages group1 - + 1
<br/>
<strong>
→ []
</strong>
</td>
</tr>
</tbody>
</table>
<p>
Using XREADGROUP across regions can result in regions reading the same entries.
This is due to the fact that Active-Active Streams is designed for at-least-once reads or a single consumer.
As shown in the previous example, Region 2 is not aware of any consumer group activity, so redirecting the XREADGROUP traffic from Region 1 to Region 2 results in reading entries that have already been read.
</p>
<h3 id="replication-performance-optimizations">
Replication performance optimizations
</h3>
<p>
Consumers acknowledge messages using the XACK command. Each ack effectively records the last consumed message. This can result in a lot of cross-region traffic. To reduce this traffic, we replicate XACK messages only when all of the read entries are acknowledged.
</p>
<table>
<thead>
<tr>
<th>
Time
</th>
<th>
Region 1
</th>
<th>
Region 2
</th>
<th>
Explanation
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<em>
t1
</em>
</td>
<td>
<code>
XADD x 110-0 f1 v1
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t2
</em>
</td>
<td>
<code>
XADD x 120-0 f1 v1
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t3
</em>
</td>
<td>
<code>
XADD x 130-0 f1 v1
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t4
</em>
</td>
<td>
<code>
XGROUP CREATE x group1 0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t5
</em>
</td>
<td>
<code>
XREADGROUP GROUP group1 Alice STREAMS x >
</code>
<br/>
<strong>
→ [110-0, 120-0, 130-0]
</strong>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t6
</em>
</td>
<td>
<code>
XACK x group1 110-0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t7
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
110-0 and its preceding entries (none) were acknowledged. We replicate an XACK effect for 110-0.
</td>
</tr>
<tr>
<td>
<em>
t8
</em>
</td>
<td>
<code>
XACK x group1 130-0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t9
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
130-0 was acknowledged, but not its preceding entries (120-0). We DO NOT replicate an XACK effect for 130-0
</td>
</tr>
<tr>
<td>
<em>
t10
</em>
</td>
<td>
<code>
XACK x group1 120-0
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<em>
t11
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
<em>
— Sync —
</em>
</td>
<td>
120-0 and its preceding entries (110-0 through 130-0) were acknowledged. We replicate an XACK effect for 130-0.
</td>
</tr>
</tbody>
</table>
<p>
In this scenario, if we redirect the XREADGROUP traffic from Region 1 to Region 2 we do not re-read entries 110-0, 120-0 and 130-0.
This means that the XREADGROUP does not return already-acknowledged entries.
</p>
<h3 id="guarantees">
Guarantees
</h3>
<p>
Unlike XREAD, XREADGOUP will never skip stream entries.
In traffic redirection, XREADGROUP may return entries that have been read but not acknowledged. It may also even return entries that have already been acknowledged.
</p>
<h2 id="summary">
Summary
</h2>
<p>
With Active-Active streams, you can write to the same logical stream from multiple regions. As a result, the behavior of Active-Active streams differs somewhat from the behavior you get with Redis Community Edition. This is summarized below:
</p>
<h3 id="stream-commands">
Stream commands
</h3>
<ol>
<li>
When using the
<em>
strict
</em>
ID generation mode, XADD does not permit full stream entry IDs (that is, an ID containing both MS and SEQ).
</li>
<li>
XREAD may skip entries when iterating a stream that is concurrently written to from more than one region. For reliable stream iteration, use XREADGROUP instead.
</li>
<li>
XSETID fails when the new ID is less than current ID.
</li>
</ol>
<h3 id="consumer-group-notes">
Consumer group notes
</h3>
<p>
The following consumer group operations are replicated:
</p>
<ol>
<li>
Consecutive XACK operations
</li>
<li>
Consumer group creation and deletion (that is, XGROUP CREATE and XGROUP DESTROY)
</li>
</ol>
<p>
All other consumer group metadata is not replicated.
</p>
<p>
A few other notes:
</p>
<ol>
<li>
XGROUP SETID and DELCONSUMER are not replicated.
</li>
<li>
Consumers exist locally (XREADGROUP creates a consumer implicitly).
</li>
<li>
Renaming a stream (using RENAME) deletes all consumer group information.
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/databases/active-active/develop/data-types/streams/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/previous-releases/k8s-6-0-6-6/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes Release Notes 6.0.6-6 (June 2020)
</h1>
<p class="text-lg -mt-5 mb-10">
Support for RS 6.0.6, new database and admission controllers, various improvements and bug fixes.
</p>
<p>
Redis Enterprise for Kubernetes 6.0.6-6 is now available. This release includes Redis Enterprise (RS) version
<a href="/docs/latest/operate/rs/release-notes/rs-6-0-may-2020/">
6.0
</a>
and introduces new features, improvements, and bug fixes.
</p>
<h2 id="overview">
Overview
</h2>
<p>
This release of the operator provides:
</p>
<ul>
<li>
Support for the Redis Enterprise Software release 6.0.6
</li>
<li>
Includes the new database and admission controllers
</li>
<li>
Various improvements and bug fixes
</li>
</ul>
<p>
To upgrade your deployment to this latest release, see
<a href="/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster/">
"Upgrade a Redis Enterprise cluster (REC) on Kubernetes"
</a>
.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
If you are running Active-Active (CRBD) databases on a previous release, do not upgrade to 6.0.6-6 at this time. There is an issue with the upgrade process that is currently being investigated (RED43635). For more information and support please
<a href="https://redislabs.com/company/support/">
contact Redis support
</a>
.
</div>
</div>
<h2 id="images">
Images
</h2>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
- redislabs/redis:6.0.6-6 or redislabs/redis:6.0.6-6.rhel7-openshift
</li>
<li>
<strong>
Operator
</strong>
- redislabs/operator:6.0.6-6 or redislabs/operator:6.0.6-6.rhel7
</li>
<li>
<strong>
Services Rigger
</strong>
- redislabs/k8s-controller:6.0.6-6 or redislabs/k8s-controller:6.0.6-6.rhel7
</li>
</ul>
<h2 id="new-features-and-improvements">
New features and improvements
</h2>
<ul>
<li>
<p>
Database controller - A new database controller in the operator provides the ability to create
and manage databases on a Redis Enterprise cluster via a custom resource (RED36516).
</p>
</li>
<li>
<p>
Admission controller - A new admission controller in the operator provides validation of
database custom resources (RED36458).
</p>
</li>
<li>
<p>
Pod tolerations - Support for specifying Redis Enterprise cluster node pod tolerations of node taints
has been added to the cluster CR (see podTolerations) (RED33069).
</p>
</li>
<li>
<p>
Pod annotations - Support for specifying Redis Enterprise cluster node pod annotations has been
added to the cluster CR (see podAnnotations) (RED35613).
</p>
</li>
<li>
<p>
Kubernetes versions - Support for Kubernetes 1.17 was added and versions 1.9 and 1.10 (previously deprecated) are no longer supported (RED41049).
</p>
</li>
<li>
<p>
Improved OLM Experience - The overall user experience and documentation in the OLM (OperatorHub) has been improved (RED37008).
</p>
</li>
<li>
<p>
Resource limits - Resource limits have been added to the recommended operator configuration (RED39572).
</p>
</li>
<li>
<p>
LoadBalancer service type added - The
<code>
LoadBalancer
</code>
value has been added to the
<code>
databaseServiceType
</code>
option in
<code>
servicesRiggerSpec
</code>
(RED43215):
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">servicesRiggerSpec</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">databaseServiceType</span><span class="p">:</span><span class="w"> </span><span class="l">LoadBalancer</span><span class="w">
</span></span></span></code></pre>
</div>
</li>
</ul>
<h2 id="important-fixes">
Important fixes
</h2>
<ul>
<li>
Service creation failure causes cluster setup failure (RED37197)
</li>
<li>
UI service update failure (RED37198)
</li>
<li>
Error shown in OLM deployment: "The field status.state is invalid" (RED40278)
</li>
<li>
OLM: StatefulSet not listed as an object owned by the Redis Enterprise Cluster (RED39296)
</li>
<li>
Setting extraLabels in the cluster CR did not label pods on OpenShift (RED39763)
</li>
<li>
log_collector failed to get the pods logs when a namespace wasn't given (RED39292)
</li>
<li>
Role and RoleBinding created or updated using an existing ServiceAccount in REC spec (RED42912)
</li>
</ul>
<h2 id="known-limitations">
Known limitations
</h2>
<ul>
<li>
<p>
CrashLoopBackOff pod status and cluster recovery - When a pod status is CrashLoopBackOff and we run the cluster recovery, the process
will not complete. The solution is to delete the crashing pods manually and
recovery process will continue (RED33713).
</p>
</li>
<li>
<p>
Active-Active (CRDB) - limitation on cluster name length - A cluster name longer than 20 characters will result in a rejected route
configuration as the host part of the domain name exceeds 63 characters. Cluster
names must be limited to 20 characters or less (RED25871).
</p>
</li>
<li>
<p>
Active-Active (CRDB) service broker cleanup - The service broker doesn't clean up database service bindings in case of failures.
These bindings must be removed manually (RED25825).
</p>
</li>
<li>
<p>
Service broker deployment error - The service broker deployment results in an error when two types of service naming
schemes are set. Choosing one of the methods will resolve this error (
<code>
redis-port
</code>
is the recommended default) (RED25547).
</p>
</li>
<li>
<p>
Cluster spec invalid errors not reported - A cluster CR specification error is not reported if two or more invalid CR resources are
updated in sequence (RED25542).
</p>
</li>
<li>
<p>
Unreachable cluster does not produce an error - When a cluster is in an unreachable state the state is still
<code>
running
</code>
instead of
being reported as an error (RED32805).
</p>
</li>
<li>
<p>
Readiness probe ignores rladmin failure - STS Readiness probe doesn't mark a node as not ready when rladmin status nodes fails (RED39300).
</p>
</li>
<li>
<p>
Missing permission for role - The redis-enterprise-operator role is missing permission on replicasets (RED39002).
</p>
</li>
<li>
<p>
Openshift 3.11 doesn't support DockerHub private registry - Openshift 3.11 doesn't support DockerHub private registry. This is a known OpenShift
issue and not addressable by Redis Enterprise for Kubernetes (RED38579).
</p>
</li>
<li>
<p>
Possible DNS conflicts within cluster nodes - DNS conflicts are possible between the cluster mdns_server and the K8s DNS.
This only impacts DNS resolution from within cluster node and while using the full fqdn *.cluster.local (RED37462).
</p>
</li>
<li>
<p>
Coexistence of 5.4.10 and 5.4.6 clusters - K8s clusters with Redis Enterprise 5.4.6 clusters are negatively affected by installing a Redis Enterprise 5.4.10 cluster due to changes in CRD (CustomeResourceDefinition) (RED37233).
</p>
</li>
<li>
<p>
Redis Enterprise CPU utilization metric reports at K8s node level rather than at pod level - In Kubernetes, the node CPU usage we report on is the usage of the K8S worker node hosting the REC pod (RED-36884). Pod resource utilization should be measured by K8s-native means rather than through the application.
</p>
</li>
<li>
<p>
Cluster name is limited on OpenShift via OLM - In OLM-deployed operators, the deployment of the cluster will fail if the name
is not "rec". When the operator is deployed via the OLM, the security context constraints (scc)
is bound to a specific service account name (i.e., "rec"). Naming the cluster
"rec" resolves the issue (RED39825).
</p>
</li>
</ul>
<h2 id="coming-soon">
Coming Soon
</h2>
<p>
The following lists features, fixes and changes the Redis team is currently investing in:
</p>
<ul>
<li>
<p>
Redis Enterprise and Kubernetes Container Artifacts - tarting from the next release of Redis Enterprise for K8s, new container artifacts will be published using different base images:
</p>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
- A UBI (RHEL 7) base image will replace the Ubuntu and the RHEL7 base images
</li>
<li>
<strong>
Operator
</strong>
- An Image built from scratch containing the Golang executable will replace the Ubuntu and the RHEL7 base images
</li>
<li>
<strong>
Services Rigger
</strong>
- A UBI (RHEL 7) base image will replace the Ubuntu and the RHEL7 base images
</li>
</ul>
</li>
<li>
<p>
Deprecation notice - he service broker solution is deprecated and will not be supported starting from the next release of the Redis Enterprise Operator for Kubernetes.
</p>
</li>
<li>
<p>
Additional Redis Enterprise Database configuration options in the Database Controller - We're currently investing in the following additional capabilities of the Database Controller:
</p>
<ul>
<li>
Support for loading database modules
</li>
<li>
Support for setting up Alerts, expressed as K8s events
</li>
<li>
Support for configuring database backup options
</li>
<li>
Support for Kubernetes 1.18
</li>
<li>
Support for Rancher K8s distribution
</li>
</ul>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/previous-releases/k8s-6-0-6-6/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Prometheus metrics v2 preview
</h1>
<p class="text-lg -mt-5 mb-10">
V2 metrics available to Prometheus as of Redis Enterprise Software version 7.8.2.
</p>
<div class="banner-article rounded-md" style="background-color: ">
<p>
While the metrics stream engine is in preview, this document provides only a partial list of v2 metrics. More metrics will be added.
</p>
</div>
<p>
You can
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/">
integrate Redis Enterprise Software with Prometheus and Grafana
</a>
to create dashboards for important metrics.
</p>
<p>
The v2 metrics in the following tables are available as of Redis Enterprise Software version 7.8.0. For help transitioning from v1 metrics to v2 PromQL, see
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2/">
Prometheus v1 metrics and equivalent v2 PromQL
</a>
.
</p>
<h2 id="database-metrics">
Database metrics
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Metric
</th>
<th style="text-align:left">
Type
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_client_connections
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of client connection establishment events
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_client_disconnections
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of client disconnections initiated by the client
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_client_connection_expired
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Total number of client connections with expired TTL (Time To Live)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_client_establishment_failures
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of client connections that failed to establish properly
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_client_expiration_refresh
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of expiration time changes of clients
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_client_tracking_off_requests
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Total number of
<code>
CLIENT TRACKING OFF
</code>
requests
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_client_tracking_on_requests
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Total number of
<code>
CLIENT TRACKING ON
</code>
requests
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_disconnected_cba_client
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of certificate-based clients disconnected
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_disconnected_ldap_client
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of LDAP clients disconnected
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_disconnected_user_password_client
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of user&password clients disconnected
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_disposed_commands_after_client_caching
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Total number of client caching commands that were disposed due to misuse
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_egress
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of egress bytes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_egress_pending
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of send-pending bytes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_egress_pending_discarded
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of send-pending bytes that were discarded due to disconnection
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_failed_cba_authentication
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of clients that failed certificate-based authentication
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_failed_ldap_authentication
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of clients that failed LDAP authentication
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_failed_user_password_authentication
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of clients that failed user password authentication
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_ingress
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of ingress bytes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_longest_pipeline_histogram
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Client connections with the longest pipeline lengths
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_other_requests
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of other requests
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_other_requests_latency_histogram
</span>
</td>
<td style="text-align:left">
histogram
</td>
<td style="text-align:left">
Latency (in µs) histogram of other commands
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_other_requests_latency_histogram_bucket
</span>
</td>
<td style="text-align:left">
histogram
</td>
<td style="text-align:left">
Latency histograms for commands other than read or write commands. Can be used to represent different latency percentiles.
<br/>
p99.9 example:
<br/>
<span class="break-all">
<code>
histogram_quantile(0.999, sum(rate(endpoint_other_requests_latency_histogram_bucket{cluster="$cluster", db="$db"}[$__rate_interval]) ) by (le, db))
</code>
</span>
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_other_responses
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of other responses
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_proxy_disconnections
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of client disconnections initiated by the proxy
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_read_requests
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of read requests
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_read_requests_latency_histogram
</span>
</td>
<td style="text-align:left">
histogram
</td>
<td style="text-align:left">
Latency (in µs) histogram of read commands
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_read_requests_latency_histogram_bucket
</span>
</td>
<td style="text-align:left">
histogram
</td>
<td style="text-align:left">
Latency histograms for read commands. Can be used to represent different latency percentiles.
<br/>
p99.9 example:
<br/>
<span class="break-all">
<code>
histogram_quantile(0.999, sum(rate(endpoint_read_requests_latency_histogram_bucket{cluster="$cluster", db="$db"}[$__rate_interval]) ) by (le, db))
</code>
</span>
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_read_responses
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of read responses
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_successful_cba_authentication
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of clients that successfully authenticated with certificate-based authentication
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_successful_ldap_authentication
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of clients that successfully authenticated with LDAP
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_successful_user_password_authentication
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of clients that successfully authenticated with user&password
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_write_requests
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of write requests
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_write_requests_latency_histogram
</span>
</td>
<td style="text-align:left">
histogram
</td>
<td style="text-align:left">
Latency (in µs) histogram of write commands
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_write_requests_latency_histogram_bucket
</span>
</td>
<td style="text-align:left">
histogram
</td>
<td style="text-align:left">
Latency histograms for write commands. Can be used to represent different latency percentiles.
<br/>
p99.9 example:
<br/>
<span class="break-all">
<code>
histogram_quantile(0.999, sum(rate(endpoint_write_requests_latency_histogram_bucket{cluster="$cluster", db="$db"}[$__rate_interval]) ) by (le, db))
</code>
</span>
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
endpoint_write_responses
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Number of write responses
</td>
</tr>
</tbody>
</table>
<h2 id="node-metrics">
Node metrics
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Metric
</th>
<th style="text-align:left">
Type
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<span class="break-all">
node_available_flash_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Available flash in the node (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_available_flash_no_overbooking_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Available flash in the node (bytes), without taking into account overbooking
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_available_memory_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Amount of free memory in the node (bytes) that is available for database provisioning
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_available_memory_no_overbooking_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Available RAM in the node (bytes) without taking into account overbooking
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_bigstore_free_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Sum of free space of back-end flash (used by flash database's [BigRedis]) on all cluster nodes (bytes); returned only when BigRedis is enabled
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_cert_expires_in_seconds
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Certificate expiration (in seconds) per given node; read more about
<a href="/docs/latest/operate/rs/security/certificates/">
certificates in Redis Enterprise
</a>
and
<a href="/docs/latest/operate/rs/security/certificates/monitor-certificates/">
monitoring certificates
</a>
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_ephemeral_storage_avail_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Disk space available to RLEC processes on configured ephemeral disk (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_ephemeral_storage_free_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Free disk space on configured ephemeral disk (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_memory_MemFree_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Free memory in the node (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_persistent_storage_avail_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Disk space available to RLEC processes on configured persistent disk (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_persistent_storage_free_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Free disk space on configured persistent disk (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_provisional_flash_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Amount of flash available for new shards on this node, taking into account overbooking, max Redis servers, reserved flash, and provision and migration thresholds (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_provisional_flash_no_overbooking_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Amount of flash available for new shards on this node, without taking into account overbooking, max Redis servers, reserved flash, and provision and migration thresholds (bytes)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_provisional_memory_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_provisional_memory_no_overbooking_bytes
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases, without taking into account overbooking
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
node_metrics_up
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Node is part of the cluster and is connected
</td>
</tr>
</tbody>
</table>
<h2 id="cluster-metrics">
Cluster metrics
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Metric
</th>
<th style="text-align:left">
Type
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<span class="break-all">
generation{cluster_wd=<node_uid>}
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Generation number of the specific cluster_wd
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
has_qourum{cluster_wd=<node_uid>, has_witness_disk=BOOL}
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Has_qourum = 1
<br/>
No quorum = 0
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
is_primary{cluster_wd=<node_uid>}
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
primary = 1
<br/>
secondary = 0
</td>
</tr>
<tr>
<td style="text-align:left">
license_shards_limit
</td>
<td style="text-align:left">
</td>
<td style="text-align:left">
Total shard limit by the license by shard type (ram / flash)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
total_live_nodes_count{cluster_wd=<node_uid>}
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Number of live nodes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
total_node_count{cluster_wd=<node_uid>}
</span>
</td>
<td style="text-align:left">
gauge
</td>
<td style="text-align:left">
Number of nodes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
total_primary_selection_ended{cluster_wd=<node_uid>}
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Monotonic counter for each selection process that ended
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
total_primary_selections{cluster_wd=<node_uid>}
</span>
</td>
<td style="text-align:left">
counter
</td>
<td style="text-align:left">
Monotonic counter for each selection process that started
</td>
</tr>
</tbody>
</table>
<h2 id="replication-metrics">
Replication metrics
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Metric
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_config
</span>
</td>
<td style="text-align:left">
Used as a placeholder for configuration labels
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_current_status
</span>
</td>
<td style="text-align:left">
Syncer status for traffic; 0 = in-sync, 2 = out of sync
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_dst_connectivity_state
</span>
</td>
<td style="text-align:left">
Destination connectivity state
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_dst_connectivity_state_ms
</span>
</td>
<td style="text-align:left">
Destination connectivity state duration
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_dst_lag
</span>
</td>
<td style="text-align:left">
Lag in milliseconds between the syncer and the destination
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_dst_repl_offset
</span>
</td>
<td style="text-align:left">
Offset of the last command acknowledged
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_flush_counter
</span>
</td>
<td style="text-align:left">
Number of destination flushes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_ingress_bytes
</span>
</td>
<td style="text-align:left">
Number of bytes read from source shard
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_ingress_bytes_decompressed
</span>
</td>
<td style="text-align:left">
Number of bytes read from source shard
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_internal_state
</span>
</td>
<td style="text-align:left">
Internal state of the syncer
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_lag_ms
</span>
</td>
<td style="text-align:left">
Lag time between the source and the destination for traffic in milliseconds
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_rdb_size
</span>
</td>
<td style="text-align:left">
The source's RDB size in bytes to be transferred during the syncing phase
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_rdb_transferred
</span>
</td>
<td style="text-align:left">
Number of bytes transferred from the source's RDB during the syncing phase
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_src_connectivity_state
</span>
</td>
<td style="text-align:left">
Source connectivity state
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_src_connectivity_state_ms
</span>
</td>
<td style="text-align:left">
Source connectivity state duration
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_src_repl_offset
</span>
</td>
<td style="text-align:left">
Last known source offset
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_state
</span>
</td>
<td style="text-align:left">
Internal state of the shard syncer
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_syncer_repl_offset
</span>
</td>
<td style="text-align:left">
Offset of the last command handled by the syncer
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_total_requests
</span>
</td>
<td style="text-align:left">
Number of destination writes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
database_syncer_total_responses
</span>
</td>
<td style="text-align:left">
Number of destination writes acknowledged
</td>
</tr>
</tbody>
</table>
<h2 id="shard-metrics">
Shard metrics
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Metric
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_active_defrag_running
</span>
</td>
<td style="text-align:left">
Automatic memory defragmentation current aggressiveness (% cpu)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_allocator_active
</span>
</td>
<td style="text-align:left">
Total used memory, including external fragmentation
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_allocator_allocated
</span>
</td>
<td style="text-align:left">
Total allocated memory
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_allocator_resident
</span>
</td>
<td style="text-align:left">
Total resident memory (RSS)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_aof_last_cow_size
</span>
</td>
<td style="text-align:left">
Last AOFR, CopyOnWrite memory
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_aof_rewrite_in_progress
</span>
</td>
<td style="text-align:left">
The number of simultaneous AOF rewrites that are in progress
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_aof_rewrites
</span>
</td>
<td style="text-align:left">
Number of AOF rewrites this process executed
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_aof_delayed_fsync
</span>
</td>
<td style="text-align:left">
Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_blocked_clients
</span>
</td>
<td style="text-align:left">
Count the clients waiting on a blocking call
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_connected_clients
</span>
</td>
<td style="text-align:left">
Number of client connections to the specific shard
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_connected_slaves
</span>
</td>
<td style="text-align:left">
Number of connected replicas
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_db0_avg_ttl
</span>
</td>
<td style="text-align:left">
Average TTL of all volatile keys
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_expired_keys
</span>
</td>
<td style="text-align:left">
Total count of volatile keys
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_db0_keys
</span>
</td>
<td style="text-align:left">
Total key count
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_evicted_keys
</span>
</td>
<td style="text-align:left">
Keys evicted so far (since restart)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_expire_cycle_cpu_milliseconds
</span>
</td>
<td style="text-align:left">
The cumulative amount of time spent on active expiry cycles
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_expired_keys
</span>
</td>
<td style="text-align:left">
Keys expired so far (since restart)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_forwarding_state
</span>
</td>
<td style="text-align:left">
Shard forwarding state (on or off)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_keys_trimmed
</span>
</td>
<td style="text-align:left">
The number of keys that were trimmed in the current or last resharding process
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_keyspace_read_hits
</span>
</td>
<td style="text-align:left">
Number of read operations accessing an existing keyspace
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_keyspace_read_misses
</span>
</td>
<td style="text-align:left">
Number of read operations accessing a non-existing keyspace
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_keyspace_write_hits
</span>
</td>
<td style="text-align:left">
Number of write operations accessing an existing keyspace
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_keyspace_write_misses
</span>
</td>
<td style="text-align:left">
Number of write operations accessing a non-existing keyspace
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_master_link_status
</span>
</td>
<td style="text-align:left">
Indicates if the replica is connected to its master
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_master_repl_offset
</span>
</td>
<td style="text-align:left">
Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_master_sync_in_progress
</span>
</td>
<td style="text-align:left">
The master shard is synchronizing (1 true
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_max_process_mem
</span>
</td>
<td style="text-align:left">
Current memory limit configured by redis_mgr according to node free memory
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_maxmemory
</span>
</td>
<td style="text-align:left">
Current memory limit configured by redis_mgr according to database memory limits
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_mem_aof_buffer
</span>
</td>
<td style="text-align:left">
Current size of AOF buffer
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_mem_clients_normal
</span>
</td>
<td style="text-align:left">
Current memory used for input and output buffers of non-replica clients
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_mem_clients_slaves
</span>
</td>
<td style="text-align:left">
Current memory used for input and output buffers of replica clients
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_mem_fragmentation_ratio
</span>
</td>
<td style="text-align:left">
Memory fragmentation ratio (1.3 means 30% overhead)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_mem_not_counted_for_evict
</span>
</td>
<td style="text-align:left">
Portion of used_memory (in bytes) that's not counted for eviction and OOM error
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_mem_replication_backlog
</span>
</td>
<td style="text-align:left">
Size of replication backlog
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_module_fork_in_progress
</span>
</td>
<td style="text-align:left">
A binary value that indicates if there is an active fork spawned by a module (1) or not (0)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
namedprocess_namegroup_cpu_seconds_total
</span>
</td>
<td style="text-align:left">
Shard process CPU usage percentage
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
namedprocess_namegroup_thread_cpu_seconds_total
</span>
</td>
<td style="text-align:left">
Shard main thread CPU time spent in seconds
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
namedprocess_namegroup_open_filedesc
</span>
</td>
<td style="text-align:left">
Shard number of open file descriptors
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
namedprocess_namegroup_memory_bytes
</span>
</td>
<td style="text-align:left">
Shard memory size in bytes
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
namedprocess_namegroup_oldest_start_time_seconds
</span>
</td>
<td style="text-align:left">
Shard start time of the process since unix epoch in seconds
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_rdb_bgsave_in_progress
</span>
</td>
<td style="text-align:left">
Indication if bgsave is currently in progress
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_rdb_last_cow_size
</span>
</td>
<td style="text-align:left">
Last bgsave (or SYNC fork) used CopyOnWrite memory
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_rdb_saves
</span>
</td>
<td style="text-align:left">
Total count of bgsaves since the process was restarted (including replica fullsync and persistence)
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_repl_touch_bytes
</span>
</td>
<td style="text-align:left">
Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_total_commands_processed
</span>
</td>
<td style="text-align:left">
Number of commands processed by the shard; calculate the number of commands for a time period by comparing the value at different times
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_total_connections_received
</span>
</td>
<td style="text-align:left">
Number of connections received by the shard; calculate the number of connections for a time period by comparing the value at different times
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_total_net_input_bytes
</span>
</td>
<td style="text-align:left">
Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_total_net_output_bytes
</span>
</td>
<td style="text-align:left">
Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_up
</span>
</td>
<td style="text-align:left">
Shard is up and running
</td>
</tr>
<tr>
<td style="text-align:left">
<span class="break-all">
redis_server_used_memory
</span>
</td>
<td style="text-align:left">
Memory used by shard (in BigRedis this includes flash) (bytes)
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|