Performance Tuning Recommendations

This section describes some recommended performance tuning configurations to optimize the Governance Registry. It assumes that you have set up the Governance Registry on Unix/Linux, which is recommended for a production deployment.

Important:

Performance tuning requires you to modify important system files, which affect all programs running on the server. We recommend you to familiarize yourself with these files using Unix/Linux documentation before editing them.
The values we discuss here are general recommendations. They might not be the optimal values for the specific hardware configurations in your environment. We recommend you to carry out load tests on your environment to tune the Governance Registry accordingly.
For detailed instructions on the Carbon platform-level performance tuning recommendations, go to Performance Tuning in the WSO2 Administration Guide.

OS-level settings

To optimize network and OS performance, configure the following settings in /etc/sysctl.conf file of Linux. These settings specify a larger port range, a more effective TCP connection timeout value, and a number of other important parameters at the OS-level.

It is not recommended to use net.ipv4.tcp_tw_recycle = 1 when working with network address translation (NAT), such as if you are deploying products in EC2 or any other environment configured with NAT.
```
net.ipv4.tcp_fin_timeout = 30
fs.file-max = 2097152
net.ipv4.tcp_tw_recycle = 1
net.ipv4.tcp_tw_reuse = 1
net.core.rmem_default = 524288
net.core.wmem_default = 524288
net.core.rmem_max = 67108864
net.core.wmem_max = 67108864
net.ipv4.tcp_rmem = 4096 87380 16777216
net.ipv4.tcp_wmem = 4096 65536 16777216
net.ipv4.ip_local_port_range = 1024 65535      
```
To alter the number of allowed open files for system users, configure the following settings in /etc/security/limits.conf file of Linux (be sure to include the leading * character).
```
* soft nofile 4096
* hard nofile 65535
```
Optimal values for these parameters depend on the environment.
To alter the maximum number of processes your user is allowed to run at a given time, configure the following settings in /etc/security/limits.conf file of Linux (be sure to include the leading * character). Each carbon server instance you run would require upto 1024 threads (with default thread pool configuration). Therefore, you need to increase the nproc value by 1024 per each carbon server (both hard and soft).
```
* soft nproc 20000
* hard nproc 20000
```

JVM-level settings

If one or more worker nodes in a clustered deployment require access to the Management Console, increase the entity expansion limit as follows in the <G-REG_HOME>/bin/wso2server.bat file (for Windows) or the <G-REG_HOME>/bin/wso2server.sh file (for Linux/Solaris). The default entity expansion limit is 64000.

-DentityExpansionLimit=10000

WSO2 Carbon platform-level settings

In multi-tenant mode, the WSO2 Carbon runtime limits the thread execution time. That is, if a thread is stuck or taking a long time to process, Carbon detects such threads, interrupts and stops them. Carbon prints the current stack trace before interrupting the thread. This mechanism is implemented as an Apache Tomcat valve. Therefore, it should be configured in the <PRODUCT_HOME>/repository/conf/tomcat/catalina-server.xml file as shown below.
```
<Valve className="org.wso2.carbon.tomcat.ext.valves.CarbonStuckThreadDetectionValve" threshold="600"/>
```
- The className is the Java class used for the implementation. Set it to org.wso2.carbon.tomcat.ext.valves.CarbonStuckThreadDetectionValve.
- The threshold gives the minimum duration in seconds after which a thread is considered stuck. The default value is 600 seconds.
Change the <maxActive>, <maxWait>, <validationInterval> configurations accordingly which are related to database connections in the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file.
- G-Reg server needs at least two database connections to startup the server. The recommended minimum database connection count is 8, the max active database count should be defined according to your requirements and the maximum database connection which can be handled with the database system.
- The value of the <maxActive> element should be more than the value of the <indexerPoolSize> element in the <G-REG_HOME>/repository/conf/registry.xml file

G-REG-level settings

Improvement Area	Performance Recommendations
Indexing Frequency	Change the value of the `<indexingFrequencyInSeconds>` element accordingly in the `<G-REG_HOME>/repository/conf/registry.xml` file. The default value is 3.
Zip Upload Thread Pool Size and Max File Upload Size	Change the value of the `SO_TIMEOUT` property to 7200000 in the `<G-REG_HOME>/repository/conf/axis2/axis2_client.xml` file, to increase the timeouts for the UI. Set the value of the `disableWSDLValidation` property to `false` in the `<G-REG_HOME>/repository/conf/registry.xml` file, to disable WSDL and Schema validation. Set the value of the `<startIndexing>` property to `false` in the `<G-REG_HOME>/repository/conf/registry.xml` file, to disable registry indexing. Set the value of the `<versionResourcesOnChange>` element to false in the `<G-REG_HOME>/repository/conf/registry.xml` file, to stop automatic versioning of resources. Set the number of maximum active DB connections to 120 and max_connection to 500 (MySQL level), and the maximum wait time to 600000 in the `<PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml` file. Change the `Xmx` property in the `<PRODUCT_HOME>/bin/wso2server.sh` file (for Linux) or `<PRODUCT_HOME>/bin/wso2server.bat`et G-Reg memory configurations to 4GB.
Solr - RAM Buffer	If you are loading a lot of data at once, then increase this value. A number in the vicinity of 128 is applicable for most apps.
Solr - Merge Factor	When the Merge Factor is low, the indexed document count is low.
Solr - Lock Timeouts	Setting the Solr lock timeout value with a higher value indexes more documents at once and Solr response time is lower. Our current Solr configuration is appropriate for most G-Reg related operation, except for huge file indexing.
Memory Allocation	Increase memory allocated by modifying `/bin/wso2server.sh` with the following settings: -Xms16m -Xmx2048m -XX:MaxPermSize=1024m We recommend to keep `-Xms` as small as possible. E.g. `-Xms 16m` Governance Registry needs at least `192 Xmx` to start the Java instance, however `-Xmx` has to be enough for handle your workload. (Recommended allocation is `2048m` or more.) Governance Registry needs at least `128 MB` as `MaxPermSize`, to do basic operations like uploading ZIP file (with 23 WSDL).