Логирование медленных запросов для функций и CRUD-запросов¶

В этом руководстве описано, как настроить запись медленных запросов в журнал для функций и CRUD-запросов. Подробнее о модуле slow_log можно узнать в разделе Логирование медленных запросов.

Руководство включает следующие шаги:

Пререквизиты
Используемые файлы
Запуск стенда
Включение журнала медленных запросов
Запись CRUD-запросов в журнал
Логирование пользовательской функции
Остановка стенда

Пререквизиты¶

Для выполнения примера требуются:

установленный Docker-образ Tarantool DB;
приложение Docker Compose;
утилита tt CLI;
исходные файлы примера slow_log.
Примечание

Есть два способа получить исходные файлы примера:
- Архив с полной документацией Tarantool DB, полученный по почте или скачанный в личном кабинете tarantool.io. Пример архива: tarantooldb-documentation-3.0.0.tar.gz. Пример slow_log расположен в таком архиве в директории ./doc/examples/slow_log/.
- Отдельный архив slow_log.tar.gz, скачанный c сайта Tarantool.

Используемые файлы¶

Для запуска и настройки кластера используются файлы из папки slow_log:

cluster/ – директория c файлами для запуска кластера Tarantool DB:
- config.yml – конфигурация и топология кластера;
- docker-compose.yml – описание узлов кластера Tarantool DB;
- migrations/scenario – директория, содержащая файлы с описанием миграций;
tools/ – директория с файлами для запуска кластера etcd и TCM:
- docker-compose.yml – описание узлов кластера etcd;
- tcm.yml – конфигурация для запуска Tarantool Cluster Manager.

Запуск стенда¶

Для успешного запуска должны быть свободны следующие порты:

2379
3301–3308
8081

Перейдите в директорию примера slow_log:

cd ./doc/examples/slow_log/

Запустите стенд Tarantool DB:

make start

Команда развернет стенд, состоящий из:

кластера Tarantool DB:
- 2 роутера;
- 2 набора реплик по 3 хранилища;
кластера etcd из 3 узлов;
1 Tarantool Cluster Manager (TCM).

После запуска должны работать все контейнеры, кроме init_host.

Также после запуска кластера становится доступен веб-интерфейс TCM. Для входа в TCM откройте в браузере адрес http://localhost:8081. Логин и пароль для входа:

Username: admin
Password: secret

В TCM откройте вкладку Stateboard. Выберите в наборе реплик router-msk узел router-msk и в открывшемся окне перейдите на вкладку Terminal. Во вкладке Terminal проверьте наличие спейса data:

box.space

Спейс data должен присутствовать в выводе, он создается при запуске кластера.

Роль slow_log задана на роутере. Чтобы проверить это, перейдите в выбранном роутере на вкладку Details. Видно, что в поле roles заданы роли roles.crud-router и app.roles.slow_log.

Включение журнала медленных запросов¶

Чтобы включить логирование медленных запросов:

В TCM перейдите на вкладку Configuration.
В секции конфигурации roles_cfg замените enable: false на enable: true:
```
roles_cfg:
  app.roles.slow_log:
    enable: true # <--
```
Нажмите кнопку Apply.

Запись CRUD-запросов в журнал¶

В примере данные хранятся в спейсе data, который имеет следующий формат:

box.schema.space.create('data', {if_not_exists = true})
box.space.data:format({
    { name = 'id', type = 'number' },
    { name = 'bucket_id', type = 'unsigned' },
    { name = 'data', type = 'any' },
})
box.space.data:create_index('pk', { parts = {'id'}, if_not_exists = true})
box.space.data:create_index('bucket_id', { parts = {'bucket_id'}, unique = false, if_not_exists = true})

Чтобы начать работу с базой данных через интерактивную консоль Tarantool, нужно подключиться к узлу кластера. Сделать это можно двумя способами:

в веб-интерфейсе TCM;
в терминале с помощью утилиты tt CLI:
```
tt connect admin:secret-cluster-cookie@localhost:3301
```

Подключитесь к роутеру, используя первый способ – через TCM. Для этого:

Перейдите на вкладку Stateboard.
Нажмите на набор реплик router-msk.
Выберите узел router-msk и в открывшемся окне перейдите на вкладку Terminal.

На вкладке Terminal добавьте кортеж в спейс data, используя функцию из модуля CRUD:

require('crud').replace("data", {1, box.NULL, {}})

Вернитесь в локальный терминал и просмотрите логи приложения:

cd cluster
docker compose logs tarantool-router-msk | grep 'Function call crud'
cd ..

Запись в логе может выглядеть так:

tarantool-router-msk-1  | 2025-02-05 11:17:23.203 [1] main/231/main/app.roles.slow_log slow_log.lua:21
I> Function call crud.replace(["data",[1,null,[]]]) was too long: 0.000s

Логирование пользовательской функции¶

В примере создана персистентная функция app.wait_for, которая ждет заданное количество секунд:

box.schema.func.create('app.wait_for',  {
    language = 'LUA',
    if_not_exists = true,
    body = [[
        function(sleep_time)
            local log = require('log')
            local fiber = require('fiber')
            log.info("start wait_for " .. sleep_time)
            fiber.sleep(sleep_time)
            log.info("stop wait_for " .. sleep_time)
        end
    ]],
})

Чтобы включить запись в журнал для функции app.wait_for, обновите секцию app.roles.slow_log в файле конфигурации:

roles_cfg:
  app.roles.slow_log:
    enable: true
    threshold: 3
    namespaces:
      - app

В TCM на вкладке Stateboard выберите роутер router-msk и подключитесь к нему, открыв вкладку Terminal.

Во вкладке Terminal вызовите функцию app.wait_for, задав для нее значение в 3 секунды:

box.schema.func.call('app.wait_for', 3)