adding-benchmarks

Skill do zarządzania benchmarkami wydajności w systemie CI. Prowadzi Cię przez tworzenie plików JSON z metrykami, integrację z bootstrap.sh oraz automatyczne przesyłanie wyników do dashboardu. System automatycznie agreguje benchmarki z poszczególnych pakietów, dodając prefiksy ścieżek, a następnie GitHub Action wysyła dane do panelu historycznego. Wyniki pojawiają się na żywym dashboardzie z możliwością śledzenia zmian w czasie.

1. Utwórz plik benchmark w formacie JSON w katalogu bench-out/ swojego pakietu, nadając mu nazwę *.bench.json. Każdy wpis powinien zawierać pole name (identyfikator metryki), value (zmierzona wartość) i unit (jednostka miary, np. ms, bytes).
2. Strukturyzuj nazwy benchmarków za pomocą ukośników / aby utworzyć logiczną hierarchię — ostatni segment nazwy stanie się nazwą wykresu na dashboardzie, a wszystkie poprzednie segmenty utworzą strukturę folderów.
3. Upewnij się, że Twój pakiet jest uwzględniony w procesie agregacji poprzez bench_merge w głównym pliku bootstrap.sh — narzędzie automatycznie połączy wszystkie pliki JSON i doda prefiks ścieżki pakietu.
4. Skonfiguruj workflow CI w pliku ci3.yml aby przesyłał scalony plik JSON do cache'a CI i uruchamiał GitHub Action odpowiedzialny za upload do panelu benchmarków.
5. Zweryfikuj wyniki na żywym dashboardzie dostępnym pod adresem https://aztecprotocol.github.io/benchmark-page-data/bench/?branch=next — powinieneś zobaczyć swoje benchmarki w odpowiedniej grupie hierarchicznej.