Configuring Overload Protection

The the existing CDL overload protection configuration is replaced with a new configuration.

Note

Earlier, the overload protection was enabled by default with hard coded limits of 1 million records per slot, 10 million records per index and 5 gb record size per slot. However, in this release, the feature is disabled by default and requires configuration to enable this feature and to configure the appropriate overload limits (optional) for each parameter.

CDL Overload Data Protection

Command

Changes

Old command:
cdl datastore session overload-protection disable true 

The old CDL overload protection command is deprecated.

Note

The command is not functional but is available only for backward compatibility.

New command:

cdl datastore session features overload-protection enable <true/false> 

The overload protection configuration is moved under cdl datastore session features configuration to configure overload-protection and alerts.

CDL is now equipped to configure:

  • record-capacity per slot/index

  • record-capacity in bytes per slot

  • configure major and critical alarm %

If the overload protection is enabled then the alerts are also enabled. The prometheus-rules-cdl pod is spawned. If overload-protection is disabled then the alerts are disabled. The prometheus-rules-cdl pod is removed.

Configuring Overload Protection Parameter

The following parameters are configured to set limits for overload-protection:

  • cdl datastore session features overload-protection index-max-record-count <value> 
  • cdl datastore session features overload-protection slot-max-record-count <value> 
  • cdl datastore session features overload-protection slot-max-size <value> 
  • cdl datastore session features overload-protection hard-limit-percentage <value> 

The table below lists the configuration details:

Overload Protection Parameter Configuration

CLI Command

Description

cdl datastore session features overload-protection enable <true/false> 

(Optional) CDL overload-protection is disabled by default. The default value is false.

cdl datastore session features overload-protection index-max-record-count <value> 

(Optional) Maximum number of records that can be stored in the Index shard.

The default value is 60000000 (60M).

The range is 100k to 100M.

Note

The range from 100 to 1000 is applicable only for testing in the lab environment. It is not recommended for production environment.

cdl datastore session features overload-protection slot-max-record-count <value> 

(Optional) Maximum number of records that can be stored in Slot shard.

The default value is 2500000 (2.5M).

The range is either 100 or 100k to 10M.

Note

The value 100 is applicable only for testing in the lab environment. It is not recommended for production environment.

cdl datastore session features overload-protection slot-max-size <value> 

(Optional) Maximum size of Slot shard in mega bytes.

The default value is 16384 (16GB).

The range is 1GB to 96GB.

cdl datastore session features overload-protection hard-limit-percentage <value> 

(Optional) Additional capacity (percentage) in addition to the soft limit. This is used to determine when to reject the update requests at CDL endpoint. For eg: if index shard = 1, index-record-capacity = 100 and hard-limit-percentage = 5, then the create requests are rejected when number of index records = 100 and update requests are rejected only when it reaches 105.

The default value is 5. The range is 0-10.

cdl datastore session features overload-protection major-alert-threshold <value> 

(Optional) Threshold (percentage) at which CDL triggers an alert cdlOverloaded-major.

The default value is 80.

The range is 40-100.

cdl datastore session features overload-protection critical-alert-threshold <value> 

(Optional) Threshold (percentage) at which CDL triggers an alert cdlOverloaded-critical.

The default value is 90.

The range is 40-100.

To configure the alert percentage, run the following command:

cdl datastore session features overload-protection critical-alert-threshold <percentage> 
cdl datastore session features overload-protection major-alert-threshold <percentage>