Skip to main content

## Debuggie

Debuggie, это набор инструментов для сбора и анализа отладочной информации об функционировании удалённой системы.

Набор включает в себя:

  • Middleware, собирающую отладочную информацию

  • Viewie - CLI-утилиту, предназначенную для просмотра дампов отладочной информации

  • API для отладочного вывода информации из кода отлаживаемых приложений

### Установка

Пакет устанавливается стандартным способом:

pip install debuggie

Для работы пакета требуется `m3.core.json.M3JSONEncoder`

### Подключение

  1. В `settings.INSTALLED_APPS` добавляется приложение `"debuggie"`.

  2. В `settings.MIDDLEWARE_CLASSES` добавляется middleware `"debuggie.Debuggie"`.

  3. B “корневом”” `urls.py` добавляется `(r'^debug/', include('debuggie.urls')),`.

  4. Опционально в `settings.DEBUGGIE_SYSTEM_INFO_CALLBACK` указывается (строкой вида `"package.module.function"`) функция, предоставляющая информацию о системе.

Важно: Debuggie middleware должна добавляться после `SessionMiddleware` и `AuthenticationMiddleware`, т.к. зависит от них!

### Запись отладочной информации

  • Пользователь аутентифицируется в системе,

  • Указанием в адресной строке переходит на url `<some_host>/debug`

  • На открытой странице можно включать/выключать режим отладки, очистить дамп отладочной информации или загрузить его в виде `.txt`-файла.

При этом ссылки на загрузку и очистку дампа появятся после того, как пользователь:

  1. Включит отладочный режим

  2. Совершит в системе какие либо действия

  3. Обновит страницу отладочного режима.

### Просмотр файла дампа отладочной информации

Информация просматривается в терминале командой

viewie <dump_file.txt>

Программа просмотра работает в интерактивном режиме и содержит встроенную справку

Metadata

Release files for m3-debuggie 2.0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for m3-debuggie 2.0.8
File Size Uploaded
m3-debuggie-2.0.8.tar.gz 8.8 kB Details

Release files / m3-debuggie-2.0.8.tar.gz

Download URL m3-debuggie-2.0.8.tar.gz
Size 8.8 kB
Tags Source
SHA-256 checksum
How to use checksums
6d3f7b29c7c2a5d006f9d4077c54b72ff5df2d128d1e2302a0109025afc53551
BLAKE2b-256 checksum
How to use checksums
ba5c47019d519d17d9e9ee79ded7af2cc774f961e58627eaa0be4bd31aff521e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

2.0.8 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page