A
api-logging-guidelines
Zasady logowania w trasach API — unikaj szumu, loguj to, co ważne
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill zawiera sprawdzone praktyki i wytyczne do poprawnego logowania w trasach API. Definiuje odpowiednie poziomy logowania, co warto rejestrować, a czego unikać. Użyj go podczas implementacji lub przeglądu logowania w trasach, debugowania lub optymalizacji ilości logów. Dowiesz się, jak unikać redundantnych wpisów, kiedy stosować ERROR, WARN, INFO i DEBUG, oraz jakie zdarzenia biznesowe i błędy rzeczywiście warte są zalogowania.
Jak używać
- Zainstaluj skill w swoim projekcie agenta, importując moduł api-logging-guidelines z repozytorium inkeep.
- Podczas implementacji nowej trasy API zapoznaj się z tabelą poziomów logowania: ERROR dla nieoczekiwanych awarii, WARN dla problemów odwracalnych, INFO dla ważnych zdarzeń biznesowych, DEBUG dla szczegółów diagnostycznych.
- Sprawdź, czy middleware już loguje szczegóły żądania (metoda, ścieżka, status, czas trwania, parametry). Jeśli tak, nie duplikuj tych informacji w logach trasy.
- Loguj zdarzenia biznesowe o znaczeniu (np. zmiana planu użytkownika, przetworzenie płatności) oraz błędy z kontekstem (ID dzierżawcy, numer próby, URL webhooka).
- Podczas debugowania wykorzystaj poziom DEBUG do logowania parametrów zapytania, wyników pośrednich i trafiań do cache'u, ale nie dodawaj tych wpisów do kodu produkcyjnego.
- Przejrzyj istniejące trasy API pod kątem redundantnych logów i usuń duplikaty, które powtarzają informacje już dostępne w logach middleware'u.