Toolverse
Wszystkie skille

logging-best-practices

autor: neondatabase

Strukturyzuj logi aplikacji wokół pojedynczych zdarzeń kontekstowych dla lepszego debugowania i analityki

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Wyświetlenia
1

O skillu

Umiejętność dostarczająca wytyczne do implementacji efektywnego logowania w aplikacjach. Skupia się na wzorcu "wide events" (kanonicznych liniach logów) — emisji jednego bogatego w kontekst zdarzenia na żądanie na usługę. Zamiast rozrzucać instrukcje logowania po całym kodzie, konsolidujesz wszystkie dane w jedno strukturyzowane zdarzenie emitowane po zakończeniu żądania. Umożliwia to potężne debugowanie i analitykę poprzez wysoką kardynalność pól (ID użytkownika, ID żądania) i wysoką wymiarowość (wiele pól na zdarzenie).

Jak używać

  1. Zainstaluj umiejętność w swoim środowisku agenta lub MCP server, wskazując repozytorium neondatabase/mcp-server-neon oraz ścieżkę do folderu logging-best-practices.

  2. Zastosuj wytyczne, gdy piszesz lub przeglądasz kod logowania — szczególnie przy dodawaniu console.log, logger.info lub podobnych instrukcji w swoich handlerach żądań.

  3. Przeanalizuj swoją obecną strategię logowania i zidentyfikuj miejsca, gdzie rozrzucasz wiele linii logów po całym kodzie obsługi żądania. Zamiast tego skonsoliduj wszystkie dane w jeden obiekt zdarzenia.

  4. Utwórz strukturę "wide event" — pojedyncze zdarzenie kontekstowe zawierające metadane żądania (method, path, requestId, timestamp), dane użytkownika, dane biznesowe (koszyk, stan transakcji) oraz wynik (status_code, outcome, duration_ms).

  5. Emituj to zdarzenie w bloku finally lub na koniec obsługi żądania, aby upewnić się, że wszystkie informacje — zarówno ze ścieżki sukcesu, jak i błędu — są zawarte w jednym logu strukturyzowanym.

  6. Upewnij się, że zdarzenie zawiera pola o wysokiej kardynalności (ID użytkownika, ID żądania) i wysokiej wymiarowości (wiele różnych pól), aby umożliwić zaawansowaną analitykę i debugowanie w narzędziach do obsługi logów.

Podobne skille