Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add performance tuning related documentation for 4.x.x documentation #8379

Open
ashera96 opened this issue Sep 18, 2024 · 0 comments
Open

Add performance tuning related documentation for 4.x.x documentation #8379

ashera96 opened this issue Sep 18, 2024 · 0 comments

Comments

@ashera96
Copy link
Contributor

Description:

We need to fact-check the documentation [1]. Refer to the following section under Scaling Gateways and Traffic Managers:

Based on the performance numbers attained at the WSO2 Labs, the recommended ratio is 10 Gateways to 1 Traffic Manager (10:1, one Traffic Manager is tested to have successfully handled the load of 10 Gateways, one Gateway handling the load  of ~5000 TPS).

This section implies that, if 1 GW handles 5k TPS, with 10 GWs, we should be able to handle 50k TPS. However, the number that we have tested is 20k TPS. Therefore, we need to fact-check the info in this section.

Also, the section Clustering Gateways and Key Managers with key caching (refer to [2]) should be removed as it is no longer applicable.

Looks like the documentation [3] was removed from 4.x onwards. We have to consider adding it back to the 4.x docs as we no longer have any documentation related to performance tuning. More specifically, on tuning data-agent parameters.

[transport.binary.agent]
queue_size
batch_size
core_pool_size
max_pool_size
max_transport_pool_size
secure_max_transport_pool_size

[1] https://apim.docs.wso2.com/en/latest/deploy-and-publish/deploy-on-gateway/api-gateway/scaling-the-gateway/#scaling-gateways-and-traffic-managers
[2] https://apim.docs.wso2.com/en/latest/deploy-and-publish/deploy-on-gateway/api-gateway/scaling-the-gateway/#clustering-gateways-and-key-managers-with-key-caching
[3] https://apim.docs.wso2.com/en/3.2.0/install-and-setup/setup/deployment-best-practices/tuning-performance/#tuning-data-agent-parameters

Affected Product Versions:
APIM 4.0.0
APIM 4.1.0
APIM 4.2.0
APIM 4.3.0
APIM 4.4.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant