Pripravujeme pre Vás novú dokumentáciu, aktuálny stav nájdete tu

CDESK LOGOVACÍ APLIKACE

KE SKRIPTŮM (DOCKER VERZE)

Obsah stránky

Přehled

Tato aplikace poskytuje vizualizaci logů ze skriptů CDESK a grafické rozhraní pro jejich manuální spuštění. Logy skriptů je možné filtrovat podle data, typu zprávy (například INFO, WARNING, ERROR…) a zdrojového skriptu. Součástí tohoto adresáře je i cron pro mazání logů starších než 7 dní.

Soubory a adresáře

app.py

Tento soubor obsahuje aplikaci, ve které jsou definovány koncové body a funkcionalita pro zobrazení a filtrování logů, stejně jako manuální spuštění skriptů.

templates

Adresář s různými stránkami aplikace.

logs

Adresář obsahující logy. Logy jsou rozděleny podle data vytvoření. Například log soubor pro datum 11.01.2021 bude vypadat jako 2021-01-11.log. Program však dokáže zpracovat všechny log soubory s příponou .log.

Dockerfile

Tento Dockerfile je potřebný pro nastavení kontejneru pro čištění logů, aby se odstranily logy starší než 7 dní. Tato doporučená funkcionalita odstraní starší logy skriptů a uvolní tak obsazenou paměť.

Nastavení a konfigurace

Python

Pro spuštění této aplikace potřebujete mít nainstalovaný Python na vašem PC/serveru. Doporučuje se novější verze, například 3.11 nebo 3.12.

Adresa a port aplikace

Výchozí adresa této aplikace je localhost (127.0.0.1) s portem 5001. Port je možné změnit v souboru app.py, úplně na jeho konci, kde se aplikace inicializuje.

Kroky nastavení
  1. V kořenovém adresáři této aplikace (kde se nachází app.py) vytvořte nové virtuální prostředí (python -m venv .venv) a aktivujte ho (.venv\Scripts\activate pro Windows, source .venv/bin/activate pro macOS a Linux).
  2. Spusťte pip install -r requirements.txt pro instalaci všech potřebných závislostí pro tuto aplikaci.
  3. Spusťte python app.py pro spuštění této aplikace. V terminálu uvidíte adresu aplikace (výchozí http://127.0.0.1:5001), kde najdete logy skriptů a můžete manuálně spouštět již existující CDESK skripty.

Doporučuje se také spustit Docker kontejner pro čištění logů, aby se automaticky odstraňovaly logy starší než 7 dní. Z kořenového adresáře aplikace použijte příkaz: docker rm -f log-cleaner-container && docker build -t log-cleaner . && docker run -d –name log-cleaner-container -v „</cesta/k/logs>:/app/logs“ log-cleaner

kde </cesta/k/logs> je cesta k adresáři s logy (/logs) v kořenovém adresáři aplikace.

Poznámky k aplikaci

Tato aplikace bude přístupná pouze z lokálního počítače, na kterém byla spuštěna. Adresa aplikace bude vytištěna v konzoli, kde jste zadali příkaz python app.py, měla by to být localhost adresa s vámi zvoleným portem (127.0.0.1:<váš port>). Pokud bude s aplikací pracovat více lidí, doporučuje se spustit ji na nějakém serveru/virtuálním stroji.

Použití aplikace

Aplikace má 2 hlavní části – zobrazení logů a manuální spouštění skriptů. Po přejití na domovskou stránku aplikace (výchozí 127.0.0.1:5001) budete přesměrováni na /logs, kde se zobrazí logy skriptů. Pro manuální spuštění skriptů jděte na stránku /run-scripts. Pro jednodušší ovládání použijte navigační lištu v horní části stránky.

Logy skriptu

V aplikaci můžete nastavit různé filtry pro zobrazení pouze části logů. Mezi tyto filtry patří datum, typ zprávy, název skriptu a počet logů zobrazených na stránku.

Kdykoli se použije nový filtr nebo se přidají nové logy jiným skriptem, seznam logů by se měl znovu načíst stisknutím tlačítka „Filter“ pro uplatnění změn.

Manuální spuštění skriptu

Na této stránce aplikace můžete spustit kterýkoli existující kontejner se skriptem, jehož název začíná na ‚cdesk-script‘. Pokud je kontejner vypnutý, spustí se. V opačném případě, pokud již běží, spustí příkaz python3 /app/main.py v rámci kontejneru. Proto je důležité splnit tyto dvě podmínky, aby se vaše vlastní skripty zobrazily a správně spustily:

  • Název kontejneru začíná na ‚cdesk-script‘
  • Soubor pro spuštění skriptu se jmenuje ‚main.py‘