Welcome to m3_logview’s documentation!¶
Описание¶
Приложение предназначено для запроса у веб-сервера всех лог файлов, лежащих в директории, прописанной в settings.LOG_PATH, и просмотра сожержимого этих файлов!
Подключение¶
Для подключения необходимо:
добавить в settings.py -> installed_apps -> 'm3.contrib.logview'
импортировать from m3.contrib.logview.actions import LogsAction as m3_logs_action.
Содержимое модуля¶
m3_logview.actions¶
Created on 24.08.2010
@author: kir
- class m3_logview.actions.GetLogsAction¶
Получает файл логирования, имя которого приходит в контексте. Возвращает m3.ui.actions.results.PreJsonResult, которому передается словарь {‘rows’: список содержимого файла, ‘total’: длина этого списка}
Параметры: - request – параметры запроса
- context (m3.ui.actions.context.ActionContext) – контекст запроса
- class m3_logview.actions.LogsAction¶
Возвращает окно m3.ui.actions.results.ExtUIScriptResult Выводит наименование имеющихся файлов логирования
Параметры: - request – параметры запроса
- context (m3.ui.actions.context.ActionContext) – контекст запроса
- class m3_logview.actions.LogsDateChangeAction¶
Получает список лог файлов, дата создания которых лежит между параметрами start_date и end_date, которые приходят в контексте. Возвращает m3.ui.actions.results.PreJsonResult, которому передается список списков, состоящих из индекса и имя файла.
Параметры: - request – параметры запроса
- context (m3.ui.actions.context.ActionContext) – контекст запроса
- class m3_logview.actions.Mis_Admin_ActionsPack¶
Набор действий для работы с административной панелью
m3_logview.helpers¶
Created on 25.10.2010
@author: kir
- m3_logview.helpers.ERROR = u'error.log'¶
Часть имени файла ошибки, нужно для функции парсинга m3_logview.helpers.log_file_parse
- m3_logview.helpers.file_creation_time(full_path)¶
Возвращает дату и время создания лог файла. Время создания файла st_ctime, st_mtime - зависит от операционной системы: для юниксов содержит дату последнего изменения метаданных, а для виндов - дату создания файла.
Параметры: full_path (str) – полный путь до лог файла
- m3_logview.helpers.get_log_content(filename)¶
Возвращает список словарей, в которых лежит распарсенное содержимое файла filename, лежащего в директории логов.
Параметры: filename (str) – название файла логирования
- m3_logview.helpers.log_file_parse(log_file)¶
Функция парсинга файлов логирования. Возвращает список из словарей: в случае, если файл error.log, то [{‘date’: ..., ‘message’:..., ‘full’:...}], иначе [{‘date’: ..., ‘message’:...}], где date-дата события, message-сообщение события, full-полный текст ошибки.
Параметры: log_file (file) – лог файл
- m3_logview.helpers.log_files_list(start_date_str=None, end_date_str=None, to_email=None)¶
Возвращает список списков вида [индекс, файл], где индекс - порядковый номер, файл - файл логирования из директории, заданной в settings.LOG_PATH. Если заданы start_date_str и end_date_str, то берутся те файлы, дата создания которых лежит между этими параметрами. Если эти эти параметры не заданы, то берутся сегодняшние файлы и файлы с расширением .log. Требует администраторские права.
Параметры: - start_date_str (str) – дата начала фильтрации
- end_date_str (str) – дата окончания фильтрации
Примеры:¶
Пример использования в панели(TOPTOOLBAR), пункт меню в администрировании
admin_root.subitems.append(DesktopLauncher(name = u'Система логирования', url=m3_logs_action.absolute_url()))
Окно нашего модуля:
