Jak poprawnie logować błędy

Jak poprawnie logować błędy

Wątek przeniesiony 2016-10-07 16:32 z C# i .NET przez somekind.

RD
  • Rejestracja:ponad 10 lat
  • Ostatnio:około 2 miesiące
  • Postów:302
0

Zastanawia mnie jakie jest prawidłowe podejście przy zapisywaniu komunikatu błędów do pliku. Rozważmy taką sytuacje: moja aplikacja to klient który odzywa się do serwisu.

Klient

Kopiuj
 
public class HomeController : Controller

try
{
	bool result = reportService.UpdateReportFor(userId)
	if (!result)
		throw new Exception();
}
catch (Exception ex)
{
	ClientLogger.Error("Index Error", ex);
}


Serwis

Kopiuj
 
public class ReportService

UpdateReportFor(int userId)
{
	try
	{
		//...
	}
	catch (Exception ex)
	{
		ServiceLogger.Error("UpdateReportFor Error", ex);
return false;
	}
}

Ja bym to zrobił tak:
Leci wyjątek w ReportServicemam w nim try catch, łapę i loguje błąd i zwracam z metody coś co informuje mnie że coś poszło nie tak np. -1. W kliencie sprawdzam że jeżeli wynik == -1 to rzucam kolejny wyjątek. W ten sposób logują mi się dwa błędy jeden z serwisu a drugi z klienta. Plus tego jest taki że mogę sobie złożyć to w całość i widzę że błąd z klienta jest powiązany z błędem z serwisu. Minus tego jest taki że nie mam od razu całej ścieżki.

Zastanawia mnie teraz czy to podejście jest prawidłowe. Przy założeniu że zapisuje logi do tego samego pliku to znalezienie metody która wywołuje metodę na niższym poziomie (ReportService) nie będzie trudne.
Co natomiast w przypadku jak błędy z klienta zapisuje w innym pliku niż błędy z serwisów ? Będę teraz musiał przeglądać dodatkowe pliki i sprawdzać która metoda kliencka (z którego klienta) wywołała metodę w serwisie, a to moim zdaniem jest słabe i czasochłonne.

Jednakże najbardziej przyjazna dla mnie wydaje się metoda gdzie łapę wyjątek dopiero na wyższym poziomie (klient) bo wtedy od razu mam całą ścieżkę błędu. Natomiast nie wydaje mi się żeby to było poprawne.

  1. Co w przypadku jak mam jeszcze dodatkową warstwę repozytoriów. Tzn serwis korzysta z repozytoriów i w repo leci mi błąd. Gdzie robić try catche i jak to obsłużyć?

  2. Lepiej zapisywać logi do różnych plików np 1 plik = 1 serwis, czy jak to możliwe trzymać je w jednym.

edytowany 4x, ostatnio: RideorDie
somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:dzień
  • Lokalizacja:Wrocław
2

Z serwisu zwróć rezultat operacji z informacją o tym, że operacja się nie powiodła, możesz nawet konkretny rodzaj błędu (ale enumem, a nie przez -1). Na kliencie zaś zaloguj co najwyżej, że dla takich, a takich danych, serwis zwrócił błąd.
Skoro poleciał wyjątek w serwisie, zalogowałeś go, to czemu chcesz jeszcze obciążać klienta jakimiś wyjątkami?

RD
  • Rejestracja:ponad 10 lat
  • Ostatnio:około 2 miesiące
  • Postów:302
0
somekind napisał(a):

Skoro poleciał wyjątek w serwisie, zalogowałeś go, to czemu chcesz jeszcze obciążać klienta jakimiś wyjątkami?

No bo nie mam całego stak trace.
@somekind Naoglądałem się kodu, gdzie były łapane wyjątki w serwisach i czasami ciężko było dojść co tą metodę wywołało, bo stak trace nie pokazywał tego.

No to w takim przypadku wydaje mi się że nie mam potrzeby zwracać żadnego rezultatu operacji z serwisu bo nic mi to nie da, a tylko skomplikuje.

