litestar-org/litestar

Docs: Add latency data to docs/benchmarks

Open

#2.548 aberto em 27 de out. de 2023

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Métricas do repositório

Stars
 (8.243 stars)
Métricas de merge de PR
 (Mesclagem média 2d 22h) (53 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Examine a página atual de benchmarks em docs/litestar/benchmarks.rst (ou similar). Obtenha os resultados de latência do repositório api performance tests (por exemplo, arquivos de saída). Adicione uma tabela ou resumo das métricas de latência (p50, p99) junto com os dados de RPS. Verifique construindo a documentação localmente.
Pilha de tecnologia
python
Domain
documentationperformance
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Familiarity with Litestar docsBasic Python skillsAccess to benchmark suite
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85