litestar-org/litestar

Docs: Add latency data to docs/benchmarks

Open

#2,548 创建于 2023年10月27日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Python (8,243 star) (550 fork)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

描述

Summary

The current docs page only reports Requests per second, which is definitely a very important metric for web frameworks. However, latency is also very important!

The current benchmarks suite already reports the latency details - it will be really nice if the results can be included in the docs.

Why not just let the reader run the benchmarks themselves?

  • running the benchmarks takes a long time
  • it doesn't work sometimes - I got several errors while running the benchmarks suite as-is

Basic Example

No response

Drawbacks and Impact

No response

Unresolved questions

No response

贡献者指南

技术栈
python
领域
documentationperformance
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Familiarity with Litestar docsBasic Python skillsAccess to benchmark suite
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
Examine the current benchmarks page at docs/litestar/benchmarks.rst (or similar). Fetch latency results from the api performance tests repository (e.g., output files). Add a table or summary of latency metrics (p50, p99) alongside RPS data. Verify by building docs locally.