Como Reivindicar Resultados de Benchmark com o Bencher
A maioria dos resultados de benchmarks são efêmeros. Eles desaparecem assim que seu terminal atinge o limite de retrocesso. Alguns frameworks de benchmark permitem que você armazene os resultados em cache, mas a maioria só o faz localmente. O Bencher permite que você acompanhe seus benchmarks tanto de execuções locais quanto de CI e compare os resultados, enquanto ainda utiliza seu framework de benchmark favorito. O Bencher possui algumas funcionalidades que facilitam o acompanhamento dos resultados de benchmarks locais que precisam ser consideradas ao migrar para acompanhar benchmarks no CI.
Projetos unclaimed
O Bencher permite que você acompanhe os resultados dos benchmarks sem criar uma conta. Quando você invoca o subcomando CLI bencher run
sem definir a opção --token
, o Bencher criará um novo Projeto unclaimed
instantaneamente para seus resultados de benchmark. Se você seguiu os tutoriais de Início Rápido ou Início Rápido Autônomo, você estava aproveitando essa funcionalidade.
Qualquer pessoa pode visualizar e postar resultados de benchmark em um Projeto unclaimed
. Para reivindicar um Projeto unclaimed
, você precisará criar uma conta. Se você seguir o link de inscrição Claim this project
no final da sua saída do bencher run
, você automaticamente reivindicará o Projeto quando sua conta for criada.
Se você já tem uma conta no Bencher, pode navegar até a Página Pública de Desempenho do Projeto e clicar no botão Claim this project
no topo da página. Da mesma forma, se você já tem um token de API, pode usar o token de API com a opção --token
na próxima vez que você invocar o bencher run
para reivindicar o Projeto.
🐰 IMPORTANTE: Uma vez que um Projeto é
claimed
, ele não pode ser postado anonimamente. Você deve usar um token de API com a opção--token
.
Criar um Token de API
Para usar o
bencher run
subcomando CLI
com a opção --token
,
você precisará criar um token de API.
Clique para adicionar um Token de API
Etapas:
- Navegue até o Console Bencher.
- Passe o mouse sobre seu nome no canto superior direito.
- Um menu suspenso deve aparecer. Selecione
Tokens
. - Na página de Tokens de API, clique no botão
➕ Add
.
Projetos on-the-fly
O Bencher permite criar tanto Projetos claimed
quanto unclaimed
on-the-fly.
Quando você invoca o subcomando de CLI bencher run
sem definir a opção --project
ou se o slug especificado não corresponder a um Projeto existente,
o Bencher criará um novo Projeto on-the-fly para os resultados do seu benchmark.
Se você seguiu os tutoriais Início Rápido ou Início Rápido (auto-hospedado),
você estava aproveitando essa funcionalidade.
Se a opção --project
não for especificada, um slug de Projeto on-the-fly será gerado para você com base em:
- O nome do diretório pai do repositório
git
, se disponível. - O hash curto hexadecimal de 7 dígitos do commit inicial do repositório
git
, se disponível. - Uma impressão digital alfanumérica de 13 caracteres da máquina local, para sistemas operacionais suportados.
Por exemplo, um slug de Projeto on-the-fly gerado pode ser: project-abc4567-wxyz123456789
Se você está contando com um slug de Projeto on-the-fly e deseja rastrear resultados de benchmark entre máquinas diferentes,
você deve usar a opção --project
para especificar o Projeto.
Caso contrário, um novo Projeto on-the-fly poderá ser criado para cada máquina diferente.
🐰 IMPORTANTE: Se a variável de ambiente
CI
estiver definida comotrue
, então você precisa ou usar a opção--project
para especificar o Projeto ou definir a opção--ci-on-the-fly
.
🐰 Parabéns! Você aprendeu como reivindicar seus resultados de benchmark! 🎉