Описание параметров сервисов#

В данном разделе приведены параметры для LUNA Vector Search Module и их детальное описание.

Под параметрами (также называемыми настройками) понимаются регулируемые значения, которые управляют работой модуля.

Настройки сервиса LUNA Vector Search Module
Настройки плагина поиска
Подробное описание настроек

Настройки LUNA Vector Search Module#

Настройку LUNA Vector Search Module можно выполнить с помощью сервиса Configurator:

LUNA_VECTOR_SEARCH_MODULE_HTTP_SETTINGS
LUNA_EVENTS_DB
- db_type
- db_host
- db_port
- db_user
- db_password
- db_name
- connection_pool_size
- dsn
LUNA_VECTOR_SEARCH_MODULE_DB
- type
- url
- token
LUNA_MONITORING
- storage_type
- send_data_for_monitoring
- use_ssl
- host
- port
- flushing_period
- organization
- token
- bucket
- http_port
- db_user
- db_password
- db_name
LUNA_SERVICE_METRICS
DESCRIPTOR_ENCRYPTION
LUNA_VECTOR_SEARCH_MODULE_LOGGER
ADDITIONAL_SERVICES_USAGE
Прочие настройки

Настройки плагина поиска#

Настройку плагина можно выполнить с помощью сервиса Configurator:

LUNA_VECTOR_SEARCH_PLUGIN

Подробное описание настроек#

Часть параметров задается с помощью ограничений (limitations). Такие параметры могут не отображаться на вкладке "Settings" сервиса Configurator. Проверить полный список параметров сервиса можно на вкладке "Limitations".

Группа параметров LUNA_VECTOR_SEARCH_MODULE_HTTP_SETTINGS#

В данной группе параметров содержатся настройки, отвечающие за обработку HTTP-подключений. См. подробную информацию по следующей ссылке: https://sanic.dev/en/guide/deployment/configuration.html#builtin-values

request_timeout#

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

Формат задания настройки — integer (секунды).

Значение по умолчанию — 60.

response_timeout#

Параметр задает продолжительность времени между моментом, когда сервер передает HTTP-запрос приложению, и моментом, когда HTTP-ответ отправляется клиенту.

Формат задания настройки — integer (секунды).

Значение по умолчанию — 600.

request_max_size#

Параметр задает максимальный размер запроса.

Формат задания настройки — integer (байты).

Значение по умолчанию — 1073741824.

keep_alive_timeout#

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

Формат задания настройки — integer (секунды).

Значение по умолчанию — 15.

Группа параметров LUNA_EVENTS_DB#

В данной группе параметров задаются настройки подключения к базе данных сервиса Events, из которой LVSM получает данные о событиях для создания и синхронизации коллекций.

db_type#

Параметр задает тип базы данных. Доступны следующие значения:

"postgres";
"oracle".

Параметр является обязательным.

Формат задания настройки — string.

Значение по умолчанию — postgres.

db_host#

Параметр задает имя сервера (хост) базы данных.

Формат задания настройки — string.

Значение по умолчанию — 127.0.0.1.

db_port#

Параметр задает порт базы данных.

Формат задания настройки — integer.

Значение по умолчанию — 5432.

db_user#

Параметр задает имя пользователя базы данных.

Формат задания настройки — string.

Значение по умолчанию — luna.

db_password#

Параметр задает пароль пользователя базы данных.

Формат задания настройки — string.

Значение по умолчанию — luna.

db_name#

Параметр задает имя базы данных для типа "postgres".

Формат задания настройки — string.

Значение по умолчанию — luna_events.

db_settings > connection_pool_size#

Параметр задает размер пула соединений к БД.

Параметр является обязательным.

Формат задания настройки — integer.

Значение по умолчанию — 1.

dsn#

Параметр задает строку подключения DSN для соединения с БД.

DSN — это строка подключения, которая идентифицирует и указывает на источник данных (базу данных), к которому нужно установить соединение.

В строке DSN могут задаваться такие настройки, как множественные хосты, аутентификационные данные, порт и другие параметры.

Настройки зависят от типа БД. Множественные хосты поддерживаются только с PostgreSQL.

По умолчанию параметр "dsn" не отображается во вкладке "Settings" в Configurator. Проверить список всех доступных параметров для группы настроек можно на вкладке "Limitations".

Пример:

{
"dsn": "luna:luna@postgres01:5432,postgres02:5432/luna_events?some_option=some_value",
"db_settings": {
    "connection_pool_size": 5
    }
}

Здесь:

