logovanie

Ako písať technickú dokumentáciu, Dokumentácia a používateľské príručky

Monitoring, logovanie a observability

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

 

Reálny problém z praxe

Support hlási:

„Používateľ tvrdí, že objednávka neprešla.“

Tester skúsi scenár.
Objednávka prejde.

Vývojár sa pýta:

„Máme k tomu logy?“

Nikto nevie.

V systéme nie je jasné:

  • čo sa loguje
  • kde sa to loguje
  • ako sa to dohľadá

Výsledok:

problém sa nedá overiť
a končí ako „nedá sa reprodukovať“

 

Čo sa tu vlastne pokazilo (analýza systému)

Problém nie je v chybe.…

Administrátorská príručka, Dokumentácia a používateľské príručky

Incidenty, logovanie a diagnostika

/

Séria: Ako písať dokumentáciu a manuály v IT projekte

 

Reálny problém z praxe

Používateľ nahlásil, že sa nedá prihlásiť.
Support to posunul ako bug.

Tester to nevedel reprodukovať.
Vývoj nenašiel chybu.

Nakoniec sa ukázalo, že problém bol v expirovanom tokene.
Stačilo pozrieť log.

Lenže nikto nevedel:

  • kde log nájsť
  • čo v ňom hľadať
  • ako interpretovať chybu

A tak sa riešil incident bez dát.…

Ako testovať..., Cestné mýto, diaľničné známky a cestná daň, Dáta, databáza a logovanie, Konkrétne oblasti, Všeobecné témy

Ako testovať auditné logy a dohľadateľnosť priestupkov

/

Príklad
Predstav si systém, ktorý eviduje priestupky – napríklad jazdu bez platnej diaľničnej známky alebo neoprávnený prístup do systému. Operátor upraví záznam priestupku, neskôr ho iný pracovník zruší a následne prebehne kontrola zo strany auditu.

Ak systém nemá správne auditné logy, vznikne problém:

  • nie je jasné, kto zmenu vykonal,
  • kedy sa záznam upravil,
  • čo presne sa zmenilo.
…
Ako testovať..., Bonusy, Dáta, databáza a logovanie, Všeobecné témy

Všeobecné pravidlá pre logy a auditné záznamy

/

Všeobecné pravidlá pre logy

 

  1. Štruktúrovanosť
  • Logy by mali byť strojovo čitateľné (napr. JSON, XML, CSV), nie len voľný text.
  • Vhodné na parsing, filtrovanie, vizualizáciu.
  1. Konzistentný formát
  • Rovnaké poradie a názvy polí (napr. timestamp, level, message, user_id, session_id, error_code).
  • Časová pečiatka v štandarde ako ISO 8601 (napr.
…
Ako testovať..., Dáta, databáza a logovanie, Všeobecné témy

Ako testovať logovanie chýb a auditné záznamy?

/

Bez záznamov niet retrospektívy. A bez retrospektívy niet analýzy ani zlepšovania.

Príklad:
Testujem webovú aplikáciu pre interný informačný systém. Pridám nový záznam do databázy a úmyselne zmením dátum narodenia na neplatný formát. Aplikácia zobrazí chybu – ale čo ďalej?

Otváram logy – očakávam, že:

  • sa zaznamenala výnimka (napr.
…
Návrat hore