This section describes master/standby DCS Redis instances.
-
You cannot upgrade the Redis version for an instance. For example, a master/standby DCS Redis 4.0 instance cannot be upgraded to a master/standby DCS Redis 5.0 instance. If your service requires the features of higher Redis versions, create a DCS Redis instance of a higher version and then migrate data from the old instance to the new one.
+ The major version cannot be upgraded. For example, a master/standby DCS Redis 4.0 instance cannot be upgraded to a master/standby DCS Redis 5.0 one. If your service requires the features of higher Redis versions, create a DCS Redis instance of a higher version and then migrate data from the old instance to the new one.
Features
Master/Standby DCS instances have higher availability and reliability than single-node DCS instances.
Master/Standby DCS instances have the following features:
diff --git a/docs/dcs/umn/CacheProxy.html b/docs/dcs/umn/CacheProxy.html index 3d94be3b5..312a067d5 100644 --- a/docs/dcs/umn/CacheProxy.html +++ b/docs/dcs/umn/CacheProxy.html @@ -13,7 +13,7 @@ -4 GB/8 GB/16 GB/24 GB/32 GB
+4GB/8GB/16GB/24GB/32GB
3
Single-Node Redis
A single-node DCS Redis instance has only one node and does not support data persistence. They are suitable for cache services that do not require data reliability.
- - You cannot upgrade the Redis version of an instance. For example, a single-node DCS instance cannot be upgraded from Redis 4.0 to Redis 5.0. If you need Redis features of later versions, create a DCS Redis instance of a later version and then migrate data from the earlier instance to the new one.
- Single-node instances cannot ensure data persistence and do not support manual or scheduled data backup. Exercise caution before using them.
- The major version cannot be upgraded. For example, a single-node DCS Redis 4.0 instance cannot be upgraded to a single-node DCS Redis 5.0 one. If you need Redis features of later versions, create a DCS Redis instance of a later version and then migrate data from the earlier instance to the new one.
- Single-node instances cannot ensure data persistence and do not support manual or scheduled data backup. Exercise caution before using them.
Features
- Low system overhead and high QPS
Single-node instances do not support data synchronization or data persistence, reducing system overhead and supporting higher concurrency. QPS of single-node DCS Redis instances reaches up to 100,000.
- - Process monitoring and automatic fault recovery
With an HA monitoring mechanism, if a single-node DCS instance becomes faulty, a new process is started within 30 seconds to resume service provisioning.
- - Out-of-the-box usability and no data persistence
Single-node DCS instances can be used out of the box because they do not involve data loading. If your service requires high QPS, you can warm up the data beforehand to avoid strong concurrency impact on the backend database.
- - Low-cost and suitable for development and testing
Single-node instances are 40% cheaper than master/standby DCS instances, suitable for setting up development or testing environments.
+-Features
- Low-cost and suitable for development and testing
Single-node instances are 40% cheaper than master/standby DCS instances, suitable for setting up development or testing environments.
+ - Non-persistent data
Data persistence is not ensured through one master node for single-node instances. The data cannot be backed up.
In summary, single-node DCS instances support highly concurrent read/write operations, but do not support data persistence. Data will be deleted after instances are restarted or stopped. They are suitable for scenarios which do not require data persistence, such as database front-end caching, to accelerate access and ease the concurrency load off the backend. If the desired data does not exist in the cache, requests will go to the database. When restarting the service or the DCS instance, you can pre-generate cache data from the disk database to relieve pressure on the backend during startup.
Architecture
Figure 1 shows the architecture of single-node DCS Redis instances.
+Architecture
Figure 1 shows the architecture of single-node DCS Redis instances.
- + To access a DCS Redis 3.0 instance, you must use port 6379. To access a DCS Redis 4.0 or later instance, you can customize the port. If no port is specified, the default port 6379 will be used. In the following architecture, port 6379 is used. If you have customized a port, replace 6379 with the actual port.
Architecture description:
- VPC
All server nodes of the instance run in the same VPC.
-diff --git a/docs/dcs/umn/PurchasePreparation.html b/docs/dcs/umn/PurchasePreparation.html index 2dd8a7d5a..64e6a9a95 100644 --- a/docs/dcs/umn/PurchasePreparation.html +++ b/docs/dcs/umn/PurchasePreparation.html @@ -2,11 +2,11 @@ For intra-VPC access, the client and the instance must be in the same VPC. For a Redis 3.0 instance, security group rules are required.
+ For intra-VPC access, the client and the instance must be in the same VPC.
- Application
The client of the instance, which is the application running on an Elastic Cloud Server (ECS).
DCS Redis instances are compatible with the Redis protocol, and can be accessed through open-source clients. For details about accessing DCS instances, see Accessing an Instance.
- DCS instance
A single-node DCS instance, which has only one node and one Redis process.
-DCS monitors the availability of the instance in real time. If the Redis process becomes faulty, DCS starts a new process to resume service provisioning.
Identifying Requirements
Before creating a DCS instance, identify your requirements and complete the following preparations:
-- Decide on the required cache engine version.
Different Redis versions have different features. For details, see Comparing Redis Versions.
- - Decide on the required instance type.
DCS provides single-node, master/standby, read/write splitting, Proxy Cluster, and Redis Cluster types of instances. Each type has its own architecture. For details about the instance architectures, see DCS Instance Types.
+- Decide on the required cache engine version.
Different Redis versions have different features. For details, see Comparing DCS Redis Versions.
+ - Decide on the required instance type.
DCS provides read/write splitting, single-node, master/standby, Proxy Cluster, and Redis Cluster types of instances. Each type has its own architecture. For details about the instance architectures, see DCS Instance Types.
- Decide on the required instance specification.
Each specification specifies the maximum available memory, number of connections, and bandwidth. For details, see DCS Instance Specifications.
- Decide on the region and whether cross-AZ deployment is required.
Choose a region closest to your application to reduce latency.
-A region consists of multiple availability zones (AZs) with physically isolated power supplies and networks. Master/Standby, read/write splitting, and cluster DCS instances can be deployed across AZs.
+A region consists of multiple availability zones (AZs) with physically isolated power supplies and networks. Master/Standby, read/write splitting, and cluster DCS instances can be deployed across AZs. Applications can also be deployed across AZs to achieve HA for both data and applications.
- If a master/standby, read/write splitting, or cluster DCS instance is deployed across AZs, faults in an AZ do not affect cache nodes in other AZs. This is because when the master node is faulty, the standby cache node will automatically become the master node to provide services. Such deployment achieves better disaster recovery.
- Deploying a DCS instance across AZs slightly reduces network efficiency compared with deploying an instance within an AZ. Therefore, if a DCS instance is deployed across AZs, synchronization between master and standby cache nodes is slightly less efficient.
- Decide whether backup policies are required.
Currently, backup restoration policies can be configured for instances other than single-node ones. For details about backup and restoration, see Overview.
diff --git a/docs/dcs/umn/RedisDifference.html b/docs/dcs/umn/RedisDifference.html index 257c1f491..03b38fa05 100644 --- a/docs/dcs/umn/RedisDifference.html +++ b/docs/dcs/umn/RedisDifference.html @@ -2,7 +2,7 @@Comparing Redis Versions
When creating a DCS Redis instance, you can select the cache engine version and the instance type.
-- Version
DCS supports Redis 3.0/4.0/5.0/6.0/7.0. The following table describes the differences between these versions.
+- Version
DCS supports Redis 3.0/4.0/5.0/6.0/7.0. The following table describes the differences between these versions.
-Table 1 Differences between Redis versions Feature
Redis 4.0 and Redis 5.0
Redis 6.0/7.0
+Redis 6.0/7.0
Single-node, master/standby, and Proxy Cluster
Single-node, master/standby, Proxy Cluster, read/write splitting, and Redis Cluster
+Single-node, read/write splitting, master/standby, Proxy Cluster, and Redis Cluster
Single-node, master/standby, and Redis Cluster
Procedure
- Log in to the DCS console.
- Click
in the upper left corner and select a region and a project. - In the navigation pane, choose Cache Manager.
- Click the name of an instance.
- Choose Instance Configuration > Tags.
View the tags of the instance.
+Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of an instance.
- Choose Instance Configuration > Tags.
View the tags of the instance.
- Perform the following operations as required:
- Add a tag
- Click Add/Edit Tag. You can create new tags by entering Tag key and Tag value.
If you have created predefined tags, select a predefined pair of tag key and value. To view predefined tags or create tags, click View predefined tags. You will be directed to the TMS console.
- Click OK.
- Click Add/Edit Tag. You can create new tags by entering Tag key and Tag value.
- Modify a tag
Click Add/Edit Tag. In the displayed Add/Edit Tag dialog box, delete the desired key, add the key again, enter a new tag value, and click Add.
diff --git a/docs/dcs/umn/dcs-faq-020220331.html b/docs/dcs/umn/dcs-faq-020220331.html new file mode 100644 index 000000000..d06244219 --- /dev/null +++ b/docs/dcs/umn/dcs-faq-020220331.html @@ -0,0 +1,17 @@ + + +How Do I Create a Multi-DB Proxy Cluster Instance?
++When you create a Proxy Cluster instance, there is only one database by default. This section describes how to create a Proxy Cluster instance with multiple databases.
+ +- Log in to the DCS console.
- Click
in the upper left corner to select a region. - In the navigation pane, choose Parameter Templates.
- In the row that contains the template with the desired cache engine version and instance type (Proxy Cluster), click Customize.
- Set multi-db to yes.
- Enter a new template name and click OK. The custom template is created successfully.
- In the navigation pane, choose Cache Manager. Then click Create DCS Instance to create a Proxy Cluster instance.
Set Parameter Configuration to Use custom template and select the custom template created in the preceding step.
+
+
After the instance is created, connect to it to check whether it has multiple databases.
+
++ diff --git a/docs/dcs/umn/dcs-faq-0326021.html b/docs/dcs/umn/dcs-faq-0326021.html index 8b9bdff4e..db6ff9fb8 100644 --- a/docs/dcs/umn/dcs-faq-0326021.html +++ b/docs/dcs/umn/dcs-faq-0326021.html @@ -16,7 +16,7 @@++Parent topic: Redis Usage+ - Why Is Available Memory Smaller Than Instance Cache Size?
- - Does DCS for Redis Support Multiple Databases?
+ - Does DCS for Redis Support Multi-DB?
- Does DCS for Redis Support Redis Clusters?
@@ -44,10 +44,14 @@
- Add a tag
- Why Does a Key Disappear in Redis?
+ - Notes and Procedure for Enabling Multi-DB for Proxy Cluster Instances
+ - Explaining and Using Hash Tags
- Will Cached Data Be Retained After an Instance Is Restarted?
+ - How Do I Create a Multi-DB Proxy Cluster Instance?
+ - Can DCS Redis Instances Be Upgraded, for Example, from Redis 4.0 to 5.0?
+ - Can the Major Version of a DCS Redis Instance Be Upgraded, for Example, from Redis 4.0 to 5.0?
- Are Services Interrupted If Maintenance is Performed During the Maintenance Time Window?
diff --git a/docs/dcs/umn/dcs-faq-0427028.html b/docs/dcs/umn/dcs-faq-0427028.html
new file mode 100644
index 000000000..8b77f2719
--- /dev/null
+++ b/docs/dcs/umn/dcs-faq-0427028.html
@@ -0,0 +1,14 @@
+
+
+ - Single-node, read/write splitting, and master/standby DCS Redis instances: Multi-DB is supported. By default, there are 256 databases, numbering 0–255. The default database is DB0. Multi-DB is used for data isolation. The size of each database is not evenly allocated. As a result, one database may fully occupy the memory of the instance.
- Proxy Cluster: There is only one database by default.
- For details about how to create a Proxy Cluster instance with multiple databases, see How Do I Create a Multi-DB Proxy Cluster Instance?
- For details about how to enable multi-DB for a single-DB Proxy Cluster instance, see Notes and Procedure for Enabling Multi-DB for Proxy Cluster Instances
- Redis Cluster DCS instances: Multi-DB is not supported. There is only one database (DB0).
- CPU Usage
- Memory Usage
- Used Memory
- Ops per Second
- To check the maximum number of connections, go to the Parameters tab page of the instance and check the maxclients metric. (Currently, read/write splitting instances do not have this parameter. To query the maximum connections of them, see .)
- To check the current number of connections, go to the Performance Monitoring tab page of the instance and check the Connected Clients metric.
- To check the maximum number of connections, go to the Instance > Parameters tab page of the instance and check the maxclients metric. (Currently, read/write splitting instances do not have this parameter. To query the maximum connections of them, see DCS Instance Specifications.)
- To check the current number of connections, go to the Performance Monitoring tab page of the instance and check the Connected Clients metric.
- Network
- Check the IP address configurations.
Check whether the IP address configured on the Jedis client is the same as the subnet address configured for your DCS instance.
- Test the network.
Use the ping command and telnet on the client to test the network.
- If the network cannot be pinged:
For intra-VPC access to a DCS Redis 3.0 instance, ensure that the client and your DCS instance belong to the same VPC and security group, or the security group of your DCS instance allows access through port 6379. For details, see Security Group Configurations.
+For intra-VPC access to a DCS Redis instance, ensure that the client and your DCS instance belong to the same VPC.
- If the IP address can be pinged but telnet failed, restart your instance. If the problem persists after the restart, contact technical support.
- If the network cannot be pinged:
- Check the IP address configurations.
- Check the number of connections.
Check whether the number of established network connections exceeds the upper limit configured for the Jedis connection pool. If the number of established connections approaches the configured upper limit, restart the DCS service and check whether the problem persists. If the number of established connections is far below the upper limit, continue with the following checks.
diff --git a/docs/dcs/umn/dcs-faq-0730007.html b/docs/dcs/umn/dcs-faq-0730007.html index af56c1f5a..62175a37e 100644 --- a/docs/dcs/umn/dcs-faq-0730007.html +++ b/docs/dcs/umn/dcs-faq-0730007.html @@ -4,7 +4,7 @@The possible causes are as follows:
- The command is spelled incorrectly.
As shown in the following figure, the error message is returned because the correct command for deleting a string should be del.
-
- A command available in a higher Redis version is run in a lower Redis version.
As shown in the following figure, the error message is returned because a stream command (available in Redis 5.0) is run in Redis 3.0.
+ - A command available in a higher Redis version is run in a lower Redis version.
For example, the error message is returned because a stream command (available in Redis 5.0) is run in Redis 3.0.
- Some commands are disabled.
DCS Redis instance interfaces are fully compatible with the open-source Redis in terms of data access. However, for ease of use and security purposes, some operations cannot be initiated through Redis clients. For details about disabled commands, see Command Compatibility.
diff --git a/docs/dcs/umn/dcs-faq-0730019.html b/docs/dcs/umn/dcs-faq-0730019.html deleted file mode 100644 index 89f28d33c..000000000 --- a/docs/dcs/umn/dcs-faq-0730019.html +++ /dev/null @@ -1,12 +0,0 @@ - - -Does DCS for Redis Support Multiple Databases?
--Both single-node and master/standby DCS Redis instances support multiple databases. By default, single-node and master/standby DCS instances can read and write data in 256 databases (databases numbering 0–255). The default database is DB0.
-Redis Cluster DCS instances do not support multi-DB. There is only one database (DB0).
--- diff --git a/docs/dcs/umn/dcs-faq-0730022.html b/docs/dcs/umn/dcs-faq-0730022.html index 1d9fb61ec..f24a85711 100644 --- a/docs/dcs/umn/dcs-faq-0730022.html +++ b/docs/dcs/umn/dcs-faq-0730022.html @@ -8,7 +8,6 @@--Parent topic: Redis Usage- - The command is spelled incorrectly.
- Redis 4.0 and later
You can specify a port (ranging from 1 to 65535) or use the default port (6379) for accessing an instance. If no port is specified, the default port will be used.
- In the navigation pane of the DCS console, choose Cache Manager.
- Click a DCS Redis instance.
- In the Connection area, click
next to Connection Address.
After the port is changed, all connections to the Redis instance are interrupted, and services are connected to the new port.
diff --git a/docs/dcs/umn/dcs-faq-0730043.html b/docs/dcs/umn/dcs-faq-0730043.html index 21c6d1bb1..91a51c1f3 100644 --- a/docs/dcs/umn/dcs-faq-0730043.html +++ b/docs/dcs/umn/dcs-faq-0730043.html @@ -1,8 +1,7 @@ -Can DCS Redis Instances Be Upgraded, for Example, from Redis 4.0 to 5.0?
-No. Different Redis versions use different underlying architectures. The Redis version used by a DCS instance cannot be changed once the instance is created. For example, you cannot change a DCS Redis 4.0 instance to Redis 5.0. However, you will be informed of any defects or problems found in Redis.
-If your service requires the features of higher Redis versions, create a DCS Redis instance of a higher version and then migrate data from the original instance to the new one. For details on how to migrate data, see Migrating Data with DCS.
+Can the Major Version of a DCS Redis Instance Be Upgraded, for Example, from Redis 4.0 to 5.0?
+No. It is unavailable. Different Redis versions use different underlying architectures. The Redis version used by a DCS instance cannot be changed once the instance is created. For example, you cannot change a DCS Redis 4.0 instance to Redis 5.0. If your service requires the features of higher Redis versions, create a DCS Redis instance of a higher version and then migrate data from the original instance to the new one. For details on how to migrate data, see Migrating Data with DCS.
diff --git a/docs/dcs/umn/dcs-faq-0730058.html b/docs/dcs/umn/dcs-faq-0730058.html index e69e66cf3..95c707815 100644 --- a/docs/dcs/umn/dcs-faq-0730058.html +++ b/docs/dcs/umn/dcs-faq-0730058.html @@ -2,10 +2,10 @@-When Does a Master/Standby Switchover Occur?
A master/standby switchover may occur in the following scenarios:
-- A master/standby switchover operation is initiated on the DCS Console.
- If the master node of a master/standby instance fails, a master/standby switchover will be triggered.
For example, running commands that consume a lot of resources, such as KEYS commands, will cause CPU usage to spike and as result triggers a master/standby switchover.
- - If you restart a master/standby instance on the DCS console, a master/standby switchover will be triggered.
- If you scale up a single-node, read/write splitting, or master/standby instance, a master/standby switchover will be triggered.
During scale-up, a new standby node with the new specifications is created. After full and incremental data on the master node is synchronized to the standby node, a master/standby switchover is performed and the original node is deleted.
+- A master/standby switchover operation is initiated on the DCS Console.
- If the master node of a master/standby instance fails, a master/standby switchover will be triggered.
For example, if commands (such as KEYS) that consume a lot of resources are used or logs are aged and deleted in batches, the CPU usage will surge, triggering a master/standby switchover.
+ - If you restart a master/standby instance on the DCS console, a master/standby switchover will be triggered.
- A master/standby switchover is triggered during Redis instance scale-out.
During scale-up, a new standby node with the new specifications is created. After full and incremental data on the master node is synchronized to the standby node, a master/standby switchover is performed and the original node is deleted.
After a master/standby switchover occurs, you will receive a notification. Check whether the client services are running properly. If not, check whether the TCP connection is normal and whether it can be re-established after the master/standby switchover to restore the services.
+To monitor master/standby switchovers of instances, create event monitoring on Cloud Eye. Then, the system reports master/standby switchovers based on event alarm rules. Check whether the client services are abnormal if needed. If the services are abnormal, check whether the client connections are normal, and whether client connections can be retried after master/standby switchovers. Restart the client if the connections cannot be retried.
diff --git a/docs/dcs/umn/dcs-faq-210804001.html b/docs/dcs/umn/dcs-faq-210804001.html new file mode 100644 index 000000000..b19bbd793 --- /dev/null +++ b/docs/dcs/umn/dcs-faq-210804001.html @@ -0,0 +1,21 @@ + + +Notes and Procedure for Enabling Multi-DB for Proxy Cluster Instances
++Note the following constraints when you consider implementing multi-DB:
+- Usage constraints:
- The SWAPDB command does not support multi-DB.
- The INFO KEYSPACE command does not return data of multi-DB.
- To query the total number of keys in each database, use the customized dbstats command. CPU usage will surge on the node executing this command.
- LUA scripts do not support multi-DB.
- The RANDOMKEY command does not support multi-DB.
- PUBLISH cannot be used in Lua scripts.
- The database number ranges from 0 to 255.
- Proxy Cluster DCS Redis 3.0 instances do not support multi-DB.
- Performance constraints
- The FLUSHDB command deletes keys one by one, which takes a long time and is slower than the open-source native implementation. The execution speed of the FLUSHDB command is the same as that of the SCAN command (which should be tested by the customer).
- The DBSIZE command is time-consuming. Do not use it in the code.
- If multi-DB is used, the performance of the KEYS and SCAN commands deteriorates by up to 50%.
- Other constraints:
The backend storage rewrites keys based on certain rules. Keys in the exported RDB file are not the original keys. However, the access through the Redis protocol is not affected.
+
+Procedure for Enabling or Disabling Multi-DB
By default, a Proxy Cluster instance is not enabled with multi-DB, but you can do as follows to enable multi-DB.
+- Log in to the DCS console.
- Connect to the instance and run the FLUSHALL command to clear the instance data.+
Before enabling or disabling multi-DB, ensure that all instance data is cleared and no data is being written.
+ - On the Cache Manager page of the DCS console, click the desired DCS instance.
- Choose Instance Configuration > Parameters.
- To enable multi-DB, click Modify in the row that contains parameter multi-db, and change its value to yes.
To disable multi-DB, change the value to no.
+ - Click Save and then confirm the modification. The instance does not need to be restarted.
++ diff --git a/docs/dcs/umn/dcs-faq-221222.html b/docs/dcs/umn/dcs-faq-221222.html index 086556022..55129af27 100644 --- a/docs/dcs/umn/dcs-faq-221222.html +++ b/docs/dcs/umn/dcs-faq-221222.html @@ -2,7 +2,7 @@++Parent topic: Redis Usage+Is the Read-only Address of a Master/Standby Instance Connected to the Master or Standby Node?
diff --git a/docs/dcs/umn/dcs-migrate-0220411.html b/docs/dcs/umn/dcs-migrate-0220411.html index aab6f68d4..ea9e49eb4 100644 --- a/docs/dcs/umn/dcs-migrate-0220411.html +++ b/docs/dcs/umn/dcs-migrate-0220411.html @@ -24,36 +24,36 @@ vi nginx.confA master/standby DCS Redis 4.0 or later instance has a Connection Address and a Read-only Address. The connection address is used to connect to the master node of the instance, and the read-only address is used to connect to the standby node of the instance.
-For details, see Architecture of Master/Standby DCS Redis Instances.
+For more information, see Architecture of Master/Standby DCS Redis Instances.
Figure 1 Instance addresses
By default, the client reads and writes data on the master node. Data is synchronized to the standby node. To implement read/write splitting, ensure that your client can distinguish between read and write requests. The client directs write requests to the read/write domain name and read requests to the read-only domain name.
- Example forwarding configuration:
stream { server { listen 6379; - proxy_pass {source_instance_address}:{port}; + proxy_pass {source_instance_address}:{port}; } }6379 is the listening port of the source forwarding server. {source_instance_address} and {port} are the connection address and port of the source Redis instance.
This configuration allows you to access the source Redis through the local listening port 6379 of the source forwarding server.
This configuration must be added exactly where it is shown in the following figure.
-Figure 2 Configuration location+
Figure 2 Configuration location 1- Restart Nginx.
service nginx restart
- Verify whether Nginx has been started.
netstat -an|grep 6379
If the port is being listened, Nginx has been started successfully.
-Figure 3 Verification result+
Figure 3 Verification result 1- Configure Nginx forwarding for the ECS.
- Log in to the Linux ECS and run the following commands to open and modify the configuration file:
cd /etc/nginx vi nginx.conf
- Configuration example:
stream { server { listen 6666; - proxy_pass {source_ecs_address}:6379; + proxy_pass {source_ecs_address}:6379; } }6666 is ECS's listening port, {source_ecs_address} is the public IP address of the source forwarding server, and 6379 is the listening port of the source forwarding server Nginx.
This configuration allows you to access the source forwarding server through the local listening port 6666 of the ECS.
This configuration must be added exactly where it is shown in the following figure.
-Figure 4 Configuration location+
Figure 4 Configuration location 2 - Restart Nginx.
service nginx restart
- Verify whether Nginx has been started.
netstat -an|grep 6666
If the port is being listened, Nginx has been started successfully.
-Figure 5 Verification result+
Figure 5 Verification result 2
- Run the following command on the ECS to test the network connection of port 6666:
redis-cli -h {target_ecs_address} -p 6666 -a {password}+- Run the following command on the ECS to test the network connection of port 6666:
redis-cli -h {target_ecs_address} -p 6666 -a {password}{target_ecs_address} is the EIP of the ECS, 6666 is the listening port of the ECS, and {password} is the source Redis password. If there is no password, leave it blank.
Figure 6 Connection example
- Prepare the migration tool redis-shake.
- Log in to the ECS.
- Download redis-shake on the ECS. Version 2.0.3 is used as an example. You can use other redis-shake versions as required.
wget https://github.com/tair-opensource/RedisShake/releases/download/release-v2.0.3-20200724/redis-shake-v2.0.3.tar.gz
@@ -77,7 +77,7 @@ vi nginx.confFigure 8 Migration result
- After the migration is complete, use redis-cli to connect to the source and target Redis instances to check whether the data is complete.
- Connect to the source and target Redis instances, respectively.
For details, see Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
- Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
- Connect to the source and target Redis instances, respectively.
- Delete the redis-shake configuration file.
- After the verification is complete, you are advised to clear the redis-shake configuration in time.
diff --git a/docs/dcs/umn/dcs-migrate-1117003.html b/docs/dcs/umn/dcs-migrate-1117003.html index c20ec51c0..df21157aa 100644 --- a/docs/dcs/umn/dcs-migrate-1117003.html +++ b/docs/dcs/umn/dcs-migrate-1117003.html @@ -8,31 +8,31 @@-Prerequisites
- A DCS Redis instance has been created. Note that the memory of the DCS Redis Cluster instance cannot be smaller than that of the source cluster.
- An ECS has been created for running redis-shake. The ECS must use the same VPC, subnet, and security group as the Redis instance.
diff --git a/docs/dcs/umn/dcs-migrate-demo02.html b/docs/dcs/umn/dcs-migrate-demo02.html index a443c154e..5621b2384 100644 --- a/docs/dcs/umn/dcs-migrate-demo02.html +++ b/docs/dcs/umn/dcs-migrate-demo02.html @@ -9,41 +9,46 @@Procedure
- Access the target Redis instance using redis-cli. Obtain the IP address and port of the master node of the target instance.
redis-cli -h {target_redis_address} -p {target_redis_port} -a {target_redis_password} cluster nodes+Procedure
- Access the target Redis instance using redis-cli. Obtain the IP address and port of the master node of the target instance.
redis-cli -h {target_redis_address} -p {target_redis_port} -a {target_redis_password} cluster nodes- {target_redis_address}: connection address of the target DCS Redis instance.
- {target_redis_port}: port of the target DCS Redis instance.
- {target_redis_password}: password for connecting to the target DCS Redis instance.
In the command output similar to the following, obtain the IP addresses and ports of all masters.
- Install redis-shake on the prepared ECS.
- Log in to the ECS.
- Download redis-shake on the ECS. Version 2.0.3 is used as an example. You can use other redis-shake versions as required.
wget https://github.com/tair-opensource/RedisShake/releases/download/release-v2.0.3-20200724/redis-shake-v2.0.3.tar.gz
- Decompress the redis-shake file.
tar -xvf redis-shake-v2.0.3.tar.gz
+If the source Redis is deployed in the data center intranet, install redis-shake on the intranet server. Export data and then upload the data to the cloud server as instructed by the following steps.
If the source Redis is deployed in the data center intranet, install redis-shake on the intranet server. Export data and then upload the data to the cloud server as instructed by the following steps.
- - Export the RDB file from the source Redis console. If the RDB file cannot be exported, contact customer service of the source.
- Import the RDB file.
- Import the RDB file (or files) to the cloud server. The cloud server must be connected to the target DCS instance.
- Edit the redis-shake configuration file redis-shake.conf.
vim redis-shake.conf
Add the following information about all the masters of the target:target.type = cluster # If there is no password, skip the following parameter. -target.password_raw = {target_redis_password} +target.password_raw = {target_redis_password} # IP addresses and port numbers of all masters of the target instance, which are separated by semicolons (;). target.address = {master1_ip}:{master1_port};{master2_ip}:{master2_port}...{masterN_ip}:{masterN_port} # List the RDB files to be imported, separated by semicolons (;). -rdb.input = {local_dump.0};{local_dump.1};{local_dump.2};{local_dump.3}+rdb.input = {local_dump.0};{local_dump.1};{local_dump.2};{local_dump.3}Press Esc to exit the editing mode and enter :wq!. Press Enter to save the configuration and exit the editing interface.
- Run the following command to import the RDB file to the target instance:
./redis-shake -type restore -conf redis-shake.conf
If the following information is displayed in the execution log, the backup file is imported successfully:
Enabled http stats, set status (incr), and wait forever.
- Verify the migration.
After data synchronization, access the target Redis Cluster DCS instance using redis-cli. Run the info command to query the number of keys in the Keyspace section to confirm that data has been fully imported.
-If the data has not been fully imported, run the flushall or flushdb command to clear the cached data in the instance, and synchronize data again.
+ - Verify the migration.
Before data migration, if the target Redis has no data, check data integrity after the migration is complete in the following way:
+- Connect to the source Redis and the target Redis. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
+
- Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
- Access the target Redis instance using redis-cli. Obtain the IP address and port of the master node of the target instance.
- An Elastic Cloud Server (ECS) has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide.
Select the same VPC, subnet, and security group as the DCS Redis Cluster instance, and bind EIPs to the ECS.
- If the source self-hosted Redis Cluster is deployed on cloud servers of another cloud, allow public access to the servers.
Obtaining Information of the Source and Target Redis Nodes
- Connect to the source and target Redis instances, respectively. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- In online migration of Redis Clusters, the migration must be performed node by node. Run the following command to query the IP addresses and ports of all nodes in both the source and target Redis Clusters.
redis-cli -h {redis_address} -p {redis_port} -a {redis_password} cluster nodes+-Obtaining Information of the Source and Target Redis Nodes
- Connect to the source and target Redis instances, respectively. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- In online migration of Redis Clusters, the migration must be performed node by node. Run the following command to query the IP addresses and ports of all nodes in both the source and target Redis Clusters.
redis-cli -h {redis_address} -p {redis_port} -a {redis_password} cluster nodes{redis_address} indicates the Redis connection address, {redis_port} indicates the Redis port, and {redis_password} indicates the Redis connection password.
-In the command output similar to the following, obtain the IP addresses and ports of all masters.
+In the output, obtain the IP addresses and ports of all the master nodes.
Configuring the redis-shake Tool
- Log in to the ECS.
- Run the following command on the ECS to download the redis-shake: This section uses v2.1.2 as an example. You can also download other redis-shake versions as required.
wget https://github.com/tair-opensource/RedisShake/releases/download/release-v2.1.2-20220329/release-v2.1.2-20220329.tar.gz
- - Decompress the redis-shake file.
tar -xvf redis-shake-v2.1.2.tar.gz
+Configuring the redis-shake Tool
- Log in to the ECS.
- Run the following command on the ECS to download the redis-shake: This section uses v4.3.2 as an example. You can also download other redis-shake versions as required.
wget https://github.com/tair-opensource/RedisShake/releases/download/v4.3.2/redis-shake-v4.3.2-linux-amd64.tar.gz
+ - Decompress the redis-shake file.
mkdir redis-shake-v4.3.2 +tar -C redis-shake-v4.3.2 -xzvf redis-shake-v4.3.2-linux-amd64.tar.gz
-
- Go to the redis-shake directory.
cd redis-shake-v2.0.3
- - Edit the redis-shake.conf file by providing the following information about all the masters of both the source and the target:
vim redis-shake.conf
-The modification is as follows:-source.type = cluster -# If there is no password, skip the following parameter. -source.password_raw = {source_redis_password} -# IP addresses and port numbers of all masters of the source Redis Cluster, which are separated by semicolons (;). -source.address = {master1_ip}:{master1_port};{master2_ip}:{master2_port}...{masterN_ip}:{masterN_port} -target.type = cluster -# If there is no password, skip the following parameter. -target.password_raw = {target_redis_password} -# IP addresses and port numbers of all masters of the target instance, which are separated by semicolons (;). -target.address = {master1_ip}:{master1_port};{master2_ip}:{master2_port}...{masterN_ip}:{masterN_port}+- Go to the decompressed directory.
cd redis-shake-v4.3.2
+- Edit the shake.toml file by providing the following information of both the source and the target.
vim shake.toml
+The modification is as follows:[sync_reader] +# If the source instance type is a Redis Cluster, set the value to true. +cluster = true +# IP address and port of any node in the source Redis Cluster +address = {redis_ip}:{redis_port} +# If there is no password, skip the following parameter +password = {source_redis_password} +[redis_writer] +# If the target instance type is a Redis Cluster, set the value to true. +cluster = true +# IP address and port of any node in the target Redis Cluster +address = {redis_ip}:{redis_port} +# If there is no password, skip the following parameter +password = {target_redis_password}Press Esc to exit the editing mode and enter :wq!. Press Enter to save the configuration and exit the editing interface.
Migrating Data Online
Run the following command to synchronize data between the source and the target Redis:./redis-shake -type sync -conf redis-shake.conf
+Migrating Data Online
Run the following command to synchronize data between the source and the target Redis:./redis-shake shake.toml
If the following information is displayed, the full synchronization has been completed and incremental synchronization begins.
-sync rdb done.
+syncing aof
If the following information is displayed, no new data is incremented. You can stop the incremental synchronization by pressing Ctrl+C.
-sync: +forwardCommands=0 +filterCommands=0 +writeBytes=0
+write_ops=[0.00], src-*, syncing aof, diff=[0]
Figure 1 Online migration using redis-shake
Verifying the Migration
- After the data synchronization, connect to the Redis Cluster DCS instance by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info command to check whether the data has been successfully imported as required.
If the data has not been fully imported, run the flushall or flushdb command to clear the cached data in the target instance, and migrate data again.
- - After the verification is complete, delete the redis shake configuration file.
- After the verification is complete, you are advised to clear the redis-shake configuration in time.
diff --git a/docs/dcs/umn/dcs-migrate-demo03.html b/docs/dcs/umn/dcs-migrate-demo03.html index c85fc0c18..f4caac555 100644 --- a/docs/dcs/umn/dcs-migrate-demo03.html +++ b/docs/dcs/umn/dcs-migrate-demo03.html @@ -1,29 +1,27 @@Self-Hosted Redis Cluster Migration with redis-shake (RDB)
-redis-shake is an open-source tool for migrating data online or offline (by importing backup files) between Redis Clusters. Data can be migrated to DCS Redis Cluster instances seamlessly because DCS Redis Cluster inherits the native Redis Cluster design.
+redis-shake is an open-source tool for migrating data online or offline (by importing backup files) between Redis Clusters. Data can be migrated to DCS Redis Cluster instances seamlessly because DCS Redis Cluster inherits the native Redis Cluster design. If the source Redis and the target Redis cannot be connected, or the source Redis is deployed on other clouds, you can migrate data by importing backup files.
The following describes how to use Linux redis-shake to migrate self-hosted Redis Cluster to a DCS Redis Cluster instance offline.
- If the source Redis and the target Redis cannot be connected, or the source Redis is deployed on other clouds, you can migrate data by importing backup files.
-Notes and Constraints
To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
-Prerequisites
- A DCS Redis Cluster instance has been created. For details about how to create one, see Creating a DCS Redis Instance.
The memory of the target Redis instance cannot be smaller than that of the source Redis.
- - An Elastic Cloud Server (ECS) has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide. Select the same VPC, subnet, and security group as the DCS Redis Cluster instance.
- An Elastic Cloud Server (ECS) has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide. Select the same VPC, subnet, and security group as the DCS Redis Cluster instance.
Obtaining Information of the Source and Target Redis Nodes
- Connect to the source and target Redis instances, respectively. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- In online migration of Redis Clusters, the migration must be performed node by node. Run the following command to query the IP addresses and ports of all nodes in both the source and target Redis Clusters.
redis-cli -h {redis_address} -p {redis_port} -a {redis_password} cluster nodes+Obtaining Information of the Source and Target Redis Nodes
- Connect to the source and target Redis instances, respectively. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- In online migration of Redis Clusters, the migration must be performed node by node. Run the following command to query the IP addresses and ports of all nodes in both the source and target Redis Clusters.
redis-cli -h {redis_address} -p {redis_port} -a {redis_password} cluster nodes{redis_address} indicates the Redis connection address, {redis_port} indicates the Redis port, and {redis_password} indicates the Redis connection password.
-In the command output similar to the following, obtain the IP addresses and ports of all masters.
+In the output, obtain the IP addresses and ports of all the master nodes.
-Installing RedisShake
- Log in to the ECS.
- Run the following command on the ECS to download the redis-shake: This section uses v2.1.2 as an example. You can also download other redis-shake versions as required.
wget https://github.com/tair-opensource/RedisShake/releases/download/release-v2.1.2-20220329/release-v2.1.2-20220329.tar.gz
- - Decompress the redis-shake file.
tar -xvf redis-shake-v2.1.2.tar.gz
+ - Decompress the redis-shake file.
tar -xvf release-v2.1.2-20220329.tar.gz
+
If the source cluster is deployed in the data center intranet, install redis-shake on the intranet server. Export the source cluster backup file by referring to Exporting the Backup File. Upload the backup to the ECS.
If the source cluster is deployed in the data center intranet, install redis-shake on the intranet server. Export the source cluster backup file by referring to Exporting the Backup File. Upload the backup to the cloud server as instructed by the following steps
-Exporting the Backup File
- Go to the redis-shake directory.
cd redis-shake-v2.0.3
+Exporting the Backup File
- Go to the redis-shake directory.
cd bin
+
- Edit the redis-shake.conf file by providing the following information about all the masters of the source:
vim redis-shake.conf
The modification is as follows:source.type = cluster # If there is no password, skip the following parameter. @@ -53,7 +51,7 @@ rdb.input = {local_dump.0};Verifying the Migration
- After the data synchronization, connect to the Redis Cluster DCS instance by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info command to check whether the data has been successfully imported as required.
If the data has not been fully imported, run the flushall or flushdb command to clear the cached data in the target instance, and migrate data again.
- - After the verification is complete, delete the redis shake configuration file.
- After the verification is complete, you are advised to clear the redis-shake configuration in time.
diff --git a/docs/dcs/umn/dcs-migration-0312001.html b/docs/dcs/umn/dcs-migration-0312001.html index 70115e654..3b4e2f22f 100644 --- a/docs/dcs/umn/dcs-migration-0312001.html +++ b/docs/dcs/umn/dcs-migration-0312001.html @@ -160,7 +160,7 @@ - Go to the redis-shake directory.
- Go to the decompressed directory.
diff --git a/docs/dcs/umn/dcs-faq-0326022.html b/docs/dcs/umn/dcs-faq-0326022.html index 78501d852..d1818306c 100644 --- a/docs/dcs/umn/dcs-faq-0326022.html +++ b/docs/dcs/umn/dcs-faq-0326022.html @@ -4,7 +4,7 @@-
-
Does DCS for Redis Support Multi-DB?
++DCS's support for multiple databases (multi-DB) is as follows:
+The number of databases cannot be changed, and the size of each database cannot be customized.
+++ diff --git a/docs/dcs/umn/dcs-faq-0427070.html b/docs/dcs/umn/dcs-faq-0427070.html index fa4c9118d..1f88dd466 100644 --- a/docs/dcs/umn/dcs-faq-0427070.html +++ b/docs/dcs/umn/dcs-faq-0427070.html @@ -2,7 +2,7 @@++Parent topic: Redis Usage+How Do I View Current Concurrent Connections and Maximum Connections of a DCS Redis Instance?
Viewing Concurrent Connections of a DCS Redis Instance
The number of connections received by a DCS instance is a metric that is monitored by Cloud Eye. For details on how to view metrics, see Viewing DCS Monitoring Metrics.
-On the Cloud Eye console, find the Connected Clients metric. Click
+
to view monitoring details on an enlarged graph.On the Cloud Eye console, find the Connected Clients metric. Click
to view monitoring details on an enlarged graph.Specify a time range to view the metric in a specific monitoring period. For example, you can select a 10-minute period to view the number of connections received during the period. On the graph, you can view the trend and the total number of connections received during the period.
On the Cloud Eye console, you can also view other monitoring metrics of your DCS instances, for example:diff --git a/docs/dcs/umn/dcs-faq-0603001.html b/docs/dcs/umn/dcs-faq-0603001.html index 17407c219..8d9451960 100644 --- a/docs/dcs/umn/dcs-faq-0603001.html +++ b/docs/dcs/umn/dcs-faq-0603001.html @@ -2,10 +2,10 @@Why Is the Rejected Connections Metric Displayed?
If the Rejected Connections metric is displayed, check if the number of connected clients exceeds the maximum allowed number of connections of the instances.
- The Rejected Connections metric of data nodes can be checked only for master/standby, cluster, and read/write splitting DCS Redis 4.0/5.0/6.0 instances.
+- The Rejected Connections metric of data nodes can be checked only for master/standby, cluster, and read/write splitting DCS Redis 4.0 and later instances.
If the current number of connections reaches the upper limit, you can adjust the value of maxclients. If the value of maxclients can no longer be increased, increase the instance specifications.
+If the current number of connections reaches the upper limit, you can adjust the value of maxclients. If the value of maxclients can no longer be increased, consider adding shards.
diff --git a/docs/dcs/umn/dcs-faq-0730006.html b/docs/dcs/umn/dcs-faq-0730006.html index ac0975f78..f8df86a35 100644 --- a/docs/dcs/umn/dcs-faq-0730006.html +++ b/docs/dcs/umn/dcs-faq-0730006.html @@ -7,6 +7,7 @@diff --git a/docs/dcs/umn/dcs-faq-0730026.html b/docs/dcs/umn/dcs-faq-0730026.html index 3d461f6a3..a6d123240 100644 --- a/docs/dcs/umn/dcs-faq-0730026.html +++ b/docs/dcs/umn/dcs-faq-0730026.html @@ -6,7 +6,7 @@If the instance and the client use different security groups, you must configure access rules for the security groups, allowing access through the specified port. For details, see Security Group Configurations.
-Customizing a Port
When creating a DCS Redis 4.0, 5.0, or 6.0 instance, you can enter a port number for IP Address. If you do not specify a port, the default port 6379 is used.
+Customizing a Port
When creating a DCS Redis 4.0 or later instance, you can enter a port for IP Address. If you do not specify a port, the default port 6379 is used.
Changing the Port
After a DCS Redis 4.0 or later instance is created, you can change its port.
- Version
- Version
- Decide on the required cache engine version.
- Application
- Low-cost and suitable for development and testing
Whitelist or security group
DCS Redis 3.0, 4.0, 5.0, and 6.0 professional edition instances are deployed in different modes. Therefore, the access control methods vary. You can control access to your DCS instances by setting security groups or whitelists. For details, see How Do I Configure a Security Group? or Managing IP Address Whitelist.
+DCS Redis instances of various versions are deployed in different modes. Therefore, the access control methods vary. You can control access to your DCS instances by setting security groups or whitelists. For details, see How Do I Configure a Security Group? or Managing IP Address Whitelist.
...
diff --git a/docs/dcs/umn/dcs-migration-0312003.html b/docs/dcs/umn/dcs-migration-0312003.html index 488e7cd93..ba01e7d90 100644 --- a/docs/dcs/umn/dcs-migration-0312003.html +++ b/docs/dcs/umn/dcs-migration-0312003.html @@ -2,19 +2,16 @@Online Migration Between Instances
If the source and target instances are interconnected and the SYNC and PSYNC commands are supported by the source instance, data can be migrated online in full or incrementally from the source to the target.
- During online migration, data is essentially synchronized in full to a new replica. Therefore, perform online migration during low-demand hours. Otherwise, source instance CPU usage may surge and latency may increase.
-Notes and Constraints
- You cannot use public networks for online migration.
- Before migrating data, read through Migration Solution Notes to learn about the DCS data migration function and select an appropriate target instance.
- Migrating a later Redis instance to an earlier one may fail.
- For earlier instances whose passwords contain single quotation marks ('), modify the password for online migration or try other methods.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration with Rump.
- During online migration, you are advised to set repl-timeout on the source instance to 300s and client-output-buffer-slave-hard-limit and client-output-buffer-slave-soft-limit to 20% of the maximum memory of the instance.
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
Notes and Constraints
- You cannot use public networks for online migration.
- Migrating a later Redis instance to an earlier one may fail.
- For earlier instances whose passwords contain single quotation marks ('), modify the password for online migration or try other methods.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration from Another Cloud Using Rump.
- During online migration, you are advised to set repl-timeout on the source instance to 300s and client-output-buffer-slave-hard-limit and client-output-buffer-slave-soft-limit to 20% of the maximum memory of the instance.
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- During online migration, data is essentially synchronized in full to a new replica. Therefore, perform online migration during low-demand hours. Otherwise, source instance CPU usage may surge and latency may increase.
Prerequisites
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data.
If the data exists on the target instance, the replicated data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
+-Prerequisites
- Before migrating data, read through Migration Solution Notes to learn about the DCS data migration function and select an appropriate target instance.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data.
If the data exists on the target instance, the replicated data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
Creating an Online Migration Task
- Log in to the DCS console.
If the source and target Redis are under different accounts, use the source account to log in to DCS.
- - Click
in the upper left corner of the console and select the region where your source instance is located.- Only when the online migration task and the source Redis are under an account and in a region, the SYNC and PSYNC commands of the source Redis are allowed. Otherwise, online migration cannot be performed.
- - In the navigation pane, choose Data Migration. The migration task list is displayed.
- Click Create Online Migration Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
- - Configure the VPC, subnet, and security group for the migration task.
- Use the VPC of the source or target Redis.
- The online migration task uses a tenant IP address (Migration ECS displayed on the Basic Information page of the task.) If a whitelist is configured for the source or target instance, add the migration IP address to the whitelist or disable the whitelist.
- To allow the VM used by the migration task to access the source and target instances, set an outbound rule for the task's security group to allow traffic through the IP addresses and ports of the source and target instances. By default, all outbound traffic is allowed.
Creating an Online Migration Task
+
Only when the online migration task and the source Redis are under an account and in a region, the SYNC and PSYNC commands of the source Redis are allowed. Therefore, create one task under the same account in the same region as the source.
- Log in to the DCS console.
If the source and target Redis are under different accounts, use the source account to log in to DCS.
+ - Click
in the upper left corner of the console and select the region where your source instance is located. - In the navigation pane, choose Data Migration. The migration task list is displayed.
- Click Create Online Migration Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
+ - Configure the VPC, subnet, and security group for the migration task.
- Use the VPC of the source or target Redis.
- The online migration task uses a tenant IP address (Migration ECS displayed on the Basic Information page of the task.) If a whitelist is configured for the source or target instance, add the migration IP address to the whitelist or disable the whitelist.
- To allow the VM used by the migration task to access the source and target instances, set an outbound rule for the task's security group to allow traffic through the IP addresses and ports of the source and target instances. By default, all outbound traffic is allowed.
-Checking the Network
- Check whether the source Redis instance, the target Redis instance, and the migration task are configured with the same VPC.
If yes, go to Configuring the Online Migration Task. If no, go to 2.
@@ -22,23 +19,24 @@ - Perform the following operations to establish the network.
- If the source and target Redis instances are in the same DCS region, create a VPC peering connection by referring to "Peering Connection" in Virtual Private Cloud (VPC) User Guide.
- If the source and target Redis instances are in different DCS regions, create a connection by referring to the Direct Connect User Guide.
Configuring the Online Migration Task
- On the Online Migration tab page, click Configure in the row containing the online migration task you just created.
- Select a migration type.
Supported migration types are Full and Full + Incremental, which are described in Table 1.
+Configuring the Online Migration Task
- Click Next and configure the source and target Redis instances.
If the resources are not ready yet, click Create to create a migration task. After they are ready, click Configure on the right of the task to continue its configuration.
+ - Select a migration type.
Supported migration types are Full and Full + Incremental, which are described in Table 1.
To switch DCS instance IPs after instance migration, select Full + Incremental for the migration type.
-Table 1 Migration type description Migration Type
+Table 1 Migration type description Migration Type
Description
+Description
Full
+Full
Suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during the migration will not be migrated to the target instance.
+Suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during the migration will not be migrated to the target instance.
Full + incremental
+Full + incremental
Suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances.
+Suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances.
Once the migration starts, it remains Migrating until you click Stop in the Operation column. After the migration is stopped, data in the source instance will not be lost, but data will not be written to the target instance. When the transmission network is stable, the delay of incremental migration is within seconds. The actual delay depends on the transmission quality of the network link.
Figure 1 Selecting the migration type
- Only if Migration Type is set to Full + Incremental, you can specify a bandwidth limit.
The data synchronization rate can be kept around the bandwidth limit.
- Specify Auto-Reconnect. If this option is enabled, automatic reconnections will be performed indefinitely in the case of a network exception.
Full synchronization will be triggered and requires more bandwidth if incremental synchronization becomes unavailable. Exercise caution when enabling this option.
-- Configure Source Redis and Target Redis.
- Set Source Redis Type to Redis in the cloud and add Source Redis Instance.
- Configure Target Redis Type and Target Redis Instance:
- If the target Redis and migration task are in a VPC, or across VPCs over a network in a region, set Target Redis Type to Redis in the cloud and add Target Redis Instance.
- If the target Redis and migration task are in different regions, set Target Redis Type to Self-hosted Redis and add Target Redis Instance. If the target Redis is a Redis Cluster, enter the IP addresses and ports of all masters in the cluster and separate multiple addresses with commas (,). For example: 192.168.1.1:6379,192.168.0.0:6379
- Configure Source Data and Target Data.
- Set Source Redis Type to Redis in the cloud and add Source Redis Instance.+
When a DCS instance is used as the source, do not select Self-hosted Redis.
+ - Configure Target Redis Type and Target Redis Instance:
- If the target Redis and migration task are in a VPC, or across VPCs over a network in a region, set Target Redis Type to Redis in the cloud and add Target Redis Instance.
- If the target Redis and migration task are in different regions, set Target Redis Type to Self-hosted Redis and add Target Redis Instance. If the target Redis is a Redis Cluster, enter the IP addresses and ports of all masters in the cluster and separate multiple addresses with commas (,). For example: 192.168.1.1:6379,192.168.0.0:6379
- Configure Source Redis Instance Password and Target Redis Instance Password: If the instance is password-protected, click Test Connection to check whether the instance password is correct and whether the network is connected. If the instance is not password-protected, click Test Connection directly.
Currently, the users created in Managing Users are unavailable here.
- Set Source Redis Type to Redis in the cloud and add Source Redis Instance.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
-If the migration fails, click the migration task and check the log on the Migration Logs page.
-+ - Once full + incremental migration starts, it remains Migrating after full migration.
- To manually stop a migration task, select the check box on the left of the migration task and click Stop above the migration task.
- Click Create.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+- If the migration fails, click the migration task and check the log on the Migration Logs page.
- Once full + incremental migration starts, it remains Migrating after full migration.
- To manually stop a migration task, select the check box on the left of the migration task and click Stop above the migration task.
Verifying the Migration
After the migration is complete, check data integrity in the following way.
- Connect the source Redis and the target Redis. For details, see Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command on the source and the target Redis to check the values of keys and expires.Figure 2 Checking instance data
- Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
+ During full migration, source Redis data updated during the migration will not be migrated to the target instance.
-During full migration, source Redis data updated during the migration will not be migrated to the target instance.
(Optional) Switching DCS Instance IP Addresses
The prerequisites for switching source and target Redis instance IP addresses are as follows. The target Redis can be accessed automatically on a client after the switch.
Prerequisites:
-- This function is supported by basic edition DCS Redis 4.0 instances and later, but not by professional edition DCS Redis instances.
- For DCS Redis 3.0 instances, contact customer service to enable the whitelist for Redis 3.0 instance IP switches. The instance IP addresses can be switched only when the source instance is a DCS Redis 3.0 instance and the target instance is a basic edition DCS Redis 4.0, 5.0, or 6.0 instance.
- The IP addresses of a source or target instance with public access enabled cannot be switched.
- Instance IPs can be switched only for the source and target Redis that are single-node, master/standby, read/write splitting, or Proxy Cluster instances.
- Full + Incremental must be selected in 2.
- The source and target Redis instance ports must be consistent.
- - Online migration will stop during the switching.
- Instances will be read-only for one minute and disconnected for several seconds during the switching.
- If your application cannot reconnect to Redis or handle exceptions, you may need to restart the application after the IP switching.
- If the source and target instances are in different subnets, the subnet information will be updated after the switching.
- If the source is a master/standby instance, the IP address of the standby node will not be switched. Ensure that this IP address is not used by your applications.
- If your applications use a domain name to connect to Redis, the domain name will be used for the source instance. Select Yes for Switch Domain Name.
- Ensure that the passwords of the source and target instances are the same. If they are different, verification will fail after the switching.
- If a whitelist is configured for the source instance, ensure that the same whitelist is configured for the target instance before switching IP addresses.
- On the Data Migration > Online Migration page, when the migration task status changes to Incremental migration in progress, choose More > Switch IP in the Operation column.
- In the Switch IP dialog box, select whether to switch the domain name. diff --git a/docs/dcs/umn/dcs-migration-0312004.html b/docs/dcs/umn/dcs-migration-0312004.html index 7ddb896bb..0bfb012e8 100644 --- a/docs/dcs/umn/dcs-migration-0312004.html +++ b/docs/dcs/umn/dcs-migration-0312004.html @@ -2,34 +2,37 @@
- If a Redis domain name is used on the client, switch it or you must modify the domain name on the client.
- If the domain name switch is not selected, only the instance IP addresses will be switched.
- This function is supported by DCS Redis 4.0 instances and later.
- The IP addresses of a source or target instance with public access enabled cannot be switched.
- Instance IPs can be switched only for the source and target Redis that are single-node, master/standby, read/write splitting, or Proxy Cluster instances.
- Full + Incremental must be selected in 2.
- The source and target Redis instance ports must be consistent.
+ - Online migration will stop during the switching.
- Instances will be read-only for one minute and disconnected for several seconds during the switching.
- If your application cannot reconnect to Redis or handle exceptions, you may need to restart the application after the IP switching.
- If the source and target instances are in different subnets, the subnet information will be updated after the switching.
- If the source is a master/standby instance, the IP address of the standby node will not be switched. Ensure that this IP address is not used by your applications.
- If your applications use a domain name to connect to Redis, the domain name will be used for the source instance. Select Yes for Switch Domain Name.
- Ensure that the passwords of the source and target instances are the same. If they are different, verification will fail after the switching.
- If a whitelist is configured for the source instance, ensure that the same whitelist is configured for the target instance before switching IP addresses.
- On the Data Migration > Online Migration page, when the migration task status changes to Incremental migration in progress, choose More > Switch IP in the Operation column.
- In the Switch IP dialog box, select whether to switch the domain name.
- If a Redis domain name is used on the client, switch it or you must modify the domain name on the client.
- If the domain name switch is not selected, only the instance IP addresses will be switched.
- Click OK. The IP address switching task is submitted successfully. When the status of the migration task changes to IP switched, the IP address switching is complete.
To restore the IPs, choose More > Roll Back IP in the operation column. The IPs are rolled back when the task is in the Successful state.
Backup Import Between DCS Redis Instances
You can migrate data between DCS instances by importing backup files.
-- If the source Redis and target Redis are in the same region under the same DCS account, and the source Redis is not a single-node instance, see Importing Backup Data from a Redis Instance.
- If the source Redis and target Redis are in different regions or under different DCS accounts, or the source Redis is a single-node instance, see Importing Backup Data from an OBS Bucket.
Notes and Constraints
To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
+Notes and Constraints
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- Migration may fail if the target instance uses smaller specifications than its source.
-Prerequisites
- You have successfully backed up the source Redis instance.
- For Importing Backup Data from a Redis Instance, you do not need to download the backup file to the local PC. For details about how to back up data, see Manually Backing Up a DCS Instance.
- For Importing Backup Data from an OBS Bucket, download the backup file to the local PC by referring to Downloading a Backup File.
- You have prepared the target Redis instance. If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
Redis is backward compatible. The target instance version must be the same as or later than the source instance version.
- Ensure that the target Redis instance has sufficient storage space. You can clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
+Importing Backup Data from a Redis Instance
- Log in to the DCS console.
- Click
in the upper left corner of the console and select the region where your source and target instances are located. - In the navigation pane, choose Data Migration. The migration task list is displayed.
- Click Create Backup Import Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
- - For source Redis, set Data Source to Redis.Figure 1 Selecting a data source (Redis)-
- For Source Redis Instance, select the source instance to be migrated.
- Select the backup task whose data is to be migrated.
- For Target Redis Instance, select the DCS Redis instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
++Procedure
- If the source Redis and target Redis are in the same region under the same DCS account, and the source Redis is not a single-node instance, see Importing Backup Data from a Redis Instance.
- If the source Redis and target Redis are in different regions or under different DCS accounts, or the source Redis is a single-node instance, see Importing Backup Data from an OBS Bucket.
Importing Backup Data from a Redis Instance
- Log in to the DCS console.
- Click in the upper left corner of the console and select the region where your source and target instances are located.
- In the navigation pane, choose Data Migration. The migration task list is displayed.
- Click Create Backup Import Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
+ - For source Redis, set Data Source to Redis.
- For Source Redis Instance, select the source instance to be migrated.
- Select the backup task whose data is to be migrated.
- For Target Redis Instance, select the DCS Redis instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+Importing Backup Data from an OBS Bucket
Simply download the source Redis data and then upload the data to an OBS bucket in the same account and region as the target DCS Redis instance. After you have created a backup import task, data in the OBS bucket will be read and migrated to the target Redis.
-- - .aof, .rdb, .zip, and .tar.gz files can be uploaded to OBS buckets. You can directly upload .aof and .rdb files or compress them into .zip or .tar.gz files before uploading.
- To migrate data from a cluster Redis instance, download all backup files and upload all of them to the OBS bucket. Each backup file contains data for a shard of the instance. During the migration, you need to select backup files of all shards.
- .aof, .rdb, .zip, and .tar.gz files can be uploaded to OBS buckets. You can directly upload .aof and .rdb files or compress them into .zip or .tar.gz files before uploading.
- To migrate data from a cluster Redis instance, download all backup files and upload all of them to the OBS bucket. Each backup file contains data for a shard of the instance. During the migration, you need to select backup files of all shards.
- Create an OBS bucket in the account and region where the target Redis instance is located. If a qualified OBS bucket is available, you do not need to create one.When creating an OBS bucket, pay attention to the configuration of the following parameters. For details on how to set other parameters, see "Creating a Bucket" in Object Storage Service User Guide.-
- Region:
The OBS bucket must be in the same region as the target DCS Redis instance.
- Default Storage Class: Select Standard or Infrequent Access.
Do not select Archive. Otherwise, the migration will fail.
- Region:
- Upload the backup file to the OBS bucket.
- In the bucket list, click the name of the created bucket.
- In the navigation pane, choose Objects.
- On the Objects tab page, click Upload Object.
- Specify Storage Class.
Do not select Archive. Otherwise, the migration will fail.
+ - Upload the backup file to the OBS bucket.
- In the bucket list on the OBS console, click the name of the created bucket.
- In the navigation pane, choose Objects.
- On the Objects tab page, click Upload Object.
- Specify Storage Class.
Do not select Archive. Otherwise, the migration will fail.
- Upload the objects.
Drag files or folders to the Upload Object area or click add file.
A maximum of 100 files can be uploaded at a time. The total size cannot exceed 5 GB. If the total size of files to be uploaded exceeds 5 GB, click "How to Upload a File Larger than 5 GB" in the upper part of the Upload Object dialog box and perform operations as instructed.
- Click Upload.
- Click
in the upper left corner and choose Distributed Cache Service for Redis under Databases to open the DCS console. - In the navigation pane, choose Data Migration.
- Click Create Backup Import Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
- - In the Source Redis area, select OBS Bucket for Data Source and then select the OBS bucket to which you have uploaded backup files.
- Click Add Backup and select the backup files to be migrated.
- In the Target Redis area, select the Target Redis Instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+ - Log in to the DCS console.
- In the navigation pane, choose Data Migration.
- Click Create Backup Import Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
+ - In the Source Data area, select OBS bucket for Data Source and then select the OBS bucket to which you have uploaded backup files.
- Click Add Backup and select the backup files to be migrated.
- In the Target Data area, select the Target Redis Instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+Verifying the Migration
After the migration is complete, check data integrity in the following way.
+- Connect the source Redis and the target Redis. For details, see Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command on the source and the target Redis to check the values of keys and expires.Figure 1 Checking instance data+
- Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
Parent topic: Migrating Data Between DCS Instancesdiff --git a/docs/dcs/umn/dcs-migration-0312006.html b/docs/dcs/umn/dcs-migration-0312006.html index 94c47dc69..0b740f5b0 100644 --- a/docs/dcs/umn/dcs-migration-0312006.html +++ b/docs/dcs/umn/dcs-migration-0312006.html @@ -2,37 +2,35 @@Migrating Redis from Another Cloud Online
If the source and target instances are interconnected and the SYNC and PSYNC commands are supported by the source instance, data can be migrated online in full or incrementally from another cloud to the target DCS.
-- During online migration, data is essentially synchronized in full to a new replica. Therefore, perform online migration during low-demand hours. Otherwise, source instance CPU usage may surge and latency may increase.
-Notes and Constraints
- If the SYNC and PSYNC commands are disabled by the source instance, enable them by contacting the source vendor. Otherwise, the migration fails.
- You cannot use public networks for online migration.
- During online migration, you are advised to set repl-timeout on the source instance to 300s and client-output-buffer-slave-hard-limit and client-output-buffer-slave-soft-limit to 20% of the maximum memory of the source instance.
- The source must be Redis 3.0 or later.
- For earlier instances whose passwords contain single quotation marks ('), modify the password for online migration or try other methods.
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
-Notes and Constraints
- If the SYNC and PSYNC commands are disabled by the source instance, enable them by contacting the source vendor. Otherwise, the migration fails.
- You cannot use public networks for online migration.
- During online migration, you are advised to set repl-timeout on the source instance to 300s and client-output-buffer-slave-hard-limit and client-output-buffer-slave-soft-limit to 20% of the maximum memory of the source instance.
- The source must be Redis 3.0 or later.
- For earlier instances whose passwords contain single quotation marks ('), modify the password for online migration or try other methods.
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- During online migration, data is essentially synchronized in full to a new replica. Therefore, perform online migration during low-demand hours. Otherwise, source instance CPU usage may surge and latency may increase.
Prerequisites
- Before migrating data, read through Migration Tools and Schemes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration with Rump.
- The IP address and port of the source Redis instance has been obtained.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
-Prerequisites
- Before migrating data, read through Migration Solution Notes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration from Another Cloud Using Rump.
- The IP address and port of the source Redis instance has been obtained.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
Creating an Online Migration Task
- Log in to the DCS console using the account of the target DCS Redis instance.
- Click in the upper left corner of the console and select the region where your target instance is located.
- In the navigation pane, choose Data Migration.
- Click Create Online Migration Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
- - Configure the VPC, subnet, and security group for the migration task.+
- Select the same VPC as the target Redis. Ensure that the migration resource can access the target Redis instance.
- The online migration task uses a tenant IP address (Migration ECS displayed on the Basic Information page of the task.) If a whitelist is configured for the source or target instance, add the migration IP address to the whitelist or disable the whitelist.
- To allow the VM used by the migration task to access the source and target instances, set an outbound rule for the task's security group to allow traffic through the IP addresses and ports of the source and target instances. By default, all outbound traffic is allowed.
Creating an Online Migration Task
- Log in to the DCS console using the account of the target DCS Redis instance.
- Click in the upper left corner of the console and select the region where your target instance is located.
- In the navigation pane, choose Data Migration.
- Click Create Online Migration Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
+ - Configure the VPC, subnet, and security group for the migration task.
- Select the same VPC as the target Redis. Ensure that the migration resource can access the target Redis instance.
- The online migration task uses a tenant IP address (Migration ECS displayed on the Basic Information page of the task.) If a whitelist is configured for the source or target instance, add the migration IP address to the whitelist or disable the whitelist.
- To allow the VM used by the migration task to access the source and target instances, set an outbound rule for the task's security group to allow traffic through the IP addresses and ports of the source and target instances. By default, all outbound traffic is allowed.
-Checking the Network
- Check whether the source Redis instance, the target Redis instance, and the migration task are configured with the same VPC.
If yes, go to Configuring the Online Migration Task. If no, go to 2.
- Check whether the VPCs configured for the source Redis instance, the target Redis instance, and the migration task are connected to ensure that the VM resource of the migration task can access the source and target Redis instances.
If yes, go to Configuring the Online Migration Task. If no, go to 3.
- - If the source and target Redis instances are on different clouds, create a connection using only Direct Connect. For details, see the Direct Connect User Guide.
- If the source and target Redis instances are on different clouds, create a Direct Connect connection. For details, see the Direct Connect User Guide.
Configuring the Online Migration Task
- On the Online Migration tab page, click Configure in the row containing the online migration task you just created.
- Select a migration type.
Supported migration types are Full and Full + Incremental, which are described in Table 1.
+Configuring the Online Migration Task
- Click Next and configure the source and target Redis instances.
If the resources are not ready yet, click Create to create a migration task. After they are ready, click Configure on the right of the task to continue its configuration.
+ - Select a migration type.
Supported migration types are Full and Full + Incremental, which are described in Table 1.
-Table 1 Migration type description Migration Type
+Table 1 Migration type description Migration Type
Description
+Description
Full
+Full
Suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during the migration will not be migrated to the target instance.
+Suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during the migration will not be migrated to the target instance.
Full + incremental
+Full + incremental
Suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances.
+Suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances.
Once the migration starts, it remains Migrating until you click Stop in the Operation column. After the migration is stopped, data in the source instance will not be lost, but data will not be written to the target instance. When the transmission network is stable, the delay of incremental migration is within seconds. The actual delay depends on the transmission quality of the network link.
- Configure Target Redis Type and Target Redis Instance:
Set Redis in the cloud for Target Redis Type and add Target Redis Instance.
- Configure Source Redis Instance Password and Target Redis Instance Password: If the instance is password-protected, click Test Connection to check whether the instance password is correct and whether the network is connected. If the instance is not password-protected, click Test Connection directly. If the test fails, check whether the password is correct, and whether the migration task network is connected.
-If a DCS Redis instance is used, the users created in Managing Users are currently unavailable.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
-If the migration fails, click the migration task and check the log on the Migration Logs page.
-+ - Once incremental migration starts, it remains Migrating after full migration.
- To manually stop a migration task, select the check box on the left of the migration task and click Stop above the migration task.
- Click Create.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+- If the migration fails, click the migration task and check the log on the Migration Logs page.
- Once incremental migration starts, it remains Migrating after full migration.
- To manually stop a migration task, select the check box on the left of the migration task and click Stop above the migration task.
Verifying the Migration
Before data migration, if the target Redis has no data, check data integrity after the migration is complete in the following way:
- Connect to the source Redis and the target Redis. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
- Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
During full migration, source Redis data updated during the migration will not be migrated to the target instance.
+diff --git a/docs/dcs/umn/dcs-migration-0312010.html b/docs/dcs/umn/dcs-migration-0312010.html index 22952500a..8d7ae656f 100644 --- a/docs/dcs/umn/dcs-migration-0312010.html +++ b/docs/dcs/umn/dcs-migration-0312010.html @@ -1,35 +1,34 @@Self-Hosted Redis Migration with redis-cli (AOF)
-redis-cli is the command line tool of Redis, which can be used after you install the Redis server. This section describes how to use redis-cli to migrate a data from a self-hosted Redis instance to a DCS instance.
+redis-cli is the command line tool of Redis, which can be used after you install the Redis server. This section describes how to use redis-cli to migrate a data from a self-hosted Redis instance to a DCS instance. To migrate the source backup to a DCS instance via an OBS bucket, see Self-Hosted Redis Migration with Backup Files.
An AOF file can be generated quickly. It applies to scenarios where you can access the Redis server and modify the configurations, such as scenarios with self-built Redis servers.
-Notes and Constraints
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- Smaller target instance specifications than source instance specifications may cause failures.
- Migrate data during off-peak hours.
- Before data migration, suspend your services so that data changes newly generated will not be lost during the migration.
Notes and Constraints
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- Migration may fail if the target instance uses smaller specifications than its source.
- Migrate data during off-peak hours.
- Before data migration, suspend your services so that newly generated data changes will not be lost during the migration.
Prerequisites
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
- An Elastic Cloud Server (ECS) has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide.
Generating an AOF File
- Log in to the ECS.
- Install redis-cli. The following steps assume that your client is installed on the Linux OS.
- Run the following command to download Redis: You can also install other Redis versions. For details, see the Redis official website.
wget http://download.redis.io/releases/redis-5.0.8.tar.gz
- Run the following command to decompress the source code package of your Redis client:
tar -xzf redis-5.0.8.tar.gz
- Run the following commands to go to the Redis directory and compile the source code of your Redis client:
cd redis-5.0.8 -make -cd src
+cd src +make
- Run the following command to download Redis: You can also install other Redis versions. For details, see the Redis official website.
- Run the following command to enable cache persistence and obtain the AOF persistence file:
redis-cli -h {source_redis_address} -p {port} -a {password} config set appendonly yes+ - Run the following command to enable cache persistence and obtain the AOF persistence file:
redis-cli -h {source_redis_address} -p {port} -a {password} config set appendonly yes{source_redis_address} is the connection address of the source Redis, {port} is the port of the source Redis, and {password} is the connection password of the source Redis.
-If the size of the AOF file does not change after you have enabled persistence, the AOF file contains full cached data.
-+ - To find out the path for storing the AOF file, use redis-cli to access the Redis instance, and run the config get dir command. Unless otherwise specified, the file is named as appendonly.aof by default.
- To disable synchronization after the AOF file is generated, use redis-cli to log in to the Redis instance and run the config set appendonly no command.
- If the size of the AOF file does not change after you have enabled persistence, the AOF file contains full cached data.
- To find out the path for storing the AOF file, use redis-cli to access the Redis instance, and run the config get dir command. Unless otherwise specified, the file is named as appendonly.aof by default.
- To disable synchronization after the AOF file is generated, use redis-cli to log in to the Redis instance and run the config set appendonly no command.
Uploading the AOF file to ECS
To save time, you are advised to compress the AOF file and upload it to ECS using an appropriate mode (for example, SFTP mode).
-+ Ensure that the ECS has sufficient disk space for data file decompression, and can communicate with the DCS instance. Generally, the ECS and DCS instance are configured to belong to the same VPC and subnet, and the configured security group rules do not restrict access ports. For details about how to configure a security group, see Security Group Configurations.
-Ensure that the ECS has sufficient disk space for data file decompression, and can communicate with the DCS instance. Generally, the ECS and DCS instance are configured to belong to the same VPC and subnet, and the configured security group rules do not restrict access ports. For details about how to configure a security group, see Security Group Configurations.
-Importing Data
Log in to the ECS and run the following command to import data.
-redis-cli -h {dcs_instance_address} -p {port} -a {password} --pipe < appendonly.aof+redis-cli -h {dcs_instance_address} -p {port} -a {password} --pipe < appendonly.aof{dcs_instance_address} indicates the address of the target Redis instance, {port} indicates the port of the target Redis instance, and {password} indicates the password for connecting to the target Redis instance.
It takes 4 to 10 seconds to import an AOF file of 1 million data (20 bytes per data segment) to a VPC.
diff --git a/docs/dcs/umn/dcs-migration-0312011.html b/docs/dcs/umn/dcs-migration-0312011.html index 34e437dc1..21c72283d 100644 --- a/docs/dcs/umn/dcs-migration-0312011.html +++ b/docs/dcs/umn/dcs-migration-0312011.html @@ -1,7 +1,7 @@Verifying the Migration
After the data is imported successfully, access the DCS instance and run the info command to check whether the data has been successfully imported as required. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
+Verifying the Migration
Before data migration, if the target Redis has no data, check data integrity after the migration is complete in the following way:
+- Connect to the source Redis and the target Redis. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
+ - Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
If the import fails, check the procedure. If the import command is incorrect, run the flushall or flushdb command to clear the cache data in the target instance, modify the import command, and try again.
Self-Hosted Redis Migration with redis-cli (RDB)
-redis-cli is the command line tool of Redis, which can be used after you install the Redis server. redis-cli supports data export as an RDB file. If your Redis service does not support AOF file export, use redis-cli to obtain an RDB file. Then, use another tool (such as redis-shake) to import the file to a DCS instance.
+redis-cli is the command line tool of Redis, which can be used after you install the Redis server. redis-cli supports data export as an RDB file. If your Redis service does not support AOF file export, use redis-cli to obtain an RDB file. Then, use another tool (such as redis-shake) to import the file to a DCS instance. To migrate the source backup to a DCS instance via an OBS bucket, see Self-Hosted Redis Migration with Backup Files.
Notes and Constraints
- Migrate data during off-peak hours.
- When the source is Redis native cluster data, individually export the data of each node in the cluster, and then import the data node by node.
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
Prerequisites
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
- Log in to the ECS.
- Install redis-cli. The following steps assume that your client is installed on the Linux OS.
- Run the following command to download Redis: You can also install other Redis versions. For details, see the Redis official website.
wget http://download.redis.io/releases/redis-5.0.8.tar.gz
- Run the following command to decompress the source code package of your Redis client:
tar -xzf redis-5.0.8.tar.gz
- Run the following commands to go to the Redis directory and compile the source code of your Redis client:
cd redis-5.0.8 -make -cd src
+cd src +make
- Run the following command to export the RDB file:
redis-cli -h {source_redis_address} -p {port} -a {password} --rdb {output.rdb}{source_redis_address} is the connection address of the source Redis, {port} is the port of the source Redis, {password} is the connection password of the source Redis, and {output.rdb} is the RDB file name.
@@ -28,13 +28,14 @@ cd srcUploading the RDB File to ECS
To save time, you are advised to compress the RDB file and upload it to ECS using an appropriate mode (for example, SFTP mode).
-+ Ensure that the ECS has sufficient disk space for data file decompression, and can communicate with the DCS instance. Generally, the ECS and DCS instance are configured to belong to the same VPC and subnet, and the configured security group rules do not restrict access ports. For details about how to configure a security group, see Security Group Configurations.
-Ensure that the ECS has sufficient disk space for data file decompression, and can communicate with the DCS instance. Generally, the ECS and DCS instance are configured to belong to the same VPC and subnet, and the configured security group rules do not restrict access ports. For details about how to configure a security group, see Security Group Configurations.
-Importing Data
Use redis-shake to import data.
It takes 4 to 10 seconds to import an RDB file of 1 million data (20 bytes per data segment) to a VPC.
diff --git a/docs/dcs/umn/dcs-migration-090626001_0.html b/docs/dcs/umn/dcs-migration-090626001_0.html index 541528a91..cc5e9bb7e 100644 --- a/docs/dcs/umn/dcs-migration-090626001_0.html +++ b/docs/dcs/umn/dcs-migration-090626001_0.html @@ -20,7 +20,7 @@ chmod +x rump;Verifying the Migration
After the data is imported successfully, access the DCS instance and run the info command to check whether the data has been successfully imported as required. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
+Verifying the Migration
Before data migration, if the target Redis has no data, check data integrity after the migration is complete in the following way:
+- Connect to the source Redis and the target Redis. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
+ - Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
If the import fails, check the procedure. If the import command is incorrect, run the flushall or flushdb command to clear the cache data in the target instance, modify the import command, and try again.
Migrating Data
Run the following command to migrate data:
-rump -from {source_redis_address} -to {target_redis_address}+rump -from {source_redis_address} -to {target_redis_address}- {source_redis_address}
Source Redis instance address, in the format of redis://[user:password@]host:port/db. [user:password@] is optional. If the instance is accessed in password-protected mode, you must specify the password in the RFC 3986 format. user can be omitted, but the colon (:) cannot be omitted. For example, the address may be redis://:mypassword@192.168.0.45:6379/1.
db is the sequence number of the database. If it is not specified, the default value is 0.
- {target_redis_address}
Address of the target Redis instance, in the same format as the source.
diff --git a/docs/dcs/umn/dcs-migration-090626002.html b/docs/dcs/umn/dcs-migration-090626002.html index 065d45bcc..f6fb0e0d8 100644 --- a/docs/dcs/umn/dcs-migration-090626002.html +++ b/docs/dcs/umn/dcs-migration-090626002.html @@ -96,7 +96,7 @@DCS console
Migrate data from an earlier-version DCS Redis instance to a later-version DCS Redis instance, for example, from a DCS Redis 3.0 instance to a DCS Redis 4.0/5.0/6.0 instance.
+Migrate data from an earlier-version DCS Redis instance to a later-version DCS Redis instance, for example, from a DCS Redis 3.0 instance to a DCS Redis 6.0 instance.
- If the network between the source and target DCS Redis instances is connected, follow the instructions in Online Migration Between Instances.
- If the network is not connected, follow the instructions in Backup Import Between DCS Redis Instances.
Attempts to migrate data from a later-version Redis instance to an earlier-version Redis instance are not recommended because they will fail due to data compatibility issues between different Redis versions.
diff --git a/docs/dcs/umn/dcs-migration-1117001.html b/docs/dcs/umn/dcs-migration-1117001.html index f50f071a2..4eec31573 100644 --- a/docs/dcs/umn/dcs-migration-1117001.html +++ b/docs/dcs/umn/dcs-migration-1117001.html @@ -3,9 +3,9 @@Backup Import from Another Cloud
This section describes how to migrate Redis from another cloud to DCS by importing backup files.
Simply download the source Redis data and then upload the data to an OBS bucket in the same account and region as the target DCS Redis instance. After you have created a migration task on the DCS console, DCS will read data from the OBS bucket and data will be migrated to the target instance.
-Notes and Constraints
To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
+-Notes and Constraints
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- Migration may fail if the target instance uses smaller specifications than its source.
Prerequisites
- Before migrating data, read through Migration Tools and Schemes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration with Rump.
- Prepare the source Redis backup file. The backup file must be in .aof, .rdb, .zip, or .tar.gz format.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
Prerequisites
- Before migrating data, read through Migration Solution Notes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration from Another Cloud Using Rump.
- Prepare the source Redis backup file. The backup file must be in .aof, .rdb, .zip, or .tar.gz format.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
Creating an OBS Bucket and Uploading Backup Files
+Creating a Migration Task
- Go to the DCS console.
- In the navigation pane, choose Data Migration.
- Click Create Backup Import Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
- - In the Source Redis area, select OBS Bucket for Data Source and then select the OBS bucket to which you have uploaded backup files.
- Click Add Backup and select the backup files to be migrated.
- In the Target Redis area, select the Target Redis Instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+ - In the Source Redis area, select OBS bucket for Data Source and then select the OBS bucket to which you have uploaded backup files.
- Click Add Backup and select the backup files to be migrated.
- In the Target Redis area, select the Target Redis Instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
Verifying the Migration
Before data migration, if the target Redis has no data, check data integrity after the migration is complete in the following way:
+- Connect to the source Redis and the target Redis. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
+ - Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
diff --git a/docs/dcs/umn/dcs-migration-190703002.html b/docs/dcs/umn/dcs-migration-190703002.html index f8f99c316..8d0896b6f 100644 --- a/docs/dcs/umn/dcs-migration-190703002.html +++ b/docs/dcs/umn/dcs-migration-190703002.html @@ -3,9 +3,9 @@Self-Hosted Redis Migration with Backup Files
This section describes how to migrate self-hosted Redis to DCS by importing backup files.
Simply download the source Redis data and then upload the data to an OBS bucket in the same account and region as the target DCS Redis instance. After you have created a migration task on the DCS console, DCS will read data from the OBS bucket and data will be migrated to the target instance.
-Notes and Constraints
To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
+-Notes and Constraints
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- Migration may fail if the target instance uses smaller specifications than its source.
Prerequisites
- Before migrating data, read through Migration Tools and Schemes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration with Rump.
- Prepare the source Redis backup file. The backup file must be in .aof, .rdb, .zip, or .tar.gz format.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
Prerequisites
- Before migrating data, read through Migration Solution Notes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration from Another Cloud Using Rump.
- Prepare the source Redis backup file. The backup file must be in .aof, .rdb, .zip, or .tar.gz format.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
Creating an OBS Bucket and Uploading Backup Files
-Creating a Migration Task
- Go to the DCS console.
- In the navigation pane, choose Data Migration.
- Click Create Backup Import Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
- - In the Source Redis area, select OBS Bucket for Data Source and then select the OBS bucket to which you have uploaded backup files.
- Click Add Backup and select the backup files to be migrated.
- In the Target Redis area, select the Target Redis Instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+ - In the Source Redis area, select OBS bucket for Data Source and then select the OBS bucket to which you have uploaded backup files.
- Click Add Backup and select the backup files to be migrated.
- In the Target Redis area, select the Target Redis Instance prepared in Prerequisites.
- If the target Redis instance has a password, enter the password and click Test Connection to check whether the password is correct. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
Verifying the Migration
After the data is imported successfully, access the DCS instance and run the info command to check whether the data has been successfully imported as required. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
-If the import fails, check the procedure. If the import command is incorrect, run the flushall or flushdb command to clear the cache data in the target instance, modify the import command, and try again.
+Verifying the Migration
Before data migration, if the target Redis has no data, check data integrity after the migration is complete in the following way:
+- Connect to the source Redis and the target Redis. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
+ - Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
diff --git a/docs/dcs/umn/dcs-migration-190703003.html b/docs/dcs/umn/dcs-migration-190703003.html index eb3e6b377..5b370de45 100644 --- a/docs/dcs/umn/dcs-migration-190703003.html +++ b/docs/dcs/umn/dcs-migration-190703003.html @@ -2,38 +2,36 @@Migrating Self-Built Redis Online
If the source self-host and target instances are interconnected and the SYNC and PSYNC commands are supported by the source instance, data can be migrated online in full or incrementally from the source to the target DCS.
-- During online migration, data is essentially synchronized in full to a new replica. Therefore, perform online migration during low-demand hours. Otherwise, source instance CPU usage may surge and latency may increase.
-Notes and Constraints
- If the SYNC and PSYNC commands are disabled by the source instance, enable them before migrating data. Otherwise, the migration fails.
- You cannot use public networks for online migration.
- During online migration, you are advised to set repl-timeout on the source instance to 300s and client-output-buffer-slave-hard-limit and client-output-buffer-slave-soft-limit to 20% of the maximum memory of the source instance.
- The source must be Redis 3.0 or later.
- For earlier instances whose passwords contain single quotation marks ('), modify the password for online migration or try other methods.
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
-Notes and Constraints
- If the SYNC and PSYNC commands are disabled by the source instance, enable them before migrating data. Otherwise, the migration fails.
- You cannot use public networks for online migration.
- During online migration, you are advised to set repl-timeout on the source instance to 300s and client-output-buffer-slave-hard-limit and client-output-buffer-slave-soft-limit to 20% of the maximum memory of the source instance.
- The source must be Redis 3.0 or later.
- For earlier instances whose passwords contain single quotation marks ('), modify the password for online migration or try other methods.
- To migrate to an instance with SSL enabled, disable the SSL setting first. For details, see Transmitting DCS Redis Data with Encryption Using SSL.
- During online migration, data is essentially synchronized in full to a new replica. Therefore, perform online migration during low-demand hours. Otherwise, source instance CPU usage may surge and latency may increase.
Prerequisites
- Before migrating data, read through Migration Tools and Schemes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration with Rump.
- The IP address and port of the source Redis instance has been obtained.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
-Prerequisites
- Before migrating data, read through Migration Solution Notes to learn about the DCS data migration function and select an appropriate target instance.
- By default, a cluster instance has only one DB (DB0). Before you migrate data from a multi-DB single-node or master/standby instance to a Redis Cluster instance, check whether any data exists on databases other than DB0. To ensure that the migration succeeds, move all data to DB0 by referring to Online Migration from Another Cloud Using Rump.
- The IP address and port of the source Redis instance has been obtained.
- If a target DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If you already have a DCS Redis instance, you do not need to create one again. For comparing migration data and reserving sufficient memory, you are advised to clear the instance data before the migration. For details, see Clearing DCS Instance Data. If any data exists on the target instance, duplicate data between the source and target is overwritten. If the data exists only on the target instance, the data will be retained.
Creating an Online Migration Task
- Log in to the DCS console using the account of the target DCS Redis instance.
- Click in the upper left corner of the console and select the region where your target instance is located.
- In the navigation pane, choose Data Migration.
- Click Create Online Migration Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
- - Configure the VPC, subnet, and security group for the migration task.+
- Select the same VPC as the target Redis. Ensure that the migration resource can access the target Redis instance.
- The online migration task uses a tenant IP address (Migration ECS displayed on the Basic Information page of the task.) If a whitelist is configured for the source or target instance, add the migration IP address to the whitelist or disable the whitelist.
- To allow the VM used by the migration task to access the source and target instances, set an outbound rule for the task's security group to allow traffic through the IP addresses and ports of the source and target instances. By default, all outbound traffic is allowed.
Creating an Online Migration Task
- Log in to the DCS console using the account of the target DCS Redis instance.
- Click in the upper left corner of the console and select the region where your target instance is located.
- In the navigation pane, choose Data Migration.
- Click Create Online Migration Task.
- Enter the task name and description.
The task name must start with a letter, contain 4 to 64 characters, and contain only letters, digits, hyphens (-), and underscores (_).
+ - Configure the VPC, subnet, and security group for the migration task.
- Select the same VPC as the target Redis. Ensure that the migration resource can access the target Redis instance.
- The online migration task uses a tenant IP address (Migration ECS displayed on the Basic Information page of the task.) If a whitelist is configured for the source or target instance, add the migration IP address to the whitelist or disable the whitelist.
- To allow the VM used by the migration task to access the source and target instances, set an outbound rule for the task's security group to allow traffic through the IP addresses and ports of the source and target instances. By default, all outbound traffic is allowed.
-Checking the Network
- Check whether the source Redis instance, the target Redis instance, and the migration task are configured with the same VPC.
If yes, go to Creating an Online Migration Task. If no, go to 2.
- Check whether the VPCs configured for the source Redis instance, the target Redis instance, and the migration task are connected to ensure that the VM resource of the migration task can access the source and target Redis instances.
If yes, go to Configuring the Online Migration Task. If no, go to 3.
- - Perform the following operations to establish the network.
- If the VPC of the source and target Redis instances are of the same cloud vendor and in the same region, create a VPC peering connection by referring to "VPC Peering Connection" in the Virtual Private Cloud User Guide.
- If the source and target Redis instances are on different clouds or in different regions, create a connection using only Direct Connect. For details, see the Direct Connect User Guide.
- Perform the following operations to establish the network.
- If the VPC of the source and target Redis instances are of the same cloud vendor and in the same region, create a VPC peering connection by referring to "VPC Peering Connection" in the Virtual Private Cloud User Guide.
- If the source and target Redis instances are on different clouds or in different regions, create a Direct Connect connection. For details, see the Direct Connect User Guide.
Configuring the Online Migration Task
- On the Online Migration tab page, click Configure in the row containing the online migration task you just created.
- Select a migration type.
Supported migration types are Full and Full + Incremental, which are described in Table 1.
+Configuring the Online Migration Task
- Click Next and configure the source and target Redis instances.
If the resources are not ready yet, click Create to create a migration task. After they are ready, click Configure on the right of the task to continue its configuration.
+ - Select a migration type.
Supported migration types are Full and Full + Incremental, which are described in Table 1.
-Table 1 Migration type description Migration Type
+-Table 1 Migration type description Migration Type
Description
+Description
Full
+Full
Suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during the migration will not be migrated to the target instance.
+Suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during the migration will not be migrated to the target instance.
Full + incremental
+Full + incremental
Suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances.
+Suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances.
Once the migration starts, it remains Migrating until you click Stop in the Operation column. After the migration is stopped, data in the source instance will not be lost, but data will not be written to the target instance. When the transmission network is stable, the delay of incremental migration is within seconds. The actual delay depends on the transmission quality of the network link.
- Configure Target Redis Type and Target Redis Instance:
Set Redis in the cloud for Target Redis Type and add Target Redis Instance.
- Configure Source Redis Instance Password and Target Redis Instance Password: If the instance is password-protected, click Test Connection to check whether the instance password is correct and whether the network is connected. If the instance is not password-protected, click Test Connection directly. If the test fails, check whether the password is correct, and whether the migration task network is connected.
-If a DCS Redis instance is used, the users created in Managing Users are currently unavailable.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
-If the migration fails, click the migration task and check the log on the Migration Logs page.
-+ - Once incremental migration starts, it remains Migrating after full migration.
- To manually stop a migration task, select the check box on the left of the migration task and click Stop above the migration task.
- Click Create.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
+- If the migration fails, click the migration task and check the log on the Migration Logs page.
- Once incremental migration starts, it remains Migrating after full migration.
- To manually stop a migration task, select the check box on the left of the migration task and click Stop above the migration task.
Verifying the Migration
Before data migration, if the target Redis has no data, check data integrity after the migration is complete in the following way:
- Connect to the source Redis and the target Redis. Connect to Redis by referring to Accessing a DCS Redis Instance Through redis-cli.
- Run the info keyspace command to check the values of keys and expires.
- Calculate the differences between the values of keys and expires of the source Redis and the target Redis. If the differences are the same, the data is complete and the migration is successful.
During full migration, source Redis data updated during the migration will not be migrated to the target instance.
+diff --git a/docs/dcs/umn/dcs-pd-0326006.html b/docs/dcs/umn/dcs-pd-0326006.html index ed8b78512..c6239422e 100644 --- a/docs/dcs/umn/dcs-pd-0326006.html +++ b/docs/dcs/umn/dcs-pd-0326006.html @@ -11,6 +11,7 @@IAM
IAM provides identity authentication, permissions management, and access control.
With IAM, you can control access to DCS.
+diff --git a/docs/dcs/umn/dcs-pd-200713005.html b/docs/dcs/umn/dcs-pd-200713005.html index 603806062..64f40426a 100644 --- a/docs/dcs/umn/dcs-pd-200713005.html +++ b/docs/dcs/umn/dcs-pd-200713005.html @@ -6,7 +6,7 @@Cloud Eye
Cloud Eye is a secure, scalable, and integrated monitoring service. With Cloud Eye, you can monitor your DCS service and configure alarm rules and notifications.
DCS for Redis instances support most Redis commands, which are listed in Commands Supported by DCS for Redis 3.0. Any client compatible with the Redis protocol can access DCS.
- For security purposes, some Redis commands are disabled in DCS, as listed in Commands Disabled by DCS for Redis 3.0.
- Some Redis commands are supported by cluster DCS instances for multi-key operations in the same slot. For details, see Command Restrictions.
- Some Redis commands have usage restrictions, which are described in Other Command Usage Restrictions.
Commands Supported by DCS for Redis 3.0
The following lists commands supported by DCS for Redis 3.0.
- diff --git a/docs/dcs/umn/dcs-ug-0312017.html b/docs/dcs/umn/dcs-ug-0312017.html index 79bbd1151..4f0edaf58 100644 --- a/docs/dcs/umn/dcs-ug-0312017.html +++ b/docs/dcs/umn/dcs-ug-0312017.html @@ -3,7 +3,7 @@- Commands available since later Redis versions are not supported by earlier-version instances. Run a command on redis-cli to check whether it is supported by DCS for Redis. If the message "(error) ERR unknown command" is returned, the command is not supported.
- The following commands listed in the tables are not supported by Proxy Cluster instances:
- List group: BLPOP, BRPOP, and BRPOPLRUSH
- CLIENT commands in the Server group: CLIENT KILL, CLIENT GETNAME, CLIENT LIST, CLIENT SETNAME, CLIENT PAUSE, and CLIENT REPLY.
- Server group: MONITOR
- Key group: RANDOMKE (for old Proxy Cluster instances)
diff --git a/docs/dcs/umn/dcs-pd-200813003.html b/docs/dcs/umn/dcs-pd-200813003.html index bed2e19c0..aafdfbce8 100644 --- a/docs/dcs/umn/dcs-pd-200813003.html +++ b/docs/dcs/umn/dcs-pd-200813003.html @@ -3,8 +3,8 @@ - Commands available since later Redis versions are not supported by earlier-version instances. Run a command on redis-cli to check whether it is supported by DCS for Redis. If the message "(error) ERR unknown command" is returned, the command is not supported.
- The following commands listed in the tables are not supported by Proxy Cluster instances:
- List group: BLPOP, BRPOP, and BRPOPLRUSH
- CLIENT commands in the Server group: CLIENT KILL, CLIENT GETNAME, CLIENT LIST, CLIENT SETNAME, CLIENT PAUSE, and CLIENT REPLY.
- Server group: MONITOR
- Key group: RANDOMKEY (for old Proxy Cluster instances)
Command Restrictions
Some Redis commands are supported by Redis Cluster DCS instances for multi-key operations in the same slot. For details, see Table 1.
Some commands support multiple keys but do not support cross-slot access. For details, see Table 2.
-Table 3 lists commands restricted for Proxy Cluster DCS Redis 4.0 instances.
-Table 4 lists commands restricted for read/write splitting DCS Redis 4.0 instances.
+Table 3 lists commands restricted for Proxy Cluster DCS Redis instances.
+Table 4 lists commands restricted for read/write splitting DCS Redis instances.
-Table 1 Redis commands restricted in Redis Cluster DCS instances Category
Multi-key commands that do not support cross-slot access
SMOVE, SORT, BITOP, MSETNX, RENAME, RENAMENX, BLPOP, BRPOP, RPOPLPUSH, BRPOPLPUSH, PFMERGE, PFCOUNT, BLMOVE, COPY, GEOSEARCHSTORE, LMOVE, ZRANGESTORE
+SMOVE, SORT, BITOP, MSETNX, RENAME, RENAMENX, BLPOP, BRPOP, RPOPLPUSH, BRPOPLPUSH, PFMERGE, PFCOUNT, BLMOVE, COPY, GEOSEARCHSTORE, LMOVE, ZRANGESTORE, XREAD, XREADGROUP
SCAN
Proxy Cluster instances do not support the SCAN command in pipelines.
-For a Proxy Cluster instance, you can issue the SCAN command to a specific shard by adding ip:port. (Shard IP addresses and ports can be queried through the icluster nodes command.)
-If running the SCAN command fails to return the required information, your proxy cluster may be of an earlier version. Contact customer service to upgrade the proxy version.
+Proxy Cluster instances do not support the SCAN command in transactions.
+For a Proxy Cluster instance, you can issue the SCAN command to a specific shard by adding ip:port. (Shard IP addresses and ports can be queried through the icluster nodes command.)
+If running the SCAN command fails to return the required information, your proxy cluster may be of an earlier version. Contact customer service to upgrade the proxy version.
icluster nodes xxx 192.168.00.00:1111@xxx xxx connected 10923-16383 xxx 192.168.00.01:2222@xxx xxx connected 0-5460 @@ -276,8 +276,8 @@ value1 cluster keyslot key1 9189 icluster nodes -xxx 192.168.00.00:1111@xxx xxx connected 10923-16383 -xxx 192.168.00.01:2222@xxx xxx connected 0-5460 +xxx 192.168.00.00:1111@xxx xxx connected 10923-16383 +xxx 192.168.00.01:2222@xxx xxx connected 0-5460 xxx 192.168.00.02:3333@xxx xxx connected 5461-10922 MEMORY USAGE key1 192.168.00.02:3333 54
@@ -323,7 +323,7 @@ MEMORY USAGE key1 192.168.00.02:3333MULTI
The order of cross-slot commands in a transaction is not guaranteed.
-The following commands cannot be used in transactions: WATCH, MONITOR, RANDOMKEY, KEYS, SCAN, SUBSCRIBE, UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, SCRIPT, EVAL, EVALSHA, DBSIZE, AUTH, FLUSHDB, FLUSHALL, CLIENT, MEMORY
+The following commands cannot be used in transactions: WATCH, MONITOR, RANDOMKEY, KEYS, SCAN, SUBSCRIBE, UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, SCRIPT, EVAL, EVALSHA, DBSIZE, AUTH, FLUSHDB, FLUSHALL, CLIENT, MEMORY
EXEC
diff --git a/docs/dcs/umn/dcs-pd-210626001.html b/docs/dcs/umn/dcs-pd-210626001.html index 44cb98d18..dcd0ee84d 100644 --- a/docs/dcs/umn/dcs-pd-210626001.html +++ b/docs/dcs/umn/dcs-pd-210626001.html @@ -14,9 +14,9 @@Description
Type
+Type
Dependency
+Dependency
All permissions for DCS. Users granted these permissions can operate and use all DCS instances.
System-defined policy
+System-defined policy
None
+None
DCS UserAccess
Common user permissions for DCS, excluding permissions for creating, modifying, deleting DCS instances and modifying instance specifications.
System-defined policy
+System-defined policy
None
+None
DCS ReadOnlyAccess
Read-only permissions for DCS. Users granted these permissions can only view DCS instance data.
System-defined policy
+System-defined policy
None
+None
+DCS Administrator
+Administrator permissions for DCS. Users granted these permissions can operate and use all DCS instances.
+System-defined role
+Server Administrator and Tenant Guest roles, which must be attached in the same project as the DCS Administrator role
Transmitting DCS Redis Data with Encryption Using SSL
Single-node, master/standby, and Redis Cluster DCS Redis 6.0/7.0 instances support SSL encryption to ensure data transmission security. This function is not available for other instance versions. RESP (Redis Serialization Protocol), the communication protocol of Redis, only supports plaintext transmission in versions earlier than Redis 6.0.
-- Due to SSL encryption, SSL and client IP pass-through cannot be enabled at the same time. Encrypted links do not carry client IPs.
-Enabling or Disabling SSL
- Log in to the DCS console.
- Click
in the upper left corner of the management console and select the region where your instance is located. - In the navigation pane, choose Cache Manager.
- On the Cache Manager page, click a DCS instance.
- In the navigation pane, choose SSL.
- Click
next to SSL Certificate to enable or disable SSL.- - Enabling or disabling SSL will restart the instance and disconnect it for a few seconds. Wait until off-peak hours and ensure that your application can re-connect.
- The restart cannot be undone. For single-node DCS instances and other instances where AOF persistence is disabled (appendonly is set to no), data will be cleared and ongoing backup tasks will be stopped. Exercise caution when performing this operation.
- Enabling SSL will deteriorate read/write performance.
- Click Download Certificate to download the SSL certificate.
- Decompress the SSL certificate and upload the decompressed ca.crt file to the server where the Redis client is located.
- Add the path of the ca.crt file to the command for connecting to the instance. For example, to access an instance on redis-cli, see Accessing a DCS Redis Instance Through redis-cli.
+Notes and Constraints
- Either SSL or client IP pass-through can be enabled. When SSL is enabled, data is encrypted without carrying client IP addresses.
- Enabling SSL will deteriorate read/write performance.
- Enabling or disabling SSL will restart the instance and disconnect it for a few seconds. Wait until off-peak hours and ensure that your application can re-connect.
- The restart cannot be undone. For single-node DCS instances and other instances where AOF persistence is disabled ("appendonly" is set to "no"), data will be cleared and ongoing backup tasks will be stopped. Exercise caution when performing this operation.
Enabling or Disabling SSL
- Log in to the DCS console.
- Click in the upper left corner of the console and select the region where your instance is located.
- In the navigation pane, choose Cache Manager.
- On the Cache Manager page, click a DCS instance.
- In the navigation pane, choose SSL.
- Click next to SSL Certificate to enable or disable SSL.
- Click Download Certificate to download the SSL certificate.
- Decompress the SSL certificate and upload the decompressed ca.crt file to the server where the Redis client is located.
- Add the path of the ca.crt file to the command for connecting to the instance. For example, to access an instance on redis-cli, see Connecting to Redis on redis-cli.
diff --git a/docs/dcs/umn/dcs-ug-0312009.html b/docs/dcs/umn/dcs-ug-0312009.html index 065f5a3d4..2bdc867b3 100644 --- a/docs/dcs/umn/dcs-ug-0312009.html +++ b/docs/dcs/umn/dcs-ug-0312009.html @@ -3,11 +3,18 @@Connecting to Redis on phpredis (PHP)
This section describes how to connect to Redis on phpredis. For more information about how to use other Redis clients, visit the Redis official website.
The following operations are based on an example of accessing a Redis instance on a client on an elastic cloud server (ECS).
-- The operations described in this section apply only to single-node, master/standby, and Proxy Cluster instances. To use phpredis to connect to a Redis Cluster instance, see the phpredis description.
-Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- If the ECS runs the Linux OS, ensure that the GCC compilation environment has been installed on the ECS.
-Notes and Constraints
The operations described in this section apply only to single-node, master/standby, and Proxy Cluster instances. To use phpredis to connect to a Redis Cluster instance, see the phpredis description.
Connecting to Redis on phpredis
- View the IP address/domain name and port number of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
++Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- The Linux ECS must have GNU Compiler Collection (GCC) installed. To query the GCC version, run the gcc --version command.
Run the following command to install GCC on the ECS if needed, CentOS is used as an example:
+yum install -y make +yum install -y pcre-devel +yum install -y zlib-devel +yum install -y libevent-devel +yum install -y openssl-devel +yum install -y gcc-c++
+
diff --git a/docs/dcs/umn/dcs-ug-0312010.html b/docs/dcs/umn/dcs-ug-0312010.html index 9e3a47881..81b8494ef 100644 --- a/docs/dcs/umn/dcs-ug-0312010.html +++ b/docs/dcs/umn/dcs-ug-0312010.html @@ -3,12 +3,19 @@Connecting to Redis on phpredis
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
- Log in to the ECS.
The following uses CentOS as an example to describe how to access an instance through phpredis.
- Install GCC-C++ and Make compilation components.
yum install gcc-c++ make
- Install the PHP development package and CLI tool.
Run the following yum command to install the PHP development package:
@@ -50,7 +57,7 @@ echo $value; $redis->close(); ?> -{redis_instance_address} indicates the example IP address/domain name of the DCS instance and {port} indicates the port number of the DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. {password} indicates the password used to log in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. If password-free access is enabled, shield the if statement for password authentication.
+{redis_instance_address} indicates the example IP address/domain name of the DCS instance and {port} indicates the port number of the DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. {password} indicates the password used to log in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. If password-free access is enabled, shield the if statement for password authentication.
- Run the php redis.php command to access the DCS instance.
Connecting to Redis on hiredis (C++)
This section describes how to access a Redis instance on hiredis (C++). For more information about how to use other Redis clients, visit the Redis official website.
The following operations are based on an example of accessing a Redis instance on a client on an elastic cloud server (ECS).
-- The operations described in this section apply only to single-node, master/standby, and Proxy Cluster instances. To use C++ to connect to a Redis Cluster instance, see the C++ Redis client description.
-To access a Redis 7.0 instance, use a hiredis 1.1.0-rc1 or later client. For example, valkey 7.2.5 and later are recommended.
-Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- If the ECS runs the Linux OS, ensure that the GCC compilation environment has been installed on the ECS.
-Notes and Constraints
The operations described in this section apply only to single-node, master/standby, and Proxy Cluster instances. To use C++ to connect to a Redis Cluster instance, see the C++ Redis client description.
+To access a Redis 7.0 instance, use a hiredis 1.1.0-rc1 or later client. For example, valkey 7.2.5 and later are recommended.
Connecting to Redis on hiredis
- View the IP address/domain name and port number of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
++Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- The Linux ECS must have GNU Compiler Collection (GCC) installed. To query the GCC version, run the gcc --version command.
Run the following command to install GCC on the ECS if needed, CentOS is used as an example:
+yum install -y make +yum install -y pcre-devel +yum install -y zlib-devel +yum install -y libevent-devel +yum install -y openssl-devel +yum install -y gcc-c++
+
Connecting to Redis on hiredis
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
- Log in to the ECS.
The following uses CentOS as an example to describe how to access an instance in C++.
- Install GCC, Make, and hiredis.
If the system does not provide a compiling environment, run the following yum command to install the environment:
yum install gcc make
@@ -28,13 +35,13 @@ int main(int argc, char **argv) { redisContext *conn; redisReply *reply; if (argc < 3) { - printf("Usage: example {instance_ip_address} 6379 {password}\n"); + printf("Usage: example {instance_ip_address} 6379 {password}\n"); exit(0); } const char *hostname = argv[1]; const int port = atoi(argv[2]); const char *password = argv[3]; - struct timeval timeout = { 1, 500000 }; // 1.5 seconds + struct timeval timeout = { 1, 500000 }; // 1.5 seconds conn = redisConnectWithTimeout(hostname, port, timeout); if (conn == NULL || conn->err) { if (conn) { @@ -67,21 +74,21 @@ int main(int argc, char **argv) { - Run the following command to compile the code:
gcc connRedis.c -o connRedis -I /usr/local/include/hiredis -lhiredis
If an error is reported, locate the directory where the hiredis.h file is saved and modify the compilation command.
After the compilation, an executable connRedis file is obtained.
- - Run the following command to access the chosen DCS Redis instance:
./connRedis {redis_instance_address} 6379 {password}-{redis_instance_address} indicates the IP address/domain name of DCS instance and 6379 is an example port number of DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. {password} indicates the password used to log in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation.
+ - Run the following command to access the chosen DCS Redis instance:
./connRedis {redis_instance_address} 6379 {password}+{redis_instance_address} indicates the IP address/domain name of DCS instance and 6379 is an example port number of DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. {password} indicates the password used to log in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. Omit the password setting in the command for a password-free instance.
You have successfully accessed the instance if the following command output is displayed:
AUTH: OK SET: OK GET welcome: Hello, DCS for Redis!
diff --git a/docs/dcs/umn/dcs-ug-0312011.html b/docs/dcs/umn/dcs-ug-0312011.html index fac789044..3f6b717ee 100644 --- a/docs/dcs/umn/dcs-ug-0312011.html +++ b/docs/dcs/umn/dcs-ug-0312011.html @@ -3,36 +3,43 @@If an error is reported, indicating that the hiredis library files cannot be found, run the following commands to copy related files to the system directories and add dynamic links:
-mkdir /usr/lib/hiredis +
If an error is reported, indicating that the hiredis library files cannot be found, run the following commands to copy related files to the system directories and add dynamic links:
+mkdir /usr/lib/hiredis cp /usr/local/lib/libhiredis.so.0.13 /usr/lib/hiredis/ mkdir /usr/include/hiredis cp /usr/local/include/hiredis/hiredis.h /usr/include/hiredis/ echo '/usr/local/lib' >>;>>;/etc/ld.so.conf ldconfig
-Replace the locations of the so and .h files with actual ones before running the commands.
+Replace the locations of the so and .h files with actual ones before running the commands.
Connecting to Redis on redis-py (Python)
This section describes how to access a Redis instance on redis-py. For more information about how to use other Redis clients, visit the Redis official website.
The following operations are based on an example of accessing a Redis instance on a client on an elastic cloud server (ECS).
-+ Notes and Constraints
Use redis-py to connect to single-node, master/standby, read/write splitting, and Proxy Cluster instances and redis-py-cluster to connect to Redis Cluster instances.
+To access a Redis 7.0 instance, use a redis-py 4.3.0 or later client. 5.0.0 and later versions are recommended.
+-Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- If the ECS runs the Linux OS, ensure that the Python compilation environment has been installed on the ECS.
Connecting to Redis on redis-py
- View the IP address/domain name and port number of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
++Procedure
- To access a single-node, master/standby, read/write splitting, or Proxy Cluster instance, see Accessing a Non-Redis Cluster Instance Using redis-py.
- To access a Redis Cluster instance, see Accessing a Redis Cluster Instance Using redis-py.
diff --git a/docs/dcs/umn/dcs-ug-0312012.html b/docs/dcs/umn/dcs-ug-0312012.html index 8d08d48f3..f28983660 100644 --- a/docs/dcs/umn/dcs-ug-0312012.html +++ b/docs/dcs/umn/dcs-ug-0312012.html @@ -3,26 +3,33 @@Accessing a Non-Redis Cluster Instance Using redis-py
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
- Log in to the ECS.
The following uses CentOS as an example to describe how to access an instance using a Python client.
- - Access the DCS Redis instance.If the ECS OS does not provide Python, run the following yum command to install it:+
yum install python
-- The Python version must be 3.6 or later. If the default Python version is earlier than 3.6, perform the following operations to change it:
-- Run the rm -rf python command to delete the Python symbolic link.
- Run the ln -s pythonX.X.X python command to create another Python link. In the command, X.X.X indicates the Python version number.
- For single-node, master/standby, or Proxy Cluster types:
- Install Python and redis-py.
- If the system does not provide Python, run the yum command to install it.
- Run the following command to download and decompress the redis-py package:
wget https://github.com/andymccurdy/redis-py/archive/master.zip +
- Access the DCS Redis instance.
- If the ECS OS does not provide Python, run the following yum command to install it:
yum install python
+The Python version must be 3.6 or later. If the default Python version is earlier than 3.6, perform the following operations to change it:
+- Run the rm -rf python command to delete the Python symbolic link.
- Run the ln -s pythonX.X.X python command to create another Python link. In the command, X.X.X indicates the Python version number.
- Install Python and redis-py.
- If the system does not provide Python, run the yum command to install it.
- Run the following command to download and decompress the redis-py package:
wget https://github.com/andymccurdy/redis-py/archive/master.zip unzip master.zip
- Go to the directory where the decompressed redis-py package is saved, and install redis-py.
python setup.py install
After the installation, run the python command. redis-py have been successfully installed if the following command output is displayed:
-Figure 1 Running the python command+
Figure 1 Running the python command
- Use the redis-py client to connect to the instance. In the following steps, commands are executed in CLI mode. (Alternatively, write the commands into a Python script and then execute the script.)
- Run the python command to enter the CLI mode. You have entered CLI mode if the following command output is displayed:Figure 2 Entering the CLI mode+
- Use the redis-py client to connect to the instance. In the following steps, commands are executed in CLI mode. (Alternatively, write the commands into a Python script and then execute the script.)
- Run the python command to enter the CLI mode. You have entered CLI mode if the following command output is displayed:Figure 2 Entering the CLI mode
- Run the following command to access the chosen DCS Redis instance:
r = redis.StrictRedis(host='XXX.XXX.XXX.XXX', port=6379, password='******');
-XXX.XXX.XXX.XXX indicates the IP address/domain name of the DCS instance and 6379 is an example port number of the instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ****** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation.
+XXX.XXX.XXX.XXX indicates the IP address/domain name of the DCS instance and 6379 is an example port number of the instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ****** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. Omit the , password='******' part in the command for a password-free instance.
You have successfully accessed the instance if the following command output is displayed. Enter commands to perform read and write operations on the database.
-Figure 3 Redis connected successfully+
Figure 3 Redis connected successfully
- Run the python command to enter the CLI mode. You have entered CLI mode if the following command output is displayed:
- Run the python command to enter the CLI mode. You have entered CLI mode if the following command output is displayed:
- For the Redis Cluster type:
- Install the redis-py-cluster client.
- Download the released version.
wget https://github.com/Grokzen/redis-py-cluster/releases/download/2.1.3/redis-py-cluster-2.1.3.tar.gz
- - Decompress the package.
tar -xvf redis-py-cluster-2.1.3.tar.gz
- - Go to the directory where the decompressed redis-py-cluster package is saved, and install redis-py-cluster.
python setup.py install
+
- Download the released version.
- Install the redis-py-cluster client.
- If the ECS OS does not provide Python, run the following yum command to install it:
- Install Python and redis-py.
Accessing a Redis Cluster Instance Using redis-py
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
+ - Log in to the ECS.
The following uses CentOS as an example to describe how to access an instance using a Python client.
+ - Access the DCS Redis instance.
- If the ECS OS does not provide Python, run the following yum command to install it:
yum install python
+The Python version must be 3.6 or later. If the default Python version is earlier than 3.6, perform the following operations to change it:
+- Run the rm -rf python command to delete the Python symbolic link.
- Run the ln -s pythonX.X.X python command to create another Python link. In the command, X.X.X indicates the Python version number.
- Install the redis-py-cluster client.
- Download the released version.
wget https://github.com/Grokzen/redis-py-cluster/releases/download/2.1.3/redis-py-cluster-2.1.3.tar.gz
+ - Decompress the package.
tar -xvf redis-py-cluster-2.1.3.tar.gz
+ - Go to the directory where the decompressed redis-py-cluster package is saved, and install redis-py-cluster.
python setup.py install
- Download the released version.
- Access the DCS Redis instance by using redis-py-cluster.
In the following steps, commands are executed in CLI mode. (Alternatively, write the commands into a Python script and then execute the script.)
-- Run the python command to enter the CLI mode.
- Run the following command to access the chosen DCS Redis instance. If the instance does not have a password, exclude password='******' from the command.
>>> from rediscluster import RedisCluster +
- Access the DCS Redis instance by using redis-py-cluster.In the following steps, commands are executed in CLI mode. (Alternatively, write the commands into a Python script and then execute the script.)+
- Run the python command to enter the CLI mode.
- Run the following command to access the chosen DCS Redis instance:
>>> from rediscluster import RedisCluster >>> startup_nodes = [{"host": "192.168.0.143", "port": "6379"},{"host": "192.168.0.144", "port": "6379"},{"host": "192.168.0.145", "port": "6379"},{"host": "192.168.0.146", "port": "6379"}] @@ -41,12 +48,13 @@ unzip master.zip>>> rc.set("foo", "bar") True >>> print(rc.get("foo")) -'bar' - +'bar' +>>> +****** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. Omit the , password='******' part in the command for a password-free instance.
+You have successfully accessed the instance if the following command output is displayed. Enter commands to perform read and write operations on the database.
- If the ECS OS does not provide Python, run the following yum command to install it:
Connecting to Redis on ioredis (Node.js)
This section describes how to access a Redis instance on ioredis. For more information about how to use other Redis clients, visit the Redis official website.
The following operations are based on an example of accessing a Redis instance on a client on an elastic cloud server (ECS).
-- The operations described in this section apply only to single-node, master/standby, and Proxy Cluster instances. To access a Redis Cluster instance on ioredis, see Node.js Redis client description.
-Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- If the ECS runs the Linux OS, ensure that the GCC compilation environment has been installed on the ECS.
-Notes and Constraints
The operations described in this section apply only to single-node, master/standby, and Proxy Cluster instances. To access a Redis Cluster instance on ioredis, see Node.js Redis client description.
diff --git a/docs/dcs/umn/dcs-ug-0312013.html b/docs/dcs/umn/dcs-ug-0312013.html index 358564cfc..d726a65dd 100644 --- a/docs/dcs/umn/dcs-ug-0312013.html +++ b/docs/dcs/umn/dcs-ug-0312013.html @@ -3,12 +3,19 @@Connecting to Redis on ioredis
- For client servers running Ubuntu (Debian series):
- View the IP address/domain name and port number of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
- - Log in to the ECS.
- Install Node.js.
apt install nodejs-legacy
-If the preceding command does not work, run the following commands:
-wget https://nodejs.org/dist/v0.12.4/node-v0.12.4.tar.gz --no-check-certificate +
+Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- The Linux ECS must have GNU Compiler Collection (GCC) installed. To query the GCC version, run the gcc --version command.
Run the following command to install GCC on the ECS if needed, CentOS is used as an example:
+yum install -y make +yum install -y pcre-devel +yum install -y zlib-devel +yum install -y libevent-devel +yum install -y openssl-devel +yum install -y gcc-c++
+
+Connecting to Redis on ioredis
- For a client server running Ubuntu (Debian series), see For Client Servers Running Ubuntu (Debian Series).
- For a client server running CentOS (Red Hat series), see For client servers running CentOS (Red Hat series).
+For Client Servers Running Ubuntu (Debian Series)
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
+ - Log in to the ECS.
- Install Node.js.
apt install nodejs-legacy
+If the preceding command does not work, run the following commands:
+wget https://nodejs.org/dist/v4.28.5/node-v4.28.5.tar.gz --no-check-certificate tar -xvf node-v4.28.5.tar.gz cd node-v4.28.5 ./configure make make install
-- After the installation is complete, run the node --version command to query the Node.js version to check whether the installation is successful.
- - Install the node package manager (npm).
apt install npm
- - Install the Redis client ioredis.
npm install ioredis
- - Edit the sample script for connecting to a DCS Redis instance.
Add the following content to the ioredisdemo.js script, including information about connection and data reading.
-var Redis = require('ioredis'); +After the installation is complete, run the node --version command to query the Node.js version to check whether the installation is successful.
+ - Install the node package manager (npm).
apt install npm
+ - Install the Redis client ioredis.
npm install ioredis
+ - Edit the sample script for connecting to a DCS Redis instance.
Add the following content to the ioredisdemo.js script, including information about connection and data reading.
+var Redis = require('ioredis'); var redis = new Redis({ port: 6379, // Redis port host: '192.168.0.196', // Redis host @@ -43,26 +50,24 @@ redis.sadd('set', 1, 3, 5, 7); redis.sadd('set', [1, 3, 5, 7]); // All arguments are passed directly to the redis server: redis.set('key', 100, 'EX', 10);-host indicates the example IP address/domain name of the DCS instance and port indicates the port number of the DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ****** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation.
- - Run the sample script to access the chosen DCS Redis instance.
node ioredisdemo.js
+host indicates the example IP address/domain name of the DCS instance and port indicates the port of the DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ****** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. Omit the password setting in the command for a password-free instance.
+ - Run the sample script to access the chosen DCS Redis instance.
node ioredisdemo.js
- For client servers running CentOS (Red Hat series):
- View the IP address/domain name and port number of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
- - Log in to the ECS.
- Install Node.js.
yum install nodejs
-If the preceding command does not work, run the following commands:
-wget https://nodejs.org/dist/v0.12.4/node-v0.12.4.tar.gz --no-check-certificate -tar -xvf node-v0.12.4.tar.gz -cd node-v0.12.4 +
For client servers running CentOS (Red Hat series)
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
+ - Log in to the ECS.
- Install Node.js.
yum install nodejs
+If the preceding command does not work, run the following commands:
+wget https://nodejs.org/dist/v4.28.5/node-v4.28.5.tar.gz --no-check-certificate +tar -xvf node-v4.28.5.tar.gz +cd node-v4.28.5 ./configure make make install
-- After the installation is complete, run the node --version command to query the Node.js version to check whether the installation is successful.
- - Install npm.
yum install npm
- - Install the Redis client ioredis.
npm install ioredis
- - Edit the sample script for connecting to a DCS Redis instance.
Add the following content to the ioredisdemo.js script, including information about connection and data reading.
-var Redis = require('ioredis'); +After the installation is complete, run the node -v command to query the Node.js version to check whether the installation is successful.
+ - Install the node package manager (npm).
yum install npm
+ - Install the Redis client ioredis.
npm install ioredis
+ - Edit the sample script for connecting to a DCS Redis instance.
Add the following content to the ioredisdemo.js script, including information about connection and data reading.
+var Redis = require('ioredis'); var redis = new Redis({ port: 6379, // Redis port host: '192.168.0.196', // Redis host @@ -83,8 +88,8 @@ redis.sadd('set', 1, 3, 5, 7); redis.sadd('set', [1, 3, 5, 7]); // All arguments are passed directly to the redis server: redis.set('key', 100, 'EX', 10);-host indicates the example IP address/domain name of the DCS instance and port indicates the port number of the DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ****** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation.
- - Run the sample script to access the chosen DCS Redis instance.
node ioredisdemo.js
+host indicates the example IP address/domain name of the DCS instance and port indicates the port of the DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ****** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. Omit the password setting in the command for a password-free instance.
+ - Run the sample script to access the chosen DCS Redis instance.
node ioredisdemo.js
Connecting to Redis on StackExchange.Redis (C#)
This section describes how to access a Redis instance on StackExchange.Redis. For more information about how to use other Redis clients, visit the Redis official website.
The following operations are based on an example of accessing a Redis instance on a client on an elastic cloud server (ECS).
-- Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- If the ECS runs the Linux OS, ensure that the GCC compilation environment has been installed on the ECS.
-Notes and Constraints
If you use the StackExchange client to connect to a Proxy Cluster instance, the multi-DB function cannot be used.
+To access a Redis 7.0 instance, use a hiredis 2.6.111 or later client. 2.7.0 and later versions are recommended.
Connecting to Redis on StackExchange.Redis
- View the IP address/domain name and port number of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
++Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- The Linux ECS must have GNU Compiler Collection (GCC) installed. To query the GCC version, run the gcc --version command.
Run the following command to install GCC on the ECS if needed, CentOS is used as an example:
+yum install -y make +yum install -y pcre-devel +yum install -y zlib-devel +yum install -y libevent-devel +yum install -y openssl-devel +yum install -y gcc-c++
+
diff --git a/docs/dcs/umn/dcs-ug-0312016.html b/docs/dcs/umn/dcs-ug-0312016.html index d23175b86..9fcddc6a2 100644 --- a/docs/dcs/umn/dcs-ug-0312016.html +++ b/docs/dcs/umn/dcs-ug-0312016.html @@ -25,7 +25,7 @@Connecting to Redis on StackExchange.Redis
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
- Log in to the ECS.
A Windows ECS is used as an example.
- Install Visual Studio Community 2017 on the ECS.
- Start Visual Studio 2017 and create a project.
Set the project name to redisdemo.
- Install StackExchange.Redis by using the NuGet package manager of Visual Studio.
Access the NuGet package manager console according to Figure 1, and enter Install-Package StackExchange.Redis -Version 2.2.79. (The version number is optional).
@@ -54,7 +61,7 @@ namespace redisdemo } } } -{instance_ip_address} and {port} are the IP address/domain name and port number of the DCS Redis instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ******** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation.
+{instance_ip_address} and {port} are the IP address/domain name and port of the DCS Redis instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. ******** indicates the password used for logging in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. Omit the password setting in the command for a password-free instance.
- Run the code. You have successfully accessed the instance if the following command output is displayed:
Hello, DCS for Redis!
For more information about other commands of StackExchange.Redis, visit StackExchange.Redis.
- Command Renaming
+
- Upgrading the Minor or Proxy Version of a DCS Instance
+Status
State of the chosen instance.
+State of the chosen instance. For example, running, creating, and faulty.
ID
@@ -82,7 +82,7 @@Maintenance
Time when maintenance takes place. To modify the time window, click the
+
icon.Time when maintenance takes place. To modify the time window, click the
icon.Connection
@@ -130,7 +130,6 @@
Performing a Master/Standby Switchover for a DCS Instance
On the DCS console, you can manually switch the master and standby nodes of a DCS instance. This operation is used for special purposes, for example, releasing all service connections or terminating ongoing service operations.
Only master/standby and read/write splitting instances support a master/standby node switchover.
- - Services may be interrupted for up to 10 seconds during the switchover. Before performing a switchover, ensure that your application supports reconnection.
- During a master/standby node switchover, a large amount of resources will be consumed for data synchronization between the master and standby nodes. You are advised to perform this operation during off-peak hours.
- Data of the maser and standby nodes is synchronized asynchronously. Therefore, a small amount of data that is being operated on during the switchover may be lost.
- Services may be interrupted for up to 10 seconds during the switchover. Before performing a switchover, ensure that your application supports reconnection.
- During a master/standby node switchover, a large amount of resources will be consumed for data synchronization between the master and standby nodes. You are advised to perform this operation during off-peak hours.
- Data of the master and standby nodes is synchronized asynchronously. Therefore, a small amount of data that is being operated on during the switchover may be lost.
diff --git a/docs/dcs/umn/dcs-ug-0312024.html b/docs/dcs/umn/dcs-ug-0312024.html index d049aeb41..cde8ae92d 100644 --- a/docs/dcs/umn/dcs-ug-0312024.html +++ b/docs/dcs/umn/dcs-ug-0312024.html @@ -7,95 +7,97 @@Prerequisites
The DCS instance for which you want to perform a master/standby node switchover is in the Running state.
Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- On the Cache Manager page, click the name of the DCS instance you want to configure.
- Choose Instance Configuration > Parameters.
- On the Parameters page, click Modify.
- Modify parameters based on your requirements.
Table 1 describes the parameters. In most cases, retain the default values.
--Table 1 DCS Redis instance configuration parameters Parameter
+@@ -290,7 +376,7 @@Table 1 DCS Redis instance configuration parameters Parameter
Description
+Description
Value Range
+Value Range
Default Value
active-expire-num
+active-expire-num
Number of expired keys that can be deleted in regular scans.
-Redis 3.0 instances do not have this parameter.
+Number of expired keys that can be deleted in regular scans.
+This parameter is supported by DCS Redis 4.0 and later instances.
1–1000
+1–1000
20
timeout
+timeout
The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
+The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
Proxy Cluster instances do not have this parameter.
0–7200 seconds
+0~7200
+Unit: second
0
appendfsync
+appendfsync
Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
+Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
There are three settings:
no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe.
everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
Single-node instances do not have this parameter.
- no
- always
- everysec
- no
- always
- everysec
no
appendonly
+appendonly
Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
+Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
yes: enabled
no: disabled
Single-node instances do not have this parameter.
- yes
- no
- yes
- no
yes
client-output-buffer-limit-slave-soft-seconds
+client-output-buffer-limit-slave-soft-seconds
Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
+Value that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
Single-node instances do not have this parameter.
0–60
+0–60
+Unit: second
60
client-output-buffer-slave-hard-limit
+client-output-buffer-slave-hard-limit
Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
+Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
client-output-buffer-slave-soft-limit
+client-output-buffer-slave-soft-limit
Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
+Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
maxmemory-policy
+maxmemory-policy
The deletion policy to apply when the maxmemory limit is reached. Options:
+The deletion policy to apply when the maxmemory limit is reached. Options:
volatile-lru: Evict keys by trying to remove the less recently used (LRU) keys first, but only among keys that have an expire set. (Recommended)
allkeys-lru: Evict keys by trying to remove the LRU keys first.
volatile-random: evict keys randomly, but only evict keys with an expire set.
@@ -105,142 +107,148 @@volatile-lfu: Evict keys by trying to remove the less frequently used (LFU) keys first, but only among keys that have an expire set.
allkeys-lfu: Evict keys by trying to remove the LFU keys first.
Depends on the instance version.
+Depends on the instance version.
Depends on the instance version and type.
lua-time-limit
+lua-time-limit
Maximum time allowed for executing a Lua script (in milliseconds).
+Maximum time allowed for executing a Lua script.
Read/write splitting instances do not have this parameter.
100–5000
+100–5000
+Unit: millisecond
5,000
master-read-only
+master-read-only
Sets the instance to be read-only. All write operations will fail.
+Sets the instance to be read-only. All write operations will fail.
Proxy Cluster and read/write splitting instances do not have this parameter.
- yes
- no
- yes
- no
no
maxclients
+maxclients
The maximum number of clients allowed to be concurrently connected to a DCS instance.
+The maximum number of clients allowed to be concurrently connected to a DCS instance.
Read/Write splitting instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
proto-max-bulk-len
+proto-max-bulk-len
Maximum size of a single element request (in bytes).
+Maximum size of a single element request. Set this parameter to be greater than the customer request length. Otherwise, the request cannot be executed.
Read/write splitting instances do not have this parameter.
1,048,576–536,870,912
+1,048,576–536,870,912
+Unit: byte
536,870,912
repl-backlog-size
+repl-backlog-size
The replication backlog size (bytes). The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
+The replication backlog size. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
Single-node instances do not have this parameter.
16,384–1,073,741,824
+16,384–1,073,741,824
+Unit: byte
1,048,576
repl-backlog-ttl
+repl-backlog-ttl
The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
+The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
Single-node instances do not have this parameter.
0–604,800
+0–604,800
+Unit: second
3,600
repl-timeout
+repl-timeout
Replication timeout (in seconds).
+Replication timeout.
Single-node instances do not have this parameter.
30–3,600
+30–3,600
+Unit: second
60
hash-max-ziplist-entries
+hash-max-ziplist-entries
Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
+Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
1–10,000
+1–10,000
512
hash-max-ziplist-value
+hash-max-ziplist-value
Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
+Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
set-max-intset-entries
+set-max-intset-entries
When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
+When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
1–10,000
+1–10,000
512
zset-max-ziplist-entries
+zset-max-ziplist-entries
Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
+Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
1–10,000
+1–10,000
128
zset-max-ziplist-value
+zset-max-ziplist-value
Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
+Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
latency-monitor-threshold
+latency-monitor-threshold
Threshold time in latency monitoring. Unit: millisecond.
+Threshold time in latency monitoring.
Set to 0: Latency monitoring is disabled.
Set to more than 0: All with at least this many milliseconds of latency will be logged.
By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring.
Proxy Cluster instances do not have this parameter.
0–86,400,000 ms
+0–86,400,000
+Unit: millisecond
0
notify-keyspace-events
+notify-keyspace-events
Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
+Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
K: Keyspace events, published with the __keyspace@__ prefix.
E: Keyevent events, published with __keyevent@__ prefix
g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
@@ -255,30 +263,108 @@The parameter value must contain either K or E. A cannot be used together with any of the characters in "g$lshzxe". For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events.
Proxy Cluster instances do not have this parameter.
See the parameter description.
+See the parameter description.
Ex
slowlog-log-slower-than
+slowlog-log-slower-than
Redis records queries that exceed a specified execution time.
-slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Redis will record the query.
+Redis records queries that exceed a specified execution time.
+slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the query will be recorded.
0–1,000,000
+0–1,000,000
+Unit: microsecond
10,000
slowlog-max-len
+slowlog-max-len
The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
0–1000
+0–1000
128
auto-kill-timeout-lua-process
+yes: enabled
+no: disabled
+When this parameter is enabled, lua scripts are killed when their execution times out. However, scripts with write operations are not killed, but their nodes automatically restart (if persistence has been enabled for the instance) without saving the write operations.
+Single-node instances do not have this parameter.
+- yes
- no
no
+multi-db
+Manually back up the instance and clear all instance data before you enable or disable multi-DB. To restore the deleted data, use the backup import function on the Data Migration page. Options:
+yes: enable
+no: disable
+Only Proxy Cluster DCS Redis 4.0 and later instances have this parameter.
+- yes
- no
no
+dispatch-pubsub-to-fixed-shard
+This parameter specifies whether pub/sub channels are on the shard of slot 0. When this parameter is enabled, the pub/sub processing logic is consistent with that of single-node instances. You are advised to enable this parameter if you do not depend heavily on pub/sub. If you depend heavily on pub/sub, use the default configuration to allocate subscriptions to all shards.
+- yes: Enable this parameter to allocate subscription channels to the shard of slot 0.
- no: Disable this parameter to allocate channels to the shard of each channel-hashed slot.
Only Proxy Cluster instances have this parameter.
+- yes
- no
no
+readonly-lua-route-to-slave-enabled
+If enabled, read-only Lua scripts of read-only users are executed and routed to the standby node.
+- yes: enabled
- no: disabled
Available only for read/write splitting instances.
+- yes
- no
no
+proxy-slowlog-log-slower-than
+Slow queries of a proxy cover scheduled commands whose execution is delayed. proxy-slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the proxy will record the query.
+Available only for Proxy Cluster and read/write splitting instances.
+30,000–2,000,000
+Unit: microsecond
+500,000
+proxy-slowlog-max-len
+The maximum allowed number of slow queries of a proxy that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+Available only for Proxy Cluster and read/write splitting instances.
+0–1000
+128
+support-dispatch-to-replica-list
+Evenly allocates specified read commands to slave nodes. Currently, only the KEYS command can be configured.
+Available only for Proxy Cluster or read/write splitting instances whose proxy version is 5.0.14.12 or later.
+Left blank by default. Setting this parameter to KEYS performs the KEYS command only on the slave node.
+-
+Typical Scenarios of Configuring Parameters
The following describes how to change the value of the appendonly parameter:
- If Redis is used as the cache and services are insensitive to Redis data losses, disable instance persistence to improve performance. In this case, change the value of appendonly to no. For details, see Procedure.
- If Redis is used as the database or services are sensitive to Redis data losses, enable instance persistence. In this case, change the value of appendonly to yes. For details, see Procedure. After instance persistence is enabled, you need to consider the frequency of writing Redis cache data to disks and the impact on the Redis performance. You can use this parameter together with the appendfsync parameter. There are three modes of calling fsync():
- no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
- always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe.
- everysec: fsync() is called once per second, ensuring both data security and performance.
diff --git a/docs/dcs/umn/dcs-ug-0312028.html b/docs/dcs/umn/dcs-ug-0312028.html index c50984440..84f88370d 100644 --- a/docs/dcs/umn/dcs-ug-0312028.html +++ b/docs/dcs/umn/dcs-ug-0312028.html @@ -2,7 +2,7 @@ Currently, the appendonly and appendfsync parameters can be modified on the console only for master/standby and Redis 4.0 and later Redis Cluster instances.
+ Currently, the appendonly and appendfsync parameters can be modified on the console only for master/standby, read/write splitting, and Redis 4.0 and later Redis Cluster instances.
Viewing Background Tasks
After you initiate certain instance operations such as modifying instance specifications and changing or resetting a password, a background task will start for the operation. On the DCS console, you can view the background task status and clear task information by deleting task records.
-Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of the desired instance on the left.
- Choose Background Tasks.Filter tasks by specifying the time, property, or keyword.
- Click
to refresh the task status. - To clear the record of a background task, click Delete in the Operation column.
You can only delete the records of tasks in the Successful or Failed state.
+Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of the desired instance on the left.
- Choose Background Tasks.Filter tasks by specifying the time, property, or keyword.diff --git a/docs/dcs/umn/dcs-ug-0312030.html b/docs/dcs/umn/dcs-ug-0312030.html index 3c924ebad..57ebcdba3 100644 --- a/docs/dcs/umn/dcs-ug-0312030.html +++ b/docs/dcs/umn/dcs-ug-0312030.html @@ -1,6 +1,6 @@ -
- Click to refresh the task status.
- To clear the record of a background task, click Delete in the Operation column.
You can only delete the records of tasks in the Successful or Failed state.
Backing Up and Restoring DCS Instances
+Backing Up and Restoring Instance Data
-
diff --git a/docs/dcs/umn/dcs-ug-0312031.html b/docs/dcs/umn/dcs-ug-0312031.html
index 3e9c01570..5c724585a 100644
--- a/docs/dcs/umn/dcs-ug-0312031.html
+++ b/docs/dcs/umn/dcs-ug-0312031.html
@@ -1,7 +1,7 @@
- Instance backup takes 5 to 30 minutes. The data added or modified during the backup process will not be backed up. To reduce the impact of backup on services, it is recommended that data should be backed up during off-peak periods.
- Only instances in the Running state can be backed up.
Configuring an Automatic Backup Policy
-On the DCS console, you can configure an automatic backup policy. The system then backs up data in your instances according to the backup policy.
+On the DCS console, you can configure an automatic backup policy. The system then regularly backs up data in your instances according to the backup policy.
By default, automatic backup is disabled. To enable it, perform the operations described in this section. Single-node instances do not support backup and restoration.
If automatic backup is not required, disable the automatic backup function in the backup policy.
Prerequisites
A master/standby, read/write splitting, or cluster DCS instance is in the Running state.
@@ -29,21 +29,23 @@Time at which automatic backup starts. Value: the full hour between 00:00 to 23:00
The DCS checks backup policies once every hour. If the backup start time in a backup policy has arrived, data in the corresponding instance is backed up.
-NOTE:Instance backup takes 5 to 30 minutes. The data added or modified during the backup process will not be backed up. To reduce the impact of backup on services, it is recommended that data should be backed up during off-peak periods.
-Only instances in the Running state can be backed up.
+NOTE: - Click
- Click
- Click OK.
- Automatic backup starts at the scheduled time. You can view backup records on the current page.
After the backup is complete, click Download, Restore, or Delete next to the backup record as required.
+ - Click OK.
The automated backup can be disabled. The backup policies can be modified.
++ Modified Retention Period (days) applies only to new backup files.
+ - Automatic backup starts at the scheduled time. You can view backup records on the current page.
After the backup is complete, click Download, Restore, or Delete next to the backup record as required.
diff --git a/docs/dcs/umn/dcs-ug-0312032.html b/docs/dcs/umn/dcs-ug-0312032.html index d2808e0aa..b4b97ab73 100644 --- a/docs/dcs/umn/dcs-ug-0312032.html +++ b/docs/dcs/umn/dcs-ug-0312032.html @@ -1,7 +1,7 @@-Parent topic: Backing Up and Restoring DCS Instances+Parent topic: Backing Up and Restoring Instance DataManually Backing Up a DCS Instance
-You need to manually back up data in DCS instances in a timely manner. This section describes how to manually back up data in master/standby instances using the DCS console.
+You need to manually back up data in DCS instances in a timely manner. This section describes how to manually back up data in master/standby instances on the DCS console.
By default, manually backed up data is permanently retained. If backup data is no longer in use, you can delete it manually.
@@ -15,7 +15,7 @@Prerequisites
At least one master/standby DCS instance is in the Running state.
diff --git a/docs/dcs/umn/dcs-ug-0312033.html b/docs/dcs/umn/dcs-ug-0312033.html index a3a60b3ff..bd3ee1756 100644 --- a/docs/dcs/umn/dcs-ug-0312033.html +++ b/docs/dcs/umn/dcs-ug-0312033.html @@ -1,7 +1,7 @@-Parent topic: Backing Up and Restoring DCS Instances+Parent topic: Backing Up and Restoring Instance DataRestoring a DCS Instance
--On the DCS console, you can restore backup data to a chosen DCS instance.
+You can restore backup data to a specific DCS instance.
Prerequisites
- At least one master/standby or cluster DCS instance is in the Running state.
- A backup task has been run to back up data in the instance to be restored and the status of the backup task is Succeeded.
Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of the DCS instance to display more details about the DCS instance.
- On the instance details page, click Backups & Restorations.
A list of historical backup tasks is then displayed.
@@ -15,7 +15,7 @@
diff --git a/docs/dcs/umn/dcs-ug-0312034.html b/docs/dcs/umn/dcs-ug-0312034.html index 1dff0d1c9..8130df012 100644 --- a/docs/dcs/umn/dcs-ug-0312034.html +++ b/docs/dcs/umn/dcs-ug-0312034.html @@ -20,7 +20,7 @@-Parent topic: Backing Up and Restoring DCS Instances+Parent topic: Backing Up and Restoring Instance Datadiff --git a/docs/dcs/umn/dcs-ug-0312037.html b/docs/dcs/umn/dcs-ug-0312037.html index 97621fcf4..8972a0634 100644 --- a/docs/dcs/umn/dcs-ug-0312037.html +++ b/docs/dcs/umn/dcs-ug-0312037.html @@ -11,7 +11,7 @@-Parent topic: Backing Up and Restoring DCS Instances+Parent topic: Backing Up and Restoring Instance Data - Importing backups generated by a later-version Redis instance to an earlier one may fail.
- Before importing backup files, ensure that resource-intensive commands (such as FLUSHALL, KEYS, and HGETALL) have been disabled on the target Redis.
- The Redis memory usage of a single .rdb backup file must be less than 10 GB.
- If the backup file contains multi-DB data, its database count cannot exceed what is supported by the target Redis.
Preparing the Target DCS Redis Instance
- If a DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If a DCS Redis instance is available, you do not need to create a new one. However, you can clear the instance data before the migration.
- If the target instance is Redis 4.0 and later, clear the data by referring to Clearing DCS Instance Data.
- If the target instance is a DCS Redis 3.0 instance, run the FLUSHALL command to clear data.
- If the target instance data is not cleared before the migration and the source and target instances contain the same key, the key in the target instance will be overwritten by the key in the source instance after the migration.
diff --git a/docs/dcs/umn/dcs-ug-0312038.html b/docs/dcs/umn/dcs-ug-0312038.html index 7639cab12..ba115d575 100644 --- a/docs/dcs/umn/dcs-ug-0312038.html +++ b/docs/dcs/umn/dcs-ug-0312038.html @@ -64,7 +64,7 @@Preparing the Target DCS Redis Instance
- If a DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If a DCS Redis instance is available, you do not need to create a new one. However, you can clear the instance data before the migration.
- For details, see Clearing DCS Instance Data.
- If the target instance data is not cleared before the migration and the source and target instances contain the same key, the key in the target instance will be overwritten by the key in the source instance after the migration.
- Redis is backward compatible. The target instance version must be the same as or later than the source instance version.
Step 4: Create a Migration Task
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Data Migration. The migration task list is displayed.
- Click Create Online Migration Task.
- Enter the task name and description.
- Configure the VPC, subnet, and security group for the migration task.
The VPC, subnet, and security group facilitate the migration. Ensure that the migration resources can access the source and target Redis instances.
- - The migration task uses a tenant IP address (Migration ECS displayed on the Basic Information page of the task.) If a whitelist is configured for the source or target instance, add the migration IP address to the whitelist or disable the whitelist.
- To allow the VM used by the migration task to access the source and target instances, set an outbound rule for the task's security group to allow traffic through the IP addresses and ports of the source and target instances. By default, all outbound traffic is allowed.
- Click Next.
- Click Submit.
- Click or Create.
- Click Submit.
Configuring the Online Migration Task
- On the Online Migration tab page, click Configure in the row containing the online migration task you just created.
- Specify Migration Type.
Supported migration types are Full and Full + incremental, which are described in Table 2.
diff --git a/docs/dcs/umn/dcs-ug-0312047.html b/docs/dcs/umn/dcs-ug-0312047.html index 949065959..6dd9ac9d1 100644 --- a/docs/dcs/umn/dcs-ug-0312047.html +++ b/docs/dcs/umn/dcs-ug-0312047.html @@ -2,9 +2,9 @@Viewing Traces on the CTS Console
After CTS is enabled, the tracker starts recording operations on cloud resources. Operation records for the last seven days can be viewed on the CTS console. This section describes how to query operation records of the last seven days on the CTS console.
-Procedure
- Log in to the management console.
- Click in the upper left corner of the console and select a region and a project.
Select the same region as your application service.
+Procedure
- Log in to the console.
- Click in the upper left corner of the console and select a region and a project.-
Select the same region as your application service.
- Click Service List and choose Management & Deployment > Cloud Trace Service.
- In the navigation pane, click Trace List.
- Specify the filters used for querying traces. The following filters are available:
- Trace Type, Trace Source, Resource Type, and Search By
Select an option from the drop-down list. Select DCS from the Trace Source drop-down list.
+ - Click Service List and choose Management & Deployment > Cloud Trace Service.
- In the navigation pane, click Trace List.
- Specify the filters used for querying traces. The following filters are available:
- Trace Type, Trace Source, Resource Type, and Search By
Select an option from the drop-down list. Select DCS from the Trace Source drop-down list.
When you select Trace name, you also need to select a specific trace name.
When you select Resource ID, you also need to select a specific resource ID.
When you select Resource name, you also need to select a specific resource name.
diff --git a/docs/dcs/umn/dcs-ug-0326008.html b/docs/dcs/umn/dcs-ug-0326008.html index b9df76900..644593b4e 100644 --- a/docs/dcs/umn/dcs-ug-0326008.html +++ b/docs/dcs/umn/dcs-ug-0326008.html @@ -6,22 +6,21 @@
- Trace Type, Trace Source, Resource Type, and Search By
- Trace Type, Trace Source, Resource Type, and Search By
-Prerequisites
You have prepared necessary resources.
Creating a DCS Redis Instance
- Log in to the DCS console.
- Click
in the upper left corner of the console and select a region and a project. - Click Create DCS Instance.
- Select a region closest to your application to reduce latency and accelerate access.
- Specify the following instance parameters based on the information collected in Identifying Requirements.
- Cache Engine:
Select Redis.
- - Version:
Currently, versions 4.0/5.0/6.0/7.0 are supported.
+Creating a DCS Redis Instance
- Log in to the DCS console.
- Click in the upper left corner of the console and select a region and a project.
- Click Create DCS Instance.
- Select a region closest to your application to reduce latency and accelerate access.
- Specify the following instance parameters based on the information collected in Identifying Requirements.
- In Cache Engine, select an engine. Default: Redis.
- Version:
Currently, versions 4.0/5.0/6.0/7.0 are supported.
- - To compare Redis versions, see Comparing Redis Versions.
- The Redis version cannot be changed once the instance is created. To use a later Redis version, create another DCS Redis instance and then migrate data from the old instance to the new one.
- The method of connecting a client to a Redis Cluster instance is different from that of connecting a client to other types of instances. For details, see Accessing a DCS Redis Instance Through redis-cli.
- Set Instance Type to Single-node, Master/Standby, Proxy Cluster or Redis Cluster.
- Set CPU Architecture to x86.
- Set Replicas. The default value is 2 (including the master).
This parameter is displayed only when you select Redis 4.0 or later and the instance type is master/standby, read/write splitting, or Redis Cluster.
+ - Set Instance Type to Single-node, Master/Standby, Proxy Cluster, Redis Cluster, or Read/Write splitting.
- Set CPU Architecture to x86.
- Set Replicas. The default value is 2 (including the master).
This parameter is displayed only when you select Redis 4.0 or later and the instance type is master/standby, read/write splitting, or Redis Cluster.
- If the version is 4.0 or later, and Proxy Cluster or Redis Cluster are selected, the Sharding parameter is displayed. Options:
- Use default: Use the default sharding specifications.
- Customize: Customize the size of each shard and then select corresponding instance specifications.
- Select an AZ.
If the instance type is master/standby, Proxy Cluster, read/write splitting, or Redis Cluster, Standby AZ is displayed. Select a standby AZ for the standby node of the instance.
- - To accelerate access, deploy your instance and your application in the same AZ.
- There are multiple AZs in each region. If resources are insufficient in an AZ, the AZ will be unavailable. In this case, select another AZ.
- Select an AZ.
Instances other than single-node ones support both AZ and Standby AZ.+ - If instance nodes in an AZ are faulty, nodes in other AZs will not be affected. The standby node automatically becomes the master node to continue to operate, ensuring disaster recovery (DR).
- Deploying a DCS instance across AZs slightly reduces network efficiency compared with deploying an instance within an AZ. Therefore, if a DCS instance is deployed across AZs, synchronization between master and standby cache nodes is slightly less efficient.
- To accelerate access, deploy your instance and your application in the same AZ.
- There are multiple AZs in each region. If resources are insufficient in an AZ, the AZ will be unavailable. In this case, select another AZ.
- Instance Specification:
The remaining quota is displayed on the console.
To apply to increase quota, click Increase quota below the specifications.
- Configure the instance network parameters.
- Select a VPC and a subnet.
- Configure the IP address.
Redis Cluster instances only support automatically-assigned IP addresses. The other instance types support both automatically-assigned IP addresses and manually-specified IP addresses. You can manually specify an IP address available in your subnet.
-DCS Redis 4.0/5.0/6.0 instances support automatic IP address assignment and port customization. You can specify a port number in the range from 1 to 65535. The default port number is 6379.
+DCS Redis 4.0 and later instances support automatic IP address assignment and port customization. You can specify a port in the range from 1 to 65535. The default port is 6379.
- Select a security group.
A security group is a set of rules that control access to ECSs. It provides access policies for mutually trusted ECSs with the same security protection requirements in the same VPC.
-DCS for Redis 4.0/5.0/6.0 are based on VPC Endpoint and do not support security groups. Configure the whitelist after creating such an instance by referring to Managing IP Address Whitelist.
+DCS for Redis 4.0 and later are based on VPC Endpoint and do not support security groups. Configure the whitelist after creating such an instance by referring to Managing IP Address Whitelist.
- Set the instance password.
- Select Yes or No for Password Protected.@@ -32,7 +31,7 @@
- Password-free access carries security risks. Exercise caution when selecting this mode.
- On the instance creation page, the default parameter templates are used by default.
- If you use a custom template, the selected cache engine version and instance type must match those of the template. For details about using custom templates, see Creating a Custom Parameter Template.
- Choose whether to enable Auto Backup.
This parameter is displayed only when the instance type is master/standby, read/write splitting, or cluster. For more information on how to configure a backup policy, see Overview.
- - Specify the number of instances to create.
- Enter an instance name.
The value of Name contains at least 4 characters. When you create multiple instances at a time, the instances are named in the format of custom name-n, where n starts from 000 and is incremented by 1. For example, if you create two instances and set name to dcs_demo, the two instances are respectively named as dcs_demo-000 and dcs_demo-001.
+ - Specify the number of instances to create.
- Enter an instance name.
The value of Name contains at least 4 characters. When you create multiple instances at a time, the instances are named in the format of custom name-n, where n starts from 000 and is incremented by 1. For example, if you create two instances and set name to dcs_demo, the two instances are respectively named as dcs_demo-000 and dcs_demo-001.
- Click More Settings to configure more parameters.
- Enter a description of the instance.
- Rename critical commands.
Command Renaming is displayed for Redis 4.0 and later. Currently, you can only rename the COMMAND, KEYS, FLUSHDB, FLUSHALL, HGETALL, SCAN, HSCAN, SSCAN, and ZSCAN commands. For Proxy Cluster instances, you can also rename the DBSIZE and DBSTATS commands.
- Specify the maintenance window.
Choose a window for DCS O&M personnel to perform maintenance on your instance. You will be contacted before any maintenance activities are performed.
Accessing a DCS Redis Instance Through redis-cli
Access a DCS Redis instance through redis-cli on an ECS in the same VPC. For more information on how to use other Redis clients, visit https://redis.io/clients.
- - The following uses the default port 6379. If you have specified a port, replace 6379 with the actual port.
- When connecting to a Redis Cluster instance, ensure that -c is added to the command. Otherwise, the connection will fail.
- Run the following command to connect to a Redis Cluster instance:
./redis-cli -h {dcs_instance_address} -p 6379 -a {password} -c
- - Run the following command to connect to a single-node, master/standby, or Proxy Cluster instance:
./redis-cli -h {dcs_instance_address} -p 6379 -a {password}
+ - The following uses the default port 6379. If you have specified a port, replace 6379 with the actual port.
- When connecting to a Redis Cluster instance, ensure that -c is added to the command. Otherwise, the connection will fail. -
- If SSL is enabled for a single-node or master/standby DCS Redis 6.0 instance, set an SSL certificate path.
./redis-cli -h {dcs_instance_address} -p 6379 -a {password} --tls --cacert {certification file path}
- - If SSL is enabled for a Redis Cluster DCS Redis 6.0 instance, set a certificate path.
./redis-cli -h {dcs_instance_address} -p 6379 -a {password} -c --tls --cacert {certification file path}
+ - If SSL is enabled for a single-node or master/standby DCS Redis 6.0 instance, set an SSL certificate path.
./redis-cli -h {dcs_instance_address} -p 6379 -a {password} --tls --cacert {certification file path}
+ - If SSL is enabled for a Redis Cluster DCS Redis 6.0 instance, set a certificate path.
./redis-cli -h {dcs_instance_address} -p 6379 -a {password} -c --tls --cacert {certification file path}
- To connect to Redis with SSL encryption, use redis-cli 6.x or later.
Prerequisites
- The DCS Redis instance you want to access is in the Running state.
- An ECS has been created. For more information on how to create ECSs, see the Elastic Cloud Server User Guide.
- If the ECS runs the Linux OS, ensure that the GCC compilation environment has been installed on the ECS. Run the following command to install GCC if needed:
yum install -y make @@ -25,8 +25,9 @@ yum install -y gcc-c++
- Run the following command to connect to a Redis Cluster instance:
- Run the following command to decompress the source code package of your Redis client:
- Run the following commands to go to the Redis directory and compile the source code of your Redis client: -
make
-cd src
+cd src
+make
+make install
- Access a DCS instance of a type other than Redis Cluster.
Perform the following procedure to access a single-node, master/standby, read/write splitting, or Proxy Cluster instance.
./redis-cli -h ${dcs_instance_address} -p 6379 -a ${password}
diff --git a/docs/dcs/umn/dcs-ug-0326011.html b/docs/dcs/umn/dcs-ug-0326011.html index 6dda4196d..5c0bb58dd 100644 --- a/docs/dcs/umn/dcs-ug-0326011.html +++ b/docs/dcs/umn/dcs-ug-0326011.html @@ -29,7 +29,7 @@From master/standby or read/write splitting to Proxy Cluster
- Memory usage must be less than 70% of the maximum memory of the new flavor.
- Some keys may be evicted if the current memory usage exceeds 90% of the total.
- After the change, create alarm rules again for the instance.
- For instances that are currently master/standby, ensure that their read-only IP address or domain name is not used by your application.
- If your application cannot reconnect to Redis or handle exceptions, you may need to restart the application after the change.
- Modify instance specifications during off-peak hours. An instance is temporarily interrupted and remains read-only for about 1 minute during the specification change.
- After the instance is changed to Proxy Cluster, multi-DB is enabled for Proxy Cluster by default. Therefore, consider the restrictions of multi-DB and commands, see Notes and Procedure for Enabling Multi-DB for Proxy Cluster Instances, and Command Restrictions.
- Memory usage must be less than 70% of the maximum memory of the new flavor.
- Some keys may be evicted if the current memory usage exceeds 90% of the total.
- After the change, create alarm rules again for the instance.
- For instances that are currently master/standby, ensure that their read-only IP address or domain name is not used by your application.
- If your application cannot reconnect to Redis or handle exceptions, you may need to restart the application after the change.
- Modify instance specifications during off-peak hours. An instance is temporarily interrupted and remains read-only for about 1 minute during the specification change.
From Proxy Cluster to master/standby or read/write splitting
@@ -139,7 +139,7 @@ -Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Choose More > Modify Specifications in the row containing the DCS instance.
- On the Modify Specifications page, select the desired specification.
For a master/standby, read/write splitting, or Redis Cluster DCS Redis 4.0 or later instance, you can choose to change by specification or replica quantity.
+Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Choose More > Modify Specifications in the row containing the DCS instance.
- On the Modify Specifications page, select the desired specification.
For a master/standby, read/write splitting, or Redis Cluster DCS Redis 4.0 or later instance, you can choose to change by specification or replica quantity.
- Set Apply Change to Now or During maintenance.
Select During maintenance if the modification interrupts connections.
@@ -188,12 +188,11 @@
Abnormal instance nodes cause instance modification failures.
If this case, contact customer service.
+In this case, and contact customer service.
Dataset memory distribution check
-NOTE:+This check item applies only to Proxy Cluster and Redis Cluster instances.
-(This check item applies only to Proxy Cluster and Redis Cluster instances.)
Specification modification of a cluster instance involves data migration between nodes. If an instance has any key bigger than 512 MB, the modification will fail when big key migration between nodes times out.
If the instance dataset memory is unevenly distributed among nodes and the difference is greater than 512 MB, the instance has a big key and the change may fail.
@@ -209,8 +208,7 @@Network input traffic check
-NOTE:+This check item applies only to single-node, read/write splitting, and master/standby instances.
-(This check item applies only to single-node, read/write splitting, and master/standby instances.)
The change may fail if the network input traffic is too heavy and the write buffer overflows.
- Cache Engine:
- Click Submit to start modifying the DCS instance.
You can go to Background Tasks page to view the modification status. For more information, see Viewing Background Tasks.
+- Click Submit to start modifying the DCS instance.
You can go to Background Tasks page to view the modification status. For more information, see Viewing Background Tasks.
Specification modification of a single-node or master/standby DCS instance takes about 5 to 30 minutes to complete, while that of a cluster DCS instance takes a longer time. After an instance is successfully modified, it changes to the Running state.diff --git a/docs/dcs/umn/dcs-ug-0326013.html b/docs/dcs/umn/dcs-ug-0326013.html index 8b0599b9d..858f96ce0 100644 --- a/docs/dcs/umn/dcs-ug-0326013.html +++ b/docs/dcs/umn/dcs-ug-0326013.html @@ -2,7 +2,7 @@ - If the specification modification of a single-node DCS instance fails, the instance is temporarily unavailable for use. The specification remains unchanged. Some management operations (such as parameter configuration and specification modification) are temporarily not supported. After the specification modification is completed in the backend, the instance changes to the new specification and becomes available for use again.
- If the specification modification of a master/standby or cluster DCS instance fails, the instance is still available for use with its original specifications. Some management operations (such as parameter configuration, backup, restoration, and specification modification) are temporarily not supported. Remember not to read or write more data than allowed by the original specifications; otherwise, data loss may occur.
- After the specification modification is successful, the new specification of the instance takes effect.
Restarting DCS Instances
On the DCS console, you can restart one or multiple DCS instances at a time.
- - Restarting a single-node DCS instance or other types of DCS instances with AOF persistence disabled (appendonly set to no) clears the instance data. Exercise caution.
- While a DCS instance is restarting, it cannot be read from or written to.
- An attempt to restart a DCS instance while it is being backed up may result in a failure.
- Restarting a DCS instance will disconnect the original client. You are advised to configure automatic reconnection in your application.
- Restarting a single-node DCS instance or other types of DCS instances with AOF persistence disabled (appendonly set to no) clears the instance data. Exercise caution.
- While a DCS instance is restarting, it cannot be read from or written to.
- An attempt to restart a DCS instance while it is being backed up may result in a failure.
- Restarting a DCS instance will disconnect the original client. You are advised to configure automatic reconnection in your application.
diff --git a/docs/dcs/umn/dcs-ug-0326014.html b/docs/dcs/umn/dcs-ug-0326014.html index a9f19f248..e1a3f3339 100644 --- a/docs/dcs/umn/dcs-ug-0326014.html +++ b/docs/dcs/umn/dcs-ug-0326014.html @@ -2,13 +2,11 @@Prerequisites
The DCS instances you want to restart are in the Running or Faulty state.
Deleting DCS Instances
On the DCS console, you can delete one or multiple DCS instances at a time. You can also delete all instance creation tasks that have failed to run.
-- - After a DCS instance is deleted, the instance data will also be deleted without backup. In addition, any backup data of the instance will be deleted. Therefore, download the backup files of the instance for permanent storage before deleting the instance.
- If the instance is in cluster mode, all cluster nodes will be deleted.
Prerequisites
- The DCS instances you want to delete have been created.
- The DCS instances you want to delete are in the Running or Faulty state.
Notes and Constraints
- DCS instances already exist. They are in the Running or Faulty state.
- Deleted DCS instances as well as the data in these instances and the backup files cannot be recovered. Exercise caution when performing this operation. To retain data backups, before deleting instances, download and save their backups locally.
- If the instance is in cluster mode, all cluster nodes will be deleted.
Procedure
Deleting DCS Instances
-- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- On the Cache Manager page, select one or more DCS instances you want to delete.
DCS instances in the Creating, Restarting, Upgrading, Resizing, Clearing data, Backing up, or Restoring state cannot be deleted.
- - Choose More > Delete above the instance list.
- Click Yes to delete the instance.
It takes 1 to 30 minutes to delete DCS instances.
+- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Select one or more DCS instances to be deleted and choose Delete above.
To delete a single instance, choose More > Delete in the Operation column in the row containing the instance.
+ - Click Yes to delete the instance.
It takes 1 to 30 minutes to delete DCS instances.
To delete a single instance, choose Operation > More > Delete in the same row as the instance.
-Namespace
SYS.DCS
DCS Redis 4.0/5.0/6.0 Instance Metrics
- The Monitored Object column lists instances that support the corresponding metrics.
- Dimensions lists the metric dimensions.
DCS Redis 4.0 and Later Instance Metrics
- - The monitoring data is the aggregated master node data.
- Some metrics are aggregated from the master and replica nodes. For details, see "Metric Description" in Table 2.
- Dimensions lists the metric dimensions.
Table 2 DCS Redis 4.0/5.0/6.0 instance metrics Metric ID
+-Table 2 DCS Redis 4.0 and later instance metrics Metric ID
Metric
+Metric
Description
+Description
Value Range
+Value Range
Monitored Object
+Conversion Rule
Monitoring Period (Raw Data)
+Monitored Object (Dimension)
+Monitoring Period (Raw Data)
cpu_usage
+cpu_usage
CPU Usage
+CPU Usage
The monitored object's maximum CPU usage among multiple sampling values in a monitoring period
-Unit: %
+The monitored object's maximum CPU usage among multiple sampling values in a monitoring period
0–100%
+0–100
+Unit: %
Single-node, read/write splitting, or master/standby DCS Redis instance
+N/A
1 minute
+Single-node, read/write splitting, or master/standby DCS Redis instance
+1 minute
command_max_delay
+command_max_delay
Maximum Command Latency
+Maximum Command Latency
Maximum latency of commands
-Unit: ms
+Maximum latency of commands
≥ 0 ms
+≥ 0
+Unit: ms
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
total_connections_received
+total_connections_received
New Connections
+New Connections
Number of connections received during the monitoring period
+Number of connections received during the monitoring period
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
is_slow_log_exist
+is_slow_log_exist
Slow Query Logs
+Slow Query Logs
Existence of slow query logs in the instance
+Existence of slow query logs in the instance
NOTE:Slow queries caused by the MIGRATE, SLAVEOF, CONFIG, BGSAVE, and BGREWRITEAOF commands are not counted.
- 1: yes
- 0: no
- 1: yes
- 0: no
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
memory_usage
+memory_usage
Memory Usage
+Memory Usage
Memory consumed by the monitored object
-Unit: %
+Memory consumed by the monitored object
0–100%
+0–100
+Unit: %
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
expires
+expires
Keys With an Expiration
+Keys With an Expiration
Number of keys with an expiration in Redis
+Number of keys with an expiration in Redis
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
keyspace_hits_perc
+keyspace_hits_perc
Hit Rate
+Hit Rate
Ratio of the number of Redis cache hits to the number of lookups. Calculation: keyspace_hits/(keyspace_hits + keyspace_misses)
-Unit: %
+Ratio of the number of Redis cache hits to the number of lookups. Calculation: keyspace_hits/(keyspace_hits + keyspace_misses)
+Aggregated from the master and replica nodes. If no read command is performed within a monitoring period, the ratio is 0.
0–100%
+0–100
+Unit: %
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
used_memory
+used_memory
Used Memory
+Used Memory
Number of bytes used by the Redis server
-Unit: KB, MB, or byte (configurable on the console)
+Number of bytes used by the Redis server
≥ 0
+≥ 0
+Unit: byte
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
used_memory_dataset
+used_memory_dataset
Used Memory Dataset
+Used Memory Dataset
Dataset memory that the Redis server has used
-Unit: KB, MB, or byte (configurable on the console)
+Dataset memory that the Redis server has used
≥ 0
+≥ 0
+Unit: byte
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
used_memory_dataset_perc
+used_memory_dataset_perc
Used Memory Dataset Ratio
+Used Memory Dataset Ratio
Percentage of dataset memory that server has used
-Unit: %
+Percentage of dataset memory that server has used
+Aggregated from the master and replica nodes.
0–100%
+0–100
+Unit: %
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
used_memory_rss
+used_memory_rss
Used Memory RSS
+Used Memory RSS
Resident set size (RSS) memory that the Redis server has used, which is the memory that actually resides in the memory, including all stack and heap memory but not swapped-out memory
-Unit: KB, MB, or byte (configurable on the console)
+Resident set size (RSS) memory that the Redis server has used, which is the memory that actually resides in the memory, including all stack and heap memory but not swapped-out memory
≥ 0
+≥ 0
+Unit: byte
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
instantaneous_ops
+instantaneous_ops
Ops per Second
+Ops per Second
Number of commands processed per second
+Number of commands processed per second
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
keyspace_misses
+keyspace_misses
Keyspace Misses
+Keyspace Misses
Number of failed lookups of keys in the main dictionary during the monitoring period
+Number of failed lookups of keys in the main dictionary during the monitoring period
+Aggregated from the master and replica nodes.
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
keys
+keys
Keys
+Keys
Number of keys in Redis
+Number of keys in Redis
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
rx_controlled
+rx_controlled
Flow Control Times
+Flow Control Times
Number of flow control times during the monitoring period
+Number of flow control times during the monitoring period
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
bandwidth_usage
+bandwidth_usage
Bandwidth Usage
+Bandwidth Usage
Percentage of the maximum bandwidth limit used (the average value of the sum of input and output flows)
-Unit: %
+Percentage of the maximum bandwidth limit used (the average value of the sum of input and output flows)
≥ 0
+≥ 0
+Unit: %
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
connections_usage
+connections_usage
Connection Usage
+Connection Usage
Percentage of the current number of connections to the maximum allowed number of connections
-Unit: %
+Percentage of the current number of connections to the maximum allowed number of connections
≥ 0
+≥ 0
+Unit: %
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
Instance Node Status
+Instance Node Status
Instance Node Status
+Instance Node Status
Status of instance nodes. If the status is normal, the value is 0. If the status is abnormal, the value is 1.
+Status of instance nodes. If the status is normal, the value is 0. If the status is abnormal, the value is 1.
-
+-
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
command_max_rt
+command_max_rt
Maximum Latency
+Maximum Latency
Maximum delay from when the node receives commands to when it responds
-Unit: μs
+Maximum delay from when the node receives commands to when it responds
+≥ 0
+≥ 0
+Unit: μs
Single-node DCS Redis instance
+N/A
1 minute
+Single-node DCS Redis instance
+1 minute
command_avg_rt
+command_avg_rt
Average Latency
+Average Latency
Average delay from when the node receives commands to when it responds
-Unit: μs
+Average delay from when the node receives commands to when it responds
≥ 0
+≥ 0
+Unit: μs
Single-node DCS Redis instance
+N/A
+Single-node DCS Redis instance
1 minute
+1 minute
cpu_avg_usage
+cpu_avg_usage
Average CPU Usage
+Average CPU Usage
Current average usage of CPU resources
-Unit: %
+Current average usage of CPU resources
≥ 0
+≥ 0
+Unit: %
Single-node, read/write splitting, or master/standby DCS Redis instance
+N/A
1 minute
+Single-node, read/write splitting, or master/standby DCS Redis instance
+1 minute
blocked_clients
+blocked_clients
Blocked Clients
+Blocked Clients
Number of clients suspended by block operations
+Number of clients suspended by block operations
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
connected_clients
+connected_clients
Connected Clients
+Connected Clients
Number of connected clients (excluding those from slave nodes)
+Number of connected clients (excluding those from slave nodes)
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
del
+del
DEL
+DEL
Number of DEL commands processed per second
-Unit: count/s
+Number of DEL commands processed per second
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
evicted_keys
+evicted_keys
Evicted Keys
+Evicted Keys
Number of keys that have been evicted and deleted during the monitoring period
+Number of keys that have been evicted and deleted during the monitoring period
+Aggregated from the master and replica nodes.
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
expire
+expire
EXPIRE
+EXPIRE
Number of EXPIRE commands processed per second
-Unit: count/s
+Number of EXPIRE commands processed per second
+0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
expired_keys
+expired_keys
Expired Keys
+Expired Keys
Number of keys that have expired and been deleted during the monitoring period
+Number of keys that have expired and been deleted during the monitoring period
+Aggregated from the master and replica nodes.
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
get
+get
GET
+GET
Number of GET commands processed per second
-Unit: count/s
+Number of GET commands processed per second
+Aggregated from the master and replica nodes.
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
hdel
+hdel
HDEL
+HDEL
Number of HDEL commands processed per second
-Unit: count/s
+Number of HDEL commands processed per second
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
hget
+hget
HGET
+HGET
Number of HGET commands processed per second
-Unit: count/s
+Number of HGET commands processed per second
+Aggregated from the master and replica nodes.
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
hmget
+hmget
HMGET
+HMGET
Number of HMGET commands processed per second
-Unit: count/s
+Number of HMGET commands processed per second
+Aggregated from the master and replica nodes.
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
hmset
+hmset
HMSET
+HMSET
Number of HMSET commands processed per second
-Unit: count/s
+Number of HMSET commands processed per second
+0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
hset
+hset
HSET
+HSET
Number of HSET commands processed per second
-Unit: count/s
+Number of HSET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
instantaneous_input_kbps
+instantaneous_input_kbps
Input Flow
+Input Flow
Instantaneous input traffic
-Unit: KB/s
+Instantaneous input traffic
≥ 0 KB/s
+≥ 0
+Unit: KiB/s
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
instantaneous_output_kbps
+instantaneous_output_kbps
Output Flow
+Output Flow
Instantaneous output traffic
-Unit: KB/s
+Instantaneous output traffic
≥ 0 KB/s
+≥ 0
+Unit: KiB/s
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
memory_frag_ratio
+memory_frag_ratio
Memory Fragmentation Ratio
+Memory Fragmentation Ratio
Ratio between Used Memory RSS and Used Memory
+Current memory fragmentation
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
mget
+mget
MGET
+MGET
Number of MGET commands processed per second
-Unit: count/s
+Number of MGET commands processed per second
+Aggregated from the master and replica nodes.
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
mset
+mset
MSET
+MSET
Number of MSET commands processed per second
-Unit: count/s
+Number of MSET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
pubsub_channels
+pubsub_channels
PubSub Channels
+PubSub Channels
Number of Pub/Sub channels
+Number of Pub/Sub channels
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
pubsub_patterns
+pubsub_patterns
PubSub Patterns
+PubSub Patterns
Number of Pub/Sub patterns
+Number of Pub/Sub patterns
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
set
+set
SET
+SET
Number of SET commands processed per second
-Unit: count/s
+Number of SET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
used_memory_lua
+used_memory_lua
Used Memory Lua
+Used Memory Lua
Number of bytes used by the Lua engine
-Unit: KB, MB, or byte (configurable on the console)
+Number of bytes used by the Lua engine
≥ 0
+≥ 0
+Unit: byte
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
used_memory_peak
+used_memory_peak
Used Memory Peak
+Used Memory Peak
Peak memory consumed by Redis since the Redis server last started
-Unit: KB, MB, or byte (configurable on the console)
+Peak memory consumed by Redis since the Redis server last started
≥ 0
+≥ 0
+Unit: byte
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
sadd
+sadd
SADD
+SADD
Number of SADD commands processed per second
-Unit: count/s
+Number of SADD commands processed per second
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
smembers
+smembers
SMEMBERS
+SMEMBERS
Number of SMEMBERS commands processed per second
-Unit: count/s
+Number of SMEMBERS commands processed per second
0–500,000
+0–500,000
+Unit: count/s
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
keyspace_misses
+keyspace_misses
Keyspace Misses
+Keyspace Misses
Number of failed lookups of keys in the main dictionary during the monitoring period
+Number of failed lookups of keys in the main dictionary during the monitoring period
≥ 0
+≥ 0
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
used_memory_dataset
+used_memory_dataset
Used Memory Dataset
+Used Memory Dataset
Dataset memory that the Redis server has used
-Unit: KB, MB, or byte (configurable on the console)
+Dataset memory that the Redis server has used
≥ 0
+≥ 0
+Unit: byte
DCS Redis instance
+1024(IEC)
1 minute
+DCS Redis instance
+1 minute
used_memory_dataset_perc
+used_memory_dataset_perc
Used Memory Dataset Ratio
+Used Memory Dataset Ratio
Percentage of dataset memory that server has used
-Unit: %
+Percentage of dataset memory that server has used
0–100%
+0–100
+Unit: %
DCS Redis instance
+N/A
1 minute
+DCS Redis instance
+1 minute
Redis Server Metrics of DCS Redis Instances
- The Monitored Object column lists instances that support the corresponding metrics.
Redis Server Metrics of DCS Redis Instances
- - Available for master/standby, read/write splitting, and cluster DCS Redis instances.
- Dimensions lists the metric dimensions.
Table 3 Redis Server metrics Metric ID
+-Table 3 Redis Server metrics Metric ID
Metric
+Metric
Description
+Description
Value Range
+Value Range
Monitored Object
+Conversion Rule
Monitoring Period (Raw Data)
+Monitored Object (Dimension)
+Monitoring Period (Raw Data)
cpu_usage
+cpu_usage
CPU Usage
+CPU Usage
The monitored object's maximum CPU usage among multiple sampling values in a monitoring period
-Unit: %
+The monitored object's maximum CPU usage among multiple sampling values in a monitoring period
0–100%
+0–100
+Unit: %
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
cpu_avg_usage
+cpu_avg_usage
Average CPU Usage
+Average CPU Usage
The monitored object's average CPU usage of multiple sampling values in a monitoring period
-Unit: %
+The monitored object's average CPU usage of multiple sampling values in a monitoring period
0–100%
+0–100
+Unit: %
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
memory_usage
+memory_usage
Memory Usage
+Memory Usage
Memory consumed by the monitored object
-Unit: %
+Memory consumed by the monitored object
0–100%
+0–100
+Unit: %
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
connected_clients
+connected_clients
Connected Clients
+Connected Clients
Number of connected clients (excluding those from slave nodes)
+Number of connected clients (excluding those from slave nodes)
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
client_longest_out_list
+client_longest_out_list
Client Longest Output List
+Client Longest Output List
Longest output list among current client connections
+Longest output list among current client connections
≥ 0
+≥ 0
Redis Server of a master/standby, read/write splitting, or cluster DCS Redis 4.0 or later instance
+N/A
1 minute
+Redis Server of a master/standby, read/write splitting, or cluster DCS Redis 4.0 or later instance
+1 minute
client_biggest_in_buf
+client_biggest_in_buf
Client Biggest Input Buf
+Client Biggest Input Buf
Maximum input data length among current client connections
-Unit: byte
+Maximum input data length among current client connections
≥ 0
+≥ 0
+Unit: byte
Redis Server of a master/standby, read/write splitting, or cluster DCS Redis 4.0 or later instance
+1024(IEC)
1 minute
+Redis Server of a master/standby, read/write splitting, or cluster DCS Redis 4.0 or later instance
+1 minute
blocked_clients
+blocked_clients
Blocked Clients
+Blocked Clients
Number of clients suspended by block operations such as BLPOP, BRPOP, and BRPOPLPUSH
+Number of clients suspended by block operations such as BLPOP, BRPOP, and BRPOPLPUSH
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
used_memory
+used_memory
Used Memory
+Used Memory
Number of bytes used by the Redis server
-Unit: byte
+Number of bytes used by the Redis server
≥ 0
+≥ 0
+Unit: byte
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
used_memory_rss
+used_memory_rss
Used Memory RSS
+Used Memory RSS
RSS memory that the Redis server has used, which including all stack and heap memory but not swapped-out memory
-Unit: byte
+RSS memory that the Redis server has used, which including all stack and heap memory but not swapped-out memory
≥ 0
+≥ 0
+Unit: byte
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
used_memory_peak
+used_memory_peak
Used Memory Peak
+Used Memory Peak
Peak memory consumed by Redis since the Redis server last started
-Unit: byte
+Peak memory consumed by Redis since the Redis server last started
≥ 0
+≥ 0
+Unit: byte
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
used_memory_lua
+used_memory_lua
Used Memory Lua
+Used Memory Lua
Number of bytes used by the Lua engine
-Unit: byte
+Number of bytes used by the Lua engine
≥ 0
+≥ 0
+Unit: byte
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
memory_frag_ratio
+memory_frag_ratio
Memory Fragmentation Ratio
+Memory Fragmentation Ratio
Current memory fragmentation, which is the ratio between used_memory_rss/used_memory.
+Current memory fragmentation, which is the ratio between used_memory_rss/used_memory.
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
total_connections_received
+total_connections_received
New Connections
+New Connections
Number of connections received during the monitoring period
+Number of connections received during the monitoring period
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
total_commands_processed
+total_commands_processed
Commands Processed
+Commands Processed
Number of commands processed during the monitoring period
+Number of commands processed during the monitoring period
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
instantaneous_ops
+instantaneous_ops
Ops per Second
+Ops per Second
Number of commands processed per second
+Number of commands processed per second
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
total_net_input_bytes
+total_net_input_bytes
Network Input Bytes
+Network Input Bytes
Number of bytes received during the monitoring period
-Unit: byte
+Number of bytes received during the monitoring period
≥ 0
+≥ 0
+Unit: byte
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
total_net_output_bytes
+total_net_output_bytes
Network Output Bytes
+Network Output Bytes
Number of bytes sent during the monitoring period
-Unit: byte
+Number of bytes sent during the monitoring period
≥ 0
+≥ 0
+Unit: byte
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
instantaneous_input_kbps
+instantaneous_input_kbps
Input Flow
+Input Flow
Instantaneous input traffic
-Unit: KB/s
+Instantaneous input traffic
≥ 0 KB/s
+≥ 0
+Unit: KiB/s
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
instantaneous_output_kbps
+instantaneous_output_kbps
Output Flow
+Output Flow
Instantaneous output traffic
-Unit: KB/s
+Instantaneous output traffic
≥ 0 KB/s
+≥ 0
+Unit: KiB/s
Redis Server of a read/write splitting or cluster instance
+1024(IEC)
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
rejected_connections
+rejected_connections
Rejected Connections
+Rejected Connections
Number of connections that have exceeded maxclients and been rejected during the monitoring period
+Number of connections that have exceeded maxclients and been rejected during the monitoring period
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
expired_keys
+expired_keys
Expired Keys
+Expired Keys
Number of keys that have expired and been deleted during the monitoring period
+Number of keys that have expired and been deleted during the monitoring period
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
evicted_keys
+evicted_keys
Evicted Keys
+Evicted Keys
Number of keys that have been evicted and deleted during the monitoring period
+Number of keys that have been evicted and deleted during the monitoring period
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
pubsub_channels
+pubsub_channels
PubSub Channels
+PubSub Channels
Number of Pub/Sub channels
+Number of Pub/Sub channels
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
pubsub_patterns
+pubsub_patterns
PubSub Patterns
+PubSub Patterns
Number of Pub/Sub patterns
+Number of Pub/Sub patterns
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
keyspace_hits_perc
+keyspace_hits_perc
Hit Rate
+Hit Rate
Ratio of the number of Redis cache hits to the number of lookups. Calculation: keyspace_hits/(keyspace_hits + keyspace_misses)
-Unit: %
+Ratio of the number of Redis cache hits to the number of lookups. Calculation: keyspace_hits/(keyspace_hits + keyspace_misses)
0–100%
+0–100
+Unit: %
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
command_max_delay
+command_max_delay
Maximum Command Latency
+Maximum Command Latency
Maximum latency of commands
-Unit: ms
+Maximum latency of commands
≥ 0 ms
+≥ 0
+Unit: ms
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
is_slow_log_exist
+is_slow_log_exist
Slow Query Logs
+Slow Query Logs
Existence of slow query logs in the node
+Existence of slow query logs in the node
NOTE:Slow queries caused by the MIGRATE, SLAVEOF, CONFIG, BGSAVE, and BGREWRITEAOF commands are not counted.
- 1: yes
- 0: no
- 1: yes
- 0: no
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
keys
+keys
Keys
+Keys
Number of keys in Redis
+Number of keys in Redis
≥ 0
+≥ 0
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
sadd
+sadd
SADD
+SADD
Number of SADD commands processed per second
-Unit: count/s
+Number of SADD commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
smembers
+smembers
SMEMBERS
+SMEMBERS
Number of SMEMBERS commands processed per second
-Unit: count/s
+Number of SMEMBERS commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
ms_repl_offset
+ms_repl_offset
Replication Gap
+Replication Gap
Data synchronization gap between the master and the replica
+Data synchronization gap between the master and the replica
-
+-
Replica of a cluster DCS Redis 4.0 or 5.0 instance
+N/A
1 minute
+Replica of a cluster DCS Redis 4.0 or 5.0 instance
+1 minute
del
+del
DEL
+DEL
Number of DEL commands processed per second
-Unit: count/s
+Number of DEL commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
expire
+expire
EXPIRE
+EXPIRE
Number of EXPIRE commands processed per second
-Unit: count/s
+Number of EXPIRE commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
get
+get
GET
+GET
Number of GET commands processed per second
-Unit: count/s
+Number of GET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
hdel
+hdel
HDEL
+HDEL
Number of HDEL commands processed per second
-Unit: count/s
+Number of HDEL commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
hget
+hget
HGET
+HGET
Number of HGET commands processed per second
-Unit: count/s
+Number of HGET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
hmget
+hmget
HMGET
+HMGET
Number of HMGET commands processed per second
-Unit: count/s
+Number of HMGET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
hmset
+hmset
HMSET
+HMSET
Number of HMSET commands processed per second
-Unit: count/s
+Number of HMSET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
hset
+hset
HSET
+HSET
Number of HSET commands processed per second
-Unit: count/s
+Number of HSET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
mget
+mget
MGET
+MGET
Number of MGET commands processed per second
-Unit: count/s
+Number of MGET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
mset
+mset
MSET
+MSET
Number of MSET commands processed per second
-Unit: count/s
+Number of MSET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
set
+set
SET
+SET
Number of SET commands processed per second
-Unit: count/s
+Number of SET commands processed per second
0–500,000
+0–500,000
+Unit: count/s
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
rx_controlled
+rx_controlled
Flow Control Times
+Flow Control Times
Number of flow control times during the monitoring period
-Unit: count
+Number of flow control times during the monitoring period
≥ 0
+≥ 0
+Unit: count
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
bandwidth_usage
+bandwidth_usage
Bandwidth Usage
+Bandwidth Usage
Percentage of the used bandwidth to the maximum bandwidth limit
+Percentage of the used bandwidth to the maximum bandwidth limit
0–200%
+0–200
+Unit: %
Redis Server of a read/write splitting or cluster instance
+N/A
+Redis Server of a read/write splitting or cluster instance
Redis Server of a master/standby DCS Redis 4.0 or later instance
1 minute
+1 minute
Proxy Metrics
- The Monitored Object column lists instances that support the corresponding metrics.
- Dimensions lists the metric dimensions.
Proxy Metrics
- - Available for Proxy Cluster and read/write splitting instances.
- Dimensions lists the metric dimensions.
Table 4 Proxy metrics of Proxy Cluster or read/write splitting DCS Redis 4.0/5.0 instances Metric ID
+Table 4 Proxy metrics of Proxy Cluster or read/write splitting DCS Redis 4.0/5.0 instances Metric ID
Metric
+Metric
Metric Description
+Metric Description
Value Range
+Value Range
Monitored Object
+Conversion Rule
Monitoring Period (Raw Data)
+Monitored Object (Dimension)
+Monitoring Period (Raw Data)
node_status
+node_status
Instance Node Status
+Instance Node Status
Indication of whether the proxy is normal.
+Indication of whether the proxy is normal.
- 0: Normal
- 1: Abnormal
- 0: Normal
- 1: Abnormal
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
cpu_usage
+cpu_usage
CPU Usage
+CPU Usage
The monitored object's maximum CPU usage among multiple sampling values in a monitoring period
-Unit: %
+The monitored object's maximum CPU usage among multiple sampling values in a monitoring period
0–100%
+0–100
+Unit: %
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
cpu_avg_usage
+cpu_avg_usage
Average CPU Usage
+Average CPU Usage
The monitored object's average CPU usage of multiple sampling values in a monitoring period
-Unit: %
+The monitored object's average CPU usage of multiple sampling values in a monitoring period
0–100%
+0–100
+Unit: %
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
memory_usage
+memory_usage
Memory Usage
+Memory Usage
Memory consumed by the monitored object
-Unit: %
+Memory consumed by the monitored object
0–100%
+0–100
+Unit: %
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
connected_clients
+connected_clients
Connected Clients
+Connected Clients
Number of connected clients
+Number of connected clients
≥ 0
+≥ 0
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
instantaneous_ops
+instantaneous_ops
Ops per Second
+Ops per Second
Number of commands processed per second
+Number of commands processed per second
≥ 0
+≥ 0
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
instantaneous_input_kbps
+instantaneous_input_kbps
Input Flow
+Input Flow
Instantaneous input traffic
-Unit: KB/s
+Instantaneous input traffic
≥ 0 KB/s
+≥ 0
+Unit: KiB/s
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+1024(IEC)
1 minute
+Proxy
+1 minute
instantaneous_output_kbps
+instantaneous_output_kbps
Output Flow
+Output Flow
Instantaneous output traffic
-Unit: KB/s
+Instantaneous output traffic
≥ 0 KB/s
+≥ 0
+Unit: KiB/s
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+1024(IEC)
1 minute
+Proxy
+1 minute
total_net_input_bytes
+total_net_input_bytes
Network Input Bytes
+Network Input Bytes
Number of bytes received during the monitoring period
-Unit: byte
+Number of bytes received during the monitoring period
≥ 0
+≥ 0
+Unit: byte
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+1024(IEC)
1 minute
+Proxy
+1 minute
total_net_output_bytes
+total_net_output_bytes
Network Output Bytes
+Network Output Bytes
Number of bytes sent during the monitoring period
-Unit: byte
+Number of bytes sent during the monitoring period
≥ 0
+≥ 0
+Unit: byte
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+1024(IEC)
1 minute
+Proxy
+1 minute
connections_usage
+connections_usage
Connection Usage
+Connection Usage
Percentage of the current number of connections to the maximum allowed number of connections Unit: %
+Percentage of the current number of connections to the maximum allowed number of connections
0–100%
+0–100
+Unit: %
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
command_max_rt
+command_max_rt
Maximum Latency
+Maximum Latency
Maximum delay from when the node receives commands to when it responds
-Unit: us
+Maximum delay from when the node receives commands to when it responds
>=0us
+≥ 0
+Unit: μs
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
command_avg_rt
+command_avg_rt
Average Latency
+Average Latency
Average delay from when the node receives commands to when it responds
-Unit: us
+Average delay from when the node receives commands to when it responds
>=0us
+≥ 0
+Unit: μs
Proxy in a Proxy Cluster or read/write splitting DCS Redis instance
+N/A
1 minute
+Proxy
+1 minute
dcs_cluster_proxy_node
Proxy in a Proxy Cluster DCS Redis 3.0 instance
+Proxies (Redis 3.0)
dcs_cluster_proxy2_node
Proxy in a Proxy Cluster or read/write splitting DCS Redis 4.0 or later instance
+Proxies (Redis 4.0 and later)
2024-12-02
+2025-11-05
++ +2024-12-02
Added notes and constraints about the password in data migration sections.
Added Resetting Instance Passwords.
@@ -152,7 +157,7 @@2020-03-25
Modified the following content:
-- Changed the cluster instance type to Proxy Cluster in section What Is DCS?
- Modified the lists of supported and disabled Redis commands in section Command Compatibility.
- Added the assured/maximum bandwidth parameter in section DCS Instance Specifications.
- Moved the metrics originally described in section Related Services to section DCS Metrics and updated the metrics supported by Cloud Eye.
- Modified instance creation parameters in Creating a DCS Redis Instance according to DCS console upgrade and parameter modifications.
- Modified instance details parameters in section Viewing and Modifying DCS Instance Information according to DCS console upgrade and parameter modifications.
- Modified instance configuration parameters in section Modifying Configuration Parameters.
- Removed the function of stopping instances.
- Added description about restrictions of starting instances in section Starting DCS Instances.
- Changed parameter Time Window to Maintenance in section Modifying Maintenance Time Window.
- Modified description about configuring instance backup policies in section Configuring an Automatic Backup Policy.
- Added chapter Monitoring, updated metrics supported by Cloud Eye, and added description about operations of viewing monitoring data and setting alarm rules.
- Changed the supported number of DBs for single-node and master/standby instances in section Does DCS for Redis Support Multiple Databases?
- Changed the cluster instance type to Proxy Cluster in section What Is DCS?
- Modified the lists of supported and disabled Redis commands in section Command Compatibility.
- Added the assured/maximum bandwidth parameter in section DCS Instance Specifications.
- Moved the metrics originally described in section Related Services to section DCS Metrics and updated the metrics supported by Cloud Eye.
- Modified instance creation parameters in Creating a DCS Redis Instance according to DCS console upgrade and parameter modifications.
- Modified instance details parameters in section Viewing and Modifying DCS Instance Information according to DCS console upgrade and parameter modifications.
- Modified instance configuration parameters in section Modifying Configuration Parameters.
- Removed the function of stopping instances.
- Added description about restrictions of starting instances in section Starting DCS Instances.
- Changed parameter Time Window to Maintenance in section Modifying Maintenance Time Window.
- Modified description about configuring instance backup policies in section Configuring an Automatic Backup Policy.
- Added chapter Monitoring, updated metrics supported by Cloud Eye, and added description about operations of viewing monitoring data and setting alarm rules.
- Changed the supported number of DBs for single-node and master/standby instances in section Does DCS for Redis Support Multi-DB?
2019-04-12
@@ -183,7 +188,7 @@2017-11-08
Added the following content:
-- Provided support for DCS instances in cluster mode.
- Added sections Modifying DCS Instance Specifications and Backing Up and Restoring DCS Instances.
- Added the Time Window parameter.
- Added section Preparing Required Resources.
- Provided support for DCS instances in cluster mode.
- Added sections Modifying DCS Instance Specifications and Backing Up and Restoring Instance Data.
- Added the Time Window parameter.
- Added section Preparing Required Resources.
- Added some FAQs in chapter FAQs.
Connecting to Redis on Jedis (Java)
@@ -367,7 +368,7 @@ private SSLSocketFactory getTrustStoreSslSocketFactory() throws Exception{This section describes how to access a Redis instance on Jedis. For more information about how to use other Redis clients, visit the Redis official website.
Spring Data Redis is already integrated with Jedis and Lettuce for Spring Boot projects. Spring Boot 1.x is integrated with Jedis, and Spring Boot 2.x is integrated with Lettuce. To use Jedis in Spring Boot 2.x and later, you need to solve Lettuce dependency conflicts.
-- Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port number of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
+Notes and Constraints
Springboot 2.3.12.RELEASE or later is required. Jedis 3.10.0 or later is required.
+To access a Redis 7.0 instance, use a Jedis 5.0.0 or later client. 5.1.1 and later versions are recommended.
+Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
Pom Configuration
<!-- import spring-data-redis --> <dependency> @@ -24,17 +24,17 @@ <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> - <version>${jedis.version}<version> + <version>${jedis.version}</version> </dependency>application.properties Configuration
- Single-node, master/standby, read/write splitting, and Proxy Cluster
#Redis host -spring.redis.host=<host> +spring.redis.host=<host> #Redis port -spring.redis.port=<port> +spring.redis.port=<port> #Redis database number spring.redis.database=0 #Redis password -spring.redis.password=<password> +spring.redis.password=<password> #Redis read/write timeout spring.redis.timeout=2000 #Whether to enable connection pooling @@ -48,11 +48,11 @@ spring.redis.jedis.pool.max-active=200 #Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. The default value -1 indicates to wait indefinitely. spring.redis.jedis.pool.max-wait=3000 #Interval for checking and evicting idle connection. Default: 60s. -spring.redis.jedis.pool.time-between-eviction-runs=60S
+spring.redis.jedis.pool.time-between-eviction-runs=60s - Redis Cluster
#Redis Cluster node connection information -spring.redis.cluster.nodes=<ip:port>,<ip:port>,<ip:port> +spring.redis.cluster.nodes=<ip:port>,<ip:port>,<ip:port> #Redis Cluster password -spring.redis.password=<password> +spring.redis.password=<password> #Redis Cluster max. redirecting times spring.redis.cluster.max-redirects=3 #Redis read/write timeout @@ -68,7 +68,7 @@ spring.redis.jedis.pool.max-active=200 #Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. The default value -1 indicates to wait indefinitely. spring.redis.jedis.pool.max-wait=3000 #Interval for checking and evicting idle connections. Default: 60s. -spring.redis.jedis.pool.time-between-eviction-runs=60S
+spring.redis.jedis.pool.time-between-eviction-runs=60s
Bean Configuration
- Single-node, master/standby, read/write splitting, and Proxy Cluster
import java.time.Duration; @@ -86,37 +86,37 @@ import redis.clients.jedis.JedisPoolConfig; @Configuration public class RedisConfiguration { - @Value("${redis.host}") + @Value("${redis.host}") private String redisHost; - @Value("${redis.port:6379}") + @Value("${redis.port:6379}") private Integer redisPort = 6379; - @Value("${redis.database:0}") + @Value("${redis.database:0}") private Integer redisDatabase = 0; - @Value("${redis.password:}") + @Value("${redis.password:}") private String redisPassword; - @Value("${redis.connect.timeout:3000}") + @Value("${redis.connect.timeout:3000}") private Integer redisConnectTimeout = 3000; - @Value("${redis.read.timeout:2000}") + @Value("${redis.read.timeout:2000}") private Integer redisReadTimeout = 2000; - @Value("${redis.pool.minSize:50}") + @Value("${redis.pool.minSize:50}") private Integer redisPoolMinSize = 50; - @Value("${redis.pool.maxSize:200}") + @Value("${redis.pool.maxSize:200}") private Integer redisPoolMaxSize = 200; - @Value("${redis.pool.maxWaitMillis:3000}") + @Value("${redis.pool.maxWaitMillis:3000}") private Integer redisPoolMaxWaitMillis = 3000; - @Value("${redis.pool.softMinEvictableIdleTimeMillis:1800000}") + @Value("${redis.pool.softMinEvictableIdleTimeMillis:1800000}") private Integer redisPoolSoftMinEvictableIdleTimeMillis = 30 * 60 * 1000; - @Value("${redis.pool.timeBetweenEvictionRunsMillis:60000}") + @Value("${redis.pool.timeBetweenEvictionRunsMillis:60000}") private Integer redisPoolBetweenEvictionRunsMillis = 60 * 1000; @Bean @@ -164,7 +164,7 @@ public class RedisConfiguration { poolConfig.setTestOnReturn(false); //Indicates whether to check for idle connections. If this is set to false, idle connections are not evicted. poolConfig.setTestWhileIdle(true); - //Duration after which idle connections are evicted. If the idle duration is greater than this value and the maximum number of idle connections is reached, idle connections are directly evicted. + //Duration after which idle connections are evicted. If the idle duration is greater than this value and the minimum number of idle connections is exceeded, idle connections are directly evicted. poolConfig.setSoftMinEvictableIdleTimeMillis(redisPoolSoftMinEvictableIdleTimeMillis); //Disable MinEvictableIdleTimeMillis(). poolConfig.setMinEvictableIdleTimeMillis(-1); @@ -194,28 +194,28 @@ public class RedisConfiguration { @Value("${redis.cluster.nodes}") private String redisClusterNodes; - @Value("${redis.password:}") + @Value("${redis.password:}") private String redisPassword; - @Value("${redis.connect.timeout:3000}") + @Value("${redis.connect.timeout:3000}") private Integer redisConnectTimeout = 3000; - @Value("${redis.read.timeout:2000}") + @Value("${redis.read.timeout:2000}") private Integer redisReadTimeout = 2000; - @Value("${redis.pool.minSize:50}") + @Value("${redis.pool.minSize:50}") private Integer redisPoolMinSize = 50; - @Value("${redis.pool.maxSize:200}") + @Value("${redis.pool.maxSize:200}") private Integer redisPoolMaxSize = 200; - @Value("${redis.pool.maxWaitMillis:3000}") + @Value("${redis.pool.maxWaitMillis:3000}") private Integer redisPoolMaxWaitMillis = 3000; - @Value("${redis.pool.softMinEvictableIdleTimeMillis:1800000}") + @Value("${redis.pool.softMinEvictableIdleTimeMillis:1800000}") private Integer redisPoolSoftMinEvictableIdleTimeMillis = 30 * 60 * 1000; - @Value("${redis.pool.timeBetweenEvictionRunsMillis:60000}") + @Value("${redis.pool.timeBetweenEvictionRunsMillis:60000}") private Integer redisPoolBetweenEvictionRunsMillis = 60 * 1000; @Bean @@ -269,7 +269,7 @@ public class RedisConfiguration { poolConfig.setTestOnReturn(false); //Indicates whether to check for idle connections. If this is set to false, idle connections are not evicted. poolConfig.setTestWhileIdle(true); - //Duration after which idle connections are evicted. If the idle duration is greater than this value and the maximum number of idle connections is reached, idle connections are directly evicted. + //Duration after which idle connections are evicted. If the idle duration is greater than this value and the minimum number of idle connections is exceeded, idle connections are directly evicted. poolConfig.setSoftMinEvictableIdleTimeMillis(redisPoolSoftMinEvictableIdleTimeMillis); //Disable MinEvictableIdleTimeMillis(). poolConfig.setMinEvictableIdleTimeMillis(-1); @@ -352,7 +352,8 @@ private SSLSocketFactory getTrustStoreSslSocketFactory() throws Exception{-
Redis instance password
+Redis instance password. Needless for password-free instances. If you forget your password or need to reset it, see Resetting Instance Passwords.
+
clusterNodes
Cluster node connection information, including the node IP address and port number
+Cluster node connection information, including the node IP address and port
maxRedirects
@@ -377,7 +378,8 @@ private SSLSocketFactory getTrustStoreSslSocketFactory() throws Exception{password
Password
+Redis instance password. Needless for password-free instances. If you forget your password or need to reset it, see Resetting Instance Passwords.
+1800000
Duration (in milliseconds) after which idle connections are evicted. If the idle duration is greater than this value and the maximum number of idle connections is reached, idle connections are directly evicted.
+Duration (in milliseconds) after which idle connections are evicted. If the idle duration is greater than this value and the minimum number of idle connections is exceeded, idle connections are directly evicted.
minEvictableIdleTimeMillis
diff --git a/docs/dcs/umn/dcs-ug-1009001.html b/docs/dcs/umn/dcs-ug-1009001.html index b6b90cb09..fc0ebea78 100644 --- a/docs/dcs/umn/dcs-ug-1009001.html +++ b/docs/dcs/umn/dcs-ug-1009001.html @@ -3,8 +3,8 @@Viewing Redis Run Logs
You can create run log files on the DCS console to collect run logs of DCS Redis instances within a specified period. After the logs are collected, you can download the log files to view the logs.
This function is supported by DCS Redis 4.0 instances and later.
-Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of a DCS instance.
- Click Run Logs.
- Click Create Log File.
For a master/standby, read/write splitting, or cluster instance, logs will be collected from the specified shard and replica. If the instance is the single-node type, logs of the only node of the instance will be collected.
-Select the collection period and click OK.
+Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of a DCS instance.
- Click Run Logs.
- Click Collect Logs, configure log collection information, specify the collection period, and click OK.
For a master/standby, read/write splitting, or cluster instance, you can collect logs by shard and replica. The shard and replica must be specified. If the instance is the single-node type, logs of the only node of the instance will be collected.
+A log file contains logs of one day. For example, if you select last 3 days, three log files will be generated.
- After the log file is successfully collected, click Download to download it.
- Log files are retained for seven days. Download them if necessary.
- The Redis kernel generates few logs, so your selected period may contain no log.
- Supported only by DCS Redis 4.0 and later instances, and the maxmemory-policy parameter of the instances must be set to allkeys-lfu or volatile-lfu.
- During hot key analysis, all keys will be traversed. The larger the number of keys, the longer the analysis takes.
- Perform hot key analysis shortly after peak hours to ensure the accuracy of the analysis results.
- The hot key analysis is performed on the master node of each instance and will reduce the instance access performance by up to 10%.
- A maximum of 100 hot key analysis records are retained for each instance. When this limit is reached, the oldest records will be deleted to make room for new records. You can also manually delete records you no longer need.
- Perform big key and hot key analysis during off-peak hours to avoid 100% CPU usage.
Big Key Analysis Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of a DCS Redis instance.
- Choose Analysis and Diagnosis > Cache Analysis.
- On the Big Key Analysis tab page, manually perform big key analysis or schedule daily automatic analysis.
- After an analysis task completes, click View to view the analysis results.
You can view the analysis results of different data types.
+Big Key Analysis Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of a DCS Redis instance.
- Choose Analysis and Diagnosis > Cache Analysis.
- On the Big Key Analysis tab page, manually perform big key analysis or schedule daily automatic analysis.
- After an analysis task completes, click View to view the analysis results.
You can view the analysis results of different data types.
diff --git a/docs/dcs/umn/dcs-ug-190905001.html b/docs/dcs/umn/dcs-ug-190905001.html index ce94547e5..1af9b9795 100644 --- a/docs/dcs/umn/dcs-ug-190905001.html +++ b/docs/dcs/umn/dcs-ug-190905001.html @@ -105,11 +105,12 @@ A maximum of 20 big key analysis records are retained for Strings and 80 are retained for Lists, Sets, Zsets, and Hashes.
CPU Usage
+Maximum CPU Usage
0–100%
+0–100
+Unit: %
Alarm threshold: > 70%
+Alarm threshold: > 90%
Number of consecutive periods: 2
Alarm severity: Major
Average CPU Usage
0–100%
+0–100
+Unit: %
Alarm threshold: > 70%
Number of consecutive periods: 2
@@ -136,7 +138,8 @@Memory Usage
0–100%
+0–100
+Unit: %
Alarm threshold: > 70%
Number of consecutive periods: 2
@@ -189,7 +192,8 @@Bandwidth Usage
0–200%
+0–200
+Unit: %
Alarm threshold: > 90%
Number of consecutive periods: 2
@@ -235,11 +239,12 @@CPU Usage
+Maximum CPU Usage
0–100%
+0–100
+Unit: %
Alarm threshold: > 70%
+Alarm threshold: > 90%
Number of consecutive periods: 2
Alarm severity: Critical
Memory Usage
0–100%
+0–100
+Unit: %
Alarm threshold: > 70%
Number of consecutive periods: 2
diff --git a/docs/dcs/umn/dcs-ug-210107001.html b/docs/dcs/umn/dcs-ug-210107001.html index 88d7ac692..7e1df4080 100644 --- a/docs/dcs/umn/dcs-ug-210107001.html +++ b/docs/dcs/umn/dcs-ug-210107001.html @@ -4,7 +4,7 @@This section describes how to query the shards and replicas of a DCS Redis 4.0 or later instance and how to manually promote a replica to master.
Currently, this function is supported only by master/standby, read/write splitting, and cluster DCS Redis 4.0 and later instances. DCS Redis 3.0 instances and single-node instances do not support this function.
- A master/standby or read/write splitting instance has only one shard with one master and one replica by default. You can view the sharding information on the Shards and Replicas page. To manually switch the master and replica roles, see Performing a Master/Standby Switchover for a DCS Instance.
- A cluster instance has multiple shards. Each shard has two replicas by default. On the Shards and Replicas page, you can view the sharding information and manually switch the master and replica roles. For details about the number of shards corresponding to different instance specifications, see Redis Cluster.
Managing DCS Instance Shards and Replicas
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager. The Cache Manager page is displayed.
- Click an instance.
- Choose Shards and Replicas.
The page displays all shards in the instance and the list of replicas of each shard.
+-Managing DCS Instance Shards and Replicas
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Cache Manager. The Cache Manager page is displayed.
- Click an instance.
- Choose Shards and Replicas.
The page displays all shards in the instance and the list of replicas of each shard.
- Click
to show all replicas of a shard.Figure 1 Lists of shards and replicas (cluster)
Figure 2 Lists of shards and replicas (master/standby)
- For a cluster instance, you can promote a replica in a shard to be master.
- Click Promote to Master in the row containing another replica which is in the "Replica" role.
- Click Yes.
- For a cluster instance, you can promote a replica in a shard to be master.
Step 2: Prepare the Target DCS Redis Instance
- If a DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If a DCS Redis instance is available, you do not need to create a new one. However, you can clear the instance data before the migration.
- If the target instance is Redis 4.0 and later, clear the data by referring to Clearing DCS Instance Data.
- If the target instance is a DCS Redis 3.0 instance, run the FLUSHALL command to clear data.
- If the target instance data is not cleared before the migration and the source and target instances contain the same key, the key in the target instance will be overwritten by the key in the source instance after the migration.
Step 2: Prepare the Target DCS Redis Instance
- If a DCS Redis instance is not available, create one first. For details, see Creating a DCS Redis Instance.
- If a DCS Redis instance is available, you do not need to create a new one. However, you can clear the instance data before the migration.
- For details, see Clearing DCS Instance Data.
- If the target instance data is not cleared before the migration and the source and target instances contain the same key, the key in the target instance will be overwritten by the key in the source instance after the migration.
Step 3: Create a Migration Task
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Data Migration.
- Click Create Backup Import Task.
- Enter the task name and description.
- Set Data Source to Redis.
- For source Redis, select the instance prepared in Step 1: Obtain the Source Instance Name and Password.
- Select the backup task whose data is to be migrated.
- For Target Instance, select the DCS Redis prepared in Step 2: Prepare the Target DCS Redis Instance.
- Enter the password of the target instance. Click Test Connection to verify the password. If the instance is not password-protected, click Test Connection directly.
- Click Next.
- Confirm the migration task details and click Submit.
Go back to the data migration task list. After the migration is successful, the task status changes to Successful.
diff --git a/docs/dcs/umn/dcs-ug-210330002.html b/docs/dcs/umn/dcs-ug-210330002.html index d2d5aec40..abbb7869b 100644 --- a/docs/dcs/umn/dcs-ug-210330002.html +++ b/docs/dcs/umn/dcs-ug-210330002.html @@ -2,55 +2,51 @@Scanning and Deleting Expired Keys in a DCS Redis Instance
There are two ways to delete a key in Redis.
-- Use the DEL command to directly delete a key.
- Use commands such as EXPIRE to set a timeout on a key. After the timeout elapses, the key becomes inaccessible but is not deleted immediately because Redis is mostly single-threaded. Redis uses the following strategies to release the memory used by expired keys:
- Lazy free deletion: The deletion strategy is controlled in the main I/O event loop. Before a read/write command is executed, a function is called to check whether the key to be accessed has expired. If it has expired, it will be deleted and a response will be returned indicating that the key does not exist. If the key has not expired, the command execution resumes.
- Scheduled deletion: A time event function is executed at certain intervals. Each time the function is executed, a random collection of keys are checked, and expired keys are deleted. Instead of checking all keys each time, open-source Redis randomly checks 20 keys each time, 10 times per second by default. This avoids prolonging blocks on the Redis main thread, but the memory used by expired keys cannot be released quickly.
- Use the DEL command to directly delete a key.
- Use commands such as EXPIRE to set a timeout on a key. After the timeout elapses, the key becomes inaccessible but is not deleted immediately because Redis is mostly single-threaded. Redis uses the following strategies to release the memory used by expired keys:
- Lazy free deletion: The deletion strategy is controlled in the main I/O event loop. Before a read/write command is executed, a function is called to check whether the key to be accessed has expired. If it has expired, it will be deleted and a response will be returned indicating that the key does not exist. If the key has not expired, the command execution resumes.
- Scheduled deletion: A time event function is executed at certain intervals. Each time the function is executed, a random collection of keys are checked, and expired keys are deleted. Instead of checking all keys each time, open-source Redis randomly checks 20 keys each time (specified by parameter active-expire-num), 10 times per second by default. This avoids prolonging blocks on the Redis main thread, but the memory used by expired keys cannot be released quickly.
DCS integrates these strategies, and provides a common expired key query method to allow you to periodically release the memory used by expired keys. You can configure scheduled scans on the master nodes of your instances. The entire keyspace is traversed during the scans, triggering Redis to check whether the keys have expired and to remove expired keys if any.
-- Perform expired key scans during off-peak hours to avoid 100% CPU usage.
-Notes and Constraints
Expired keys can be scanned only for DCS Redis 4.0 and later instances.
-Released expired keys cannot be queried.
+-Notes and Constraints
- Expired keys can be scanned only for DCS Redis 4.0 and later instances.
- Released expired keys cannot be queried.
- Deleted expired keys cannot be viewed.
- This scan is on the master node of the instance and will affect instance performance.
- Perform expired key scans during off-peak hours to avoid 100% CPU usage.
Scanning and Deleting Expired Keys in a DCS Redis Instance
- Log in to the DCS console.
- Click
in the upper left corner of the management console and select the region where your instance is located. - In the navigation pane, choose Cache Manager.
- Click the name of a DCS Redis instance.
- Choose Analysis and Diagnosis > Cache Analysis.
- On the Expired Key Scan tab page, scan for expired keys and release them.
- Click Start Scanning to scan for expired keys immediately.
- Enable Scheduled to schedule automatic scans at a specified time. For details about how to configure automatic scans, see Table 1 and Automated Scan Performance and Suggestions.
Scanning and Deleting Expired Keys in a DCS Redis Instance
- Log in to the DCS console.
- Click in the upper left corner of the management console and select the region where your instance is located.
- In the navigation pane, choose Cache Manager.
- Click the name of a DCS Redis instance.
- Choose Analysis and Diagnosis > Cache Analysis.
- On the Expired Key Scan tab page, scan for expired keys and release them.
The keyspace will be scanned to release the memory used by expired keys that were not released due to the lazy free mechanism.
+- Click Start Analysis to manually scan expired keys with preset parameters (number of keys to iterate: 100; scan timeout: 360 minutes).
- Enable Scheduled to schedule automatic scans at a specified time. For details about how to configure automatic scans, see Table 1 and Automated Scan Performance and Suggestions.
Table 1 Parameters for scheduling automatic scans Parameter
+Table 1 Parameters for scheduling automatic scans Parameter
Description
+Description
Start At
+Start At
The first scan can only start after the current time.
+The first scan can only start after the current time.
Format: YYYY-MM-DD hh:mm:ss
Interval
+Interval
Interval between scans.
-- If the previous scan is not complete when the start time arrives, the upcoming scan will be skipped.
- If the previous scan is complete within five minutes after the start time, the upcoming scan will not be skipped.
NOTE:+Continuous scans may cause high CPU usage. Set this parameter based on the total number of keys in the instance and the increase of keys. For details, see Automated Scan Performance and Suggestions.
-Interval between scans.
+- If the previous scan is not complete when the start time arrives, the upcoming scan will be skipped.
- If the previous scan is complete within five minutes after the start time, the upcoming scan will not be skipped.
- Continuous scans may cause high CPU usage. Set this parameter based on the total number of keys in the instance and the increase of keys. For details, see Automated Scan Performance and Suggestions.
Value range: 0–43,200
Default value: 1440
Unit: minute
Timeout
+Timeout
This parameter is used to prevent scanning timeout due to unknown reasons. If scanning times out due to unknown reasons, subsequent scheduled tasks cannot be executed. After the specified timeout elapses, a failure message is returned and the next scan will be performed.
+This parameter is used to prevent scanning timeout due to unknown reasons. If scanning times out due to unknown reasons, subsequent scheduled tasks cannot be executed. After the specified timeout elapses, a failure message is returned and the next scan will be performed.
- Set the timeout to at least twice the interval.
- You can set a value based on the time taken in previous scans and the maximum timeout that can be tolerated in the application scenario.
Value range: 1–86,400
Default value: 2880
Unit: minute
Keys to Iterate
+Keys to Iterate
The SCAN command is used to iterate the keys in the current database. The COUNT option is used to let the user tell the iteration command how many elements should be returned from the dataset in each iteration. For details, see the description of the SCAN command. Iterative scanning can reduce the risks of slowing down Redis when a large number of keys are scanned at a time.
+The SCAN command is used to iterate the keys in the current database. The COUNT option is used to let the user tell the iteration command how many elements should be returned from the dataset in each iteration. For details, see the description of the SCAN command. Iterative scanning can reduce the risks of slowing down Redis when a large number of keys are scanned at a time.
For example, if there are 10 million keys in Redis and the number of keys to iterate is set to 1000, a full scan will be complete after 10,000 iterations.
Value range: 10–1,000
-Default value: 10
+Default value: 50
Unit: number
- After an expired key scan task is submitted, a task record is generated for each expired key scan. You can view the task ID, status, scan mode, start time, and end time.
Figure 1 Expired key scan tasks-
The scan fails in the following scenarios:- An exception occurred.
- There are too many keys, resulting in a timeout. Some keys have already been deleted before the timeout.
The scan fails in the following scenarios:-- An exception occurred.
- There are too many keys, resulting in a timeout. Some keys have already been deleted before the timeout.
Configuration suggestions
-- You can configure the number of keys to be scanned and the scanning interval based on the total number of keys and the increase in the number of keys in the instance.
- In the reference test with 15 million keys and Keys to Iterate set to 10, the scanning takes about 125 minutes. In this case, set the scan interval to more than 4 hours.
- If you want to accelerate the scanning, set Keys to Iterate to 100. It takes about 12.5 minutes to complete the scanning. Therefore, set the scan interval to more than 30 minutes.
- The larger the number of keys to iterate, the faster the scanning, and the higher the CPU usage. There is a trade-off between time and CPU usage.
- If the number of expired keys does not increase rapidly, you can scan expired keys once a day.-
Start scanning during off-peak hours. Set the interval to one day and the timeout to two days.
-
- You can configure the number of keys to be scanned and the scanning interval based on the total number of keys and the increase in the number of keys in the instance.
- In the reference test with 15 million keys and Keys to Iterate set to 10, the scanning takes about 125 minutes. In this case, set the scan interval to more than 4 hours.
- If you want to accelerate the scanning, set Keys to Iterate to 100. It takes about 12.5 minutes to complete the scanning. Therefore, set the scan interval to more than 30 minutes.
- The larger the number of keys to iterate, the faster the scanning, and the higher the CPU usage. There is a trade-off between time and CPU usage.
- If the number of expired keys does not increase rapidly, you can scan expired keys once a day.
- Perform scans during off-peak hours. Set intervals to one day and timeouts to two days.
diff --git a/docs/dcs/umn/dcs-ug-210622002.html b/docs/dcs/umn/dcs-ug-210622002.html index 657c7d041..d2f0b71a7 100644 --- a/docs/dcs/umn/dcs-ug-210622002.html +++ b/docs/dcs/umn/dcs-ug-210622002.html @@ -4,95 +4,97 @@This section describes how to view parameter templates on the DCS console.
Procedure
- Log in to the DCS console.
- Click in the upper left corner and select a region and a project.
- In the navigation pane, choose Parameter Templates.
- Choose the Default Templates or Custom Templates tab.
- View parameter templates.
Currently, you can enter a keyword in the search box to search for a parameter template by template name.
- Click a parameter template. The parameters contained in the template are displayed. For details about the parameters, see Table 1.
-
Table 1 DCS Redis instance configuration parameters Parameter
+diff --git a/docs/dcs/umn/dcs-ug-210622003.html b/docs/dcs/umn/dcs-ug-210622003.html index 437b6b547..7cab49ec7 100644 --- a/docs/dcs/umn/dcs-ug-210622003.html +++ b/docs/dcs/umn/dcs-ug-210622003.html @@ -8,95 +8,97 @@Table 1 DCS Redis instance configuration parameters Parameter
Description
+Description
Value Range
+Value Range
Default Value
active-expire-num
+active-expire-num
Number of expired keys that can be deleted in regular scans.
-Redis 3.0 instances do not have this parameter.
+Number of expired keys that can be deleted in regular scans.
+This parameter is supported by DCS Redis 4.0 and later instances.
1–1000
+1–1000
20
timeout
+timeout
The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
+The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
Proxy Cluster instances do not have this parameter.
0–7200 seconds
+0~7200
+Unit: second
0
appendfsync
+appendfsync
Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
+Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
There are three settings:
no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe.
everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
Single-node instances do not have this parameter.
- no
- always
- everysec
- no
- always
- everysec
no
appendonly
+appendonly
Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
+Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
yes: enabled
no: disabled
Single-node instances do not have this parameter.
- yes
- no
- yes
- no
yes
client-output-buffer-limit-slave-soft-seconds
+client-output-buffer-limit-slave-soft-seconds
Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
+Value that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
Single-node instances do not have this parameter.
0–60
+0–60
+Unit: second
60
client-output-buffer-slave-hard-limit
+client-output-buffer-slave-hard-limit
Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
+Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
client-output-buffer-slave-soft-limit
+client-output-buffer-slave-soft-limit
Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
+Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
maxmemory-policy
+maxmemory-policy
The deletion policy to apply when the maxmemory limit is reached. Options:
+The deletion policy to apply when the maxmemory limit is reached. Options:
volatile-lru: Evict keys by trying to remove the less recently used (LRU) keys first, but only among keys that have an expire set. (Recommended)
allkeys-lru: Evict keys by trying to remove the LRU keys first.
volatile-random: evict keys randomly, but only evict keys with an expire set.
@@ -102,142 +104,148 @@volatile-lfu: Evict keys by trying to remove the less frequently used (LFU) keys first, but only among keys that have an expire set.
allkeys-lfu: Evict keys by trying to remove the LFU keys first.
Depends on the instance version.
+Depends on the instance version.
Depends on the instance version and type.
lua-time-limit
+lua-time-limit
Maximum time allowed for executing a Lua script (in milliseconds).
+Maximum time allowed for executing a Lua script.
Read/write splitting instances do not have this parameter.
100–5000
+100–5000
+Unit: millisecond
5,000
master-read-only
+master-read-only
Sets the instance to be read-only. All write operations will fail.
+Sets the instance to be read-only. All write operations will fail.
Proxy Cluster and read/write splitting instances do not have this parameter.
- yes
- no
- yes
- no
no
maxclients
+maxclients
The maximum number of clients allowed to be concurrently connected to a DCS instance.
+The maximum number of clients allowed to be concurrently connected to a DCS instance.
Read/Write splitting instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
proto-max-bulk-len
+proto-max-bulk-len
Maximum size of a single element request (in bytes).
+Maximum size of a single element request. Set this parameter to be greater than the customer request length. Otherwise, the request cannot be executed.
Read/write splitting instances do not have this parameter.
1,048,576–536,870,912
+1,048,576–536,870,912
+Unit: byte
536,870,912
repl-backlog-size
+repl-backlog-size
The replication backlog size (bytes). The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
+The replication backlog size. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
Single-node instances do not have this parameter.
16,384–1,073,741,824
+16,384–1,073,741,824
+Unit: byte
1,048,576
repl-backlog-ttl
+repl-backlog-ttl
The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
+The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
Single-node instances do not have this parameter.
0–604,800
+0–604,800
+Unit: second
3,600
repl-timeout
+repl-timeout
Replication timeout (in seconds).
+Replication timeout.
Single-node instances do not have this parameter.
30–3,600
+30–3,600
+Unit: second
60
hash-max-ziplist-entries
+hash-max-ziplist-entries
Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
+Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
1–10,000
+1–10,000
512
hash-max-ziplist-value
+hash-max-ziplist-value
Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
+Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
set-max-intset-entries
+set-max-intset-entries
When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
+When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
1–10,000
+1–10,000
512
zset-max-ziplist-entries
+zset-max-ziplist-entries
Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
+Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
1–10,000
+1–10,000
128
zset-max-ziplist-value
+zset-max-ziplist-value
Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
+Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
latency-monitor-threshold
+latency-monitor-threshold
Threshold time in latency monitoring. Unit: millisecond.
+Threshold time in latency monitoring.
Set to 0: Latency monitoring is disabled.
Set to more than 0: All with at least this many milliseconds of latency will be logged.
By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring.
Proxy Cluster instances do not have this parameter.
0–86,400,000 ms
+0–86,400,000
+Unit: millisecond
0
notify-keyspace-events
+notify-keyspace-events
Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
+Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
K: Keyspace events, published with the __keyspace@__ prefix.
E: Keyevent events, published with __keyevent@__ prefix
g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
@@ -252,30 +260,108 @@The parameter value must contain either K or E. A cannot be used together with any of the characters in "g$lshzxe". For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events.
Proxy Cluster instances do not have this parameter.
See the parameter description.
+See the parameter description.
Ex
slowlog-log-slower-than
+slowlog-log-slower-than
Redis records queries that exceed a specified execution time.
-slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Redis will record the query.
+Redis records queries that exceed a specified execution time.
+slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the query will be recorded.
0–1,000,000
+0–1,000,000
+Unit: microsecond
10,000
slowlog-max-len
+slowlog-max-len
The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
0–1000
+0–1000
128
auto-kill-timeout-lua-process
+yes: enabled
+no: disabled
+When this parameter is enabled, lua scripts are killed when their execution times out. However, scripts with write operations are not killed, but their nodes automatically restart (if persistence has been enabled for the instance) without saving the write operations.
+Single-node instances do not have this parameter.
+- yes
- no
no
+multi-db
+Manually back up the instance and clear all instance data before you enable or disable multi-DB. To restore the deleted data, use the backup import function on the Data Migration page. Options:
+yes: enable
+no: disable
+Only Proxy Cluster DCS Redis 4.0 and later instances have this parameter.
+- yes
- no
no
+dispatch-pubsub-to-fixed-shard
+This parameter specifies whether pub/sub channels are on the shard of slot 0. When this parameter is enabled, the pub/sub processing logic is consistent with that of single-node instances. You are advised to enable this parameter if you do not depend heavily on pub/sub. If you depend heavily on pub/sub, use the default configuration to allocate subscriptions to all shards.
+- yes: Enable this parameter to allocate subscription channels to the shard of slot 0.
- no: Disable this parameter to allocate channels to the shard of each channel-hashed slot.
Only Proxy Cluster instances have this parameter.
+- yes
- no
no
+readonly-lua-route-to-slave-enabled
+If enabled, read-only Lua scripts of read-only users are executed and routed to the standby node.
+- yes: enabled
- no: disabled
Available only for read/write splitting instances.
+- yes
- no
no
+proxy-slowlog-log-slower-than
+Slow queries of a proxy cover scheduled commands whose execution is delayed. proxy-slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the proxy will record the query.
+Available only for Proxy Cluster and read/write splitting instances.
+30,000–2,000,000
+Unit: microsecond
+500,000
+proxy-slowlog-max-len
+The maximum allowed number of slow queries of a proxy that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+Available only for Proxy Cluster and read/write splitting instances.
+0–1000
+128
+support-dispatch-to-replica-list
+Evenly allocates specified read commands to slave nodes. Currently, only the KEYS command can be configured.
+Available only for Proxy Cluster or read/write splitting instances whose proxy version is 5.0.14.12 or later.
+Left blank by default. Setting this parameter to KEYS performs the KEYS command only on the slave node.
+-
+- Select Modifiable parameters.
Currently, you can enter a keyword in the search box to search for a parameter by parameter name.
- In the row that contains the parameter to be modified, enter a value in the Assigned Value column.
Table 1 describes the parameters. In most cases, default values are retained.
-Table 1 DCS Redis instance configuration parameters Parameter
+diff --git a/docs/dcs/umn/dcs-ug-210622004.html b/docs/dcs/umn/dcs-ug-210622004.html index 88aa08a28..cc899fc84 100644 --- a/docs/dcs/umn/dcs-ug-210622004.html +++ b/docs/dcs/umn/dcs-ug-210622004.html @@ -6,95 +6,97 @@Table 1 DCS Redis instance configuration parameters Parameter
Description
+Description
Value Range
+Value Range
Default Value
active-expire-num
+active-expire-num
Number of expired keys that can be deleted in regular scans.
-Redis 3.0 instances do not have this parameter.
+Number of expired keys that can be deleted in regular scans.
+This parameter is supported by DCS Redis 4.0 and later instances.
1–1000
+1–1000
20
timeout
+timeout
The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
+The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
Proxy Cluster instances do not have this parameter.
0–7200 seconds
+0~7200
+Unit: second
0
appendfsync
+appendfsync
Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
+Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
There are three settings:
no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe.
everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
Single-node instances do not have this parameter.
- no
- always
- everysec
- no
- always
- everysec
no
appendonly
+appendonly
Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
+Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
yes: enabled
no: disabled
Single-node instances do not have this parameter.
- yes
- no
- yes
- no
yes
client-output-buffer-limit-slave-soft-seconds
+client-output-buffer-limit-slave-soft-seconds
Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
+Value that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
Single-node instances do not have this parameter.
0–60
+0–60
+Unit: second
60
client-output-buffer-slave-hard-limit
+client-output-buffer-slave-hard-limit
Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
+Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
client-output-buffer-slave-soft-limit
+client-output-buffer-slave-soft-limit
Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
+Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
maxmemory-policy
+maxmemory-policy
The deletion policy to apply when the maxmemory limit is reached. Options:
+The deletion policy to apply when the maxmemory limit is reached. Options:
volatile-lru: Evict keys by trying to remove the less recently used (LRU) keys first, but only among keys that have an expire set. (Recommended)
allkeys-lru: Evict keys by trying to remove the LRU keys first.
volatile-random: evict keys randomly, but only evict keys with an expire set.
@@ -106,142 +108,148 @@volatile-lfu: Evict keys by trying to remove the less frequently used (LFU) keys first, but only among keys that have an expire set.
allkeys-lfu: Evict keys by trying to remove the LFU keys first.
Depends on the instance version.
+Depends on the instance version.
Depends on the instance version and type.
lua-time-limit
+lua-time-limit
Maximum time allowed for executing a Lua script (in milliseconds).
+Maximum time allowed for executing a Lua script.
Read/write splitting instances do not have this parameter.
100–5000
+100–5000
+Unit: millisecond
5,000
master-read-only
+master-read-only
Sets the instance to be read-only. All write operations will fail.
+Sets the instance to be read-only. All write operations will fail.
Proxy Cluster and read/write splitting instances do not have this parameter.
- yes
- no
- yes
- no
no
maxclients
+maxclients
The maximum number of clients allowed to be concurrently connected to a DCS instance.
+The maximum number of clients allowed to be concurrently connected to a DCS instance.
Read/Write splitting instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
proto-max-bulk-len
+proto-max-bulk-len
Maximum size of a single element request (in bytes).
+Maximum size of a single element request. Set this parameter to be greater than the customer request length. Otherwise, the request cannot be executed.
Read/write splitting instances do not have this parameter.
1,048,576–536,870,912
+1,048,576–536,870,912
+Unit: byte
536,870,912
repl-backlog-size
+repl-backlog-size
The replication backlog size (bytes). The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
+The replication backlog size. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
Single-node instances do not have this parameter.
16,384–1,073,741,824
+16,384–1,073,741,824
+Unit: byte
1,048,576
repl-backlog-ttl
+repl-backlog-ttl
The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
+The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
Single-node instances do not have this parameter.
0–604,800
+0–604,800
+Unit: second
3,600
repl-timeout
+repl-timeout
Replication timeout (in seconds).
+Replication timeout.
Single-node instances do not have this parameter.
30–3,600
+30–3,600
+Unit: second
60
hash-max-ziplist-entries
+hash-max-ziplist-entries
Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
+Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
1–10,000
+1–10,000
512
hash-max-ziplist-value
+hash-max-ziplist-value
Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
+Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
set-max-intset-entries
+set-max-intset-entries
When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
+When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
1–10,000
+1–10,000
512
zset-max-ziplist-entries
+zset-max-ziplist-entries
Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
+Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
1–10,000
+1–10,000
128
zset-max-ziplist-value
+zset-max-ziplist-value
Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
+Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
latency-monitor-threshold
+latency-monitor-threshold
Threshold time in latency monitoring. Unit: millisecond.
+Threshold time in latency monitoring.
Set to 0: Latency monitoring is disabled.
Set to more than 0: All with at least this many milliseconds of latency will be logged.
By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring.
Proxy Cluster instances do not have this parameter.
0–86,400,000 ms
+0–86,400,000
+Unit: millisecond
0
notify-keyspace-events
+notify-keyspace-events
Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
+Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
K: Keyspace events, published with the __keyspace@__ prefix.
E: Keyevent events, published with __keyevent@__ prefix
g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
@@ -256,30 +264,108 @@The parameter value must contain either K or E. A cannot be used together with any of the characters in "g$lshzxe". For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events.
Proxy Cluster instances do not have this parameter.
See the parameter description.
+See the parameter description.
Ex
slowlog-log-slower-than
+slowlog-log-slower-than
Redis records queries that exceed a specified execution time.
-slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Redis will record the query.
+Redis records queries that exceed a specified execution time.
+slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the query will be recorded.
0–1,000,000
+0–1,000,000
+Unit: microsecond
10,000
slowlog-max-len
+slowlog-max-len
The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
0–1000
+0–1000
128
auto-kill-timeout-lua-process
+yes: enabled
+no: disabled
+When this parameter is enabled, lua scripts are killed when their execution times out. However, scripts with write operations are not killed, but their nodes automatically restart (if persistence has been enabled for the instance) without saving the write operations.
+Single-node instances do not have this parameter.
+- yes
- no
no
+multi-db
+Manually back up the instance and clear all instance data before you enable or disable multi-DB. To restore the deleted data, use the backup import function on the Data Migration page. Options:
+yes: enable
+no: disable
+Only Proxy Cluster DCS Redis 4.0 and later instances have this parameter.
+- yes
- no
no
+dispatch-pubsub-to-fixed-shard
+This parameter specifies whether pub/sub channels are on the shard of slot 0. When this parameter is enabled, the pub/sub processing logic is consistent with that of single-node instances. You are advised to enable this parameter if you do not depend heavily on pub/sub. If you depend heavily on pub/sub, use the default configuration to allocate subscriptions to all shards.
+- yes: Enable this parameter to allocate subscription channels to the shard of slot 0.
- no: Disable this parameter to allocate channels to the shard of each channel-hashed slot.
Only Proxy Cluster instances have this parameter.
+- yes
- no
no
+readonly-lua-route-to-slave-enabled
+If enabled, read-only Lua scripts of read-only users are executed and routed to the standby node.
+- yes: enabled
- no: disabled
Available only for read/write splitting instances.
+- yes
- no
no
+proxy-slowlog-log-slower-than
+Slow queries of a proxy cover scheduled commands whose execution is delayed. proxy-slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the proxy will record the query.
+Available only for Proxy Cluster and read/write splitting instances.
+30,000–2,000,000
+Unit: microsecond
+500,000
+proxy-slowlog-max-len
+The maximum allowed number of slow queries of a proxy that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+Available only for Proxy Cluster and read/write splitting instances.
+0–1000
+128
+support-dispatch-to-replica-list
+Evenly allocates specified read commands to slave nodes. Currently, only the KEYS command can be configured.
+Available only for Proxy Cluster or read/write splitting instances whose proxy version is 5.0.14.12 or later.
+Left blank by default. Setting this parameter to KEYS performs the KEYS command only on the slave node.
+-
+- Click the name of a custom template. On the displayed page, modify parameters.
-- Select Modifiable parameters. Enter a keyword in the search box to search for a parameter by parameter name.
- Click Modify.
- In the row that contains the parameter to be modified, enter a value in the Assigned Value column. Table 1 describes the parameters. In most cases, default values are retained.
- Click Save.
-Table 1 DCS Redis instance configuration parameters Parameter
+diff --git a/docs/dcs/umn/dcs-ug-210626005.html b/docs/dcs/umn/dcs-ug-210626005.html index ab1f40d59..443fedbd4 100644 --- a/docs/dcs/umn/dcs-ug-210626005.html +++ b/docs/dcs/umn/dcs-ug-210626005.html @@ -4,7 +4,7 @@Table 1 DCS Redis instance configuration parameters Parameter
Description
+Description
Value Range
+Value Range
Default Value
active-expire-num
+active-expire-num
Number of expired keys that can be deleted in regular scans.
-Redis 3.0 instances do not have this parameter.
+Number of expired keys that can be deleted in regular scans.
+This parameter is supported by DCS Redis 4.0 and later instances.
1–1000
+1–1000
20
timeout
+timeout
The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
+The maximum amount of time (in seconds) a connection between a client and the DCS instance can be allowed to remain idle before the connection is terminated. A setting of 0 means that this function is disabled.
Proxy Cluster instances do not have this parameter.
0–7200 seconds
+0~7200
+Unit: second
0
appendfsync
+appendfsync
Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
+Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
There are three settings:
no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe.
everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
Single-node instances do not have this parameter.
- no
- always
- everysec
- no
- always
- everysec
no
appendonly
+appendonly
Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
+Indicates whether to log each modification of the instance (that is, data persistence). By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
yes: enabled
no: disabled
Single-node instances do not have this parameter.
- yes
- no
- yes
- no
yes
client-output-buffer-limit-slave-soft-seconds
+client-output-buffer-limit-slave-soft-seconds
Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
+Value that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
Single-node instances do not have this parameter.
0–60
+0–60
+Unit: second
60
client-output-buffer-slave-hard-limit
+client-output-buffer-slave-hard-limit
Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
+Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
client-output-buffer-slave-soft-limit
+client-output-buffer-slave-soft-limit
Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
+Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
Single-node instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
maxmemory-policy
+maxmemory-policy
The deletion policy to apply when the maxmemory limit is reached. Options:
+The deletion policy to apply when the maxmemory limit is reached. Options:
volatile-lru: Evict keys by trying to remove the less recently used (LRU) keys first, but only among keys that have an expire set. (Recommended)
allkeys-lru: Evict keys by trying to remove the LRU keys first.
volatile-random: evict keys randomly, but only evict keys with an expire set.
@@ -104,142 +106,148 @@volatile-lfu: Evict keys by trying to remove the less frequently used (LFU) keys first, but only among keys that have an expire set.
allkeys-lfu: Evict keys by trying to remove the LFU keys first.
Depends on the instance version.
+Depends on the instance version.
Depends on the instance version and type.
lua-time-limit
+lua-time-limit
Maximum time allowed for executing a Lua script (in milliseconds).
+Maximum time allowed for executing a Lua script.
Read/write splitting instances do not have this parameter.
100–5000
+100–5000
+Unit: millisecond
5,000
master-read-only
+master-read-only
Sets the instance to be read-only. All write operations will fail.
+Sets the instance to be read-only. All write operations will fail.
Proxy Cluster and read/write splitting instances do not have this parameter.
- yes
- no
- yes
- no
no
maxclients
+maxclients
The maximum number of clients allowed to be concurrently connected to a DCS instance.
+The maximum number of clients allowed to be concurrently connected to a DCS instance.
Read/Write splitting instances do not have this parameter.
Depends on the instance type and specifications.
+Depends on the instance type and specifications.
Depends on the instance type and specifications.
proto-max-bulk-len
+proto-max-bulk-len
Maximum size of a single element request (in bytes).
+Maximum size of a single element request. Set this parameter to be greater than the customer request length. Otherwise, the request cannot be executed.
Read/write splitting instances do not have this parameter.
1,048,576–536,870,912
+1,048,576–536,870,912
+Unit: byte
536,870,912
repl-backlog-size
+repl-backlog-size
The replication backlog size (bytes). The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
+The replication backlog size. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
Single-node instances do not have this parameter.
16,384–1,073,741,824
+16,384–1,073,741,824
+Unit: byte
1,048,576
repl-backlog-ttl
+repl-backlog-ttl
The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
+The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
Single-node instances do not have this parameter.
0–604,800
+0–604,800
+Unit: second
3,600
repl-timeout
+repl-timeout
Replication timeout (in seconds).
+Replication timeout.
Single-node instances do not have this parameter.
30–3,600
+30–3,600
+Unit: second
60
hash-max-ziplist-entries
+hash-max-ziplist-entries
Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
+Hashes are encoded using a memory efficient data structure when the number of entries in hashes is less than the value of this parameter.
1–10,000
+1–10,000
512
hash-max-ziplist-value
+hash-max-ziplist-value
Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
+Hashes are encoded using a memory efficient data structure when the biggest entry in hashes does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
set-max-intset-entries
+set-max-intset-entries
When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
+When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure.
1–10,000
+1–10,000
512
zset-max-ziplist-entries
+zset-max-ziplist-entries
Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
+Sorted sets are encoded using a memory efficient data structure when the number of entries in sorted sets is less than the value of this parameter.
1–10,000
+1–10,000
128
zset-max-ziplist-value
+zset-max-ziplist-value
Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
+Sorted sets are encoded using a memory efficient data structure when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter.
1–10,000
+1–10,000
64
latency-monitor-threshold
+latency-monitor-threshold
Threshold time in latency monitoring. Unit: millisecond.
+Threshold time in latency monitoring.
Set to 0: Latency monitoring is disabled.
Set to more than 0: All with at least this many milliseconds of latency will be logged.
By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring.
Proxy Cluster instances do not have this parameter.
0–86,400,000 ms
+0–86,400,000
+Unit: millisecond
0
notify-keyspace-events
+notify-keyspace-events
Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
+Controls which keyspace events notifications are enabled for. If the value is an empty string, this function is disabled. A combination of different values can be used to enable notifications for multiple event types. Possible values:
K: Keyspace events, published with the __keyspace@__ prefix.
E: Keyevent events, published with __keyevent@__ prefix
g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
@@ -254,30 +262,108 @@The parameter value must contain either K or E. A cannot be used together with any of the characters in "g$lshzxe". For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events.
Proxy Cluster instances do not have this parameter.
See the parameter description.
+See the parameter description.
Ex
slowlog-log-slower-than
+slowlog-log-slower-than
Redis records queries that exceed a specified execution time.
-slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Redis will record the query.
+Redis records queries that exceed a specified execution time.
+slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the query will be recorded.
0–1,000,000
+0–1,000,000
+Unit: microsecond
10,000
slowlog-max-len
+slowlog-max-len
The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+The maximum allowed number of slow queries that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
0–1000
+0–1000
128
auto-kill-timeout-lua-process
+yes: enabled
+no: disabled
+When this parameter is enabled, lua scripts are killed when their execution times out. However, scripts with write operations are not killed, but their nodes automatically restart (if persistence has been enabled for the instance) without saving the write operations.
+Single-node instances do not have this parameter.
+- yes
- no
no
+multi-db
+Manually back up the instance and clear all instance data before you enable or disable multi-DB. To restore the deleted data, use the backup import function on the Data Migration page. Options:
+yes: enable
+no: disable
+Only Proxy Cluster DCS Redis 4.0 and later instances have this parameter.
+- yes
- no
no
+dispatch-pubsub-to-fixed-shard
+This parameter specifies whether pub/sub channels are on the shard of slot 0. When this parameter is enabled, the pub/sub processing logic is consistent with that of single-node instances. You are advised to enable this parameter if you do not depend heavily on pub/sub. If you depend heavily on pub/sub, use the default configuration to allocate subscriptions to all shards.
+- yes: Enable this parameter to allocate subscription channels to the shard of slot 0.
- no: Disable this parameter to allocate channels to the shard of each channel-hashed slot.
Only Proxy Cluster instances have this parameter.
+- yes
- no
no
+readonly-lua-route-to-slave-enabled
+If enabled, read-only Lua scripts of read-only users are executed and routed to the standby node.
+- yes: enabled
- no: disabled
Available only for read/write splitting instances.
+- yes
- no
no
+proxy-slowlog-log-slower-than
+Slow queries of a proxy cover scheduled commands whose execution is delayed. proxy-slowlog-log-slower-than is the maximum time allowed for command execution. If this threshold is exceeded, the proxy will record the query.
+Available only for Proxy Cluster and read/write splitting instances.
+30,000–2,000,000
+Unit: microsecond
+500,000
+proxy-slowlog-max-len
+The maximum allowed number of slow queries of a proxy that can be logged. Slow query log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
+Available only for Proxy Cluster and read/write splitting instances.
+0–1000
+128
+support-dispatch-to-replica-list
+Evenly allocates specified read commands to slave nodes. Currently, only the KEYS command can be configured.
+Available only for Proxy Cluster or read/write splitting instances whose proxy version is 5.0.14.12 or later.
+Left blank by default. Setting this parameter to KEYS performs the KEYS command only on the slave node.
+-
+Custom policies can be created to supplement the system-defined policies of DCS. For the actions that can be added to custom policies, see section "Permissions Policies and Supported Actions" in the Distributed Cache Service API Reference.
You can create custom policies in either of the following ways:
- Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax.
- JSON: Edit JSON policies from scratch or based on an existing policy.
For details, see section "Creating a Custom Policy" in the Identity and Access Management API Reference. The following section contains examples of common DCS custom policies.
+For details, see "Creating a Custom Policy" in the Identity and Access Management API Reference. The following section contains examples of common DCS custom policies.
Due to data caching, a policy involving OBS actions will take effect five minutes after it is attached to a user, user group, or project.
Example Custom Policies
- Example 1: Allowing users to delete and restart DCS instances and clear data of an instance
{ diff --git a/docs/dcs/umn/dcs-ug-210818001.html b/docs/dcs/umn/dcs-ug-210818001.html index 0d08feb2d..a93a27ca5 100644 --- a/docs/dcs/umn/dcs-ug-210818001.html +++ b/docs/dcs/umn/dcs-ug-210818001.html @@ -3,6 +3,8 @@Diagnosing an Instance
+Scenario
If a fault or performance issue occurs, you can ask DCS to diagnose your instance to learn about the cause and impact of the issue and how to handle it.
Restrictions
Available for DCS Redis 4.0 and later instances.
+Procedure
- Log in to the DCS console.
- Click in the upper left corner of the console and select a region and a project.
- In the navigation pane, choose Cache Manager.
- Click the name of a DCS Redis instance.
- Choose Analysis and Diagnosis > Instance Diagnosis.
- Specify the tested object and time range, and click Start Diagnosis.
- Tested Object: You can select a single node or all nodes. By default, all nodes are tested.
- Range: You can specify up to 10 minutes before a point in time in the last 7 days.
Figure 1 Specifying the tested object and time range
Instance diagnosis may fail during specification modification.
diff --git a/docs/dcs/umn/dcs-ug-210820001.html b/docs/dcs/umn/dcs-ug-210820001.html index 45a6a0dcd..c252e6d27 100644 --- a/docs/dcs/umn/dcs-ug-210820001.html +++ b/docs/dcs/umn/dcs-ug-210820001.html @@ -26,13 +26,13 @@-Precautions for IP Switching
- Online migration will stop during the switching.
- Instances will be read-only for one minute and disconnected for several seconds during the switching.
- The target and source instances must use the same port.
- If your application cannot reconnect to Redis or handle exceptions, you may need to restart the application after the IP switching.
- If the source and target instances are in different subnets, the subnet information will be updated after the switching.
- If the source is a master/standby instance, the IP address of the standby node will not be switched. Ensure that this IP address is not used by your applications.
- If your applications use a domain name to connect to Redis, the domain name will be used for the source instance. Select Yes for Switch Domain Name.
- Ensure that the passwords of the source and target instances are the same. If they are different, verification will fail after the switching.
- If a whitelist is configured for the source instance, ensure that the same whitelist is configured for the target instance before switching IP addresses.
Switching IP Addresses
- Log in to the DCS console.
- Click in the upper left corner of the management console and select the region where your instance is located.
- In the navigation pane, choose Data Migration.
- Click Create Online Migration Task.
- Enter the task name and description.
- Configure the VPC, subnet, and security group for the migration task.
The VPC, subnet, and security group facilitate the migration. Ensure that the migration resources can access the source and target Redis instances.
+Switching IP Addresses
- Log in to the DCS console.
- Click in the upper left corner of the console and select the region where your instance is located.
- In the navigation pane, choose Data Migration.
- Click Create Online Migration Task.
- Enter the task name and description.
- Configure the VPC, subnet, and security group for the migration task.
The VPC, subnet, and security group facilitate the migration. Ensure that the migration resources can access the source and target Redis instances.
- Configure the migration task by referring to Configuring the Online Migration Task. Select Full + Incremental for Migration Type.
- On the Online Migration page, when the migration task status changes to Incremental migration in progress, choose More > Switch IP in the Operation column.
- In the Switch IP dialog box, select whether to switch the domain name.
- If a domain name is used, switch it or you must modify the domain name on the client.
- If no domain name is used, the DNS of the instances will be updated.
- Click OK. The IP address switching task is submitted successfully. When the status of the migration task changes to IP switched, the IP address switching is complete.
Rolling Back IP Addresses
If you want to change the instance IP address to the original IP address, perform the following operations:
-- Log in to the DCS console.
- Click in the upper left corner of the management console and select the region where your instance is located.
- In the navigation pane, choose Data Migration.
- On the Online Migration page, locate the row that contains the migration task in the IP switched state, choose More > Roll Back IP.
- In the confirmation dialog box, click Yes. The IP address rollback task is submitted successfully. When the task status changes to IP rolled back, the rollback is complete.
- Log in to the DCS console.
- Click in the upper left corner of the console and select the region where your instance is located.
- In the navigation pane, choose Data Migration.
- On the Online Migration page, locate the row that contains the migration task in the IP switched state, choose More > Roll Back IP.
- In the confirmation dialog box, click Yes. The IP address rollback task is submitted successfully. When the task status changes to IP rolled back, the rollback is complete.
diff --git a/docs/dcs/umn/dcs-ug-211105001.html b/docs/dcs/umn/dcs-ug-211105001.html index cc9d267af..45a18ca6c 100644 --- a/docs/dcs/umn/dcs-ug-211105001.html +++ b/docs/dcs/umn/dcs-ug-211105001.html @@ -3,9 +3,9 @@Connecting to Redis on go-redis (Go)
This section describes how to access a Redis instance on go-redis. For more information about how to use other Redis clients, visit the Redis official website.
The following operations are based on an example of accessing a Redis instance on a client on an elastic cloud server (ECS).
- -Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port number of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
+Notes and Constraints
To access a Redis 7.0 instance, use a go-redis 9.2.0 or later client.
+Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
Connecting to Redis on go-redis
- Log in to the ECS.
A Windows ECS is used as an example.
- Install Visual Studio Community 2017 on the ECS.
- Start Visual Studio and create a project. The project name can be customized. In this example, the project name is set to redisdemo.
- Import the dependency package of go-redis and enter go get github.com/go-redis/redis on the terminal.
- Write the following code:
package main @@ -48,7 +48,7 @@ func main() { } fmt.Println(val1) }-host:port are the IP address/domain name and port number of the DCS Redis instance. For details about how to obtain the IP address/domain name and port, see Prerequisites. Change them as required. ******** indicates the password used to log in to the DCS Redis instance. This password is defined during DCS Redis instance creation.
+host:port are the IP address/domain name and port of the DCS Redis instance. For details about how to obtain the IP address/domain name and port, see Prerequisites. Change them as required. ******** indicates the password used to log in to the DCS Redis instance. This password is defined during DCS Redis instance creation. Omit the password setting in the command for a password-free instance.
- Run the go build -o test main.go command to package the code into an executable file, for example, test.
To run the package in the Linux OS, set the following parameters before packaging:
set GOARCH=amd64
set GOOS=linux
diff --git a/docs/dcs/umn/dcs-ug-211105002.html b/docs/dcs/umn/dcs-ug-211105002.html index f2931b20b..dc4dcf69c 100644 --- a/docs/dcs/umn/dcs-ug-211105002.html +++ b/docs/dcs/umn/dcs-ug-211105002.html @@ -3,37 +3,45 @@Connecting to Redis on Lettuce (Java)
This section describes how to access a Redis instance on Lettuce. For more information about how to use other Redis clients, visit the Redis official website.
Spring Data Redis is already integrated with Jedis and Lettuce for Spring Boot projects. In addition, Spring Boot 1.x is integrated with Jedis, and Spring Boot 2.x with Lettuce. Therefore, you do not need to import Lettuce in Spring Boot 2.x and later projects.
-Notes and Constraints
Springboot 2.3.12.RELEASE or later is required. Lettuce 6.3.0.RELEASE or later is required.
+-Notes and Constraints
Springboot 2.3.12.RELEASE or later is required. Lettuce 6.3.0.RELEASE or later is required. Netty 4.1.100.Final or later is required.
Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port number of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
-Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
Pom Configuration
<!-- Enable Spring Data Redis, Lettuce-supported SDK is integrated by default --> +
Pom Configuration
<!-- Enable Spring Data Redis. Lettuce-supported SDK is integrated by default. --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> + <dependency> - <groupId>io.lettuce</groupId> - <artifactId>lettuce-core</artifactId> - <version>${lettuce.version}</version> + <groupId>io.lettuce</groupId> + <artifactId>lettuce-core</artifactId> + <version>6.3.0.RELEASE</version> +</dependency> + +<dependency> + <groupId>io.netty</groupId> + <artifactId>netty-transport-native-epoll</artifactId> + <version>4.1.100.Final</version> + <classifier>linux-x86_64</classifier> </dependency>application.properties Configuration
- Single-node, master/standby, read/write splitting, and Proxy Cluster
#Redis host -spring.redis.host=<host> +spring.redis.host=<host> #Redis port -spring.redis.port=<port> +spring.redis.port=<port> #Redis database number spring.redis.database=0 #Redis password -spring.redis.password=<password> +spring.redis.password=<password> #Redis read/write timeout spring.redis.timeout=2000
- Redis Cluster
#Redis Cluster node information -spring.redis.cluster.nodes=<ip:port>,<ip:port>,<ip:port> +spring.redis.cluster.nodes=<ip:port>,<ip:port>,<ip:port> #Redis Cluster max redirecting times spring.redis.cluster.max-redirects=3 #Redis Cluster node password -spring.redis.password=<password> +spring.redis.password=<password> #Redis Cluster timeout spring.redis.timeout=2000 #Enable adaptive topology refresh @@ -78,6 +86,19 @@ public class RedisConfiguration { @Value("${redis.read.timeout:2000}") private Integer redisReadTimeout = 2000; + /** + * TCP_KEEPALIVE configuration parameters: + * A keepalive interval = TCP_KEEPALIVE_TIME = 30 + * Idle duration before keepalive = TCP_KEEPALIVE_TIME/3 = 10 + * keepalive xx times before disconnect = TCP_KEEPALIVE_COUNT = 3 + */ + private static final int TCP_KEEPALIVE_TIME = 30; + + /** + * TCP_USER_TIMEOUT Idle duration limit, to address Lettuce timeout. + * refer: https://github.com/lettuce-io/lettuce-core/issues/2082 + */ + private static final int TCP_USER_TIMEOUT = 30; @Bean public RedisConnectionFactory redisConnectionFactory(LettuceClientConfiguration clientConfiguration) { @@ -96,7 +117,26 @@ public class RedisConfiguration { @Bean public LettuceClientConfiguration clientConfiguration() { - SocketOptions socketOptions = SocketOptions.builder().connectTimeout(Duration.ofMillis(redisConnectTimeout)).build(); + + SocketOptions socketOptions = SocketOptions.builder() + .keepAlive(SocketOptions.KeepAliveOptions.builder() + // A keepalive interval + .idle(Duration.ofSeconds(TCP_KEEPALIVE_TIME)) + // Idle duration before keepalive + .interval(Duration.ofSeconds(TCP_KEEPALIVE_TIME/3)) + // keepalive xx times before disconnect + .count(3) + // Whether to keep connections alive. + .enable() + .build()) + .tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions.builder() + // Addressing timeouts caused by RST on the server + .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) + .enable() + .build()) + // TCP connection timeout setting + .connectTimeout(Duration.ofMillis(redisConnectTimeout)) + .build(); ClientOptions clientOptions = ClientOptions.builder() .autoReconnect(true) @@ -109,6 +149,7 @@ public class RedisConfiguration { LettuceClientConfiguration clientConfiguration = LettuceClientConfiguration.builder() .commandTimeout(Duration.ofMillis(redisReadTimeout)) + // readFrom is not required for Proxy Cluster instances. .readFrom(ReadFrom.MASTER) .clientOptions(clientOptions) .build(); @@ -175,6 +216,19 @@ public class RedisPoolConfiguration { @Value("${redis.pool.timeBetweenEvictionRunsMillis:60000}") private Integer redisPoolBetweenEvictionRunsMillis = 60 * 1000; + /** + * TCP_KEEPALIVE configuration parameters: + * A keepalive interval = TCP_KEEPALIVE_TIME = 30 + * Idle duration before keepalive = TCP_KEEPALIVE_TIME/3 = 10 + * keepalive xx times before disconnect = TCP_KEEPALIVE_COUNT = 3 + */ + private static final int TCP_KEEPALIVE_TIME = 30; + + /** + * TCP_USER_TIMEOUT Idle duration limit, to address Lettuce timeout. + * refer: https://github.com/lettuce-io/lettuce-core/issues/2082 + */ + private static final int TCP_USER_TIMEOUT = 30; @Bean public RedisConnectionFactory redisConnectionFactory(LettuceClientConfiguration clientConfiguration) { @@ -195,7 +249,26 @@ public class RedisPoolConfiguration { @Bean public LettuceClientConfiguration clientConfiguration() { - SocketOptions socketOptions = SocketOptions.builder().connectTimeout(Duration.ofMillis(redisConnectTimeout)).build(); + + SocketOptions socketOptions = SocketOptions.builder() + .keepAlive(SocketOptions.KeepAliveOptions.builder() + // A keepalive interval + .idle(Duration.ofSeconds(TCP_KEEPALIVE_TIME)) + // Idle duration before keepalive + .interval(Duration.ofSeconds(TCP_KEEPALIVE_TIME/3)) + // keepalive xx times before disconnect + .count(3) + // Whether to keep connections alive. + .enable() + .build()) + .tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions.builder() + // Addressing timeouts caused by RST on the server + .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) + .enable() + .build()) + // TCP connection timeout setting + .connectTimeout(Duration.ofMillis(redisConnectTimeout)) + .build(); ClientOptions clientOptions = ClientOptions.builder() .autoReconnect(true) @@ -210,9 +283,10 @@ public class RedisPoolConfiguration { .poolConfig(poolConfig()) .commandTimeout(Duration.ofMillis(redisReadTimeout)) .clientOptions(clientOptions) + // readFrom is not required for Proxy Cluster instances. .readFrom(ReadFrom.MASTER) .build(); - return poolingClientConfiguration; + return clientConfiguration; } private GenericObjectPoolConfig redisPoolConfig() { @@ -235,7 +309,7 @@ public class RedisPoolConfiguration { poolConfig.setTestOnReturn(false); //Indicates whether to check for idle connections. If this is set to false, idle connections are not evicted. poolConfig.setTestWhileIdle(true); - //Idle duration after which a connection is evicted. If the actual duration is greater than this value and the maximum number of idle connections is reached, idle connections are directly evicted. + //Duration after which idle connections are evicted. If the idle duration is greater than this value and the minimum number of idle connections is exceeded, idle connections are directly evicted. poolConfig.setSoftMinEvictableIdleTime(Duration.ofMillis(redisPoolSoftMinEvictableIdleTimeMillis)); //Disable eviction policy MinEvictableIdleTimeMillis(). poolConfig.setMinEvictableIdleTime(Duration.ofMillis(-1)); @@ -286,6 +360,19 @@ public class RedisConfiguration { @Value("${redis.cluster.topology.refresh.period.millis:10000}") private Integer redisClusterTopologyRefreshPeriodMillis = 10000; + /** + * TCP_KEEPALIVE configuration parameters: + * A keepalive interval = TCP_KEEPALIVE_TIME = 30 + * Idle duration before keepalive = TCP_KEEPALIVE_TIME/3 = 10 + * keepalive xx times before disconnect = TCP_KEEPALIVE_COUNT = 3 + */ + private static final int TCP_KEEPALIVE_TIME = 30; + + /** + * TCP_USER_TIMEOUT Idle duration limit, to address Lettuce timeout. + * refer: https://github.com/lettuce-io/lettuce-core/issues/2082 + */ + private static final int TCP_USER_TIMEOUT = 30; @Bean public RedisConnectionFactory redisConnectionFactory(LettuceClientConfiguration clientConfiguration) { @@ -308,8 +395,25 @@ public class RedisConfiguration { @Bean public LettuceClientConfiguration clientConfiguration() { - - SocketOptions socketOptions = SocketOptions.builder().connectTimeout(Duration.ofMillis(redisConnectTimeout)).build(); + SocketOptions socketOptions = SocketOptions.builder() + .keepAlive(SocketOptions.KeepAliveOptions.builder() + // A keepalive interval + .idle(Duration.ofSeconds(TCP_KEEPALIVE_TIME)) + // Idle duration before keepalive + .interval(Duration.ofSeconds(TCP_KEEPALIVE_TIME/3)) + // keepalive xx times before disconnect + .count(3) + // Whether to keep connections alive. + .enable() + .build()) + .tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions.builder() + // Addressing timeouts caused by RST on the server + .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) + .enable() + .build()) + // TCP connection timeout setting + .connectTimeout(Duration.ofMillis(redisConnectTimeout)) + .build(); ClusterTopologyRefreshOptions topologyRefreshOptions = ClusterTopologyRefreshOptions.builder() .enableAllAdaptiveRefreshTriggers() @@ -399,6 +503,19 @@ public class RedisPoolConfiguration { @Value("${redis.pool.timeBetweenEvictionRunsMillis:60000}") private Integer redisPoolBetweenEvictionRunsMillis = 60 * 1000; + /** + * TCP_KEEPALIVE configuration parameters: + * A keepalive interval = TCP_KEEPALIVE_TIME = 30 + * Idle duration before keepalive = TCP_KEEPALIVE_TIME/3 = 10 + * keepalive xx times before disconnect = TCP_KEEPALIVE_COUNT = 3 + */ + private static final int TCP_KEEPALIVE_TIME = 30; + + /** + * TCP_USER_TIMEOUT Idle duration limit, to address Lettuce timeout. + * refer: https://github.com/lettuce-io/lettuce-core/issues/2082 + */ + private static final int TCP_USER_TIMEOUT = 30; @Bean public RedisConnectionFactory redisConnectionFactory(LettuceClientConfiguration clientConfiguration) { @@ -423,8 +540,25 @@ public class RedisPoolConfiguration { @Bean public LettuceClientConfiguration clientConfiguration() { - - SocketOptions socketOptions = SocketOptions.builder().connectTimeout(Duration.ofMillis(redisConnectTimeout)).build(); + SocketOptions socketOptions = SocketOptions.builder() + .keepAlive(SocketOptions.KeepAliveOptions.builder() + // A keepalive interval + .idle(Duration.ofSeconds(TCP_KEEPALIVE_TIME)) + // Idle duration before keepalive + .interval(Duration.ofSeconds(TCP_KEEPALIVE_TIME/3)) + // keepalive xx times before disconnect + .count(3) + // Whether to keep connections alive. + .enable() + .build()) + .tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions.builder() + // Addressing timeouts caused by RST on the server + .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) + .enable() + .build()) + // TCP connection timeout setting + .connectTimeout(Duration.ofMillis(redisConnectTimeout)) + .build(); ClusterTopologyRefreshOptions topologyRefreshOptions = ClusterTopologyRefreshOptions.builder() .enableAllAdaptiveRefreshTriggers() @@ -472,7 +606,7 @@ public class RedisPoolConfiguration { poolConfig.setTestWhileIdle(true); //Disable connection closure when the minimum idle time is reached. poolConfig.setMinEvictableIdleTime(Duration.ofMillis(-1)); - //Idle duration before a connection being evicted. If the actual duration is greater than this value and the maximum number of idle connections is reached, idle connections are directly evicted. MinEvictableIdleTimeMillis (default eviction policy) is no longer used. + //Idle duration before a connection being evicted. If the actual duration is greater than this value and the minimum number of idle connections is reached, idle connections are directly evicted. MinEvictableIdleTimeMillis (default eviction policy) is no longer used. poolConfig.setSoftMinEvictableIdleTime(Duration.ofMillis(redisPoolSoftMinEvictableIdleTimeMillis)); //Interval for checking and evicting idle connections. Default: 60s. poolConfig.setTimeBetweenEvictionRuns(Duration.ofMillis(redisPoolBetweenEvictionRunsMillis)); @@ -486,8 +620,25 @@ public class RedisPoolConfiguration {(Optional) Configuring SSL Connections
If SSL is enabled for an instance, to access it using SSL connections, use the following content to replace the LettuceClientConfiguration construction method clientConfiguration() in Bean Configuration. For details about whether your DCS Redis instances support SSL, see Transmitting DCS Redis Data with Encryption Using SSL.
- Single-node, master/standby, read/write splitting, and Proxy Cluster
@Bean public LettuceClientConfiguration clientConfiguration() { - - SocketOptions socketOptions = SocketOptions.builder().connectTimeout(Duration.ofMillis(redisConnectTimeout)).build(); + SocketOptions socketOptions = SocketOptions.builder() + .keepAlive(SocketOptions.KeepAliveOptions.builder() + // A keepalive interval + .idle(Duration.ofSeconds(TCP_KEEPALIVE_TIME)) + // Idle duration before keepalive + .interval(Duration.ofSeconds(TCP_KEEPALIVE_TIME/3)) + // keepalive xx times before disconnect + .count(3) + // Whether to keep connections alive. + .enable() + .build()) + .tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions.builder() + // Addressing timeouts caused by RST on the server + .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) + .enable() + .build()) + // TCP connection timeout setting + .connectTimeout(Duration.ofMillis(redisConnectTimeout)) + .build(); SslOptions sslOptions = SslOptions.builder() .trustManager(new File(certificationPath)) @@ -503,6 +654,7 @@ public LettuceClientConfiguration clientConfiguration() { .build(); LettuceClientConfiguration clientConfiguration = LettuceClientConfiguration.builder() .commandTimeout(Duration.ofMillis(redisReadTimeout)) + // readFrom is not required for Proxy Cluster instances. .readFrom(ReadFrom.MASTER) .clientOptions(clientOptions) .useSsl() @@ -512,8 +664,25 @@ public LettuceClientConfiguration clientConfiguration() { } - Redis Cluster
@Bean public LettuceClientConfiguration clientConfiguration() { - - SocketOptions socketOptions = SocketOptions.builder().connectTimeout(Duration.ofMillis(redisConnectTimeout)).build(); + SocketOptions socketOptions = SocketOptions.builder() + .keepAlive(SocketOptions.KeepAliveOptions.builder() + // A keepalive interval + .idle(Duration.ofSeconds(TCP_KEEPALIVE_TIME)) + // Idle duration before keepalive + .interval(Duration.ofSeconds(TCP_KEEPALIVE_TIME/3)) + // keepalive xx times before disconnect + .count(3) + // Whether to keep connections alive. + .enable() + .build()) + .tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions.builder() + // Addressing timeouts caused by RST on the server + .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) + .enable() + .build()) + // TCP connection timeout setting + .connectTimeout(Duration.ofMillis(redisConnectTimeout)) + .build(); SslOptions sslOptions = SslOptions.builder() .trustManager(new File(certificationPath)) @@ -623,7 +792,8 @@ public LettuceClientConfiguration clientConfiguration() {-
Password
+Redis instance password. Needless for password-free instances. If you forget your password or need to reset it, see Resetting Instance Passwords.
+
- Single-node, master/standby, read/write splitting, and Proxy Cluster
password
Password
+Redis instance password. Needless for password-free instances. If you forget your password or need to reset it, see Resetting Instance Passwords.
+-1
Duration (in milliseconds) after which idle connections are evicted. If the idle duration is greater than this value and the maximum number of idle connections is reached, idle connections are directly evicted. Recommended value: 1800000.
+Duration (in milliseconds) after which idle connections are evicted. If the idle duration is greater than this value and the minimum number of idle connections is exceeded, idle connections are directly evicted. Recommended value: 1800000.
minEvictableIdleTimeMillis
diff --git a/docs/dcs/umn/dcs-ug-211105004.html b/docs/dcs/umn/dcs-ug-211105004.html index 868c3bfc4..14ccd134c 100644 --- a/docs/dcs/umn/dcs-ug-211105004.html +++ b/docs/dcs/umn/dcs-ug-211105004.html @@ -4,9 +4,9 @@This section describes how to access a Redis instance on Redisson. For more information about how to use other Redis clients, visit the Redis official website.
For Spring Boot projects, Spring Data Redis is already integrated with Jedis and Lettuce, but does not support Redisson. Redisson provides the redisson-spring-boot-starter component (https://mvnrepository.com/artifact/org.redisson/redisson) that can be used with Spring Boot.
Spring Boot 1.x is integrated with Jedis, and Spring Boot 2.x is integrated with Lettuce.
-- - If a password was set during DCS Redis instance creation, configure the password for connecting to Redis using Redisson. Do not hard code the plaintext password.
- To connect to a single-node, read/write splitting, or Proxy Cluster instance, use the useSingleServer method of the SingleServerConfig object of Redisson. To connect to a master/standby instance, use the useMasterSlaveServers method of the MasterSlaveServersConfig object of Redisson. To connect to a Redis Cluster instance, use the useClusterServers method of the ClusterServersConfig object.
- Springboot 2.3.12.RELEASE or later is required. Redisson 3.37.0 or later is required.
Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port number of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
+Notes and Constraints
- If a password was set during DCS Redis instance creation, configure the password for connecting to Redis using Redisson. Do not hard code the plaintext password.
- To connect to a single-node, read/write splitting, or Proxy Cluster instance, use the useSingleServer method of the SingleServerConfig object of Redisson. To connect to a master/standby instance, use the useMasterSlaveServers method of the MasterSlaveServersConfig object of Redisson. To connect to a Redis Cluster instance, use the useClusterServers method of the ClusterServersConfig object.
- Springboot 2.3.12.RELEASE or later is required. Redisson 3.37.0 or later is required.
Prerequisites
- A Redis instance is created, and is in the Running state.
- View the IP address/domain name and port of the DCS Redis instance to be accessed. For details, see Viewing and Modifying DCS Instance Information.
Pom Configuration
<!-- spring-data-redis --> <dependency> @@ -24,7 +24,7 @@ <dependency> <groupId>org.redisson</groupId> <artifactId>redisson-spring-boot-starter</artifactId> - <version>${redisson.version}</version> + <version>${redisson.version}</version> </dependency>threads
Number of CPU cores x 2
+Number of CPU cores × 2
Thread pool used for executing RTopic Listener, RRemoteService, and RExecutorService.
nettyThreads
Number of CPU cores x 2
+Number of CPU cores × 2
Thread pool used by the TCP channel that connects to the redis-server. All channels share this connection pool and are mapped to Netty's Bootstrap.group(...).
Table 2 SingleServerConfig parameters (single-node, read/write splitting,, or Proxy Cluster) Parameter
+Table 2 SingleServerConfig parameters (single-node, read/write splitting, or Proxy Cluster) Parameter
Default Value
-
Node connection information, in redis://ip:port format.
+Node connection information, in redis://ip:port format.
database
@@ -474,14 +474,14 @@ public class ClusterConfig {-
Master node connection information, in redis://ip:port format.
+Master node connection information, in redis://ip:port format.
slaveAddresses
-
Standby node connection information, in Set<redis://ip:port> format.
+Standby node connection information, in Set<redis://ip:port> format.
readMode
@@ -619,14 +619,15 @@ public class ClusterConfig {-
Connection addresses of cluster nodes. Each address uses the redis://ip:port format. Use commas (,) to separate connection addresses of different nodes.
+Connection addresses of cluster nodes. Each address uses the redis://ip:port format. Use commas (,) to separate connection addresses of different nodes.
password
null
Password for logging in to the cluster.
+Redis instance password. Needless for password-free instances. If you forget your password or need to reset it, see Resetting Instance Passwords.
+scanInterval
diff --git a/docs/dcs/umn/dcs-ug-211202002.html b/docs/dcs/umn/dcs-ug-211202002.html index c3fc4d45f..515200ebc 100644 --- a/docs/dcs/umn/dcs-ug-211202002.html +++ b/docs/dcs/umn/dcs-ug-211202002.html @@ -5,7 +5,7 @@The following operations are based on an example of accessing a Redis instance on a client on an elastic cloud server (ECS).
-Prerequisites
- A Redis instance is created, and is in the Running state.
- An ECS has been created. For details about how to create an ECS, see Elastic Cloud Server User Guide
- If the ECS runs the Linux OS, ensure that the PHP compilation environment has been installed on the ECS.
diff --git a/docs/dcs/umn/dcs_03_0016.html b/docs/dcs/umn/dcs_03_0016.html new file mode 100644 index 000000000..1b54646cb --- /dev/null +++ b/docs/dcs/umn/dcs_03_0016.html @@ -0,0 +1,25 @@ + + +Connecting to Redis on predis
- View the IP address/domain name and port number of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
+Connecting to Redis on predis
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
For details, see Viewing and Modifying DCS Instance Information.
- Log in to the ECS.
- Install the PHP development package and CLI tool. Run the following yum command:
yum install php-devel php-common php-cli
- After the installation is complete, check the version number to ensure that the installation is successful.
php --version
- Download the Predis package to the /usr/share/php directory.
- Run the following command to download the Predis source file:
wget https://github.com/predis/predis/archive/refs/tags/v2.2.2.tar.gz
@@ -39,7 +39,7 @@ echo $value; ?>
-
{redis_instance_address} indicates the actual IP address/domain name of the DCS instance and {port} is the actual port number of DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. {password} indicates the password used to log in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. If password-free access is required, delete the line that contains "password".
+{redis_instance_address} indicates the actual IP address/domain name of the DCS instance and {port} is the actual port of DCS instance. For details about how to obtain the IP address/domain name and port, see 1. Change them as required. {password} indicates the password used to log in to the chosen DCS Redis instance. This password is defined during DCS Redis instance creation. If password-free access is required, delete the line that contains "password".
- Run the following command to download the Predis source file:
- Run the php redis.php command to access the DCS instance.
- View the IP address/domain name and port of the DCS Redis instance to be accessed.
Upgrading the Minor or Proxy Version of a DCS Instance
++DCS optimizes functions and fixes vulnerabilities in minor and proxy upgrades. This section describes how to upgrade the minor or proxy version of an instance.
+Upgrading the minor or proxy version does not affect the instance connection addresses, password, whitelist, or monitoring and alarms.
++Notes and Constraints
- Available for DCS Redis 4.0 and later instances.
- Only Proxy Cluster and read/write splitting instances involve proxy versions.
- An instance can be upgraded to the latest minor or proxy version which cannot be specified.
- To upgrade the minor version of a Redis Cluster instance, ensure that the client can properly process the MOVED and ASK commands. Otherwise, requests will fail.
- Rollback is unavailable.
+Impacts
- Perform instance upgrades during off-peak hours. Otherwise, upgrades may fail when the instance memory or CPU usage exceeds 90% or write traffic bursts. In such cases, try again during off-peak hours.
- The instance's minor version is upgraded by migrating nodes. During the migration, latency will increase. A migrating shard will become read-only for 1 minute and intermittently disconnected. Ensure that the client can reconnect and handle exceptions.
- The upgrading instance will be intermittently disconnected. Ensure that the client can reconnect and handle exceptions. Perform the upgrade during off-peak hours.
+Procedure
- Log in to the DCS console.
- Click
in the upper left corner and select a region and a project. - In the navigation pane, choose Cache Manager.
- Click a DCS instance.
- On the Basic Information page, you can view or upgrade the minor or proxy versions of the instance.Figure 1 Upgrading an instance's minor or proxy version+
When the upgrade button is gray and cannot be clicked, the instance's minor or proxy version is already the latest.
+- Upgrading a minor version
- Click Upgrade next to Minor Version.
Also, to upgrade the proxy version, enable Upgrade Proxy Version in the displayed window.
+ - Click OK. The upgrade is complete when the upgrade task is in the Successful state.
- Click Upgrade next to Minor Version.
- Upgrading a proxy version
- Click Upgrade next to Proxy Version.
Also, to upgrade the minor version, enable Upgrade Minor Version in the displayed window.
+ - Click OK. The upgrade is complete when the upgrade task is in the Successful state.
- Click Upgrade next to Proxy Version.
- Upgrading a minor version
++ diff --git a/docs/dcs/umn/en-us_image_0000001681179997.png b/docs/dcs/umn/en-us_image_0000001227937166.png similarity index 100% rename from docs/dcs/umn/en-us_image_0000001681179997.png rename to docs/dcs/umn/en-us_image_0000001227937166.png diff --git a/docs/dcs/umn/en-us_image_0000001962038446.png b/docs/dcs/umn/en-us_image_0000001549115173.png similarity index 100% rename from docs/dcs/umn/en-us_image_0000001962038446.png rename to docs/dcs/umn/en-us_image_0000001549115173.png diff --git a/docs/dcs/umn/en-us_image_0000001591550122.png b/docs/dcs/umn/en-us_image_0000001591550122.png deleted file mode 100644 index 1bfb32311..000000000 Binary files a/docs/dcs/umn/en-us_image_0000001591550122.png and /dev/null differ diff --git a/docs/dcs/umn/en-us_image_0000001955154978.png b/docs/dcs/umn/en-us_image_0000001955154978.png deleted file mode 100644 index c640c6dda..000000000 Binary files a/docs/dcs/umn/en-us_image_0000001955154978.png and /dev/null differ diff --git a/docs/dcs/umn/en-us_image_0000001963155450.png b/docs/dcs/umn/en-us_image_0000001963155450.png deleted file mode 100644 index 008a6ddd3..000000000 Binary files a/docs/dcs/umn/en-us_image_0000001963155450.png and /dev/null differ diff --git a/docs/dcs/umn/en-us_image_0000001964418130.png b/docs/dcs/umn/en-us_image_0000001964418130.png index 747d73aff..9c28b4ae6 100644 Binary files a/docs/dcs/umn/en-us_image_0000001964418130.png and b/docs/dcs/umn/en-us_image_0000001964418130.png differ diff --git a/docs/dcs/umn/en-us_image_0000001964888588.png b/docs/dcs/umn/en-us_image_0000001964888588.png index 747d73aff..0023411ef 100644 Binary files a/docs/dcs/umn/en-us_image_0000001964888588.png and b/docs/dcs/umn/en-us_image_0000001964888588.png differ diff --git a/docs/dcs/umn/en-us_image_0000002000818973.png b/docs/dcs/umn/en-us_image_0000002000818973.png index 24d15167d..cada105b6 100644 Binary files a/docs/dcs/umn/en-us_image_0000002000818973.png and b/docs/dcs/umn/en-us_image_0000002000818973.png differ diff --git a/docs/dcs/umn/en-us_image_0000001999635737.png b/docs/dcs/umn/en-us_image_0000002248341190.png similarity index 100% rename from docs/dcs/umn/en-us_image_0000001999635737.png rename to docs/dcs/umn/en-us_image_0000002248341190.png diff --git a/docs/dcs/umn/en-us_image_0000001187846598.png b/docs/dcs/umn/en-us_image_0000002278891732.png similarity index 100% rename from docs/dcs/umn/en-us_image_0000001187846598.png rename to docs/dcs/umn/en-us_image_0000002278891732.png diff --git a/docs/dcs/umn/en-us_image_0000002289570913.png b/docs/dcs/umn/en-us_image_0000002289570913.png new file mode 100644 index 000000000..5c1065e8a Binary files /dev/null and b/docs/dcs/umn/en-us_image_0000002289570913.png differ diff --git a/docs/dcs/umn/en-us_image_0000001233126245.png b/docs/dcs/umn/en-us_image_0000002313491413.png similarity index 100% rename from docs/dcs/umn/en-us_image_0000001233126245.png rename to docs/dcs/umn/en-us_image_0000002313491413.png diff --git a/docs/dcs/umn/en-us_image_0000001188005622.png b/docs/dcs/umn/en-us_image_0000002313524429.png similarity index 100% rename from docs/dcs/umn/en-us_image_0000001188005622.png rename to docs/dcs/umn/en-us_image_0000002313524429.png diff --git a/docs/dcs/umn/en-us_image_0000002416373129.png b/docs/dcs/umn/en-us_image_0000002416373129.png new file mode 100644 index 000000000..b38fda1aa Binary files /dev/null and b/docs/dcs/umn/en-us_image_0000002416373129.png differ diff --git a/docs/dcs/umn/en-us_image_0000002477620454.png b/docs/dcs/umn/en-us_image_0000002477620454.png new file mode 100644 index 000000000..d945ac4ff Binary files /dev/null and b/docs/dcs/umn/en-us_image_0000002477620454.png differ diff --git a/docs/dcs/umn/en-us_image_0000002477627670.png b/docs/dcs/umn/en-us_image_0000002477627670.png new file mode 100644 index 000000000..23411f983 Binary files /dev/null and b/docs/dcs/umn/en-us_image_0000002477627670.png differ diff --git a/docs/dcs/umn/en-us_image_0148195246.png b/docs/dcs/umn/en-us_image_0148195246.png deleted file mode 100644 index 1909444d2..000000000 Binary files a/docs/dcs/umn/en-us_image_0148195246.png and /dev/null differ diff --git a/docs/dcs/umn/en-us_image_0296784660.png b/docs/dcs/umn/en-us_image_0296784660.png deleted file mode 100644 index 842ce3a52..000000000 Binary files a/docs/dcs/umn/en-us_image_0296784660.png and /dev/null differ diff --git a/docs/dcs/umn/en-us_topic_0079835992.html b/docs/dcs/umn/en-us_topic_0079835992.html index b0258e32e..014177395 100644 --- a/docs/dcs/umn/en-us_topic_0079835992.html +++ b/docs/dcs/umn/en-us_topic_0079835992.html @@ -43,7 +43,7 @@++Parent topic: Operating DCS Instances+-Parent topic: Backing Up and Restoring DCS Instances+Parent topic: Backing Up and Restoring Instance Data
- Configure Target Redis Type and Target Redis Instance:
- Click Next and configure the source and target Redis instances.
- Configure Target Redis Type and Target Redis Instance:
- Click Next and configure the source and target Redis instances.
- Only if Migration Type is set to Full + Incremental, you can specify a bandwidth limit.
- Click Next and configure the source and target Redis instances.