Logování běhu aplikace

Pro zapnutí samotného logování. Nastavení platné pro všechny třídy a všechny počítače. Tato sekce zároveň umožňuje nastavení globálních parametrů ovlivňujících logování platných pro všechny počítače, jako je např. formát jména logovacích souborů apod.

[Log.ExceptionHook]
Enabled=1
ExcludedExceptionClasses=EAbort;NxHiddenError;EIdSocketError;EIdConnectTimeout;EIdNotASocket;EIdReadTimeout;EDataProtection_CannotRead;EDataProtection_CannotWrite

[Log.ExceptionHook]
Enabled=0

[Logs]
LogsDirectory=<cesta platná z pohledu aplikace>

[Log.SQL]
Enabled=1
Level=6

[Logs]
LogsDirectory=<cesta platná z pohledu aplikace>
Enabled=1
#Omezení na konkrétní aplikace
#AllowedApps=AbraGen;AppServer64;appserverl-x64

Nastavení pro jednu <třídu>, platí pro všechny počítače. Seznam možných tříd je uveden v samostatné kapitole níže.

Nastavení pro všechny třídy, platí pro uvedený <počítač>. Jméno počítače musí být uvedeno jménem, nikoliv IP adresou. Na Linuxu lze zjistit jméno počítače pomocí příkazu "hostname". Klienti v terminálovém provozu se identifikují jako <jméno_serveru>.<jméno_stanice>, např. "SERVER.UCTARNA". Tato sekce zároveň umožňuje nastavení globálních parametrů, podobně jako sekce [Logs], avšak platných pro uvedený počítač. Zde je například výhodné definovat cestu pro soubory s logy apod.

[ComputerName:Logs]
LogsDirectory=/usr/local/abragen/logs

Nastavení intervalu, v jakém bude konfigurace logování načtena. Hodnota se zadává v sekundách a minimální hodnota je 10 sekund.

Implicitní hodnota je 60 sekund.

Nastavení cesty, do které se mají ukládat souboru logů.

Implicitní hodnota je cesta do temp adresáře. V případě windows to je obsah env.proměnné TEMP (typicky c:\Documents and settings\aktuální_uživatel\Local Settings\Temp). Na Linuxu je typické umístění v cestě /tmp. Pro rychlejší nalezení logů doporučujeme si přepsat na nějakou jednoduchou cestu např. C:\Logy.

Pozor, cesta musí existovat. Probíhá test na existenci cesty. V případě, že cesta neexistuje nebo do ní nelze zapisovat, logy se nevytvářejí a logování je zastaveno. Po přenačtení konfigurace (která probíhá každých cca 60 s, resp. dle intervalu nastaveného v RefreshConfigurationInterval) systém pokus zopakuje a pokud je cesta stále chybná, je logování opět zastaveno. Pokud mezitím byla konfigurace opravena a zadaná cesta je v pořádku, logování se rozběhne.

Definuje velikost logu v bytech, po jehož překročení dojde k přesunutí aktuálního souboru do zálohy a začne se vytvářet nový soubor. Soubor se zálohou má stejné jméno jako původní soubor logu, pouze se doplní o příponu s pořadovým číslem zálohy. Případné existující soubory jsou přečíslovány na číslo o jedničku vyšší.

Implicitní hodnota je 1 073 741 824 B, tj. 1GB.

Počet souborů záloh. Soubor odsunutý do zálohy dostane ke jménu souboru jako příponu číslo. Čím větší číslo, tím se jedná o starší logy. Starší soubory než nastavený počet jsou zapomenuty.

Implicitní hodnota je 5.

Maska pro sestavení jména logovacího souboru. V masce se mohou objevit následující značky:

• %0:s = časová značka založení souboru
• %1:s = jméno aplikace bez přípony, tj. název procesu
• %2:s = PID procesu
• %3:s = jméno počítače
• %4:s = identifikace systému (např. ABRA Gen)

Pokud jsou uvedeny všechny parametry v tomto pořadí, je možné použít pouze značky %s bez čísla. Doporučujeme zadat si v tomto parametru příponu .txt aby jednotlivé logy bylo možné na windows rychle zobrazovat a nebylo nutné vybírat aplikaci pro zobrazení.

FileNameFormat=LOG%4:s %0:s %1:s %2:s %3:s.txt

Implicitní hodnota je "%s %s %s %s %s.log".

Pokud je nastaveno na 1, je logování aktivní

