This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Tuning the Performance of Statistics Publishing
- Former user (Deleted)
This section describes the parameters you need to configure to tune the performance of the Analytics profile when it is affected by high load, network traffic etc. You need to tune these parameters based on the deployment environment.
Tuning carbon.xml parameters
When a batch of data is processed and published to the Analytics dashboard, the ESB idles for a defined time interval before processing another batch of data. This is to ensure that too much data will not be stored in Analytics at a given time. By default, the ESB idles for 5000 milliseconds (5 seconds).
If you want to change the default idle time, add the following configuration to the <EI_HOME>/conf/carbon.xml file (as an element under <Server>) and specify the required idle time interval.
<MediationFlowStatisticConfig>
<StatWorkerIdleInterval></StatWorkerIdleInterval>
</MediationFlowStatisticConfig>
The parameter used in the above configuration is explained below.
| Parameter | Description | Tuning Recommendation |
|---|---|---|
StatWorkerIdleInterval | The number of milliseconds that should elapse after a batch of statistical data is processed (to be published in the Analytics Dashboard) before sending another batch. | The general recommendation is 5000 milliseconds (i.e. 5 seconds). Therefore, your ESB is tuned to this value by default. When the ESB is handling a high load of requests, this value can be reduced to increase the frequency with which the resulting statistics are published in the Analytics Dashboard. This helps to avoid storing too much data in the ESB server causing an overconsumption of memory. When the load of requests handled by the ESB is comparatively low, this time interval can be increased to reduce the system overhead incurred by frequent processing. |
Tuning data-agent parameters
The parameters in the <EI-ANALYTICS_HOME>/conf/data-bridge/data-agent-config.xml file can be tuned as follows.
| Parameter | Description | Default Value | Tuning Recommendation | |
|---|---|---|---|---|
QueueSize | The number of messages that can be stored in WSO2 EI at a given time before they are sent to be published in the Analytics Dashboard. | 32768 | This value should be increased when the Analytics profile is busy due to a request overload or if there is high network traffic. This prevents the generation of the When the Analytics profile is not very busy and when the network traffic is relatively low, the queue size can be reduced to avoid an overconsumption of memory. The number specified for this parameter should be a power of 2. | |
BatchSize | The WSO2 EI statistical data sent to the Analytics profile to be published in the Analytics Dashboard are grouped into batches. This parameter specifies the number of requests to be included in a batch. | 200 | This value should be tuned in proportion to the volume of requests sent from WSO2 EI to the Analytics profile. This value should be reduced if you want to reduce the system overhead of the Analytics profile. This value should be increased if WSO2 EI is generating a high amount of statistics and if the QueueSize cannot be further increased without causing an overconsumption of memory. | |
CorePoolSize | The number of threads allocated to publish WSO2 EI statistical data to the Analytics Dashboard via Thrift at the time WSO2 EI is started. This value increases when the throughput of statistics generated increases. However, the number of threads will not exceed the number specified for the MaxPoolSize parameter. | 1 | The number of available CPU cores should be taken into account when specifying this value. Increasing the core pool size may improve the throughput of statistical data published in the Analytics Dashboard, but latency will also be increased due to context switching. | |
MaxPoolSize | The maximum number of threads that should be allocated at any given time to publish WSO2 EI statistical data in the Analytics Dashboard. | 1 | The number of available CPU cores should be taken into account when specifying this value. Increasing the maximum core pool size may improve the throughput of statistical data published in the Analytics Dashboard, since more threads can be spawned to handle an increased number of events. However, latency will also increase since a higher number of threads would cause context switching to take place more frequently. | |
MaxTransportPoolSize | The maximum number of transport threads that should be allocated at any given time to publish WSO2 EI statistical data to the Analytics Server. | 250 | This value must be increased when there is an increase in the throughput of events handled by WSO2 EI Analytics. The value of the tcpMaxWorkerThreads parameter in the <EI-ANALYTICS_HOME>/repository/conf/data-bridge/data-bridge-config.xml must change based on the value specified for this parameter and the number of data publishers publishing statistics. e.g., When the value for this parameter is 250 and the number of data publishers is 7, the value for the tcpMaxWorkerThreads parameter must be 1750 (i.e., 7 * 250). This is because you need to ensure that there are enough receiver threads to handle the number of messages published by the data publishers. | |
SecureMaxTransportPoolSize | The maximum number of secure transport threads that should be allocated at any given time to publish WSO2 EI statistical data to the Analytics Server. | 250 | This value must be increased when there is an increase in the throughput of events handled by WSO2 EI Analytics. The value of the |