Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Best practices and guidelines for using logger in API routes. Defines appropriate logging levels, what to log, and when to avoid logging. Use when implementing or reviewing API route logging, debugging strategies, or optimizing log output.
How to use
- 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.