litestar-org/litestar

Docs: Add latency data to docs/benchmarks

Open

#2,548 opened on 2023年10月27日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Python (8,243 stars) (550 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.