Implicitní hodnota je 0. Platí pro všechny třídy (v dřívějších verzích byla u některých tříd výjimka (např. SysLog), kdy jejich logování bylo implicitně zapnuté).

Úroveň informací, které se mají logovat. Platí, že čím vyšší číslo, tím více informací se bude logovat. Možné hodnoty jsou:

• 0 (System) - systémové informace, typicky spuštění a ukončení aplikací
• 1 (Critical) - kritické chyby
• 2 (Error) - chyby
• 3 (Warning) - varování
• 4 (Notice) - běžná hlášení
• 5 (Info) - rozšiřující informace
• 6 (Debug) - ladící informace

Implicitní hodnota je 0.

Seznam aplikací, jejichž činnost se má logovat. Jména aplikací se uvádějí bez přípony a oddělují středníkem, hodnota "*" znamená všechny aplikace.

AllowedApps=AbraGen;AppServerS;ABRAOLE;DBTOOL;appserverl-x64

Implicitní hodnota je "*".

Formát časové značky hlášení v logu, viz popis parametru FileNameStamp.

Implicitní hodnota je "ddd dd. hh:nn:ss.zzz".

Formát řádky v logovacím souboru, jedná se o libovolný text, ve kterém se mohou objevit následující značky:

• %0:s = časová značka hlášení
• %1:s = číslo úrovně
• %2:s = číslo threadu
• %3:s = identifikace třídy

Text hlášení není možné tímto nastavením ovlivnit. Vždy je přidán na konec řetězce.

Pokud jsou uvedeny všechny parametry v tomto pořadí, je možné použít pouze značky %s bez čísla.

LineFormat=%0:s [%1:s] %2:s (%3:s)

Implicitní hodnota je "%s [%s] %s (%s)"

Určuje, kam se bude log ukládat. Možné hodnoty jsou: file a memory. Lze i kombinovat dohromady, v tom případě se oddělí čárkou nebo středníkem.

file - výstup se bude ukládat do souboru tak, jako dosud. Je to také výchozí volba pro většinu logovacích tříd.

memory - výstup se bude ukládat do paměti aplikačního serveru. Zobrazit ho lze pomocí aplikace AppServerProp.exe.

Target=file,memory

Systémová hlášení.

Hlášení subsystému pro přidělování unikátních identifikátorů.

Informace o perzistentních kanálech.

Podrobné informace z obnovy dat.

Informace z update databáze.

Hlášení z přenosové vrstvy (stub objekty).

Hlášení z nejnižší TCP vrstvy.

Hlášení z přenosové vrstvy (proxy objekty).

Informace o databázových spojeních a transakcích.

Vysokoúrovňové zprávy o persistentních akcích (objekt uPersist).

Informace o datasetech v DynSQL.

Logování SQL - načítání BO.

Logování SQL - počet BO.

1. Logování SQL - testování existence záznamu.

Logování SQL - vytváření záznamu BO.

Logování SQL - opravy záznamu BO.

Logování SQL - smazání záznamu BO.

Logování SQL - persistentní akce, které čtou data (SELECT).

Logování SQL - persistentní akce, které mění data včetně DML.

Speciální skupina pro logování pouze těch SQL příkazů, které překročí určitý čas.

Má navíc tyto parametry:

Threshold - doba v ms. při jejímž překročení se SQL příkaz zaloguje, defaultně je 60000

SQLOutputLength - počet znaků SQL příkazu, které se zalogují, defaultně je 20. Při nastavení na 0 se zaloguje celý SQL příkaz.

Logování použitých licencí pro lepší diagnostiku využití licencí.

Je dostupný od Level=4.

Pomocná skupina zjednodušující ovládání komunikace s SQL serverem. V sekci konfigurace skupiny lze použít pouze parametry Enabled a Level, přičemž se jimi najednou konfigurují všechny třídy, které patří do téže skupiny.

[Logs]
LogsDirectory=C:\Logs

[Log.SQL]
Enabled=1
Level=6

Logování ABRA WS serveru a webových služeb. Původní řešení jednou třídou bylo změněno na několik logovacích, podrobnějších tříd, které lze lépe konfigurovat a tím získávat i podstatné informace. Při implementaci webových služeb se doporučuje zapnout skupinu. Pozor, bude vznikat množství log souborů, které je nutné rozumně odsouvat.

