Перейти к основному содержимому
Версия: 2.11

Конфигурация

Хотя сервер NATS имеет множество флагов для простого тестирования возможностей, продукты NATS Server предоставляют гибкий формат конфигурации, сочетающий лучшие стороны традиционных форматов и современных подходов, таких как JSON и YAML.

Синтаксис​

Файл конфигурации NATS поддерживает следующий синтаксис:

  • Строки можно комментировать с помощью # и //
  • Значения можно присваивать свойствам с помощью:
    • Equals sign: foo = 2
    • Colon: foo: 2
    • Whitespace: foo 2
  • Массивы заключаются в квадратные скобки: ["a", "b", "c"]
  • Объекты заключаются в фигурные скобки: {foo: 2}
  • Объекты можно присваивать без разделителя после ключа
  • Точка с запятой может завершать выражение

Файл конфигурации NATS разбирается в кодировке UTF-8.

примечание

Конфигурацию NATS в файле также можно представить в виде объекта JSON (с комментариями!), однако при использовании переменных их по-прежнему нужно указывать без кавычек.

Строки и числа​

Как видно, синтаксический анализатор конфигурации допускает множество вариантов:

  • Значениями могут быть примитивы, списки или объекты
  • Строки и числа обычно обрабатываются ожидаемым образом
  • Числа поддерживают единицы, например 1K для 1000 и 1KB для 1024

Строковые значения, начинающиеся с цифры или точки '.', могут вызывать проблемы. Чтобы явно задать их как строки, заключите их в кавычки.

Неверная конфигурация:

listen: 127.0.0.1:4222
authorization: {
# НЕВЕРНО!
token: 3secret
}

Верная конфигурация:

listen: 127.0.0.1:4222
authorization: {
token: "3secret"
}

Переменные​

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

  • Имеют область видимости блока
  • Используют префикс $ при обращении. Ссылки на переменные не заключаются в кавычки: например, присваивание foo = "$example" задаст для foo буквальную строку "$example".
  • Могут получать значения из одноимённых переменных окружения
warning

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

# Определите переменную в конфигурации
TOKEN: "secret"

# Используйте переменную
authorization {
token: $TOKEN
}

Аналогичная конфигурация, но теперь значение задано в окружении:

# TOKEN задана в окружении
authorization {
token: $TOKEN
}

Переменную окружения можно задать непосредственно в команде (ниже) или экспортировать заранее.

TOKEN="hello" nats-server -c /config/file

Директива включения​

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

Включаемые файлы должны задаваться относительными путями от основного файла конфигурации (указанного параметром -c):

server.conf:

listen: 127.0.0.1:4222
include ./auth.conf
примечание

После include не ставится = или :, поскольку это директива.

auth.conf:

authorization: {
token: "f0oBar"
}

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

nats-server -c server.conf

Свойства​

Подключения​

ИмяОписаниеТипПо умолчаниюПерезагрузка
hostХост для клиентских соединений.string0.0.0.0Нет
portПорт клиентских соединений. Значение -1 выбирает случайный свободный порт.integer4222Нет*
listen<host>:<port> для клиентских соединений.string-Нет
client_advertiseОбъявляемый клиентский адрес <host>:<port>. Полезен для кластеров за NAT.string-Да
tlsКонфигурация TLS для клиентов и мониторинга HTTP.object-Да*
allow_non_tlsРазрешить TLS и незашифрованные соединения на одном порту.boolean-Нет
ocspOCSP Stapling по умолчанию применяется для сертификатов с флагом status_request Must-Staple. При явном отключении сервер не запрашивает прикрепляемые ответы даже при наличии Must-Staple.(multiple)trueДа
ocsp_cacheКэшировать прикрепляемые сервером ответы OCSP, чтобы не обращаться к ответчику при каждом рукопожатии.(multiple)-Да
mqttКонфигурация включения интерфейса MQTT.object-Да*
websocketКонфигурация включения интерфейса WebSocket.object-Да*

