Мониторинг¶

audit¶

Доступно с версии 2.17.0. Модуль audit содержит функции для работы с журналом аудита (по аналогии с модулем Tarantool audit.

audit.new(module_name)¶

Создает новый регистратор журнала аудита (logger) с указанным именем. Доступно с версии 2.17.0.

Параметры

module_name (string) – имя регистратора журнала аудита

Результат

экземпляр регистратора журнала аудита

audit.warn(message)¶

audit.info(message)¶

audit.verbose(message)¶

audit.alarm(message)¶

Записывает событие в журнал аудита с указанным уровнем важности. Значение на выходе представляет собой строку в журнале, которая содержит:

• текущую метку времени

• название модуля

• обозначения „W“, „I“, „V“ или „A“ – в зависимости от вызванной функции

• содержимое аргумента message

Параметры

message (any) –

Сообщение в журнале. Аргумент message может содержать:

• строку

• спецификаторы формата %d, %s или %q

• таблицу

• скалярный тип данных

Результат

nil

log¶

Модуль log содержит функции для записи сообщений в журнал (по аналогии с модулем Tarantool log).

log.error(message)¶

log.warn(message)¶

log.info(message)¶

log.verbose(message)¶

log.debug(message)¶

Записывает сообщение в журнал с указанным уровнем детализации. Значение на выходе представляет собой строку в журнале, которая содержит:

• текущую метку времени

• название модуля

• обозначения „E“, „W“, „I“, „V“ или „D“ – в зависимости от вызванной функции

• содержимое аргумента message

Параметры

message (any) –

Сообщение в журнале. Аргумент message может содержать:

• строку

• спецификаторы формата %d, %s или %q

• таблицу

• скалярный тип данных

Результат

nil

log.new(module_name)¶

Создает новый регистратор журнала (logger) с указанным именем. Доступно с версии 2.17.0.

Параметры

module_name (string) – имя регистратора журнала

Результат

экземпляр регистратора журнала

tracing¶

Модуль tracing содержит функцию трассировки.

tracing.start_span(name, ...)¶

Начинает span (основной блок трассировки в распределенных системах) и возвращает специальный объект. Для завершения трассировки выполнения функции используется метод finish возвращаемого объекта.

Параметры

name (string) – имя для span

Результат

object

metrics¶

Функции из модуля metrics. Узнать больше о метриках в TDG можно из раздела Мониторинг в руководстве администратора.

metrics.counter(name[, help, metainfo])¶

Регистрирует новый монотонно возрастающий счетчик.

Параметры

• name (string) – имя счетчика

• help (string) – описание счетчика

• metainfo (table) – метаинформация счетчика

Результат

объект счетчика

Тип результата

counter_obj

metrics.gauge(name[, help, metainfo])¶

Регистрирует новую метрику для числовых значений. Такие значения могут как возрастать, так и убывать.

Параметры

• name (string) – имя метрики типа gauge

• help (string) – описание метрики типа gauge

• metainfo (table) – метаинформация метрики типа gauge

Результат

объект gauge

Тип результата

gauge_obj

metrics.histogram(name[, help, metainfo])¶

Регистрирует новую гистограмму. Гистограмма – выборка из некоторого количества значений. Тип histogram подсчитывает полученные значения и объединяет их в настраиваемые бакеты (buckets).

Параметры

• name (string) – имя гистограммы

• help (string) – описание гистограммы

• buckets (table) – бакеты гистограммы (массив сортированных неотрицательных чисел)

• metainfo (table) – метаинформация гистограммы

Результат

объект гистограммы

Тип результата

histogram_obj

metrics.get_labels()¶

Получает метки текущего экземпляра. Доступно с версии 2.17.0.

Результат

карта пар ключ-значение, где ключ – название метки экземпляра, значение – значение метки

Тип результата

table

metrics.register_callback(callback)¶

Регистрирует обратный вызов, который будет вызываться непосредственно перед сбором метрик при экспорте плагина. Доступно с версии 2.18.0. В целях повышения производительности количество обратных вызовов, которые может зарегистрировать пользователь, ограничено 128.

Параметры

name (string) – функция без параметров

Результат

нет

metrics.unregister_callback(callback)¶

Снимает регистрацию обратного вызова, который вызывается непосредственно перед сбором метрик при экспорте плагина. Доступно с версии 2.18.0. В целях повышения производительности количество обратных вызовов, которые может зарегистрировать пользователь, ограничено 128.

Параметры

name (string) – функция без параметров

Результат

нет