hs.logger

Простой логгер для отладки

Примечание: "методы" в этом модуле на самом деле являются "статическими" функциями - см. hs.logger.new()

Обзор API

Переменные - Настраиваемые значения

defaultLogLevel

Функции - API-вызовы, предлагаемые непосредственно расширением

history
historySize
new
printHistory
setGlobalLogLevel
setModulesLogLevel

Поля - Переменные, к которым можно получить доступ только из объекта, возвращаемого конструктором

level

Методы - API-вызовы, которые можно выполнить только на объекте, возвращаемом конструктором

d
df
e
ef
f
getLogLevel
i
setLogLevel
v
vf
w
wf

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

Переменные

defaultLogLevel

Подпись	`hs.logger.defaultLogLevel`
Тип	Переменная
Описание	Уровень логгирования по умолчанию для новых экземпляров логгера.
Источник	extensions/logger/logger.lua строка 203

Функции

history

Подпись	`hs.logger.history() -> list of log entries`
Тип	Функция
Описание	Возвращает глобальную историю логгирования
Параметры	Никаких
Возвращаемое значение	список (максимум `hs.logger.historySize()`) записей логгирования, созданных всеми экземплярами логгера в хронологическом порядке; каждая запись — таблица со следующими полями: time — метка времени в секундах с момента эпохи level — число от 1 (ошибка) до 5 (подробно) id — строка, содержащая идентификатор экземпляра логгера, который создал эту запись message — строка, содержащая записанное сообщение
Источник	extensions/logger/logger.lua строка 94

historySize

Подпись	`hs.logger.historySize([size]) -> number`
Тип	Функция
Описание	Устанавливает или получает размер глобальной истории логгирования
Параметры	size — (необязательно) желаемое количество записей логгирования, которые нужно сохранить в истории; если опущено, вернёт текущий размер; начальное значение равно 0 (отключено)
Возвращаемое значение	текущий или новый размер истории
Примечания	если вы измените размер истории (кроме 0) после создания любых экземпляров логгера, возможно, что-то сломается
Источник	extensions/logger/logger.lua строка 69

new