* Ограничения перезагрузки описаны на странице параметра.

Централизованная аутентификация​

ИмяОписаниеТипПо умолчаниюПерезагрузка
authorizationСтатическое объявление одного или нескольких пользователей.object-Да
accountsСтатические аккаунты, заданные конфигурацией.object-Да
no_auth_userИмя пользователя, чьи разрешения наследуют неаутентифицированные клиенты. Пользователь должен быть определён в блоке authorization или accounts.string-Да*

* Ограничения перезагрузки описаны на странице параметра.

Децентрализованная аутентификация​

ИмяОписаниеТипПо умолчаниюПерезагрузка
operatorОдин или несколько JWT оператора в файлах или непосредственно в конфигурации.(multiple)-Нет
trusted_keysОдин или несколько доверенных открытых ключей операторов.string-Нет
resolverИмеет приоритет перед значением из operator, если задано. Строковое значение должно быть MEMORY или URL(<url>), где url — HTTP-адрес резолвера аккаунтов NATS. Примечание: резолвер аккаунтов NATS устарел; следует использовать встроенный резолвер на базе NATS.(multiple)-Да*
resolver_tlsobject-Да
resolver_preloadОтображение открытых ключей аккаунтов на их JWT.string-Да*
resolver_pinned_accounts(multiple)-Да
system_accountИмя или открытый ключ аккаунта, который будет считаться системным.string$SYSНет
no_system_accountboolean-Нет

* Ограничения перезагрузки описаны на странице параметра.

Кластеризация​

ИмяОписаниеТипПо умолчаниюПерезагрузка
clusterКонфигурация объединения серверов в кластер.object-Да*
gatewayКонфигурация соединений шлюзов между кластерами.object-Да*

* Ограничения перезагрузки описаны на странице параметра.

Листовые узлы​

ИмяОписаниеТипПо умолчаниюПерезагрузка
leafnodesКонфигурация соединений листовых узлов.object-Да*

* Ограничения перезагрузки описаны на странице параметра.

JetStream​

ИмяОписаниеТипПо умолчаниюПерезагрузка
jetstream(multiple)falseДа*
store_dirКаталог файлового хранилища JetStream.string-Да*

* Ограничения перезагрузки описаны на странице параметра.

Отображение субъектов​

ИмяОписаниеТипПо умолчаниюПерезагрузка
mappings(multiple)-Да

Журналирование​

ИмяОписаниеТипПо умолчаниюПерезагрузка
debugЕсли true, включает отладочные сообщения журнала.booleanfalseДа*
traceЕсли true, включает трассировку протокола в журнале, кроме системного аккаунта.booleanfalseДа*
trace_headersТрассировать заголовки сообщений. Также включает trace.booleanfalseДа
trace_verboseЕсли true, включает трассировку протокола в журнале, включая системный аккаунт.booleanfalseДа*
logtimeЕсли false, записи журнала не содержат временных меток.stringtrueДа*
logtime_utcЕсли true, временные метки журнала используют UTC вместо местного часового пояса.stringfalseДа
logfileИмя файла журнала.string-Да*
logfile_max_numМаксимальное число сохраняемых файлов ротации журнала. Более старые файлы удаляются.integer-Нет
logfile_size_limitРазмер в байтах, после которого журнал переключается на новый файл.integer0Нет
syslogЗаписывать журнал в syslog.booleanfalseДа*
remote_syslogАдрес удалённого syslog.string-Да*

* Ограничения перезагрузки описаны на странице параметра.

Мониторинг и трассировка​

