Logowanie jest ważną częścią procesu rozwoju. Logowanie pomaga chronić deweloperów i użytkowników przed awariami i problemami na dużą skalę w aplikacjach i systemach.
Dowiedzmy się, czym są pliki dziennika i jak zapisać jego wartość w AppMasterze.
Czym są pliki dziennika?
Log to plik tekstowy, który zawiera informacje systemowe o działaniu oprogramowania lub serwera. W logu znajdują się dane o działaniach wykonywanych przez program lub użytkownika.
Dlaczego logi są potrzebne?
Kiedy pojawiają się błędy w działaniu serwera, programu lub komputera, logi są tym, do czego odwołują się specjaliści, aby określić przyczynę i źródło tego błędu.
Logi zawierają listę zdarzeń w porządku chronologicznym, ich źródła i błędy oraz przyczyny ich wystąpienia. Różni specjaliści mogą korzystać z dzienników. Dla administratorów, pliki dziennika zawierają informacje o tym, dlaczego urządzenia i systemy uległy awarii. Programiści potrzebują logów do debugowania - znajdowania i naprawiania błędów w witrynie lub aplikacji. Logi są również pomocne dla specjalistów SEO, którzy za ich pomocą śledzą statystyki ruchu.
Logi i ich analiza to najważniejsze narzędzie w pracy specjalistów IT. Pozwala szybko zidentyfikować przyczyny i źródła problemów i awarii oraz je naprawić. W aplikacjach logi pomagają monitorować ich pracę, aby w porę znaleźć błędy.
Poziomy i rodzaje logów
Logowanie jest konieczne na wszystkich etapach rozwoju i podczas dalszego działania oprogramowania. Może to spowodować nagromadzenie wielu plików dziennika, które będą bardzo trudne do zrozumienia. Dlatego są one podzielone na poziomy i typy dla wygody i uproszczenia wyszukiwania i czytania.
Istnieją cztery główne poziomy logów:
- Debug - rejestrowanie przejść stanów na dużą skalę: dostęp do baz danych, uruchamianie i zatrzymywanie usługi.
- Warning - sytuacje nietypowe, na przykład nieprawidłowy format żądania.
- Error - zapis typowych błędów.
- Fatal - fatalne awarie: odmowa dostępu do bazy danych, brak miejsca na dysku.
Istnieją dwa dodatkowe poziomy logowania:
- Trace - zapis procesu krok po kroku; jest potrzebny, gdy trudno zlokalizować problem.
- Info - ogólne informacje o działaniu usługi.
Typy logów:
- Server - połączenia z serwerem i błędy występujące podczas połączeń;
- Event - zapisuje dane o ruchu sieciowym i wykorzystaniu (próby logowania, zdarzenia aplikacji);
- System - wszystkie zdarzenia systemowe;
- Logi autoryzacji i uwierzytelniania - procesy logowania i wylogowania, problemy z dostępem itp;
- Logi aplikacji, które znajdują się w tym systemie;
- Logi bazy danych - dostęp do bazy danych.
Jak poprawnie pisać logi?
Aby zachować wygodne w użyciu logowanie, należy poprawnie pisać logi:
- rejestrować wszystkie krytyczne zdarzenia, takie jak zatrzymanie transakcji czy uruchomienie aplikacji;
- dodawać znaczniki, aby szybko nawigować do pożądanych rekordów;
- usuwać powtarzające się słowa;
- ustalić format tworzenia plików dziennika w firmie, aby ustandaryzować proces;
- wprowadzać tylko wymagane informacje.
Rejestrowanie w AppMasterze
Każdy projekt AppMaster obsługuje standardowe logowanie. Aby pracować z logami, przejdź do zakładki Project / Deploy Stats. Tutaj, w zakładce Application Logs, znajdziesz wszystkie dzienniki aplikacji.
Jak zapisać wartość logu do pliku aplikacji?
System automatycznie zapisuje pewne zdarzenia do pliku, ale możesz dodatkowo zapisać potrzebne dane. Edytor procesów biznesowych posiada w tym celu blok Zapis do dziennika.
Blok ten posiada dwa pola wejściowe:
- Label - tytuł, który jest zapisywany do pliku dziennika w formacie string;
- Input - dowolna wartość, która musi być zapisana w dzienniku.
Tworzenie loggera
Możesz również utworzyć logger w AppMasterze. Jest to bardzo wygodne, gdy do aplikacji wysyłanych jest wiele żądań i niewygodne jest ręczne rejestrowanie wszystkiego.
Aby utworzyć logger, najpierw utwórz model danych - Log i dodaj następujące pola:
- Label - dla tytułu wpisu;
- Text - dla ciała wpisu.
Aby zapisać wartości do dziennika, potrzebny będzie proces biznesowy. Utwórz nowy BP i dla bloku Start ustaw pola:
- Label - w formacie string;
- Text - w formacie string.
Następnie dodaj blok Make i utwórz rekord, przekazując do niego pola z bloku Start.
Zapisz rekord do bazy danych za pomocą bloku Create.
Musisz utworzyć endpoint dla nowego BP, aby można było uzyskać do niego dostęp z frontendu. Przejdź do zakładki Endpoints i utwórz nowy endpoint. Ustaw opcje:
- Wybierz metodę POST;
- Ustaw adres URL;
- Wybierz grupę;
- Ustaw utworzony proces biznesowy.
Teraz możesz użyć utworzonego BP, w którym chcesz pisać dzienniki.
Podsumowując.
Podsumujmy wszystko, co omówiliśmy na temat logów.
Tak więc logi to zapisy zdarzeń, które występują w aplikacji. Mogą one pomóc w rozwiązywaniu problemów, śledzeniu użycia i monitorowaniu bezpieczeństwa.
Ustalenie, co spowodowało problem lub gdzie problem powstał, może być trudne bez logów. Logi mogą pomóc w identyfikacji błędów i problemów, aby rozwiązać je zanim spowodują poważne problemy.
Podczas pisania dzienników ważne jest, aby były one jak najbardziej szczegółowe. Należy podać datę i godzinę zdarzenia, typ zdarzenia, poziom dziennika, dane i inne istotne informacje.
Ważne jest również, aby dzienniki były bezpieczne. Jeśli rejestrowane są wrażliwe dane, należy je zaszyfrować. Nie należy przechowywać logów w miejscach publicznie dostępnych. Dostęp do nich powinien mieć tylko upoważniony personel.