Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add latency data to docs/benchmarks #2548

Open
AgarwalPragy opened this issue Oct 27, 2023 · 2 comments
Open

Docs: Add latency data to docs/benchmarks #2548

AgarwalPragy opened this issue Oct 27, 2023 · 2 comments
Labels
Documentation 📚 This is related to documentation Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on

Comments

@AgarwalPragy
Copy link
Contributor

AgarwalPragy commented Oct 27, 2023

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


Note

While we are open for sponsoring on GitHub Sponsors and
OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh Litestar dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.
Fund with Polar
@AgarwalPragy AgarwalPragy added the Enhancement This is a new feature or request label Oct 27, 2023
@peterschutt peterschutt added Documentation 📚 This is related to documentation Help Wanted 🆘 This is good for people to work on Good First Issue This is good for newcomers to take on and removed Enhancement This is a new feature or request labels Oct 27, 2023
@AgarwalPragy
Copy link
Contributor Author

@peterschutt do you have the results file from the latest run? If yes, I will be happy to convert that into a graph and update the docs :)

@peterschutt
Copy link
Contributor

Sorry @AgarwalPragy I don't.

@AgarwalPragy AgarwalPragy changed the title Enhancement: Add latency data to docs/benchmarks Docs: Add latency data to docs/benchmarks Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📚 This is related to documentation Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on
Projects
Status: Ideas
Development

No branches or pull requests

2 participants