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.