pratapalakshmiandGitHub
807f9d83ea
* feat: add load testing framework and initial reports - Introduced k6-based load tests for the Plane API, simulating mixed read/write traffic. - Created comprehensive documentation including a load test report, usage instructions, and configuration details. - Added a load test script to facilitate performance testing with defined thresholds and operation mixes. - Established clear SLO definitions and scaling recommendations based on test results. This addition aims to enhance performance validation and ensure the API can handle expected user loads effectively. * feat: enhance database connection management with environment variables - Added configurable connection management settings for the database, allowing customization of connection max age and health checks via environment variables. - Applied these settings to both the default database and read replica configurations to ensure consistent connection management across the application. This update aims to improve database performance and reliability by enabling better control over connection parameters. * feat: add comprehensive load testing scripts for API performance - Introduced three new load testing scripts using k6: script_100.js, script_500.js, and script_parallel.js, designed to simulate varying levels of user traffic and operations on the Plane API. - Each script includes detailed configurations for request thresholds, timeout settings, and scenarios for both read and write operations. - Removed the outdated script.js to streamline the load testing framework. This enhancement aims to improve performance validation and ensure the API can handle diverse user loads effectively. * refactor: streamline database connection management and enhance load testing scripts - Removed configurable connection management settings from the database configuration in common.py, simplifying the connection setup. - Updated load testing script_parllel.js to separate read and write API endpoints, improving clarity and organization of the load testing framework. - Introduced new constants for read and write project IDs, enhancing the structure of the load testing scripts. This refactor aims to improve maintainability and clarity in both database settings and load testing configurations. * docs: update load test report and usage documentation - Revised the load test report to focus on production infrastructure sizing and deployment guidance, emphasizing measured outcomes and configuration boundaries. - Updated the load testing scripts documentation to clarify the parallel read and write scenarios, including new recommended configurations and usage examples. - Adjusted thresholds in the load testing script to reflect updated performance expectations. These changes aim to enhance clarity and provide better guidance for running load tests in production environments. * docs: update load test report with revised performance metrics - Adjusted load test report to reflect updated performance metrics, including improved response times and success rates for read and write operations. - Revised thresholds and total results to provide a clearer picture of system performance under load. - Enhanced clarity in the report layout for better readability and understanding of results. These updates aim to ensure accurate documentation of load testing outcomes and facilitate better performance analysis.
Plane Load Tests
k6-based load tests for the Plane API.
| Document | Audience | Purpose |
|---|---|---|
| LOAD_TEST_REPORT.md | Stakeholders, prospects | Executive summary, SLOs, results, scaling recommendations |
| usage.md | Engineers | How to run k6, configure, and interpret output |
script.js – Load test script.