log-analyzer-cli 0.2.0

Cервис, формирующий статистический отчет на основании парсинга логов

log_analyzer

Cервис для формирования статистических отчетов на основе парсинга логов NGINX.

• GitHub | PyPI | Documentation
• Created by setter | GitHub @rustruber | PyPI @setter

Функции

• Парсинг access-логов NGINX
• Расчет ключевых метрик: количество запросов, среднее время, медиана, 95-й персентиль
• Выявление «подозрительных» URL по времени ответа
• CLI-интерфейс на Typer
• (TODO) Экспорт в JSON / CSV
• (TODO) Фильтрация по временному диапазону

Установка

pip install log-analyzer-cli

Использование

Опции

log_analyzer --help

с конфигом по-умолчанию

log_analyzer

Файл конфига, как пример (config.toml):

REPORT_SIZE = 10
REPORT_DIR = "./reports"
TEMPLATE_PATH = "./templates/report.html"
LOG_DIR = "./logs"
LOG_PATTERN = 'nginx_access_ui\.log_(\d{8})-\d{6}-[a-f0-9]+(?:\.gz)?$'

с конфигом при запуске в консоли

log_analyzer --config /путь/к/файлу.toml

Документация

Документация собирается с помощью Zensical и автоматически публикуется на GitHub Pages.

• Сайт документации

Локальный предпросмотр: just docs-serve (http://localhost:8000)

Сборка: just docs-build

API-документация генерируется автоматически из docstring-функций с помощью mkdocstrings.

Примечание для maintainer'а: Для автоматической публикации документации перейдите в Settings → Pages вашего репозитория и установите источник GitHub Actions.

Разработка

Подготовка окружения

Клонируйте репозиторий

git clone [e-mail]:rustruber/log_analyzer.git
cd log_analyzer

Синхронизируйте зависимости

uv sync

Поднять виртуальное окружение

Если работаете в PyCharm не забудьте переключить интерпретатор на нужную версию python в директории .venv/bin

source .venv/bin/activate

Установка в режиме разработки (editable)

После этого команда log_analyzer станет доступна глобально, а любые изменения в коде будут подхватываться сразу.

uv pip install -e .

Проверка качества кода

Эта команда запускает форматирование (ruff format), линтинг (ruff check), проверку типов (ty) и тесты (pytest).

just qa

Команды для разработки

Команда	Что делает
just qa	Полная проверка (форматирование, линтинг, типы, тесты)
just test	Запустить тесты
just docs-serve	Посмотреть документацию локально
just build	Собрать пакет
just type-check	Проверить типы

Запуск тестов

uv run pytest

Лицензия

MIT License

Проект создан в 2026 году.