litestar-org/litestar

Docs: Add latency data to docs/benchmarks

Open

#2,548 opened on Oct 27, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (8,243 stars) (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Description

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

Contributor guide

Tech stack
python
Domain
documentationperformance
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Litestar docsBasic Python skillsAccess to benchmark suite
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.