ИмяОписаниеТипПо умолчаниюПерезагрузка
server_nameИмя сервера, отображаемое в журнале. По умолчанию используется сгенерированный идентификатор сервера. При использовании JetStream имена всех серверов в пределах домена должны быть уникальными.string-Нет
server_tagsОдин или несколько тегов сервера. Сейчас используются для размещения потоков и потребителей JetStream.(multiple)-Да*
httpАдрес прослушивания <host>:<port> для мониторинга сервера.string-Нет
httpsАдрес прослушивания <host>:<port> для мониторинга сервера по TLS.string-Нет
http_portПорт HTTP для мониторинга сервера.integer-Нет
https_portПорт HTTPS для мониторинга сервера.integer-Нет
http_base_pathБазовый путь конечных точек мониторинга.string-Нет*
connect_error_reportsЧисло попыток, через которое сообщается о повторяющейся ошибке подключения маршрута, шлюза или листового узла. Попытки подключения выполняются раз в секунду.integer3600Да*
reconnect_error_reportsЧисло неудачных попыток переподключения маршрута, шлюза или листового узла между сообщениями об ошибке. По умолчанию сообщается о каждой попытке.integer1Да
max_traced_msg_lenОграничить объём полезной нагрузки сообщения, записываемый в трассировку.integer0Да

* Ограничения перезагрузки описаны на странице параметра.

Настройки времени выполнения​

ИмяОписаниеТипПо умолчаниюПерезагрузка
max_control_lineМаксимальная длина строки протокола (включая суммарную длину субъекта и группы очереди). Использование увеличенного значения может потребовать изменений в клиентах. Применяется ко всему трафику.string4KBДа*
max_connectionsМаксимальное число активных клиентских соединений.string64KДа
max_payloadМаксимальное число байтов полезной нагрузки сообщения. Уменьшение размера может потребовать реализации разбиения сообщений в клиентах. Применяется к полезной нагрузке клиентов и листовых узлов. Значения больше 8 МБ не рекомендуются, однако max_payload можно увеличить до 64 МБ. Максимальная полезная нагрузка не должна превышать max_pending.string1MBДа
max_pendingМаксимальное число байтов, буферизуемых для соединения. Применяется к клиентским соединениям. Приложения также могут задавать PendingLimits (число сообщений и общий размер) для своих подписок.string64MBНет
max_subscriptionsМаксимальное число подписок на соединение аккаунта клиента или листового узла. Значение 0 снимает ограничение.string0Нет*
max_subscription_tokensinteger-Нет
ping_intervalИнтервал отправки ping клиентам, листовым узлам и маршрутам. При наличии клиентского трафика, например сообщений или ping от клиента, сервер не отправляет ping. Поэтому рекомендуется задавать значение больше используемого клиентами.string2mДа
ping_maxЧисло оставшихся без ответа ping, после которого сервер закрывает соединение.integer2Да
max_closed_clientsЧисло закрытых соединений, сохраняемых сервером для отчётов /connz.integer10000Нет
no_fast_producer_stallНе задерживать быстрого издателя, когда потребитель не успевает. Вместо этого сервер отбрасывает сообщения для медленного потребителя.booleanfalseДа
default_sentinelИмя пользователя для соединений, аутентифицирующихся с помощью sentinel JWT, который сам по себе не содержит разрешений.string-Да
write_deadlineМаксимальное время блокировки сервера при записи в секундах. При превышении соединение закрывается. О способах обработки на стороне клиента см. раздел о медленных потребителях.duration10sДа*
no_header_supportОтключает поддержку заголовков сообщений.boolean-Нет
disable_sublist_cacheЕсли true, отключает кэши подписок для всех аккаунтов. Это экономит ресурсы, когда постоянно используются разные субъекты.booleanfalseНет
lame_duck_durationДолжно быть не менее 30 с.duration2mНет
lame_duck_grace_periodВремя ожидания сервера после перехода в режим lame duck до начала закрытия клиентских соединений.duration10sНет
pidfilestring-Да
ports_file_dirstring-Да
prof_block_rateЧастота выборки профиля блокировок Go. Задавайте только при профилировании: параметр замедляет сервер.integer-Да
prof_portinteger-Нет
default_js_domainОтображение аккаунтов на доменные имена.string-Нет

* Ограничения перезагрузки описаны на странице параметра.