Добро пожаловать в документацию по m3_audit¶
Содержание:
Общее описание¶
Приложение, реализующее журналирование действий в m3 и прикладном приложении.
Установка¶
Пакет m3_audit подключается как приложение M3.
Установка с помощью pip¶
Установите пакет m3_audit из репозитория пакетов компании БАРС Груп
pip install m3-audit -i https://<PyPI_сервер_БАРС_Груп>
В этом случае будут установлены все необходимые пакеты.
Установка из архива¶
Скачайте и распакуйте архив модуля https://bitbucket.org/barsgroup/m3_audit/downloads
Установка из Mercurial¶
Клонируйте исходный код модуля из репозитория
hg clone https://bitbucket.org/barsgroup/m3_audit
Установка из каталога¶
python setup.py install
Настройка¶
Подключение пакета осуществляется в файле settings.py приложения. Необходимо добавить имя пакета в раздел INSTALLED_APPS.
INSTALLED_APPS = (
m3_audit,
)
Также необходимо добавить таблицы в СУБД. Если в Вашем проекте используется модуль South запустите команду:
python manage.py migrate m3_audit
В противном случае запустите команду:
python manage.py syncdb
Использование¶
В стандартной поставке модуля имеется возможность вести аудит:
- аудит таблиц системы:
- аудит данных в справочниках
- аудит авторизации пользователей
- аудит изменения прав пользователей
AuditManager и его использование¶
Данный менеджер обслуживает аудиты: регистрирует аудиты, записывает изменения в БД и возвращает данные аудита.
# регистрация аудита
AuditManager().register('model-changes', DefaultModelChangeAuditModel)
# запись аудита
AuditManager().write('model-changes', user=request.user)
# получение данных аудита
AuditManager().get('model-changes')
Пак действий модуля¶
Данный модуль имеет пакет действий, для просмтора аудита системы из бразуера, m3_audit.action.BaseAuditUIActions
Состав модуля¶
Исключения системы¶
-
exception
m3_audit.exceptions.DropM3AuditCacheException¶ Исключение, которое возникает при попытке сброса кеша, хранящего зарегистрированные типы аудита
-
exception
m3_audit.exceptions.M3AuditException¶ Некоторое исключение подсистемы аудита
-
exception
m3_audit.exceptions.NoWriteMethonInM3AuditException¶ Выбрасывается в случае, если при регистрации аудита у класса модели не найден
-
m3_audit.utils.js_audit_list_window(audit_pack, parent_window)¶ Возвращает js код, который может быть использован для показа окна с результатами аудита
Параметры: - audit_pack (
m3_audit.actions.BaseAuditUIActions) – пак аудита - parent_window (
m3.ui.ext.windows.ExtWindow) – родительское окно
- audit_pack (