Cервис Task tool
Сервис Task tool использует набор конфигурационных переменных, которые определяют его поведение, параметры подключения к базе данных, RabbitMQ, Flower и auth-сервису, а также параметры публикации API и интеграции с Sentry.
Порядок применения значений
Значение каждой переменной определяется в следующем порядке приоритета:
- значение, сохранённое через UI — для переменных, доступных к изменению в интерфейсе;
- переменная окружения или значение из
.env; - значение по умолчанию, заданное в коде сервиса.
Таким образом:
- если параметр был изменён в UI, используется именно это значение;
- если параметр не задан в UI, используется значение из переменных среды;
- если и оно отсутствует, применяется значение по умолчанию.
- Переменные, достпные в UI
- Скрытые переменные
Переменные раздела API
ACCESS_LOG_LEVEL
- Переменная среды:
TASK_TOOL_ACCESS_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования доступа к API.
Переменные раздела Sentry
PROFILE
- Переменная среды:
TASK_TOOL_PROFILE- Тип: булево значение
- По умолчанию:
False - Описание: включает профилирование через Sentry.
Скрытые переменные сервиса Task tool
Следующие переменные используются сервисом Task tool, но не отображаются в UI.
Их можно изменить только через .env-файлы.
Настройки подключения к PostgreSQL
POSTGRES_SCHEMA
- Переменная среды:
TASK_TOOL_POSTGRES_SCHEMA - Тип: строка
- По умолчанию:
task_tool - Описание: схема PostgreSQL, используемая сервисом Task tool.
POSTGRES_POOL
- Переменная среды:
TASK_TOOL_POSTGRES_POOL - Тип: булево значение
- По умолчанию:
True - Описание: включает использование пула соединений PostgreSQL.
POSTGRES_POOL_SIZE
- Переменная среды:
TASK_TOOL_POSTGRES_POOL_SIZE - Тип: целое число
- По умолчанию:
2 - Описание: размер пула соединений PostgreSQL.
POSTGRES_POOL_OVERFLOW
- Переменная среды:
TASK_TOOL_POSTGRES_POOL_OVERFLOW - Тип: целое число
- По умолчанию:
3 - Описание: количество дополнительных соединений сверх размера пула.
Общие параметры сервиса
RABBITMQ_API_PREFIX
- Переменная среды:
RABBITMQ_API_PREFIX - Тип: строка
- По умолчанию:
/api - Описание: префикс API RabbitMQ.
PROJECT_NAME
- Переменная среды:
TASK_TOOL_PROJECT_NAME - Тип: строка
- По умолчанию:
TASK-TOOL - Описание: имя сервиса.
PROJECT_DESCRIPTION
- Переменная среды:
TASK_TOOL_PROJECT_DESCRIPTION - Тип: строка
- По умолчанию:
Сервис TASK_TOOL - Описание: описание сервиса.
USE_CONTAINER_IP_FOR_BIND
- Переменная среды:
TASK_TOOL_USE_CONTAINER_IP_FOR_BIND - Тип: булево значение
- По умолчанию:
True - Описание: использовать IP контейнера для bind-адреса сервиса.
BIND_HOST
- Переменная среды:
TASK_TOOL_BIND_HOST - Тип: строка
- По умолчанию: пустое значение
- Описание: адрес, на котором сервис принимает входящие подключения.
BIND_PORT
- Переменная среды:
TASK_TOOL_BIND_PORT - Тип: целое число
- По умолчанию:
8007 - Описание: порт входящих подключений сервиса.
ROOT_PATH
- Переменная среды:
TASK_TOOL_ROOT_PATH - Тип: строка
- По умолчанию:
/api/task_tool - Описание: корневой путь публикации API сервиса.
DOCS_PREFIX
- Переменная среды:
TASK_TOOL_DOCS_PREFIX - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации документации сервиса.
WORKERS
- Переменная среды:
TASK_TOOL_WORKERS - Тип: целое число
- По умолчанию:
1 - Описание: количество worker-процессов сервиса.
DEBUG
- Переменная среды:
TASK_TOOL_DEBUG - Тип: булево значение
- По умолчанию:
False - Описание: режим отладки.
SHOW_DEBUG_SETTING
- Переменная среды:
TASK_TOOL_SHOW_DEBUG_SETTING - Тип: булево значение
- По умолчанию:
False - Описание: управляет отображением debug-настроек.
RELOAD
- Переменная среды:
TASK_TOOL_RELOAD - Тип: булево значение
- По умолчанию:
False - Описание: включает автоматическую перезагрузку сервиса при изменении кода.
LOG_LEVEL
- Переменная среды:
TASK_TOOL_LOG_LEVEL - Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования.
EVENT_HANDLING
- Переменная среды:
TASK_TOOL_EVENT_HANDLING - Тип: булево значение
- По умолчанию:
True - Описание: включает обработку событий внутри сервиса.
STATIC_PATH
- Переменная среды:
TASK_TOOL_STATIC_PATH - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации статических файлов.
STATIC_DIR
- Тип: строка
- По умолчанию:
static - Описание: директория статических файлов сервиса.
Внутренние адреса сервисов
AUTH_HOST
- Переменная среды:
AUTH_HOST - Тип: строка
- По умолчанию:
auth - Описание: внутренний адрес auth-сервиса.
AUTH_PORT
- Переменная среды:
AUTH_PORT - Тип: целое число
- По умолчанию:
8001 - Описание: внутренний порт auth-сервиса.
AUTH_VERSION_PREFIX
- Переменная среды:
AUTH_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API auth-сервиса.
FLOWER_HOST
- Переменная среды:
FLOWER_HOST - Тип: строка
- По умолчанию:
flower - Описание: внутренний адрес сервиса Flower.
FLOWER_PORT
- Переменная среды:
FLOWER_PORT - Тип: целое число
- По умолчанию:
5555 - Описание: внутренний порт сервиса Flower.
FLOWER_API_PREFIX
- Переменная среды:
FLOWER_API_PREFIX - Тип: строка
- По умолчанию:
/api - Описание: префикс API сервиса Flower.
Параметры интеграции с Sentry
SENTRY_DSN
- Переменная среды:
TASK_TOOL_SENTRY_DSN - Тип: строка
- По умолчанию: пустое значение
- Описание: DSN для отправки событий сервиса Task tool в Sentry.