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

Jak poprawnie logować błędy

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

 
public class HomeController : Controller

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


Serwis

 
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.

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?

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

 
public class HomeController : Controller

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

Serwis

 
public class ReportService

UpdateReportFor(int userId)
{
	try
	{
		//...
	}
	catch (Exception ex)
	{
		throw;
	}
}
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ą.

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.

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.

1 użytkowników online, w tym zalogowanych: 0, gości: 1