Мониторинг

Доступные модули:

• audit - журнал аудита;
• log - запись сообщений в журнал;
• tracing - трассировка;
• metrics - метрики.

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

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

Параметры:

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

Возвращает

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

{#sandbox-audit_messages} warn(message) info(message) verbose(message) alarm(message)

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

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

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

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

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

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

  • строку
  • спецификаторы формата %d, %s или %q
  • таблицу
  • скалярный тип данных

Возвращает

nil

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

{#sandbox-log_messages} error(message) warn(message) info(message) verbose(message) debug(message)

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

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

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

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

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

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

  • строку
  • спецификаторы формата %d, %s или %q
  • таблицу
  • скалярный тип данных

Возвращает

nil

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

Параметры:

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

Возвращает

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

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

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

Параметры:

• name (string) — имя для span

Возвращает

object

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

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

Параметры:

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

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

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

Возвращает

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

Тип возвращаемого значения

counter_obj

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

Параметры:

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

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

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

Возвращает

объект gauge

Тип возвращаемого значения

gauge_obj

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

Параметры:

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

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

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

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

Возвращает

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

Тип возвращаемого значения

histogram_obj

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

Возвращает

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

Тип возвращаемого значения

table

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

Параметры:

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

Возвращает

нет

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

Параметры:

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

Возвращает

нет