Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterDescriptionDefault ValueTuning Recommendation
QueueSizeThe number of messages that can be stored in WSO2 API-M 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 queue full, dropping message error.

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.

Info

The number specified for this parameter should be a power of 2.

BatchSizeThe WSO2 API-M 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.200This value should be tuned in proportion to the volume of requests sent from WSO2 API-M 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 API-M is generating a high amount of statistics and if the QueueSize cannot be further increased without causing an overconsumption of memory.
CorePoolSizeThe number of threads allocated to publish WSO2 API-M statistical data to the Analytics Dashboard via Thrift at the time WSO2 API-M 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.1The 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.
MaxPoolSizeThe maximum number of threads that should be allocated at any given time to publish WSO2 API-M statistical data in the Analytics Dashboard.1The 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.
MaxTransportPoolSizeThe maximum number of transport threads that should be allocated at any given time to publish WSO2 API-M statistical data to the Analytics Server.250This value must be increased when there is an increase in the throughput of events handled by WSO2 API-M Analytics.

The value of the tcpMaxWorkerThreads parameter in the <APIM-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.
SecureMaxTransportPoolSizeThe maximum number of secure transport threads that should be allocated at any given time to publish WSO2 API-M 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 API-M Analytics.

The value of the sslMaxWorkerThreads parameter in the <APIM-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 sslMaxWorkerThreads 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.