CDESK APLIKACJA LOGUJĄCA
DO SKRYPTÓW(WERSJA DOCKER)
Przegląd
Ta aplikacja zapewnia wizualizację logów ze skryptów CDESK oraz graficzny interfejs do ich ręcznego uruchamiania. Logi skryptów można filtrować według daty, typu komunikatu (na przykład INFO, WARNING, ERROR…) oraz skryptu źródłowego. Częścią tego katalogu jest również cron do usuwania logów starszych niż 7 dni.
Pliki i katalogi
app.py
Ten plik zawiera aplikację, w której zdefiniowane są punkty końcowe i funkcjonalność do wyświetlania i filtrowania logów, a także ręcznego uruchamiania skryptów.
templates
Katalog z różnymi stronami aplikacji.
logs
Katalog zawierający logi. Logi są podzielone według daty utworzenia. Na przykład plik logu dla daty 11.01.2021 będzie wyglądał jak 2021-01-11.log. Program potrafi jednak przetworzyć wszystkie pliki logów z rozszerzeniem .log.
Dockerfile
Ten Dockerfile jest potrzebny do skonfigurowania kontenera do czyszczenia logów, aby usuwać logi starsze niż 7 dni. Ta zalecana funkcjonalność usunie starsze logi skryptów i zwolni tym samym zajętą pamięć.
Ustawienia i konfiguracja
Python
Do uruchomienia tej aplikacji potrzebujesz mieć zainstalowany Python na swoim komputerze/serwerze. Zalecana jest nowsza wersja, na przykład 3.11 lub 3.12.
Adres i port aplikacji
Domyślny adres tej aplikacji to localhost (127.0.0.1) z portem 5001. Port można zmienić w pliku app.py, na samym jego końcu, gdzie aplikacja jest inicjalizowana.
Kroki ustawienia
- W katalogu głównym tej aplikacji (gdzie znajduje się app.py) utwórz nowe środowisko wirtualne (python -m venv .venv) i aktywuj je (.venv\Scripts\activate dla Windows, source .venv/bin/activate dla macOS i Linux).
- Uruchom pip install -r requirements.txt, aby zainstalować wszystkie potrzebne zależności dla tej aplikacji.
- Uruchom python app.py, aby uruchomić tę aplikację. W terminalu zobaczysz adres aplikacji (domyślnie http://127.0.0.1:5001), gdzie znajdziesz logi skryptów i możesz ręcznie uruchamiać już istniejące skrypty CDESK.
Zaleca się również uruchomienie kontenera Docker do czyszczenia logów, aby automatycznie usuwać logi starsze niż 7 dni. Z katalogu głównego aplikacji użyj polecenia: 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
gdzie </cesta/k/logs> to ścieżka do katalogu z logami (/logs) w katalogu głównym aplikacji.
Uwagi do aplikacji
Ta aplikacja będzie dostępna tylko z lokalnego komputera, na którym została uruchomiona. Adres aplikacji zostanie wydrukowany w konsoli, w której wpisałeś polecenie python app.py, powinien to być adres localhost z wybranym przez Ciebie portem (127.0.0.1:<twój port>). Jeśli z aplikacją będzie pracować więcej osób, zaleca się uruchomienie jej na jakimś serwerze/maszynie wirtualnej.
Użycie aplikacji
Aplikacja ma 2 główne części – wyświetlanie logów i ręczne uruchamianie skryptów. Po przejściu na stronę główną aplikacji (domyślnie 127.0.0.1:5001) zostaniesz przekierowany na /logs, gdzie wyświetlą się logi skryptów. Aby ręcznie uruchomić skrypty, przejdź na stronę /run-scripts. Dla łatwiejszej obsługi użyj paska nawigacyjnego w górnej części strony.
Logi skryptu
W aplikacji możesz ustawić różne filtry, aby wyświetlić tylko część logów. Do tych filtrów należą data, typ komunikatu, nazwa skryptu i liczba logów wyświetlanych na stronę.
Za każdym razem, gdy zostanie zastosowany nowy filtr lub gdy inny skrypt doda nowe logi, lista logów powinna zostać ponownie załadowana poprzez naciśnięcie przycisku „Filter”, aby zastosować zmiany.
Ręczne uruchomienie skryptu
Na tej stronie aplikacji możesz uruchomić dowolny istniejący kontener ze skryptem, którego nazwa zaczyna się od 'cdesk-script’. Jeśli kontener jest wyłączony, zostanie uruchomiony. W przeciwnym razie, jeśli już działa, uruchomi polecenie python3 /app/main.py w ramach kontenera. Dlatego ważne jest spełnienie tych dwóch warunków, aby Twoje własne skrypty zostały wyświetlone i poprawnie uruchomione:
- Nazwa kontenera zaczyna się od 'cdesk-script’
- Plik do uruchomienia skryptu nazywa się 'main.py’