Подпись	`hs.logger.new(id, loglevel) -> logger`
Тип	Функция
Описание	Создаёт новый экземпляр логгера
Параметры	id — строковый идентификатор экземпляра (обычно имя модуля) loglevel — (необязательно) может быть 'ничего', 'ошибка', 'предупреждение', 'информация', 'отладка' или 'подробно', или соответствующее число от 0 до 5; использует `hs.logger.defaultLogLevel` если опущено
Возвращаемое значение	новый экземпляр логгера
Примечания	экземпляр логгера, созданный этим методом, не является обычным объектом, а представляет собой обычную таблицу со "статическими" функциями; поэтому не используйте синтаксис с двоеточием для так называемых "методов" в этом модуле (как в `mylogger.setLogLevel(3)`); вместо этого используйте обычный синтаксис точки: `mylogger.setLogLevel(3)` Пример: local log = hs.logger.new('mymodule','debug') log.i('Initializing') -- will print "[mymodule] Initializing" to the console```
Источник	extensions/logger/logger.lua строка 211

printHistory

Подпись	`hs.logger.printHistory([entries[, level[, filter[, caseSensitive]]]])`
Тип	Функция
Описание	Выводит глобальную историю логгирования в консоль
Параметры	entries — (необязательно) максимальное количество записей для вывода; если опущено, выводятся все записи из истории level — (необязательно) желаемый уровень логгирования (см. `hs.logger.setLogLevel()`); если опущено, по умолчанию `verbose` filter — (необязательно) строка для фильтрации записей (по идентификатору логгера или сообщению) с помощью `string.find` простого совпадения caseSensitive — (необязательно) если true, фильтрация чувствительна к регистру
Возвращаемое значение	Никаких
Источник	extensions/logger/logger.lua строка 139

setGlobalLogLevel

Подпись	`hs.logger.setGlobalLogLevel(lvl)`
Тип	Функция
Описание	Устанавливает уровень логгирования для всех экземпляров логгера (включая логгеры объектов).
Параметры	lvl
Возвращаемое значение	Никаких
Источник	extensions/logger/logger.lua строка 30

setModulesLogLevel

Подпись	`hs.logger.setModulesLogLevel(lvl)`
Тип	Функция
Описание	Устанавливает уровень логгирования для всех загруженных в настоящее время модулей
Параметры	lvl
Возвращаемое значение	Никаких
Примечания	Эта функция влияет только на логгеры уровня модуля, экземпляры объектов со своими логгерами (например, windowfilters) не будут затронуты; вы можете использовать `hs.logger.setGlobalLogLevel()` для них
Источник	extensions/logger/logger.lua строка 46

Поля

level

Подпись	`hs.logger.level`
Тип	Поле
Описание	Уровень логгирования экземпляра логгера, как число от 0 до 5
Источник	extensions/logger/logger.lua строка 285

Методы

d

Подпись	`hs.logger.d(...)`
Тип	Метод
Описание	Записывает отладочную информацию в консоль
Параметры	… — одна или несколько строк сообщений
Возвращаемое значение	Никаких
Источник	extensions/logger/logger.lua строка 352

df

Подпись	`hs.logger.df(fmt,...)`
Тип	Метод
Описание	Записывает отформатированную отладочную информацию в консоль
Параметры	fmt — строка форматирования по string.format … — аргументы к fmt
Возвращаемое значение	Никаких
Источник	extensions/logger/logger.lua строка 362

e

Подпись	`hs.logger.e(...)`
Тип	Метод
Описание	Записывает ошибку в консоль
Параметры	… — одна или несколько строк сообщений
Возвращаемое значение	Никаких
Источник	extensions/logger/logger.lua строка 289

ef

Подпись	`hs.logger.ef(fmt,...)`
Тип	Метод
Описание	Записывает отформатированную ошибку в консоль
Параметры	fmt — строка форматирования по string.format … — аргументы к fmt
Возвращаемое значение	Никаких
Источник	extensions/logger/logger.lua строка 299

f

Подпись	`hs.logger.f(fmt,...)`
Тип	Метод
Описание	Записывает отформатированную информацию в консоль
Параметры	fmt — строка форматирования по string.format … — аргументы к fmt
Возвращаемое значение	Никаких
Источник	extensions/logger/logger.lua строка 341

END_OF_DOCUMENT_MARKER

getLogLevel

Подпись	`hs.logger.getLogLevel() -> number`
Тип	Метод
Описание	Получает уровень ведения журнала для экземпляра логгера
Параметры	Нет
Возвращаемое значение	Уровень ведения журнала этого логгера в виде числа от 0 до 5
Источник	extensions/logger/logger.lua строка 275

i

Подпись	`hs.logger.i(...)`
Тип	Метод
Описание	Выводит информацию в консоль
Параметры	... - одна или несколько строк сообщений
Возвращаемое значение	Нет
Источник	extensions/logger/logger.lua строка 331

setLogLevel

Подпись	`hs.logger.setLogLevel(loglevel)`
Тип	Метод
Описание	Устанавливает уровень ведения журнала для экземпляра логгера
Параметры	loglevel - может быть 'nothing', 'error', 'warning', 'info', 'debug', или 'verbose'; или соответствующее число от 0 до 5
Возвращаемое значение	Нет
Источник	extensions/logger/logger.lua строка 265

v

Подпись	`hs.logger.v(...)`
Тип	Метод
Описание	Выводит подробную информацию в консоль
Параметры	... - одна или несколько строк сообщений
Возвращаемое значение	Нет
Источник	extensions/logger/logger.lua строка 373

vf

Подпись	`hs.logger.vf(fmt,...)`
Тип	Метод
Описание	Выводит отформатированную подробную информацию в консоль
Параметры	fmt - строка форматирования по аналогии с string.format ... - аргументы для fmt
Возвращаемое значение	Нет
Источник	extensions/logger/logger.lua строка 383

w

Подпись	`hs.logger.w(...)`
Тип	Метод
Описание	Выводит предупреждение в консоль
Параметры	... - одна или несколько строк сообщений
Возвращаемое значение	Нет
Источник	extensions/logger/logger.lua строка 310

wf

Подпись	`hs.logger.wf(fmt,...)`
Тип	Метод
Описание	Выводит отформатированное предупреждение в консоль
Параметры	fmt - строка форматирования по аналогии с string.format ... - аргументы для fmt
Возвращаемое значение	Нет
Источник	extensions/logger/logger.lua строка 320