Описание параметров сервисов#
Настройки сервиса Index Manager#
Данный раздел описывает параметры сервиса Index Manager.
Настройку сервиса можно выполнить с помощью сервиса Configurator.
Группа параметров LIM_MANAGER_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".
Формат задания настройки — 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.
Группа параметров LIM_MANAGER_INDEXING#
В данном разделе задаются настройки индексирования, задаваемые сервисом Index Manager.
indexer_origins#
Параметр задает список адресов запущенных экземпляров сервиса Indexer.
Формат задания настройки — array > string.
Значение по умолчанию — http://127.0.0.1:5180.
planning_period#
Параметр задает период процедуры планирования, которая осуществляет проверку наборов списков, которые требуется проиндексировать.
Если задан параметр "planning_schedule", то параметр "planning_period" будет игнорироваться.
Если заданы оба парамера, то в приоритете будет параметр "planning_schedule".
Формат задания настройки — integer (секунды).
Значение по умолчанию — 600.
planning_schedule#
Параметр задает расписание выполнения процедуры планирования в Cron-формате, которая осуществляет проверку наборов списков, которые требуется проиндексировать.
Использование расписания дает точное знание о времени запуска индексирования по сравнению с периодическим запуском каждые несколько часов или минут. Это обеспечивает более предсказуемое и контролируемое выполнение индексации, а также позволяет избежать сдвигов во времени, которые могут возникать при периодическом запуске. Например, если сервис недоступен или возникли другие проблемы, периодический запуск может быть пропущен, что может нарушить планы обновления индекса. Однако, стоит учитывать, что периодический запуск имеет свои преимущества. Например, если требуется обновлять индекс каждый час без необходимости настройки сложного расписания.
Номер недели в Cron-формате начинается с воскресенья. Например, значение "0 0 * * 0" означает, что индексирование будет выполняться в 00:00 каждое воскресенье.
Если задан параметр "planning_schedule", то параметр "planning_period" будет игнорироваться.
Если заданы оба парамера, то в приоритете будет параметр "planning_schedule".
Формат задания настройки — string (Cron-подобная строка).
Значение по умолчанию не задано.
lookup_period#
Параметр задает период процедуры поиска, которая осуществляет проверку статусов всех запущенных экземпляров Indexer.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 5.
face_lists > min_indexing_list_size#
Параметр задает минимальное количество лиц в списках для того, чтобы список был проиндексирован.
Параметр используется только при использовании параметра "indexing_lists" со значением "dynamic".
Формат задания настройки — integer.
Значение по умолчанию — 50000.
face_lists > indexing_lists#
Параметр задает набор списков для индексирования.
Можно либо явно указать списки, либо указать значение "dynamic". В последнем случае будут обработаны все списки, количество биометрических шаблонов лиц в которых превышает количество, заданное в параметре "min_indexing_list_size".
Формат задания настройки — array > string.
Значение по умолчанию — dynamic.
ef_construction#
Параметр задает ограничение на рассматриваемое число ближайших соседей при построении индекса.
Более высокие значения приводят к более точному графу, но требующему больше времени для построения.
Рекомендуется изменять параметр совместно с параметром "ef_search" сервиса Indexed Matcher.
Формат задания настройки — integer.
Значение по умолчанию — 1600.
rebuild_rules > default#
Параметр задает включает полное перестроение индекса вместо его обновления.
См. подробную информацию в разделе "Настройка перестроения и обновления индекса".
Формат задания настройки — boolean.
Значение по умолчанию — true.
rebuild_rules > max_removal_for_rebuild#
Параметр задает допустимое количество удалений биометрических шаблонов с момента создания индекса.
См. подробную информацию в разделе "Настройка перестроения и обновления индекса".
Формат задания настройки — integer.
Значение по умолчанию — 0.
Группа параметров LIM_MANAGER_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.
Группа параметров LIM_MANAGER_DB#
В данной группе параметров задаются настройки подключения к базе данных сервиса Index Manager.
db_user#
Параметр задает имя пользователя базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию не задано.
db_password#
Параметр задает пароль пользователя базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию не задано.
db_host#
Параметр задает имя сервера (хост) базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию — 127.0.0.1.
db_port#
Параметр задает порт базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию — 6379.
db_settings > connection_pool_size#
Параметр задает размер пула соединений к БД Redis.
Формат задания настройки — string.
Значение по умолчанию — 100.
db_number#
Параметр задает номер базы данных Redis. Каждый номер соответствует отдельной базе данных, что позволяет разделить данные.
Формат задания настройки — integer.
Значение по умолчанию — 0.
sentinel > master_name#
Параметр задает имя мастера базы данных Redis, который контролируется и управляется системой Sentinel.
Формат задания настройки — string.
Значение по умолчанию — index_manager.
sentinel > sentinels#
Параметр задает список адресов и портов серверов Sentinel, которые будут использоваться клиентами для обнаружения и мониторинга БД Redis.
Формат задания настройки — list > string.
Значение по умолчанию — [].
sentinel > user#
Параметр задает имя пользователя сервера Sentinel.
Формат задания настройки — string.
Значение по умолчанию не задано.
sentinel > password#
Параметр задает пароль пользователя сервера Sentinel.
Формат задания настройки — string.
Значение по умолчанию не задано.
Группа параметров LUNA_MONITORING#
Данная группа параметров задает настройки мониторинга.
См. подробную информацию о мониторинге в разделе "Мониторинг".
storage_type#
Тип хранилища для хранения данных мониторинга.
В настоящее время доступно только БД Influx.
Формат задания настройки — string.
Значение по умолчанию — influx.
send_data_for_monitoring#
Параметр позволяет включить или отключить отправку данных для мониторинга в InfluxDB.
Формат задания настройки — integer.
Значение по умолчанию — 1.
use_ssl#
Параметр позволяет использовать HTTPS для подключения к InfluxDB.
Формат задания настройки — integer.
Значение по умолчанию — 0.
organization#
Параметр задает рабочую область InfluxDB 2.x.
Формат задания настройки — string.
Значение по умолчанию — luna.
token#
Параметр задает аутентификации InfluxDB 2.x.
Формат задания настройки — string.
bucket#
Параметр задаёт имя бакета InfluxDB 2.x.
Формат задания настройки — string.
Значение по умолчанию — luna_monitoring.
host#
Параметр задаёт IP-адрес InfluxDB.
Формат задания настройки — string.
Значение по умолчанию — 127.0.0.1.
port#
Параметр задает порт InfluxDB.
Формат задания настройки — string.
Значение по умолчанию — 8086.
flushing_period#
Параметр задает частоту отправки данных мониторинга в InfluxDB.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 1.
Группа параметров LUNA_FACES_ADDRESS#
Данная группа параметров задает настройки подключения к сервису Faces.
origin#
Параметр задает протокол, IP адрес и порт сервиса Faces.
IP адрес "127.0.0.1" означает, что будет использоваться сервис Faces, расположенный на сервере с Configurator. Если сервис находится на ином сервере, то в данном параметре нужно указать корректный IP адрес сервера с запущенным сервисом Faces.
Формат задания настройки — string.
Значение по умолчанию — http://127.0.0.1:5030.
api_version#
Параметр задает версию API сервиса Faces. Доступная версия API — "3".
Формат задания настройки — integer.
Значение по умолчанию — 3.
Группа параметров LUNA_FACES_TIMEOUTS#
Данная группа параметров определяет временные интервалы для управления таймаутами HTTP-запросов, которые направляются к сервису Faces.
connect#
Параметр задает таймаут для установки соединения при отправке HTTP-запроса к сервису Faces. Это время ожидания, в течение которого клиент пытается установить соединение с сервисом.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 20.
request#
Параметр задает общий таймаут для выполнения всего HTTP-запроса. Он включает в себя время установки соединения, отправки запроса, получения ответа и закрытия соединения. Если весь процесс занимает больше времени, чем указано в этом параметре, то запрос будет прерван.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 60.
sock_connect#
Параметр задает таймаут для установки соединения на уровне сокетов. Если соединение на уровне сокетов не устанавливается в установленное время, операция будет прервана.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 10.
sock_read#
Параметр задает таймаут на чтение данных с сокета после успешного соединения. Если данные не поступают в установленное время, операция чтения будет прервана.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 60.
Группа параметров LUNA_SERVICE_METRICS#
Данная группа параметров включает и настраивает сбор метрик в формате Prometheus.
См. подробную информацию в разделе "Мониторинг".
enabled#
Параметр включает сбор метрик.
Если сбор метрик отключен, то запрос к ресурсу /metrics вернет соответствующее сообщение.
Формат задания настройки — boolean.
Значение по умолчанию — false.
metrics_format#
Параметр задает формат метрик.
На данный момент поддерживается только формат Prometheus.
См. официальную документацию Prometheus для более подробной информации.
Формат задания настройки — string.
Значение по умолчанию — prometheus.
extra_labels#
Параметр задает пользовательские типы лейблов.
Формат задания настройки — label_name=label_value.
Значение по умолчанию не задано.
Прочие#
index_storage_type#
Параметр задает тип хранилища индексов. В настоящее время доступен только вариант "LOCAL".
Значение "LOCAL" означает, что индексы будут храниться в директории, указанной в параметре "index_storage_local".
Формат задания настройки — string.
Значение по умолчанию — LOCAL.
index_storage_local#
Параметр задает директорию для хранения индексов при типе хранилища "LOCAL".
Формат задания настройки — string.
Значение по умолчанию — ./local_storage.
storage_time#
Параметр задает формат времени, используемый для записей в базе данных. Доступны следующие значения:
- "LOCAL" — отображает местное время системы, на которой выполняется запись логов;
- "UTC" — отображает координированное всемирное время, которое является стандартом времени и не зависит от местной временной зоны или сезонных изменений времени.
Формат задания настройки — string.
Значение по умолчанию — LOCAL.
lim_manager_active_plugins#
Параметр задает список плагинов, которые должен использовать сервис.
Имена задаются в следующем формате:
[
"plugin_1",
"plugin_2",
"plugin_3"
]
Список должен содержать имена файлов без расширения (.py).
Формат задания настройки — integer.
Значение по умолчанию — 1.
default_face_descriptor_version#
Параметр задает используемую версию биометрического шаблона лица.
Формат задания настройки — string.
Значение по умолчанию — 59.
Настройки сервиса Indexed Matcher#
Данный раздел описывает параметры сервиса Indexed Matcher.
Настройку сервиса можно выполнить с помощью сервиса Configurator.
Группа параметров LIM_MATCHING#
В данной группе параметров задаются настройки индексированного сравнения.
ef_search#
Параметр задает ограничение на рассматриваемое число ближайших соседей при поиске индекса.
Более высокие значения приводят к более точному, но медленному поиску.
Рекомендуется изменять параметр совместно с параметром "ef_construction" сервиса Indexed Manager.
Формат задания настройки — integer.
Значение по умолчанию — 1600.
Группа параметров LIM_MATCHER_REFRESH#
В данной группе параметров задаются настройки обновления индекса в памяти сервиса Indexed Matcher.
enabled#
Параметр позволяет включить обновление индекса в памяти.
Формат задания настройки — integer.
Значение по умолчанию — 1.
Группа параметров LIM_MATCHER_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".
Формат задания настройки — 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.
Группа параметров LIM_MATCHER_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.
Группа параметров LIM_MATCHER_DB#
В данной группе параметров задаются настройки подключения к базе данных сервиса Index Matcher.
db_user#
Параметр задает имя пользователя базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию не задано.
db_password#
Параметр задает пароль пользователя базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию не задано.
db_host#
Параметр задает имя сервера (хост) базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию — 127.0.0.1.
db_port#
Параметр задает порт базы данных Redis.
Формат задания настройки — string.
Значение по умолчанию — 6379.
db_settings > connection_pool_size#
Параметр задает размер пула соединений к БД Redis.
Формат задания настройки — string.
Значение по умолчанию — 100.
db_number#
Параметр задает номер базы данных Redis. Каждый номер соответствует отдельной базе данных, что позволяет разделить данные.
Формат задания настройки — integer.
Значение по умолчанию — 0.
sentinel > master_name#
Параметр задает имя мастера базы данных Redis, который контролируется и управляется системой Sentinel.
Формат задания настройки — string.
Значение по умолчанию — indexed_matcher.
sentinel > sentinels#
Параметр задает список адресов и портов серверов Sentinel, которые будут использоваться клиентами для обнаружения и мониторинга БД Redis.
Формат задания настройки — list > string.
Значение по умолчанию — [].
sentinel > user#
Параметр задает имя пользователя сервера Sentinel.
Формат задания настройки — string.
Значение по умолчанию не задано.
sentinel > password#
Параметр задает пароль пользователя сервера Sentinel.
Формат задания настройки — string.
Значение по умолчанию не задано.
Группа параметров LUNA_MONITORING#
Данная группа параметров задает настройки мониторинга.
См. подробную информацию о мониторинге в разделе "Мониторинг".
storage_type#
Тип хранилища для хранения данных мониторинга.
В настоящее время доступно только БД Influx.
Формат задания настройки — string.
Значение по умолчанию — influx.
send_data_for_monitoring#
Параметр позволяет включить или отключить отправку данных для мониторинга в InfluxDB.
Формат задания настройки — integer.
Значение по умолчанию — 1.
use_ssl#
Параметр позволяет использовать HTTPS для подключения к InfluxDB.
Формат задания настройки — integer.
Значение по умолчанию — 0.
organization#
Параметр задает рабочую область InfluxDB 2.x.
Формат задания настройки — string.
Значение по умолчанию — luna.
token#
Параметр задает аутентификации InfluxDB 2.x.
Формат задания настройки — string.
bucket#
Параметр задаёт имя бакета InfluxDB 2.x.
Формат задания настройки — string.
Значение по умолчанию — luna_monitoring.
host#
Параметр задаёт IP-адрес InfluxDB.
Формат задания настройки — string.
Значение по умолчанию — 127.0.0.1.
port#
Параметр задает порт InfluxDB.
Формат задания настройки — string.
Значение по умолчанию — 8086.
flushing_period#
Параметр задает частоту отправки данных мониторинга в InfluxDB.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 1.
Группа параметров LUNA_FACES_ADDRESS#
Данная группа параметров задает настройки подключения к сервису Faces.
origin#
Параметр задает протокол, IP адрес и порт сервиса Faces.
IP адрес "127.0.0.1" означает, что будет использоваться сервис Faces, расположенный на сервере с Configurator. Если сервис находится на ином сервере, то в данном параметре нужно указать корректный IP адрес сервера с запущенным сервисом Faces.
Формат задания настройки — string.
Значение по умолчанию — http://127.0.0.1:5030.
api_version#
Параметр задает версию API сервиса Faces. Доступная версия API — "3".
Формат задания настройки — integer.
Значение по умолчанию — 3.
Группа параметров LUNA_FACES_TIMEOUTS#
Данная группа параметров определяет временные интервалы для управления таймаутами HTTP-запросов, которые направляются к сервису Faces.
connect#
Параметр задает таймаут для установки соединения при отправке HTTP-запроса к сервису Faces. Это время ожидания, в течение которого клиент пытается установить соединение с сервисом.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 20.
request#
Параметр задает общий таймаут для выполнения всего HTTP-запроса. Он включает в себя время установки соединения, отправки запроса, получения ответа и закрытия соединения. Если весь процесс занимает больше времени, чем указано в этом параметре, то запрос будет прерван.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 60.
sock_connect#
Параметр задает таймаут для установки соединения на уровне сокетов. Если соединение на уровне сокетов не устанавливается в установленное время, операция будет прервана.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 10.
sock_read#
Параметр задает таймаут на чтение данных с сокета после успешного соединения. Если данные не поступают в установленное время, операция чтения будет прервана.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 60.
Группа параметров LUNA_LICENSES_ADDRESS#
Данная группа параметров задает настройки подключения к сервису Licenses.
origin#
Параметр задает протокол, IP адрес и порт сервиса Licenses.
IP адрес "127.0.0.1" означает, что будет использоваться сервис Licenses, расположенный на сервере с Configurator. Если сервис находится на ином сервере, то в данном параметре нужно указать корректный IP адрес сервера с запущенным сервисом Licenses.
Формат задания настройки — string.
Значение по умолчанию — http://127.0.0.1:5120.
api_version#
Параметр задает версию API сервиса Licenses. Доступная версия API — "1".
Формат задания настройки — integer.
Значение по умолчанию — 1.
Группа параметров LUNA_SERVICE_METRICS#
Данная группа параметров включает и настраивает сбор метрик в формате Prometheus.
См. подробную информацию в разделе "Мониторинг".
enabled#
Параметр включает сбор метрик.
Если сбор метрик отключен, то запрос к ресурсу /metrics вернет соответствующее сообщение.
Формат задания настройки — boolean.
Значение по умолчанию — false.
metrics_format#
Параметр задает формат метрик.
На данный момент поддерживается только формат Prometheus.
См. официальную документацию Prometheus для более подробной информации.
Формат задания настройки — string.
Значение по умолчанию — prometheus.
extra_labels#
Параметр задает пользовательские типы лейблов.
Формат задания настройки — label_name=label_value.
Значение по умолчанию не задано.
Прочие#
lim_matcher_cache#
Параметр задает путь до директории с кэшем.
См. подробную информацию о кэшировании в разделе "Кэширование индекса".
Для отключения кэширования необходимо оставить поле пустым.
Формат задания настройки — string.
Значение по умолчанию не задано.
index_storage_type#
Параметр задает тип хранилища индексов. В настоящее время доступен только вариант "LOCAL".
Значение "LOCAL" означает, что индексы будут храниться в директории, указанной в параметре "index_storage_local".
Формат задания настройки — string.
Значение по умолчанию — LOCAL.
index_storage_local#
Параметр задает директорию для хранения индексов при типе хранилища "LOCAL".
Формат задания настройки — string.
Значение по умолчанию — ./local_storage.
lim_matcher_active_plugins#
Параметр задает список плагинов, которые должен использовать сервис.
Имена задаются в следующем формате:
[
"plugin_1",
"plugin_2",
"plugin_3"
]
Список должен содержать имена файлов без расширения (.py).
Формат задания настройки — integer.
Значение по умолчанию — 1.
default_face_descriptor_version#
Параметр задает используемую версию биометрического шаблона лица.
Формат задания настройки — string.
Значение по умолчанию — 59.
Настройки сервиса Indexer#
Данный раздел описывает параметры сервиса Indexer.
Настройку сервиса можно выполнить с помощью сервиса Configurator.
Группа параметров LIM_INDEXER_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".
Формат задания настройки — 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.
Группа параметров LUNA_MONITORING#
Данная группа параметров задает настройки мониторинга.
См. подробную информацию о мониторинге в разделе "Мониторинг".
storage_type#
Тип хранилища для хранения данных мониторинга.
В настоящее время доступно только БД Influx.
Формат задания настройки — string.
Значение по умолчанию — influx.
send_data_for_monitoring#
Параметр позволяет включить или отключить отправку данных для мониторинга в InfluxDB.
Формат задания настройки — integer.
Значение по умолчанию — 1.
use_ssl#
Параметр позволяет использовать HTTPS для подключения к InfluxDB.
Формат задания настройки — integer.
Значение по умолчанию — 0.
organization#
Параметр задает рабочую область InfluxDB 2.x.
Формат задания настройки — string.
Значение по умолчанию — luna.
token#
Параметр задает аутентификации InfluxDB 2.x.
Формат задания настройки — string.
bucket#
Параметр задаёт имя бакета InfluxDB 2.x.
Формат задания настройки — string.
Значение по умолчанию — luna_monitoring.
host#
Параметр задаёт IP-адрес InfluxDB.
Формат задания настройки — string.
Значение по умолчанию — 127.0.0.1.
port#
Параметр задает порт InfluxDB.
Формат задания настройки — string.
Значение по умолчанию — 8086.
flushing_period#
Параметр задает частоту отправки данных мониторинга в InfluxDB.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 1.
Группа параметров LUNA_FACES_ADDRESS#
Данная группа параметров задает настройки подключения к сервису Faces.
origin#
Параметр задает протокол, IP адрес и порт сервиса Faces.
IP адрес "127.0.0.1" означает, что будет использоваться сервис Faces, расположенный на сервере с Configurator. Если сервис находится на ином сервере, то в данном параметре нужно указать корректный IP адрес сервера с запущенным сервисом Faces.
Формат задания настройки — string.
Значение по умолчанию — http://127.0.0.1:5030.
api_version#
Параметр задает версию API сервиса Faces. Доступная версия API — "3".
Формат задания настройки — integer.
Значение по умолчанию — 3.
Группа параметров LUNA_FACES_TIMEOUTS#
Данная группа параметров определяет временные интервалы для управления таймаутами HTTP-запросов, которые направляются к сервису Faces.
connect#
Параметр задает таймаут для установки соединения при отправке HTTP-запроса к сервису Faces. Это время ожидания, в течение которого клиент пытается установить соединение с сервисом.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 20.
request#
Параметр задает общий таймаут для выполнения всего HTTP-запроса. Он включает в себя время установки соединения, отправки запроса, получения ответа и закрытия соединения. Если весь процесс занимает больше времени, чем указано в этом параметре, то запрос будет прерван.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 60.
sock_connect#
Параметр задает таймаут для установки соединения на уровне сокетов. Если соединение на уровне сокетов не устанавливается в установленное время, операция будет прервана.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 10.
sock_read#
Параметр задает таймаут на чтение данных с сокета после успешного соединения. Если данные не поступают в установленное время, операция чтения будет прервана.
Формат задания настройки — integer (секунды).
Значение по умолчанию — 60.
Группа параметров LIM_INDEXER_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_SERVICE_METRICS#
Данная группа параметров включает и настраивает сбор метрик в формате Prometheus.
См. подробную информацию в разделе "Мониторинг".
enabled#
Параметр включает сбор метрик.
Если сбор метрик отключен, то запрос к ресурсу /metrics вернет соответствующее сообщение.
Формат задания настройки — boolean.
Значение по умолчанию — false.
metrics_format#
Параметр задает формат метрик.
На данный момент поддерживается только формат Prometheus.
См. официальную документацию Prometheus для более подробной информации.
Формат задания настройки — string.
Значение по умолчанию — prometheus.
extra_labels#
Параметр задает пользовательские типы лейблов.
Формат задания настройки — label_name=label_value.
Значение по умолчанию не задано.
Прочие#
index_storage_type#
Параметр задает тип хранилища индексов. В настоящее время доступен только вариант "LOCAL".
Значение "LOCAL" означает, что индексы будут храниться в директории, указанной в параметре "index_storage_local".
Формат задания настройки — string.
Значение по умолчанию — LOCAL.
index_storage_local#
Параметр задает директорию для хранения индексов при типе хранилища "LOCAL".
Формат задания настройки — string.
Значение по умолчанию — ./local_storage.
lim_indexer_active_plugins#
Параметр задает список плагинов, которые должен использовать сервис.
Имена задаются в следующем формате:
[
"plugin_1",
"plugin_2",
"plugin_3"
]
Список должен содержать имена файлов без расширения (.py).
Формат задания настройки — integer.
Значение по умолчанию — 1.
default_face_descriptor_version#
Параметр задает используемую версию биометрического шаблона лица.
Формат задания настройки — string.
Значение по умолчанию — 59.
Настройки плагина сравнения#
Группа параметров LUNA_INDEXED_LIST_PLUGIN#
Данная группа параметров отвечает за соединение плагина сравнения с Redis при высчитывании сложности запроса.
Доступна возможность указать адрес Redis Sentinel. См. раздел "Использование Redis Sentinel".
redis_url#
Параметр задает адрес Redis.
Формат задания настройки — string.
Значение по умолчанию — redis://localhost:6379.
request_timeout#
Параметр задает таймаут подключения к Redis.
Формат задания настройки — integer.
Значение по умолчанию — 60.