Logování XML zpráv posílaných a obdržených v rámci komunikace s Veřejným rozhraním pro e-Podání (VREP) a pro lepší diagnostiku problémů při komunikaci s portálem.

Logování dostupných informací o logovacím subsystému.

Logování volání některých funkcí Oracle clienta. Defaultní Target tohoto logu je memory.

Logování zpráv windows v hlavním okně aplikace a některých dalších prvcích.

Má navíc tyto parametry:

• MsgMin - min. číslo zprávy, od které se bude logovat
• MsgMax - max. číslo zprávy, od které se bude logovat
• SourceContain - text, který musí obsahovat text zprávy, aby se zalogovala

Při Level=2 se loguje jen, pokud nastane v obsluze zprávy výjimka, při Level=6 loguje všechny zprávy, které do obsluhy zpráv vstoupí

Logování vytvoření a zrušení některých objektů.

Logování modulu SCM. (Např. časy načítání jednotlivých datových zdrojů do SQL Lite, dotazování SQL Lite apod.)

Logování odesílání e-mailů ze systému ABRA Gen. Mj. vypíše informace týkající se odesílání e-mailů přes SimpleMAPI rozhraní resp. přes OLE rozhraní Outlooku. Viz též help.

Logování funkcí digitálního zabezpečení - podepisování a kryptování.

Logování rychlého vyhledávání v ABRA Gen.

[Log.FastSearch]
Enabled=1
Level=6

Logování přihlašování do ABRA Gen.

Logování v číselnících.

Logování tiskáren o informace týkající se tiskárny v ovladačích AbraReport a WinPrint. (Např. uložená tiskárna, uložený formát stránky, seznam dostupných tiskáren, šířka a výška papíru.)

[Logs]
LogsDirectory=C:\G3\AbraGen\Logs
Level=6
[Log.Print]
Enabled=1

čt 10. 07:54:02.483 [4] 00007028 (Print) TNxAbraReportDriver.DoConnectPrinter()
čt 10. 07:54:02.484 [4] 00007028 (Print) -->
čt 10. 07:54:02.485 [6] 00007028 (Print) Saved PrinterFullName = "EPSON TM-T20II Receipt"
čt 10. 07:54:02.486 [6] 00007028 (Print) Get RemoteSession: "False"
čt 10. 07:54:02.486 [6] 00007028 (Print) Terminal session: "False"
čt 10. 07:54:02.488 [6] 00007028 (Print) PrinterIndex = "6"
čt 10. 07:54:02.488 [6] 00007028 (Print) Selected printer name = "EPSON TM-T20II Receipt"
čt 10. 07:54:02.489 [6] 00007028 (Print) Windows printers = "PDFCreator, OKI-C332-2152A1, "OKI C332 PS na Sofia", "Microsoft XPS Document Writer", "Microsoft Print to PDF", Fax, "EPSON TM-T20II Receipt", "ABRA KONICA MINOLTA PS BW Laser Class Driver", \\sofia\Konika_Minolta_1600f, "#BAREVNA# KONICA MINOLTA C554SeriesPCL""
čt 10. 07:54:02.490 [6] 00007028 (Print) PaperID = "240"
čt 10. 07:54:02.671 [6] 00007028 (Print) PaperName = "Roll Paper 80 x 297 mm"
čt 10. 07:54:02.690 [4] 00007028 (Print) 
čt 10. 07:54:02.690 [4] 00007028 (Print) TQRPrinter.Create()
čt 10. 07:54:02.691 [4] 00007028 (Print) -->
...
čt 10. 07:54:22.041 [4] 00007028 (Print) TNxAbraReportDriver.PrintBill()
čt 10. 07:54:22.042 [4] 00007028 (Print) -->
čt 10. 07:54:22.043 [6] 00007028 (Print) Saved PrinterFullName = "EPSON TM-T20II Receipt"
čt 10. 07:54:22.044 [6] 00007028 (Print) Get RemoteSession: "False"
čt 10. 07:54:22.045 [6] 00007028 (Print) Terminal session: "False"
čt 10. 07:54:22.046 [6] 00007028 (Print) PrinterIndex = "6"
čt 10. 07:54:22.047 [6] 00007028 (Print) Selected printer name = "EPSON TM-T20II Receipt"
čt 10. 07:54:22.048 [6] 00007028 (Print) Windows printers = "PDFCreator, OKI-C332-2152A1, "OKI C332 PS na Sofia", "Microsoft XPS Document Writer", "Microsoft Print to PDF", Fax, "EPSON TM-T20II Receipt", "ABRA KONICA MINOLTA PS BW Laser Class Driver", \\sofia\Konika_Minolta_1600f, "#BAREVNA# KONICA MINOLTA C554SeriesPCL""
čt 10. 07:54:22.181 [4] 00007028 (Print) 
čt 10. 07:54:22.189 [4] 00007028 (Print) NxCheckAvailablePrinters()
čt 10. 07:54:22.190 [4] 00007028 (Print) -->