"luna:luna" — имя пользователя и пароль для подключения к PostgreSQL;
"@postgres01:5432,postgres02:5432" — список хостов и портов, разделенных запятыми. Это означает, что сервис будет пытаться подключиться к первому хосту ("postgres01") на порту 5432. Если это не удастся, он попытается подключиться ко второму хосту ("postgres02") также на порту 5432;
"/luna_events" — название базы данных;
"?some_option=some_value" — опциональные параметры для подключения.

При необходимости можно комбинировать строку DSN и классические настройки, однако строка DSN является более приоритетной. Можно частично заполнить строку DSN (например, "postgres01,postgres02/luna_events"), и тогда недостающие параметры будут заполнены из значений параметров "db_host", "db_port", "db_name", "db_user" и "db_password".

При запуске сервис создаст пул подключений к одному из доступных хостов DSN. В случае возникновения проблем с установлением соединения после нескольких неудачных попыток, сервис снова попытается настроить пул подключений к любому из доступных хостов DSN.

Группа параметров LUNA_VECTOR_SEARCH_MODULE_DB#

В данной группе параметров задаются настройки подключения к векторной базе данных, в которой хранятся коллекции LVSM.

См. подробную информацию о векторной базе данных в разделе "База данных Qdrant".

type#

Параметр задает тип векторной базы данных.

На данный момент поддерживается только тип "qdrant".

Формат задания настройки — string.

Значение по умолчанию — qdrant.

url#

Параметр задает протокол, IP-адрес и порт векторной базы данных Qdrant.

IP-адрес "127.0.0.1" означает, что будет использоваться векторная база данных, расположенная на сервере с Configurator. Если база данных находится на ином сервере, то в данном параметре нужно указать корректный IP-адрес сервера с запущенной базой данных Qdrant.

Формат задания настройки — string.

Значение по умолчанию — http://127.0.0.1:6333.

token#

Параметр задает токен для подключения к векторной базе данных Qdrant.

Формат задания настройки — string.

Значение по умолчанию — luna.

Группа параметров LUNA_MONITORING#

Данная группа параметров задает настройки мониторинга.

См. подробную информацию о мониторинге в разделе "Мониторинг" руководства администратора LUNA PLATFORM.

storage_type#

Параметр определяет, какой тип хранилища для хранения данных мониторинга будет использоваться. Доступно два варианта:

"influx"
"clickhouse"

Формат задания настройки — string.

Значение по умолчанию — influx.

send_data_for_monitoring#

Параметр позволяет включить или отключить отправку данных для мониторинга в InfluxDB/ClickHouse.

Формат задания настройки — integer.

Значение по умолчанию — 1.

use_ssl#

Параметр позволяет использовать HTTPS для подключения к InfluxDB/ClickHouse.

Формат задания настройки — integer.

Значение по умолчанию — 0.

host#

Параметр задает IP-адрес InfluxDB/ClickHouse.

Формат задания настройки — string.

Значение по умолчанию — 127.0.0.1.

port#

Параметр задает порт InfluxDB/ClickHouse.

Формат задания настройки — integer.

Значение по умолчанию:

для storage_type: influx — 8086;
для storage_type: clickhouse — 9090.

flushing_period#

Параметр задает частоту отправки данных мониторинга в InfluxDB/ClickHouse.

Формат задания настройки — integer (секунды).

Значение по умолчанию — 1.

organization#

Параметр применяется только при использовании storage_type: influx.

Параметр задает название организации в InfluxDB.

Формат задания настройки — string.

Значение по умолчанию — luna.

token#

Параметр применяется только при использовании storage_type: influx.

Параметр задает токен доступа к InfluxDB.

Формат задания настройки — string.

Значение по умолчанию — secret-token.

bucket#

Параметр применяется только при использовании storage_type: influx.

Параметр задает название бакета InfluxDB, в котором хранятся данные мониторинга.

Формат задания настройки — string.

Значение по умолчанию — luna_monitoring.

http_port#

Параметр применяется только при использовании storage_type: clickhouse.

Параметр задает HTTP-порт ClickHouse. HTTP-порт используется для служебных операций с базой данных.

Формат задания настройки — integer.

Значение по умолчанию — 8123.

db_user#

Параметр применяется только при использовании storage_type: clickhouse.

Параметр задает имя пользователя базы данных.

Формат задания настройки — string.

Значение по умолчанию — luna.

db_password#

Параметр применяется только при использовании storage_type: clickhouse.

Параметр задает пароль пользователя базы данных.

Формат задания настройки — string.

Значение по умолчанию — secret-password.

db_name#

Параметр применяется только при использовании storage_type: clickhouse.

Параметр задает имя базы данных в ClickHouse, в которой будут создаваться таблицы и храниться данные мониторинга.

