Logování

Tato kapitola popisuje možnosti logování LTD a jejich nastavení.

Technické logování

Kompletní technické logování zaznamenává veškeré informace o operacích, metodách, vstupech a výstupech či výjimkách, které byly použity, resp. nastaly, při volání metod webových služeb LTD. Dále zaznamenává konfigurační nastavení produktu a záznamy o využití jednotlivých komponent.

Nastavení technického logování

Technické logování je možné nastavit dvěma způsoby lišícími se dle zamýšleného použití LTD.

V konfiguračních souborech se vyplní:

  • Cesta k .log souboru. Je nutné, aby aplikační log byl přístupný pro zápis uživateli, pod kterým běží aplikační pool webové služby.

    DebugLogPath

Konfigurační soubor služby

Při integraci řešení přes webové služby se konfigurace nastavuje v souboru InstallDir\WebService\Web.config.

Příklad zápisu v konfiguračním souboru (elementy configuration a appSettings bývají již vytvořené):

<configuration>
    <appSettings>
        ...
        <add key="DebugLogPath" value="C:\logs\LTDSDK.log" />
        ...
    </appSettings>
</configuration>

Konfigurační soubor produktu

Při integraci řešení přes .NET rozhraní se konfigurace nastavuje v souboru InstallDir\Engine\Engine.config.

Zápis je stejný jako u webové služby.

Fragmentování logu

Od verze 2.0.69.1204 je přidán nový konfigurační klíč DebugLogFragments (jehož výchozí hodnota je 0). Pokud je nastavena hodnota větší než 0, rozděluje se LOG po dnech dle zvolené hodnoty s tím, že se ponechávají vždy nejnovější log soubory.

Příklad: Když je nastavena hodnota DebugLogFragments na 14 (dnů), potom log z 15. dne přepíše (nahradí) log z 1. dne.

Výchozí maska DebugLogFragments souboru je yyyy-MM-dd (příklad LTD_2020-07-10.log). Masku lze nastavit pomocí klíče DebugLogFragmentsMask.

Technický log za určitý den je možné (v případě potřeby auditní stopy) voláním metody ConvertFile/ConvertFileEx převést do PDF či PDF/A a podepsat i opatřit časovým razítkem.

Logování komponent (samostatně)

Od verze 2.1.12.0315 je možné samostatně logovat pracovní procesy komponent InstallDir\Engine\FillerWP, InstallDir\Engine\OpenOffice2 a InstallDir\Engine\pdfaPilot. Pro logování je třeba v daných složkách vytvořit .config soubor, který obsahuje celý název pracovního .exe procesu, tj. <process_name>.exe.config.

Obsahem souboru <process_name>.exe.config je zápis v XML, který definuje použitou verzi .NET Framework a aplikační nastavení pro cestu k log souboru (DebugLogPath):

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
  </startup>

  <appSettings>
    <add key="DebugLogPath" value="C:\logs\OpenOfficeWP2.log"/>
  </appSettings>
</configuration>

Pokud není soubor <process_name>.exe.config vytvořen a/nebo v něm není nastaven DebugLogPath, loguje se dle nastavení procesu, ze kterého byl pracovní proces komponenty spuštěn. Priorita nastavení je od nejnižší:

  • Engine.config.

  • <process_name>.exe.config.

  • Parametr příkazové řádky, předaný při spouštění WP.