Jeżeli ustaliliśmy że błędy powinny być logowane w kliencie to ja bym to zrobił w taki sposób.

Klient

Kopiuj
 
public class HomeController : Controller

try
{
	reportService.UpdateReportFor(userId)
}
catch (Exception ex)
{
	ClientLogger.Error("Index Error", ex);
}

Serwis

Kopiuj
 
public class ReportService

UpdateReportFor(int userId)
{
	try
	{
		//...
	}
	catch (Exception ex)
	{
		throw;
	}
}
edytowany 1x, ostatnio: RideorDie
somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:dzień
  • Lokalizacja:Wrocław
2

@RideorDie, nie jestem pewien, czy my się rozumiemy. :)
Serwis i klient są u Ciebie w jednej aplikacji, czy serwis jest gdzieś na serwerze, a klient to aplikacja GUI, która łączy się z nim przez sieć?
Jeśli tak, to jakoś wynik operacji trzeba przekazać, bo przecież nie rzucisz wyjątku między oddzielnymi fizycznie maszynami.
Jeśli nie, to wystarczy Ci taki kod, jaki napisałeś. Chociaż ja bym raczej logował tam, gdzie błąd występuje, czyli na poziomie serwisu, a nie klienta. (A raczej opakował sobie serwisy interceptorem, który mi to zapewni, jeden try-catch na aplikację wystarczy.)
Stack trace nie jest problemem, wystarczy odpowiednio skonfigurować bibliotekę logującą.

RD
  • Rejestracja:ponad 10 lat
  • Ostatnio:około 2 miesiące
  • Postów:302
0

Nie no jasne że jak mam jakieś serwisy na innym serwerze to muszę zrobić tak jak piszesz. W takim razie muszę poczytać o interceptorze i konfiguracji log4net jeszcze.

Zobacz pozostałe 5 komentarzy
somekind
Ja również. Poza tym, nie lubię AOP.
TD
@somekind dlaczego?
somekind
Bo nigdy nie spotkałem sensownego przypadku użycia tego typu biblioteki.
TD
@somekind nie próbowalem jeszcze, ale ponoć logowanie powinno robić się przez AOP. Widzisz jakieś przeciwskazania?
somekind
No ja do tego używam interceptorów dostarczanych przez kontener IoC, a nie jakichś bilbiotek, które magicznie wkompilowują coś przed kompilacją albo w runtimie na podtawie jakichś atrybutów/adnotacji.
vpiotr
  • Rejestracja:ponad 13 lat
  • Ostatnio:prawie 3 lata
0

TL;DR i nie znam C#.

Do klienta zwracaj wyjątek. W serwisie loguj tylko wtedy gdy połykasz wyjątek i zwracasz status. Może się okazać że klient strzela na ślepo z błędnymi danymi, bo masz braki w API. Wtedy masz stosy bezużytecznych zapisów w serwisie. Niedawno coś takiego poprawiałem - aplikacja logowała każdy brak uprawnień w serwisie do obsługi uprawnień - efekt: zapisy w logu dla każdego brakującego uprawnienia. Słabe trochę?

To od klienta zależy co z tym wyjątkiem się stanie - może zdecydować się na:

  • logowanie błędu plus ew. stack trace
  • pokazanie na stronie komunikatu (niekoniecznie stack trace'a)
  • spróbowanie innego wywołania serwisu

Zwracanie wartości statusowej w formie integer (lub co gorsza boolean) można stosować tam, gdzie blokujesz wypłynięcie wyjątków ze względów architektonicznych (np. nie chcesz podglądania stack trace). Wtedy zwracasz integer lub string unikalny w całej aplikacji. To będzie biedniejsza forma komunikacji bo brakuje w tym informacji kontekstowej (np. dla którego użytkownika próbowała aktualizować aplikacja), ale czasami tak trzeba. Można jeszcze się wspomóc funkcją typu "podaj opis ostatniego błędu" - rozwiązanie z Win32 API zastępujące wyjątki.

Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)