Tyto třídy byly zrušeny. Namísto nich vznikla skupina UnusedNumbers.

Třída ExceptionHook loguje výjimky v systémovém háčku. Tento log je schopný zaznamenat veškeré výjimky za běhu programu, pokud takové v systému nastanou (využití např. pro logování automatizačního serveru), ale i jinde. Při ukončování aplikace jsou události zaznamenávané pouze po dobu existence instance logovací třídy.

ExcludedExceptionClasses

V aplikacích se používá mnoho tříd výjimek, např. Exception, NxError, EAbort atd. Logování všeho činí složitějším vyhledávání informací, proto je možné zadat filtr, které třídy nás nezajímají. Více tříd je nutné oddělit středníkem.

Výchozí hodnota je EAbort;NxHiddenError;EIdSocketError;EIdConnectTimeout;EIdNotASocket;EIdReadTimeout;EDataProtection_CannotRead;EDataProtection_CannotWrite

ExcludedNxErrorCodes

ABRA zavedla svoji třídu výjimek NxErorr. Jednotlivé chyby se od sebe rozlišují číslem, tzv. ErrorCode. Podobně jako u ExcludedExceptionClasses je výhodné určité chybové kódy nelogovat. Více hodnot je možné zadat tak, že jednotlivé hodnoty se oddělí středníkem.

Výchozí hodnota parametru ExcludedNxErrorCodes je 1511 (neexistující položka business objektu). Tzn. není-li parametr ExcludedNxErrorCodes nastaven, neloguje se výskyt výjimky 1511 a ostatní výjimky se logují.

[Log.ExceptionHook]
Enabled=1

[Log.ExceptionHook]
Enabled=1
ExcludedNxErrorCodes=

CallStack

Příznak, zda doplnit ke každé výjimce CallStack.

Výchozí hodnota je 1.

[Log.ExceptionHook]
Enabled=1
CallStack=0

WithConvertions

Příznak, zda zaznamenávat do logů i konverze výjimek.

Výchozí hodnota je 0.

Třída ExceptionHooked loguje aktivaci/deaktivaci systému logování výjimek, tj. zahájení/ukončení vytváření logu ExceptionHook.

... (ExceptionHooked) Delphi exception system hooked
... (ExceptionHooked) Exception notifier installed
...
... (ExceptionHooked) Delphi exception system unhooked
... (ExceptionHooked) Exception notifier uninstalled

Výchozí hodnota je 0.

Třída ModalWindows zapisuje do logu informace o modálních oknech. Takové okno vyžaduje interaktivní zásah obsluhy. Aktivací logu se může osvětlit, proč dojde k "zaseknutí" procesů, které nesmí být interaktivní, např. webové služby, automatizační server atd.

Třída Scripting je zveřejněna do skriptování a umožňuje provádět interní logování přímo ze skriptování. Pro zápis informací do logu ze skriptů je určena třída TNxScriptingLog a její metody, především metoda WriteEvent, viz též logování ze skriptování.

Skupina zaznamenávající informace o běhu automatizačního serveru. Aby bylo možné rozumně logovat dění v automatizačním serveru, používají se pro jeho části vlastní logy. Logů není málo, proto jsme pro zjednodušení konfigurace logování zavedli skupinu. Není třeba se obávat zpomalení automatizačního serveru.

Pozor, při logování automatizačního serveru v čase vzniká množství souborů, které je potřeba rozumně odsouvat.

Skupina by měla být vždy aktivovaná.

Skupina umožňuje logovat činnost Vizualizace dat. Skupina zapne logování tříd AbraBI a AbraBIStarterThread, které je možné případně jednotlivě vypínat.

AbraBI

Třída umožní logovat Vizualizaci dat v systému ABRA Gen.

AbraBIStarterThread

Třída umožní logovat spuštění vestavěného aplikačního serveru Jetty.

Pokud použijete jiný aplikační server, např. Tomcat, není možné jej logovat.

