ppem-agent.yml
ppem-agent.yml — Файл конфигурации YAML для агента
Обзор #
Файл конфигурации агента расположен в /etc/ppem-agent.yml.
Вы можете указать способ обработки параметров с помощью специального параметра agent.remote_config.
После внесения любых изменений в файл конфигурации необходимо перезапустить службу агента:
systemctl restart ppem-agent
Файл конфигурации состоит из следующих разделов:
agent: общие параметры агента.autodiscovery: параметры автоматического обнаружения.log: параметры журналирования.http: HTTP-параметры.jwt: параметры JWT-сеансов.
Общие параметры агента #
Раздел agent позволяет настраивать общие параметры агента.
agent: name:уникальное_имя_агентаremote_config:true_или_falsemanager: {параметры_подключения_к_менеджеру} instance: {параметры_обнаружения_экземпляров} commands: {параметры_выполнения_команд} collectors: {параметры_сборщиков} system: {системные_параметры} reconnection_delay:базовая_задержка_между_попытками_повторного_подключенияconnect_timeout:тайм_аут_установки_подключения_к_менеджеруrequest_timeout:тайм_аут_запроса_JSON_RPCread_timeout:тайм_аут_чтения_из_потока_WebSocketwrite_timeout:тайм_аут_записи_в_поток_WebSocketping_interval:интервал_отправки_пингов_менеджеру_для_проверки_состоянияmax_connections:максимальное_количество_подключений_к _экземплярам_СУБД
Основные параметры #
Перечисленные здесь основные параметры позволяют настроить главные аспекты работы агента.
name:уникальное_имя_агентаremote_config:true_или_false
-
name(string, необязательный)# Уникальное имя агента.
PPEM использует это имя для разграничения агентов.
Значение по умолчанию:
""(пустая строка) — используется имя хоста операционной системы.-
remote_config(boolean, необязательный)# Некоторые параметры конфигурации агента совпадают с параметрами менеджера.
Файл конфигурации содержит специальный параметр
remote_config.Если для этого параметра указано значение
true, значения, полученные удалённо от менеджера, имеют приоритет над значениями из файла конфигурации.Значение по умолчанию:
false— агент использует параметры из файла конфигурации.
Параметры подключения к менеджеру #
Подраздел agent.manager позволяет настроить параметры подключения к менеджеру.
url:URL-адрес_менеджераapi_key:API_ключ_для_подключения_к_менеджеруtls: cert_file:файл_публичного_сертификатаkey_file:файл_закрытого_ключаroot_ca_file:файл_корневого_сертификата_cainsecure_skip_verify:true_или_falsestrict_address_checking:true_или_falseallowed_addresses: [список_разрешённых_адресов]
-
url(string, непустое значение)# URL-адрес менеджера.
Значения для формирования URL-адреса можно получить из параметров менеджера http.server.address и http.server.port.
Значение по умолчанию:
http://127.0.0.1:8080.-
api_key(string, непустое значение)# API-ключ для подключения к менеджеру.
Чтобы получить ключ:
В навигационной панели перейдите в Главная.
Если на странице отображается инструкция по установке агента, скопируйте ключ из инструкции.
Если инструкции нет, выполните следующие действия:
В навигационной панели перейдите в Инфраструктура → Агенты.
В столбце Ключ аутентификации для любого агента нажмите либо , чтобы скопировать ключ, либо , чтобы посмотреть ключ.
-
tls(object)# Параметры TLS-сертификата, необходимые для включения HTTPS и взаимной проверки TLS (mTLS) для агента.
Если механизм mTLS включён и настроен как на стороне менеджера, так и на стороне агента, то он добавляет дополнительный уровень безопасности.
-
cert_file(string, необязательный)# Абсолютный путь к файлу публичного сертификата.
Значение по умолчанию:
""(пустая строка).-
key_file(string, необязательный)# Абсолютный путь к файлу закрытого ключа.
Значение по умолчанию:
""(пустая строка).-
root_ca_file(string, необязательный)# Абсолютный путь к корневому CA-сертификату, который используется для проверки сертификата менеджера.
Значение по умолчанию:
""(пустая строка).-
отключить_проверку_безопасности(boolean, необязательный)# Важно
Использование этого параметра представляет риск для безопасности.
Рекомендуется использовать его исключительно для тестирования и отладки, но не в эксплуатационной среде.
Указывает, отключена ли проверка TLS-сертификата менеджера.
Значение по умолчанию:
false— сертификат проверяется.
-
-
strict_address_checking(boolean, необязательный)# Указывает, включён ли механизм обеспечения безопасности IP Source Guard.
Когда этот механизм включён, агент используют IP-адреса из списка allowed_addresses при подключении к URL-адресу, указанному в параметре manager.url.
В этом случае не выполняется разрешение доменного имени.
Если для этого параметра указано значение
falseили списокallowed_addressesпуст, IP-адрес извлекается напрямую из URL-адреса, либо определяется в процессе разрешения доменного имени.Значение по умолчанию:
false— механизм IP Source Guard не используется.-
allowed_addresses(список строк, необязательный)# Список IPv4- или IPv6-адресов, используемых, если для параметра manager.strict_address_checking указано значение
true.Значение по умолчанию:
[](пустой список).
Параметры обнаружения экземпляров #
Подраздел agent.instance позволяет настроить параметры обнаружения экземпляров.
connection_defaults: host:имя_хостаport:номер_портаdatabase:имя_базы_данныхuser:имя_пользователяpassword:пароль_пользователяpassword_file:путь_к_файлу_паролейsslmode:режим_безопасного_подключенияsslrootcert:путь_к_корневому_CA-сертификатуsslcert:путь_к_клиентскому_SSL-сертификатуsslkey:путь_к_закрытому_ключу_для_клиентского_SSL-сертификата
-
connection_defaults(object)# Параметры, используемые агентом при подключении к обнаруженным экземплярам.
Если не указать параметры
ssl*(указать пустые строки), агент подключается к экземплярам, используя небезопасные подключения.За подробной информацией об этих параметрах обратитесь к официальной документации Postgres Pro по libpq.
-
host(string)# Имя хоста для подключения.
Значение по умолчанию:
localhost.-
port(номер порта)# Номер порта для подключения на хосте сервера.
Значение по умолчанию:
5432.-
database(string)# Имя базы данных.
Значение по умолчанию:
postgres.-
user(string)# Имя пользователя для подключения.
Значение по умолчанию:
postgres.-
password(string, необязательный)# Пароль пользователя.
В зависимости от содержимого файла конфигурации
pg_hba.conf, пароль может быть обязательным или необязательным.Вместо этого параметра пароль можно указать в файле паролей.
Значение по умолчанию:
postgres.-
password_file(string)# Имя файла, используемого для хранения пароля пользователя.
Этот файл должен быть настроен с режимом доступа
0600, а также быть доступным пользователю операционной системы, от имени которого запущена служба агента.Если указаны оба параметра —
passwordиpassword_file, первый параметр имеет приоритет перед вторым.-
sslmode(string, необязательный)# Режим работы безопасного TCP/IP-соединения, защищённого SSL.
Значение по умолчанию:
""(пустая строка) — используется режимprefer.-
sslrootcert(string, необязательный)# Имя файла, содержащего SSL-сертификат(ы) центра сертификации (CA).
Значение по умолчанию:
""(пустая строка) — используются сертификаты из хранилища операционной системы.-
sslcert(string, необязательный)# Имя файла клиентского SSL-сертификата.
Значение по умолчанию:
""(пустая строка).-
sslkey(string, необязательный)# Имя файла закрытого ключа для клиентского SSL-сертификата.
Значение по умолчанию:
""(пустая строка).
-
Параметры выполнения команд #
Подраздел agent.commands позволяет настроить параметры выполнения команд.
Агент получает команды от менеджера и выполняет их.
max_workers:максимальное_количество_активных_рабочих_процессовtimeout:тайм_аут_выполнения_командfeedback_interval:интервал_отправки_метаданных_командallowed_bindirs: paths: [список_путей_файловой_системы]
-
max_workers(integer, необязательный)# Максимальное количество активных рабочих процессов, которые выполняют команды.
Если достигнуто максимальное количество рабочих процессов и все они заняты выполнением команд, новые поступающие команды ставятся в очередь до освобождения любого рабочего процесса.
Значение по умолчанию:
6.-
timeout(time string, необязательный)# Тайм-аут выполнения команд.
Если команда выполняется дольше указанного тайм-аута, её выполнение принудительно завершается.
Значение по умолчанию:
5h.-
feedback_interval(time string, необязательный)# Интервал отправки метаданных выполнения команд менеджеру.
Значение по умолчанию:
30s.-
allowed_bindirs.paths(список строк, необязательный)# Список путей файловой системы, из которых агент может выполнять команды.
Значение по умолчанию:
[](пустой список).
Параметры сборщиков, которые обнаруживают объекты #
Подраздел agent.collectors позволяет настроить параметры сборщиков.
Сборщики — это фоновые процессы, которые собирают различную информацию о серверном окружении и отправляют её менеджеру.
timeout:тайм_аут_цикла_обнаружения_для_сборщикаhost: interval:интервал_между_циклами_сбора_данныхbindirs: paths: [список_путей_файловой_системы_в_которых_можно_выполнять_поиск] agent: interval:интервал_между_циклами_сбора_данныхinstances: disabled:true_или_falseinterval:интервал_между_циклами_сбора_данныхinstance_objects: batch_size:размер_пакета_для_отправки_в_одном_запросеinterval:интервал_между_циклами_сбора_данныхinitial_delay:начальная_задержка_обнаруженияjitter_interval:джиттер_начальной_задержки_обнаруженияextended: enabled:true_или_falseschedule:выражение_расписания_CRONinstance_settings: interval:интервал_между_циклами_сбора_данныхreplication: interval:интервал_между_циклами_сбора_данных
-
timeout(time string, необязательный)# Тайм-аут цикла обнаружения для сборщика.
Значение по умолчанию:
30m.-
host(object)# Параметры сборщика
host.Этот сборщик обнаруживает и собирает информацию об операционной системе, в которой запущена служба агента.
-
interval(time string, необязательный)# Интервал между циклами сбора данных.
Значение по умолчанию:
1m.-
bindirs.paths(список строк, необязательный)# Список путей файловой системы для поиска исполняемых файлов и пакетов.
Этот список используется в качестве дополнения к списку commands.allowed_bindirs.paths.
Значение по умолчанию:
[](пустой список) — используются только пути, указанные в параметреcommands.allowed_bindirs.paths.
-
-
agent(object)# Этот сборщик обнаруживает и собирает информацию о запущенной службе агента.
-
interval(time string, необязательный)# Интервал между циклами сбора данных.
Значение по умолчанию:
1m.
-
-
instances(object)# Этот сборщик обнаруживает экземпляры.
-
instance_objects(object)# Этот сборщик обнаруживает различные объекты, существующие в экземплярах, такие как схемы, таблицы и т.д.
-
batch_size(integer, необязательный)# Размер пакета для отправки в одном запросе менеджеру.
Этот параметр полезен, когда экземпляр содержит большое количество объектов.
Значение по умолчанию:
1000.-
interval(time string, необязательный)# Интервал между циклами сбора данных.
Значение по умолчанию:
1m.-
initial_delay(time string, необязательный)# Начальная задержка перед первым циклом сборки данных.
С помощью этого параметра можно снизить нагрузку на СУБД.
Значение по умолчанию:
0s— нет задержки.-
jitter_interval(time string, необязательный)# Значение джиттера для initial_delay.
Реальная начальная задержка становится случайной в диапазоне
[initial_delay - jitter;initial_delay + jitter], что позволяет избежать перегрузки экземпляров запросами от сборщика.Значение по умолчанию:
0s.-
extended(object)# Расширенные параметры обнаружения.
-
enabled(boolean, необязательный)# Указывает, включено ли расширенное обнаружение объектов экземпляров.
Включение этого параметра может привести к снижению производительности, если экземпляр содержит большое количество объектов.
Значение по умолчанию:
true— расширенное обнаружение включено.-
schedule# Выражение расписания CRON, определяющее время запуска расширенного процесса обнаружения объектов, например:
@every 5m
Расписание можно настроить так, чтобы процесс обнаружения запускался в моменты минимальной нагрузки на экземпляр. Например, в ночное время или в выходные дни.
Значение по умолчанию:
""(пустая строка) — используется значение instance_objects.interval × 5.
-
-
-
instance_settings(object)# Этот сборщик обнаруживает параметры экземпляров.
-
interval(time string, необязательный)# Интервал между циклами сбора данных.
Значение по умолчанию:
1m.
-
-
репликации(object)# Этот сборщик обнаруживает конфигурацию репликации экземпляров.
-
interval(time string, необязательный)# Интервал между циклами сбора данных.
Значение по умолчанию:
10s.
-
Системные параметры #
Подраздел agent.system позволяет настроить различные системные параметры.
systemd_units_path:путь_к_хранилищу_файлов_юнитов_systemdpostgresql_configs_path:путь_к_хранилищу_файлов_конфигурации_Postgres
-
systemd_units_path(string, необязательный)# Путь к хранилищу, в котором агент хранит файлы юнитов systemd, необходимые для работы агента.
Значение по умолчанию:
""(пустая строка).-
postgresql_configs_path(string, необязательный)# Путь к хранилищу, в котором агент хранит файлы конфигурации PostgreSQL или Postgres Pro, необходимые для работы агента.
Значение по умолчанию:
""(пустая строка).
Параметры различных временных интервалов и тайм-аутов #
В этом разделе можно настроить различные временные интервалы и тайм-ауты.
reconnection_delay:базовая_задержка_между_попытками_повторного_подключенияconnect_timeout:тайм_аут_установки_подключения_к_менеджеруrequest_timeout:тайм_аут_запроса_JSON_RPCread_timeout:тайм_аут_чтения_из_потока_WebSocketwrite_timeout:тайм_аут_записи_в_поток_WebSocketping_interval:интервал_отправки_пингов_менеджеру_для_проверки_состоянияmax_connections:максимальное_количество_подключений_к _экземплярам_СУБД
-
reconnection_delay(time string, необязательный)# Базовая задержка между попытками повторного подключения при потере соединения с менеджером.
Реальная задержка является случайной и находится в диапазоне
[0.75×base_delay;1.25×base_delay], что позволяет избежать перегрузки менеджера одновременными попытками подключения от нескольких агентов.Значение по умолчанию:
2s.-
connect_timeout(time string, необязательный)# Тайм-аут установки подключения к менеджеру.
Если менеджер не отвечает в течение этого времени, агент пытается выполнить повторное подключение.
Значение по умолчанию:
2s.-
request_timeout(time string, необязательный)# Тайм-аут запросов JSON-RPC.
Значение по умолчанию:
2s.-
read_timeout(time string, необязательный)# Тайм-аут чтения из потока WebSocket.
Значение по умолчанию:
30s.-
write_timeout(time string, необязательный)# Тайм-аут записи в поток WebSocket.
Значение по умолчанию:
2s.ping_interval#Интервал отправки эхо-запросов менеджеру для поддержания существующего подключения (keep-alive).
Если значение не указано, автоматически используется значение, равное 80% от величины значения read_timeout.
-
max_connections(integer, необязательный)# Максимальное количество одновременных подключений к экземплярам.
Значение по умолчанию:
0— не ограничено.
Параметры автоматического обнаружения #
В этом разделе можно задать шаблон имени для экземпляров, обнаруженных автоматически.
autodiscovery:
instance_name_template: шаблон_имени_экземпляра-
instance_name_template(string, необязательный)# Шаблон имени для экземпляров, обнаруженных автоматически.
Менеджер также поддерживает этот параметр. При этом значение из файла конфигурации агента имеет приоритет над значением, заданным в файле конфигурации менеджера.
Этот параметр используется агентом при регистрации экземпляра.
Шаблон должен представлять собой одну строку без переносов.
Поддерживаются следующие переменные:
{{.Host}},{{.HostName}},{{.Port}},{{.Version}},{{.Edition}},{{.ServiceType}},{{.ClusterType}}и{{.SystemIdentifier}}.Если полученное имя совпадает с именем существующего экземпляра, к нему добавляется числовой суффикс (
-1,-2и так далее).Если шаблон не задан ни агентом, ни менеджером, используется шаблон по умолчанию
instance-{ID}.Значение по умолчанию:
""(пустая строка).
Параметры журналирования #
Раздел log позволяет настроить параметры журналирования агента.
log: level:уровень_журналированияformat:формат_журналовoptions: csv_field_delimiter:символ_разделителяfile: path:абсолютный_путь_к_файлу_журналаmode:режим_доступа_к_файлу_журналаrotation_age:интервал_ротации_файла_журналаrotation_size:размер_файла_журнала_для_ротации
-
level(enum)# Уровень журналирования.
Возможные значения:
debuginfowarnerror
Каждый уровень журналирования включает в себя предыдущие, например
warnсодержит сообщения журнала уровнейinfoиdebug.-
format(enum, необязательный)# Формат журналирования.
Возможные значения:
json: формат JSON.pretty: отформатированный формат JSON, например создаваемый утилитой jq.csv: текстовый формат CSV.Разделитель CSV можно указать с помощью параметра
options.csv_field_delimiter.
Значение по умолчанию:
json.-
options.csv_field_delimiter(string, необязательный)# Строка из одного символа, которая используется в качестве разделителя CSV.
Этот параметр применим, только если для параметра
formatуказано значениеcsv.Значение по умолчанию:
,(символ запятой).-
file(object, необязательный)# Файл для записи журналов. У агента должны быть права на запись в этот файл. Если файл не существует, агент создаёт его автоматически.
Если этот параметр не указан, PPEM записывает журналы в
stdout.PPEM выполняет ротацию файла журнала, если выполняется любое из следующих условий:
Служба ppem-agent получает сигнал
SIGHUP.Время жизни или размер файла журнала равен значению параметра
rotation_ageилиrotation_sizeсоответственно.
При ротации файла журнала PPEM сохраняет его и добавляет метку времени к его имени. Затем файл журнала, указанный в параметре
path, очищается.-
path(string, непустое значение)# Абсолютный путь к файлу журнала, например
/var/log/ppem.log.-
mode(string, непустое значение)# Числовая строка, которая определяет режим доступа к файлу в формате, аналогичном формату, используемому chmod, например
0644.-
rotation_age(time string, необязательный)# Максимальное время жизни отдельного файла журнала. По истечении этого времени создаётся новый файл.
Значение по умолчанию:
""(пустая строка) — смена файлов по времени жизни не производится.-
rotation_size(string, необязательный)# Максимальный размер отдельного файла журнала. При достижении этого размера создаётся новый файл.
Значение по умолчанию:
""(пустая строка) — смена файлов по размеру не производится.
Параметры HTTP #
Раздел http позволяет настроить параметры HTTP-сервера и клиента, а также несколько параметров, связанных с API.
http:
server:
address: сетевой_адрес_прослушивания
port: сетевой_порт_прослушивания
tls:
cert_file: файл_публичного_сертификата
key_file: файл_закрытого_ключа
timeout: тайм_аут_обработки_HTTP_запросов
security:
enabled: true_или_false
csp_policy: заголовок_content_security_policy
cache_control: заголовок_cache_control
pragma: заголовок_Pragma
expires: заголовок_expires
frame_options: заголовок_x_content_type
content_type_options: заголовок_x_content_type_options
permissions_policy: заголовок_permissions_policy
referrer_policy: заголовок_referrer_policy
strict_transport_security: заголовок_strict_transport_security
cross_origin_embedder_policy: заголовок_cross_origin_embedder_policy
cross_origin_opener_policy: заголовок_cross_origin_opener_policy
cross_origin_resource_policy: заголовок_cross_origin_resource_policy
client:
timeouts:
http: тайм_аут_HTTP_запросов
tls_handshake: тайм_аут_TLS-рукопожатия
dialer: тайм_аут_установки_подключения_к_серверу_для_HTTP
response_header: тайм_аут_ожидания_заголовков_HTTP_ответа
insecure_skip_verify: пропустить_проверку_сертификата_сервера
root_ca_files: [список_файлов_корневых_сертификатов_CA]
pagination:
max_page_size: максимальное_количество_объектов_в_одном_ответеПараметры HTTP-сервера #
-
address(string, необязательный)# Сетевой адрес, на котором необходимо слушать.
Если указать пустую строку, сервер будет слушать на всех сетевых интерфейсах.
Значение по умолчанию:
localhost.-
port(номер порта, необязательный)# Сетевой порт, на котором необходимо слушать.
Значение по умолчанию:
8080.-
tls(object)# Параметры TLS-сертификата, необходимые для включения HTTPS на сервере.
Если не указать файлы сертификата и ключа (пустые строки), агент использует HTTP вместо HTTPS.
-
timeout(time string, необязательный)# Тайм-аут обработки HTTP-запроса.
Значение по умолчанию:
10s.-
security(object)# Параметры безопасности HTTP-сервера. Эти параметры в основном используются для указания значений HTTP-заголовков, связанных с безопасностью.
Параметры
cross-origin-*-policyнеобходимо настроить вручную, так как PPEM не предоставляет для них значений по умолчанию.-
enabled(boolean, необязательный)# Указывает, включена ли обработка HTTP-заголовков, связанных с безопасностью.
Значение по умолчанию:
false— обработка отключена.-
csp_policy(string, необязательный)# Значение HTTP-заголовка ответа Content-Security-Policy. Помогает предотвратить XSS, кликджекинг и другие атаки с внедрением кода.
Значение по умолчанию зависит от того, настроен ли HTTP-сервер на работу с HTTPS:
Режим HTTP:
default-src 'none'; script-src 'self' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: blob:; font-src 'self'; connect-src 'self'; media-src 'self'; form-action 'self'; base-uri 'self'; frame-ancestors 'none'; frame-src https://postgrespro.com/; object-src 'none'.Режим HTTPS:
default-src 'none'; script-src 'self' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: blob:; font-src 'self'; connect-src 'self'; media-src 'self'; form-action 'self'; base-uri 'self'; frame-ancestors 'none'; frame-src https://postgrespro.com/; object-src 'none'; upgrade-insecure-requests.
-
cache_control(string, необязательный)# Значение HTTP-заголовка Cache-Control. Управляет кешированием в браузерах. Значение по умолчанию помогает предотвратить кеширование API-ответов, которые могут содержать конфиденциальные или постоянно изменяющиеся данные.
Значение по умолчанию:
no-store, no-cache, must-revalidate.-
pragma(string, необязательный)# Значение HTTP-заголовка Pragma.
Этот заголовок является устаревшим и обеспечивает обратную совместимость с кешами HTTP/1.0, которые не поддерживают HTTP-заголовок Cache-Control.
Значение по умолчанию:
no-cache.-
expires(string, необязательный)# Значение HTTP-заголовка ответа Expires.
Этот заголовок обеспечивает обратную совместимость с кешами HTTP/1.0, которые не поддерживают HTTP-заголовок Cache-Control.
Значение по умолчанию:
0.-
frame_options(string, необязательный)# Значение HTTP-заголовка ответа X-Frame-Options. Помогает предотвратить кликджекинг-атаки.
Значение по умолчанию:
""(пустая строка).-
content_type_options(string, необязательный)# Значение HTTP-заголовка ответа X-Content-Type-Options. Помогает предотвратить атаки с подменой MIME-типов.
Значение по умолчанию:
""(пустая строка).-
permissions_policy(string, необязательный)# Значение HTTP-заголовка ответа Permissions-Policy. Определяет, какие возможности браузера и API устройств могут быть использованы. Значение по умолчанию запрещает доступ к возможностям, которые могут раскрыть конфиденциальную информацию, таким как камера, микрофон и геолокация.
Значение по умолчанию:
"accelerometer=(), autoplay=(), camera=(), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()".-
referrer_policy(string, необязательный)# Значение HTTP-заголовка ответа Referrer-Policy. Определяет, какой объём информации о реферере включается в запросы.
Значение по умолчанию:
strict-origin-when-cross-origin.-
strict_transport_security(string, необязательный)# Значение HTTP-заголовка ответа Strict-Transport-Security. Принудительно заставляет браузеры использовать только HTTPS-подключения. Применяется, только если HTTP-сервер настроен на работу с HTTPS, иначе игнорируется.
Значение по умолчанию:
Режим HTTP:
""(пустая строка) — не применимо.Режим HTTPS:
max-age=31536000; includeSubDomains.
-
cross_origin_embedder_policy(string)# Значение HTTP-заголовка ответа Cross-Origin-Embedder-Policy.
Значение по умолчанию:
""(пустая строка).-
cross_origin_opener_policy(string)# Значение HTTP-заголовка ответа Cross-Origin-Opener-Policy.
Значение по умолчанию:
""(пустая строка).-
cross_origin_resource_policy(string)# Значение HTTP-заголовка ответа Cross-Origin-Resource-Policy.
Значение по умолчанию:
""(пустая строка).
-
Параметры HTTP-клиента #
-
timeouts(object)# Тайм-ауты для HTTP-клиента.
-
http(time string)# Тайм-аут HTTP-запроса.
Значение по умолчанию:
10s.-
tls_handshake(time string)# Тайм-аут TLS-рукопожатия.
Значение по умолчанию:
2s.-
dialer(time string)# Тайм-аут установки подключения, когда клиент пытается подключиться к серверу. Попытка подключения должна завершиться успешно в течение этого интервала времени.
Значение по умолчанию:
2s.-
response_header(time string)# Тайм-аут ожидания HTTP-заголовков ответа после отправки HTTP-запроса серверу.
Значение по умолчанию:
10s.
-
-
отключить_проверку_безопасности(boolean, необязательный)# Важно
Использование этого параметра представляет риск для безопасности.
Рекомендуется использовать его исключительно для тестирования и отладки, но не в эксплуатационной среде.
Указывает, отключена ли проверка TLS-сертификата сервера.
Значение по умолчанию:
false— сертификат проверяется.-
root_ca_files(список строк, необязательный)# Список абсолютных путей к корневым CA-сертификатам, которые используются для проверки сертификата сервера.
Значение по умолчанию:
[](пустой список) — используются сертификаты из хранилища операционной системы.
Параметры JWT-сеансов #
Раздел jwt позволяет настроить параметры, связанные с JSON Web Tokens.
jwt: secret:секрет_для_подписи_токенов_JWTlifetime: access:время_жизни_токена_доступаrefresh:время_жизни_токена_обновления
-
secret(string)# Секрет, используемый для подписи выпущенного токена.
Токены обновления используются для выпуска токенов доступа. Токены доступа используются для аутентификации пользователей в PPEM.
За подробной информацией об этих токенах обратитесь к Разделу 7.5.
Значение по умолчанию:
secret.-
lifetime(object)# Значения времени жизни токенов. Токен, срок действия которого превышает указанное значение, считается истёкшим и не может быть использован. В таком случае необходимо выпустить новый токен.
Параметры OpenTelemetry (OTLP) #
Раздел otlp позволяет настроить параметры интеграции PPEM с инструментами трассировки, совместимыми с OpenTelemetry.
otlp:
traces:
sampler_ratio: коэффициент_выборки_трассировок
exporter:
protocol: протокол_экспорта_трассировок
endpoint_url: URL_конечной_точки_для_экспорта_трассировок
tls:
insecure_skip_verify: пропустить_проверку_сертификата_сборщика-
traces(object)# Параметры трассировки.
-
sampler_ratio(float, необязательный)# Процент трассировок, который подлежит выборке.
В зависимости от значения параметра выборка трассировок выполняется следующим образом:
0.0 <
sampler_ratio< 1.0: выборке подлежит указанный процент трассировок.Например, значение
0.7означает, что выборке подлежит 70% трассировок.sampler_ratio≥ 1.0: выборке подлежат все трассировки.Пример значения:
1.8.sampler_ratio≤ 0.0: никакие трассировки не подлежат выборке.Пример значения:
-3.3.
Значение по умолчанию:
1.0— выборке подлежат все трассировки.-
exporter(object)# Параметры экспортера.
-
protocol(enum, необязательный)# Протокол OpenTelemetry для экспорта трассировок.
Возможные значения:
http: OTLP через HTTP.grpc: OTLP через gRPC.Пустая строка: экспорт трассировок отключён.
Значение по умолчанию:
""(пустая строка) — экспорт трассировок отключён.-
endpoint_url(string, непустое значение)# URL-адрес конечной точки сборщика, используемый экспортером для отправки трассировок.
URL-адрес может содержать номер порта и путь, но не должен содержать полную или частичную строку запроса.
Примеры:
Для OTLP через HTTP:
http://localhost:4318/v1/traces.Для OTLP через gRPC:
http://localhost:4317.
-
tls.insecure_skip_verify(boolean, необязательный)# Важно
Использование этого параметра представляет риск для безопасности.
Рекомендуется использовать его исключительно для тестирования и отладки, но не в эксплуатационной среде.
Указывает, отключена ли проверка TLS-сертификата сервера.
Значение по умолчанию:
false— сертификат проверяется.
-
-