CDESK LOGOVACIA APLIKÁCIA
K SKRIPTOM(DOCKER VERZIA)

Obsah stránky

Prehľad

Táto aplikácia poskytuje vizualizáciu logov zo skriptov CDESK a grafické rozhranie na ich manuálne spustenie. Logy skriptov je možné filtrovať podľa dátumu, typu správy (napríklad INFO, WARNING, ERROR…) a zdrojového skriptu. Súčasťou tohto adresára je aj cron na mazanie logov starších ako 7 dní.

Súbory a adresáre

app.py

Tento súbor obsahuje aplikáciu, v ktorej sú definované koncové body a funkcionalita na zobrazenie a filtrovanie logov, ako aj manuálne spustenie skriptov.

templates

Adresár s rôznymi stránkami aplikácie.

logs

Adresár obsahujúci logy. Logy sú rozdelené podľa dátumu vytvorenia. Napríklad log súbor pre dátum 11.01.2021 bude vyzerať ako 2021-01-11.log. Program však dokáže spracovať všetky log súbory s príponou .log.

Dockerfile

Tento Dockerfile je potrebný na nastavenie kontajnera pre čistenie logov, aby sa odstránili logy staršie ako 7 dní. Táto odporúčaná funkcionalita odstráni staršie logy skriptov a uvoľní tak obsadenú pamäť.

Nastavenia a konfigurácia

Python

Na spustenie tejto aplikácie potrebujete mať nainštalovaný Python na vašom PC/serveri. Odporúča sa novšia verzia, napríklad 3.11 alebo 3.12.

Adresa a port aplikácie

Predvolená adresa tejto aplikácie je localhost (127.0.0.1) s portom 5001. Port je možné zmeniť v súbore app.py, úplne na jeho konci, kde sa aplikácia inicializuje.

Kroky nastavenia
  1. V koreňovom adresári tejto aplikácie (kde sa nachádza app.py) vytvorte nové virtuálne prostredie (python -m venv .venv) a aktivujte ho (.venv\Scripts\activate pre Windows, source .venv/bin/activate pre macOS a Linux).
  2. Spustite pip install -r requirements.txt na inštaláciu všetkých potrebných závislostí pre túto aplikáciu.
  3. Spustite python app.py na spustenie tejto aplikácie. V termináli uvidíte adresu aplikácie (predvolene http://127.0.0.1:5001), kde nájdete logy skriptov a môžete manuálne spúšťať už existujúce CDESK skripty.

Odporúča sa tiež spustiť Docker kontajner na čistenie logov, aby sa automaticky odstraňovali logy staršie ako 7 dní. Z koreňového adresára aplikácie použite prí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áru s logmi (/logs) v koreňovom adresári aplikácie.

Poznámky k aplikácii

Táto aplikácia bude prístupná iba z lokálneho počítača, na ktorom bola spustená. Adresa aplikácie bude vytlačená v konzole, kde ste zadali príkaz python app.py, mala by to byť localhost adresa s vami zvoleným portom (127.0.0.1:<váš port>). Ak bude s aplikáciou pracovať viac ľudí, odporúča sa spustiť ju na nejakom serveri/virtuálnom stroji.

Použitie aplikácie

Aplikácia má 2 hlavné časti – zobrazenie logov a manuálne spúšťanie skriptov. Po prejdení na domovskú stránku aplikácie (predvolene 127.0.0.1:5001) budete presmerovaní na /logs, kde sa zobrazia logy skriptov. Na manuálne spustenie skriptov choďte na stránku /run-scripts. Pre jednoduchšie ovládanie použite navigačnú lištu v hornej časti stránky.

Logy skriptu

V aplikácii môžete nastaviť rôzne filtre na zobrazenie iba časti logov. Medzi tieto filtre patria dátum, typ správy, názov skriptu a počet logov zobrazených na stránku.


Kedykoľvek sa použije nový filter alebo sa pridajú nové logy iným skriptom, zoznam logov by sa mal znova načítať stlačením tlačidla „Filter“ na uplatnenie zmien.

Manuálne spustenie skriptu

Na tejto stránke aplikácie môžete spustiť ktorýkoľvek existujúci kontajner so skriptom, ktorého názov sa začína na ‚cdesk-script‘. Ak je kontajner vypnutý, spustí sa. V opačnom prípade, ak už beží, spustí príkaz python3 /app/main.py v rámci kontajnera. Preto je dôležité splniť tieto dve podmienky, aby sa vaše vlastné skripty zobrazili a správne spustili:

  • Názov kontajnera sa začína na ‚cdesk-script‘
  • Súbor na spustenie skriptu sa volá ‚main.py‘