Zaznamenávání synchronizačních objektů automatizačního serveru. Automatizační server je vícevláknová aplikace, která používá synchronizační objekty jádra windows. Skupina poskytuje doplňkové informace ke skupině AS~GROUP. Informace jsou čistě ladícího charakteru.

Skupinu aktivovat pouze na žádost vývoje, jinak zbytečně zahlcuje logy. Nemá smysl skupinu aktivovat bez skupiny AS~GROUP.

Jednotlivé typy úloh automatizačního serveru logují informace. Tříd v této skupině je opět mnoho, co typ úlohy, to logovací třída.

Třídu je doporučeno aktivovat v okamžiku, kdy je potřeba sledovat, co se v úlohách děje. Nemá smysl skupinu aktivovat bez skupiny AS~GROUP.

Třída zapisuje do logu informace o průběhu předkontování účetních zápisů. Loguje pomocí zpráv typu 4 (Notice, "běžná hlášení") a případné chyby během vyhodnocení výrazu předkontací pomocí typu 2 (Error, "chyby"). Třídu je doporučeno aktivovat v okamžiku, kdy je potřeba sledovat, co se přesně děje v okamžiku předkontovávání, pokud se účetní zápisy nepředkontovaly dle očekávání, ale není zřejmé proč.

Třída zapisuje do logu informace o všech chybných SQL dotazech.

Třída zapisuje do logu informace o chybných HTTP komunikacích.

Třída zapisuje do logu průběh zpracování exportů v rámci EDI komunikace a umožňuje tak snadnější odladění vyhodnocování pravidel zpracování exportů.

[Log.EDI]
Enabled=1
Level=6

Skupina umožňuje logovat činnost OLE klienta. Pro všechny třídy v OLE jsou zavedeny samostatné logy, které jsou součástí skupiny AbraOLE, stačí tedy zapnout ji.

[Log.AbraOLE]
Enabled=1
Level=6

Skupina slouží k logování Web API služeb.

Jedná se o logování na úrovni "business logiky". Web API server obdrží požadavek, předá ho knihovně ApiLib.dll a samotné vyřizování požadavku je logováno v závislosti na zde popsané konfiguraci WA~Group. Kromě toho je možné logovat také činnost samotného Web API serveru - přijímání HTTP požadavků od klienta a vracení odpovědí. Více informací viz sekce Logování v kapitole Nastavení Web API.

[Logs]
LogsDirectory=<cesta platná z pohledu aplikace>
AllowedApps=java
[Log.WA~Group]
Enabled=1
Level=6

Skupina obsahuje celou řadu tříd pro logování nízkoúrovňových operací, které je často z výkonnostních důvodů vhodné deaktivovat.

[Log.WA/Requests]
Enabled=1

[Log.WA/RequestProxy]
Enabled=1

[Log.WA/WorkerList]
Enabled=0

[Log.WA/SysReqHandler]
Enabled=0

[Log.WA/SupervisorHandler]
Enabled=0

[Log.WA/ErrorCheckThread]
Enabled=0

[Log.WA/InstMiddleware]
Enabled=0

[Log.WA/ProcessPool]
Enabled=0

[Log.WA/SysMiddleware]
Enabled=0

Skupinu je možné využít také k logování monitorování spotřeby paměti.

[Log.WA/MemoryMonitoring]
Enabled=1

[6] 00006E14 (WA/MemoryMonitoring) Memory that remained allocated on demand (X-RequestID=IJC1THIMV5Y4PGIJSSWQXFNT40): 27 656 192 B

V rámci skupiny je možné logovat také dotazování dynamických SQL:

[Log.WA/DSQL/Compiler]
Enabled=1
								
[Log.WA/DSQL/Exexutor]
Enabled=1

Další možností využití je logování volání skriptů:

[Log.WA/Script]
Enabled=1

Umožňuje logovat vyvolání online nápovědy. Viz též Často kladené otázky - Potíže se spuštěním online nápovědy v prohlížeči po použití F1.

[Log.AbraHelp]
Enabled=1
Level=6

Skupina umožňuje logovat Nepoužitá čísla dokladů.

[Log.UnusedNumbers]
Enabled=1
Level=6

Log.GDIHandles umožňuje logovat aktuálně alokované handlery. Používá se ve specifických případech při odhalování možných příčín leakování nebo pádů Web API.

[Log.GDIHandles]
Enabled=1
Level=6