Формат задания настройки — string.

Значение по умолчанию — luna_monitoring.

Группа параметров LUNA_SERVICE_METRICS#

Данная группа параметров включает и настраивает сбор метрик в формате Prometheus.

См. подробную информацию о мониторинге в разделе "Мониторинг" руководства администратора LUNA PLATFORM.

enabled#

Параметр включает сбор метрик.

Если сбор метрик отключен, то запрос к ресурсу /metrics вернет соответствующее сообщение.

Формат задания настройки — boolean.

Значение по умолчанию — false.

metrics_format#

Параметр задает формат метрик.

На данный момент поддерживается только формат Prometheus.

См. официальную документацию Prometheus для более подробной информации.

Формат задания настройки — string.

Значение по умолчанию — prometheus.

extra_labels#

Параметр задает пользовательские типы лейблов.

Формат задания настройки — label_name=label_value.

Значение по умолчанию не задано.

Группа параметров DESCRIPTOR_ENCRYPTION#

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

См. подробную информацию в разделе "Шифрование биометрических шаблонов" руководства администратора LUNA PLATFORM.

enabled#

Параметр включает шифрование биометрических шаблонов.

Формат задания настройки — boolean.

Значение по умолчанию — false.

algorithm#

Параметр задает название используемого алгоритма шифрования.

На данный момент поддерживается алгоритм aes256-gcm.

Формат задания настройки — string.

Значение по умолчанию — aes256-gcm.

params > source#

Параметр задает название источника ключа шифрования. Поддерживаются два типа источников:

raw — ключ шифрования задается непосредственно в параметре "params > key";
vaultKV — ключ шифрования хранится в хранилище секретов Vault KV, доступ к которому настраивается в параметре "params > key".

Формат задания настройки — string.

Значение по умолчанию — raw.

params > key#

Параметр задает ключ шифрования или учетные данные для его получения из указанного источника.

При источнике raw значение задается строкой.

При источнике vaultKV значение задается объектом, который содержит следующие параметры:

url — адрес хранилища секретов Vault;
token — токен доступа к хранилищу секретов Vault.

Формат задания настройки — string или object.

Значение по умолчанию не задано.

Группа параметров LUNA_VECTOR_SEARCH_MODULE_LOGGER#

Данная группа параметров задает настройки логирования.

log_level#

Параметр задает уровень отладочной печати, по приоритету: "ERROR", "WARNING", "INFO", "DEBUG".

Формат задания настройки — string.

Значение по умолчанию — INFO.

log_time#

Параметр задает формат времени, используемый в записях лога. Доступны следующие значения:

"LOCAL" — отображает местное время системы, на которой выполняется запись логов;
"UTC" — отображает координированное всемирное время, которое является стандартом времени и не зависит от местной временной зоны или сезонных изменений времени.

Формат задания настройки — string.

Значение по умолчанию — LOCAL.

log_to_stdout#

Параметр позволяет отправлять логи в стандартный вывод (stdout).

Формат задания настройки — boolean.

Значение по умолчанию — true.

log_to_file#

Параметр позволяет сохранять логи в файл. Директория с файлами логов указывается в параметре "folder_with_logs".

Примечание. При включении сохранения логов в файл следует учитывать:

необходимость контроля размера логов во избежание переполнения хранилища;
автоматическое удаление логов при перезапуске контейнера (требуется использование аргумента volume).

См. инструкцию по включению записи логов в файлы в разделе "Запись логов на сервер" руководства по установке LUNA Vector Search Module.

Формат задания настройки — boolean.

Значение по умолчанию — false.

folder_with_logs#

Параметр задает директорию, в которой хранятся логи. Относительный путь начинается с каталога с приложением.

Для использования данного параметра требуется включить параметр "log_to_file".

Формат задания настройки — string.

Значение по умолчанию — ./

Пример:

"folder_with_logs": "/srv/logs"

max_log_file_size#

Параметр задает максимальный размер файла лога в МБ перед выполнением его ротации (0 — не использовать ротацию).

Для использования данного параметра требуется включить параметр "log_to_file".

При необходимости можно настроить ротацию логов Docker. См. раздел "Настройка ротации логов Docker" в руководстве по установке LUNA PLATFORM.

Формат задания настройки — integer.

Значение по умолчанию — 1024.

multiline_stack_trace#

Параметр включает многострочную трассировку стека в логах. Когда параметр включен, информация о стеке вызовов записывается в логах так, что каждый фрейм стека помещается на отдельной строке, что улучшает читаемость. Если параметр выключен, информация о стеке вызовов записывается на одной строке, что может сделать логи менее удобными для анализа.

Формат задания настройки — boolean.

Значение по умолчанию — true.

format#

Параметр определяет формат выводимых логов. Доступны следующие значения:

"default" — стандартный формат вывода логов LUNA PLATFORM;
"json" — вывод логов в формате json;
"ecs" — вывод логов в формате ECS (Elastic Common Schema).

При использовании значения "ecs" будут использоваться следующие поля:

"http.response.status_code" — содержит код состояния ответа HTTP (200, 404, 500 и т.д.);
"http.response.execution_time" — содержит информацию о времени, затраченном на выполнение запроса и получение ответа;
"http.request.method" — содержит метод HTTP-запроса (GET, POST, PUT и т.д.);
"url.path" — содержит путь в URL-адресе запроса;
"error.code" — содержит код ошибки, если запрос завершается с ошибкой.

Формат задания настройки — string.

Значение по умолчанию — default.

Группа параметров ADDITIONAL_SERVICES_USAGE#

Данная группа параметров задает возможность использования необязательных сервисов LUNA PLATFORM.

luna_events#

Параметр задает возможность использования сервиса Events.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — true.

luna_faces#

Параметр задает возможность использования сервиса Faces.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — true.

luna_handlers#

Параметр задает возможность использования сервиса Handlers.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — true.

luna_image_store#

Параметр задает возможность использования сервиса Image Store.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — true.

luna_matcher_proxy#

Параметр задает возможность использования сервиса Python Matcher Proxy.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — false.

luna_python_matcher#

Параметр задает возможность использования сервиса Python Matcher.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — true.

luna_sender#

Параметр задает возможность использования сервиса Sender.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — true.

luna_tasks#

Параметр задает возможность использования сервиса Tasks.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — true.

luna_lambda#

Параметр задает возможность использования сервиса Lambda.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — false.

luna_video_manager#

Параметр задает возможность использования сервиса Video Manager.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — false.

luna_video_agent#

Параметр задает возможность использования сервиса Video Agent.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — false.

luna_streams_retranslator#

Параметр задает возможность использования сервиса Streams Retranslator.

Включение/отключение данного сервиса может повлиять на работу других сервисов.

Формат задания настройки — boolean ("false" или "true").

Значение по умолчанию — false.

Прочие настройки#

luna_vector_search_module_active_plugins#

Параметр задает список плагинов, которые должен использовать LUNA Vector Search Module.

Имена задаются в следующем формате:

[
   "plugin_1",
   "plugin_2",
   "plugin_3"
]

Формат задания настройки — array > string.

Значение по умолчанию не задано.

default_face_descriptor_version#

Параметр задает используемую версию биометрического шаблона лица.

Формат задания настройки — integer.

Значение по умолчанию — 65.

Примечание. См. подробную информацию о версиях биометрических шаблонов в разделе "Нейронные сети" руководства администратора LUNA PLATFORM.

default_human_descriptor_version#

Параметр задает используемую версию биометрического шаблона тела.

Формат задания настройки — integer.

Значение по умолчанию — 116.

Примечание. См. подробную информацию о версиях биометрических шаблонов в разделе "Нейронные сети" руководства администратора LUNA PLATFORM.

platform_docs_address#

Параметр задает адрес сервиса Docs, который раздает техническую документацию по продукту.

По умолчанию сервис Docs доступен по адресу http://127.0.0.1:5320. При необходимости адрес можно изменить с помощью данного параметра.

Формат задания настройки — string.

Значение по умолчанию — http://127.0.0.1:5320.

LUNA_VECTOR_SEARCH_PLUGIN#

Данный параметр позволяет настраивать работу плагина поиска, который интегрирует LUNA Vector Search Module с сервисом Python Matcher Proxy.

Состав параметров зависит от используемого плагина. Пример конфигурации:

LUNA_VECTOR_SEARCH_PLUGIN = {
    "DB": [{"type": "qdrant", "url": "http://127.0.0.1:6333", "token": "luna"}],
    "SEARCH_PARAMETERS": {"exact": true, "ef_search": 3200},
    "COLLECTION_OBSOLETE_PERIOD": null,
    "REQUEST_TIMEOUT": 60
}

Здесь:

"DB" — список подключений к векторной базе данных;
"SEARCH_PARAMETERS" — параметры выполнения векторного поиска;
"COLLECTION_OBSOLETE_PERIOD" — период, по истечении которого коллекция считается неактуальной. Если параметр установлен в null, проверка актуальности коллекции не выполняется;
"REQUEST_TIMEOUT" — таймаут выполнения запросов.

Формат задания настройки — object.

Значение по умолчанию не задано.