Параметры АктивногоШлюза
Основные правила работы с конфигурацией АктивногоШлюза
Файлы конфигурации АктивногоШлюза
Многие параметры конфигурации АктивногоШлюза (например, параметры подключения и прокси-сервера, шифры или параметры дампа памяти) хранятся в файлах свойств config.properties и custom.properties, которые расположены в каталоге конфигурации АктивногоШлюза. Свойства, перечисленные в файлах свойств, применимы для АктивныхШлюзов Окружений и Кластера.
Файлы config.properties и custom.properties разделены на секции. Каждое название раздела заключено в квадратные скобки, например:
[collector]
MSGrouter = true
restInterface = true
DumpSupported = false
config.properties
Файл конфигурации config.properties содержит параметры установки АктивногоШлюза по умолчанию и не может быть изменен. Примечание: Этот файл конфигурации перезаписывается при каждом обновлении АктивногоШлюза.
custom.properties
Настройки, хранящиеся в custom.properties, переопределяют соответствующие настройки в config.properties, и во время обновления файл копируется в новую версию АктивногоШлюза.
Файлы конфигурации разбиты на [разделы], которые указаны в квадратных скобках.
Чтобы указать настраиваемые параметры в custom.properties, введите имена разделов и включите соответствующие свойства в эти разделы.
Вы можете использовать файл config.txt в качестве справки при добавлении пользовательских настроек в файл custom.properties. Файл config.txt, который также находится в каталоге конфигурации АктивногоШлюза, не используется АктивныйШлюз, однако содержит справочный список возможных свойств конфигурации. Кроме того, вы можете сначала найти соответствующий раздел в файле config.properties, а затем скопировать заголовок раздела вместе с именами нужных свойств в custom.properties.
После этого вы можете изменить записи в разделе по мере необходимости.
launcheruserconfig.conf
Средство запуска АктивногоШлюза — это наблюдающий процесс, который запускает виртуальную машину Java для вашего АктивногоШлюза. Конфигурация лаунчера хранится в файле launcheruserconfig.conf в каталоге конфигурации АктивногоШлюза. Он содержит свойства и параметры запуска, которые передаются виртуальной машине Java.
Файл launcheruserconfig.conf сохраняется во время обновлений АктивногоШлюза.
Перезапуск АктивногоШлюза
Если вы меняете конфигурацию АктивногоШлюза, вы должны перезапустить основную службу АктивногоШлюза, чтобы ваши изменения вступили в силу.
Ограничения памяти АктивногоШлюза
Ограничения на использование памяти для АктивногоШлюза можно указать в конфигурационном файле лаунчера launcheruserconfig.conf.
- Настройки ограничения памяти могут быть комбинацией:
-java.xmx.relative_part— процента доступной оперативной памяти-java.xmx.absolute_part— абсолютного значения объема памяти в МБ.
Например:
# Xmx settings 83% of available RAM + 0 MB
-java.xmx.absolute_part=0
-java.xmx.relative_part=83
-healthcheck.heartbeat.portrange=60100:60200
-arguments_section.jvm
-Dsomecustomproperty=value
Диапазон портов АктивногоШлюза
Средство запуска АктивногоШлюза отслеживает процесс АктивногоШлюза на локальном контрольном порту. Этот порт выбирается программой запуска из предопределенного диапазона портов, указанного в конфигурации программы запуска. Программа запуска находит свободный порт в заданном диапазоне, а затем передает номер порта процессу АктивногоШлюза.
По умолчанию программа запуска будет использовать порты выше 50000 для мониторинга пульса. Для некоторых развертываний может потребоваться настроить для этой цели другие порты. Чтобы указать диапазон портов, который должен использовать модуль запуска АктивногоШлюза, добавьте или измените свойство -healthcheck.heartbeat.portrange в файле конфигурации модуля запуска launcheruserconfig.conf, как в примере ниже.
# Xmx settings 80% of available RAM + 0 MB
-java.xmx.absolute_part=0
-java.xmx.relative_part=83
-healthcheck.heartbeat.portrange=60100:60200
-arguments_section.jvm
-Dsomecustomproperty=value
Пользовательские параметры для Java-процесса АктивногоШлюза
Чтобы передать пользовательские параметры Java-процессу АктивногоШлюза, укажите параметры в конфигурационном файле лаунчера launcheruserconfig.conf:
- Все строки после
-arguments_section.jvmпередаются в качестве аргументов JVM. Таким образом, указав опции-D, вы можете указать аргументы для АктивногоШлюза.
Например:
# Xmx settings 80% of available RAM + 0 MB
-java.xmx.absolute_part=0
-java.xmx.relative_part=83
-healthcheck.heartbeat.portrange=60100:60200
-arguments_section.jvm
-Dsomecustomproperty=value
Модули и разделы АктивногоШлюза
Различные функциональные возможности, предоставляемые АктивномуШлюзу, называются модулями. Когда вы устанавливаете АктивныйШлюз для определенной цели, устанавливается или включается другой набор модулей.
Модуль активен, если соответствующее свойство конфигурации указано со значением true в разделе конфигурации, посвященном модулю. Обратите внимание, однако, что вы не можете включить все модули, используя custom.properties, просто изменив значение свойства: если вы установили свой АктивныйШлюз, чтобы он служил в качестве частного синтетического местоположения или для мониторинга мейнфрейма, и вам нужно изменить цель вашего АктивногоШлюза , вам необходимо переустановить АктивныйШлюз.
Каждый модуль имеет соответствующий раздел в конфигурации
В дополнение к разделам конфигурации, предназначенным для определенных функций АктивногоШлюза, каждый модуль АктивногоШлюза имеет собственный раздел в файлах конфигурации АктивногоШлюза. Настройки, указанные в этом разделе, относятся именно к этому модулю. Это относится, например, к настройкам прокси. Однако не все настройки можно повторить таким образом и указать для модуля: каждый раздел модуля имеет только ограниченное количество принимаемых опций. НЕ копируйте параметры конфигурации между разделами, если только это не указано специально.
Модуль AWS
AWS-мониторинг
Раздел: [aws_monitoring]
| Свойство | Описание |
|---|---|
aws_monitoring_enabled
|
Включает модуль мониторинга AWS. Возможные значения: true или false.
|
Модуль Azure
Мониторинг Microsoft Azure
Раздел: [azure_monitoring]
| Свойство | Описание |
|---|---|
azure_monitoring_enabled
|
Включает модуль Microsoft Azure. Возможные значения: true или false.
|
Модуль Cloud Foundry
Мониторинг Cloud Foundry
Раздел: [cloudfoundry_monitoring]
| Свойство | Описание |
|---|---|
cloudfoundry_monitoring_enabled
|
Включает модуль Cloud Foundry. Возможные значения: true или false.
|
Этот раздел может содержать настройки прокси для связи с Cloud Foundry. Если в этом разделе указано proxy-off=true, то прокси для связи с Cloud Foundry отсутствует. Если он содержит свойство proxy-host, то для мониторинга Cloud Foundry будет использоваться именно этот прокси, а не прокси, указанный в [http.client.external].
Примечание. Если у вас есть раздел [cloudfoundry_monitoring] в вашем файле custom.properties, вам также необходимо иметь раздел [http.client.external], где вы должны указать все остальные параметры связи .rs, которые будут использоваться для связи Cloud Foundry.
Модуль Kubernetes
Мониторинг Kubernetes
Раздел: [kubernetes_monitoring]
| Свойство | Описание |
|---|---|
kubernetes_monitoring_enabled
|
Включает модуль мониторинга Kubernetes. Возможные значения: true или false.
|
Этот раздел может содержать параметры прокси-сервера для связи с Kubernetes, а также другие параметры, связанные с тонкой настройкой параметров связи для мониторинга Kubernetes.
Если в этом разделе указано proxy-off=true, то прокси для связи с Kubernetes отсутствует. Если он содержит свойство proxy-host, то для мониторинга Kubernetes будет использоваться именно этот прокси, а не прокси, указанный в [http.client.external].
Примечание. Если у вас есть раздел [kubernetes_monitoring] в файле custom.properties, вам также потребуется раздел [http.client.external], в котором вы должны указать все остальные параметры связи, которые будут использоваться для связи Kubernetes.
Модуль Мониторинга логов
Раздел: [log_analytics_collector]
| Свойство | Описание |
|---|---|
log_analytics_collector_enabled
|
Включает модуль мониторинга логов. Возможные значения: true или false.
|
Раздел: [generic_ingest]
В частности, для мониторинга журналов при настройке универсального приема журналов можно настроить свойства очереди данных журнала. Вы можете указать временную папку, в которой будут храниться данные журнала очереди (по умолчанию это временная папка, настроенная в настоящее время в вашей системе), и изменить максимальный размер очереди, которая будет использоваться в этой папке (размер по умолчанию — 300 МБ).
| Свойство | Значение по умолчанию | Описание |
|---|---|---|
disk_queue_path
|
Текущая общесистемная временная папка | Указывает путь к временной папке, в которой будут храниться данные журнала, поставленные в очередь. |
disk_queue_max_size_mb
|
300 МБ | Задает максимальный размер данных журнала в очереди, которые можно хранить во временной папке. |
Модуль VMware
Мониторинг VMware
Раздел: [vmware_monitoring]
| Свойство | Описание |
|---|---|
vmware_monitoring_enabled
|
Включает модуль мониторинга VMware. Возможные значения: true или false.
|
Модуль Анализа БД
Информация о базе данных Oracle
Раздел: [dbAgent]
| Свойство | Описание |
|---|---|
dbAgent_enabled
|
Включает модуль анализа базы данных Oracle. Возможные значения: true или false.
|
Модуль Расширений 1.0
Раздел: [rpm]
| Свойство | Описание |
|---|---|
rpm_enabled
|
Включает модуль удаленных плагинов, который используется для запуска расширений АктивногоШлюза. Возможные значения: true или false.
|
Модуль Расширений 2.0
Раздел: [extension_controller]
| Свойство | Описание |
|---|---|
extension_controller_enabled
|
Включает модуль Расширений 2.0. Возможные значения: true или false.
|
Модуль zRemote
Установка модуля zRemote для мониторинга z/OS.
Раздел: [zremote]
| Свойство | Описание |
|---|---|
zremote_enabled
|
Включает модуль zRemote. Возможные значения: true или false.
|
Модуль Синтетики
Синтетические мониторы из частных синтетических локаций
Раздел: [synthetic]
Настройки прокси для синтетического мониторинга. Если в этом разделе указано proxy-off=true, то прокси для Синтетического мониторинга нет. Если он содержит свойство proxy-host, то этот прокси будет использоваться для синтетического мониторинга, а не прокси, указанный в [http.client.external] (или в [http.client], если [http.client.external] не определено).
Примечание. Если у вас есть раздел [synthetic] в вашем файле custom.properties, у вас может быть раздел [http.client.external], в котором вы должны указать все остальные параметры связи, которые будут использоваться для синтетического мониторинга. Кроме того, вы можете указать остальные параметры связи в разделе [http.client].
Однако, если вы создаете раздел [http.client.external], вы должны указать там все параметры связи. В противном случае параметры связи для отслеживаемых сред (Cloud Foundry, Kubernetes или Synthetic Monitoring) вернутся к заводским значениям по умолчанию.
Обратите внимание, что изменение свойства synthetic_enabled работает только в том случае, если вы установили АктивныйШлюз для запуска синтетических мониторов из частного местоположения. Если вы установили АктивныйШлюз для маршрутизации трафика, мониторинга облачных сред или мониторинга удаленных технологий с помощью расширений или мониторинга мейнфрейма, вам необходимо переустановить АктивныйШлюз, чтобы использовать его для синтетического мониторинга.
| Свойство | Значение по умолчанию | Описание |
|---|---|---|
synthetic_enabled
|
false в режиме развертывания по умолчанию
|
Позволяет АктивномуШлюзу выполнять мониторы из частных синтетических местоположений. |
synthetic_autoinstall
|
true для автоматического обновления движка Синтетики
|
Автоматически устанавливается в true во время установки для синтетических АктивныхШлюзов.
|
proxy-server
|
unset | Адрес прокси-сервера |
proxy-port
|
unset | Порт прокси (числовой) |
proxy-user
|
unset | Имя пользователя прокси (необязательно) |
proxy-password
|
unset | Пароль прокси (необязательно)
Пароль, указанный в свойстве |
proxy-off
|
unset | Отключить прокси-связь между АктивнымШлюзом и тестируемым ресурсом. |
proxy-non-proxy-hosts
|
unset | Не использовать прокси при общении с этими хостами. |
Важно
Мы рекомендуем вам не изменять значение свойства synthetic_autoupgrade_chromium в custom.properties, поскольку ваши изменения могут быть перезаписаны.
synthetic_autoupgrade_chromium для автообновления Chromium можно определить на уровне местоположения (для местоположений с АктивнымиШлюзами Окружений) либо через веб-интерфейс, либо с помощью вызова PUT API местоположения API синтетических местоположений v2. Для АктивногоШлюза Кластера это свойство можно настроить с помощью вызова PUT (Ключ-АстромManaged) API Кластера v2. Это свойство не определено для АктивныхШлюзов, которые не были назначены местоположению. Для Activates, назначенных местоположению, значением по умолчанию является true.
Модуль Beacon Forwarder
Использование АктивногоШлюза для реального мониторинга пользователей
Раздел: [beacon_forwarder]
| Свойство | Описание |
|---|---|
beacon_forwarder_enabled
|
Включает модуль Beacon Forwarder. Возможные значения: true или false.
|
Модуль API HTTP-метрик
Прием метрик: простой способ передать любые пользовательские метрики в Ключ-Астром
Раздел: [metrics_ingest]
| Свойство | Описание |
|---|---|
metrics_ingest_enabled
|
Включает модуль HTTP Metric API, который упрощает прием метрик. Возможные значения: true или false.
|
Модуль Дампов памяти
Запуск и загрузка дампов памяти
Раздел: [collector]
| Свойство | Описание |
|---|---|
DumpSupported
|
Включает модуль дампов памяти. Возможные значения: true или false.
|
Когда в вашем приложении возникают утечки памяти или большое количество объектов, важно получить дампы памяти, чтобы вы могли проанализировать эти проблемы. В производственных средах это часто становится проблемой, когда вы не можете войти в среду и у вас нет других средств запуска дампов памяти. Ключ-Астром позволяет вам запускать и безопасно загружать дампы памяти в инструмент анализа по вашему выбору.
Модуль Маршрутизации ЕдиныхАгентов
АктивногоШлюза знает о структуре времени выполнения вашей среды и направляет сообщения от ЕдиныхАгентов на правильные конечные точки сервера. Он обрабатывает маршрутизацию сообщений, буферизацию, сжатие, аутентификацию и доступ к закрытым сетям.
Раздел: [collector]
| Свойство | Описание |
|---|---|
MSGrouter
|
Включает модуль маршрутизации ЕдиныхАгентов, который направляет трафик ЕдиныхАгентов и другого АктивногоШлюза через Ключ-Астром. Возможные значения: true или false.
|
Модуль OTLP-приёма
Этот модуль создает конечную точку на АктивномШлюзе, которая может получать данные трассировки OpenTelemetry (трассы и интервалы) в формате OTLP.
Раздел: [otlp_ingest]
| Свойство | Описание |
|---|---|
otlp_ingest_enabled
|
Включает модуль приема OTLP, который упрощает прием трассировки OpenTelemetry. Возможные значения: true или false.
|
Модуль REST API
Раздел: [collector]
Вы можете использовать АктивныйШлюз для доступа к API Ключ-Астром. АктивныйШлюз поддерживает вызовы всех конечных точек конфигурации и среды API в версиях v1 и v2. Чтобы получить доступ к API Ключ-Астром с помощью АктивногоШлюза, используйте URL-адрес в следующем формате: https://{ваш-АктивныйШлюз-домен}/e/{идентификатор вашей среды}/api/...
| Свойство | Описание |
|---|---|
restInterface
|
Включает модуль REST API, упрощающий доступ к API Ключ-Астром с помощью REST. Возможные значения: true или false.
|
Раздел Адреса балансировщика нагрузки
Раздел: [connectivity]
| Свойство | Значение по умолчанию | Описание |
|---|---|---|
dnsEntryPoint
|
unset | Точки входа для АктивногоШлюза (например, https://sg1.mydomain.com:9999). ЕдиныйАгент получает доступ к АктивномуШлюзу через этот URL-адрес (или список URL-адресов — значением этого свойства может быть список, разделенный запятыми). Если не задано, используется автоматически определяемая конечная точка. Эту запись можно использовать, если доступ к АктивномуШлюзу осуществляется, например, через внешний IP-адрес или балансировщик нагрузки. В зависимости от развертывания АктивногоШлюза убедитесь, что вы используете правильный префикс (http или https), иначе ваши ЕдиныеАгенты не смогут подключиться.
|
Раздел Сетевых зон
Раздел: [connectivity]
| Свойство | Значение по умолчанию | Описание |
|---|---|---|
networkZone
|
unset | Определяет сетевую зону, к которой принадлежит АктивныйШлюз. АктивныйШлюз может принадлежать только одной сетевой зоне. Имя сетевой зоны представляет собой строку буквенно-цифровых символов, дефисов (-), знаков подчеркивания (_) и точек (.). Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени сетевой зоны. Длина строки ограничена 256 символами.
После добавления или изменения этого параметра требуется перезапуск АктивногоШлюза. После перезапуска в Ключе-Астром автоматически создается сетевая зона. |
Раздел Групп
Раздел: [collector]
| Свойство | Значение по умолчанию | Описание |
|---|---|---|
group
|
unset | Группа АктивныхШлюзов |
Раздел Файловый кэш АктивныхШлюзов
Требуется АктивныйШлюз версии 1.241+
Файловый кэш АктивногоШлюза уменьшает трафик между АктивнымШлюзом и кластером, позволяя ЕдинымАгентам загружать автоматические обновления из АктивногоШлюза, а не из кластера.
Кэш файлов активируется автоматически при установке или обновлении АктивногоШлюза. Однако активация происходит только при соблюдении минимального требования к пространству в 512 МБ. Если минимальные требования к пространству не выполняются, кэширование автоматически деактивируется.
Файловый кеш можно настроить или отключить в конфигурации АктивногоШлюза, в файле custom.properties:
Раздел: [generic_filecache]
| Свойство | Значение по умолчанию | Описание |
|---|---|---|
generic_filecache_enabled
|
true
|
Включает или отключает файловый кеш АктивногоШлюза. Возможные значения: true или false.
|
generic_filecache_path
|
<ActiveGate temporary directory>/generic_filecache
|
Путь к каталогу файлового кэша АктивногоШлюза. Каталог будет создан, если он не существует (если это позволяют права доступа к файлу). |
generic_filecache_size
|
2147483648 (2 ГБ)
|
Размер файлового кеша АктивногоШлюза в байтах.
Файловый кэш АктивногоШлюза будет занимать не больше места, чем указано в конфигурации. Если доступное пространство меньше размера, указанного в конфигурации, АктивныйШлюз будет использовать доступное пространство. |
generic_filecache_max_age
|
1209600000 (14 дней)
|
Максимальный возраст файлов, хранящихся в файловом кэше АктивногоШлюза, в миллисекундах. Возраст файла отсчитывается с момента последнего использования файла (а не с момента загрузки/создания).
|
Раздел [com.compuware.apm.webserver]
| Свойство | Значение по умолчанию | Описание |
|---|---|---|
port-ssl
|
9999
|
Порт, через который АктивныйШлюз прослушивает трафик ЕдиныхАгентов — используется для HTTPS-соединения. |
port
|
unset | Порт, на котором АктивныйШлюз прослушивает трафик от ЕдиныхАгентов — используется для HTTP-соединения. По умолчанию он отключен.
В Linux рекомендуется значение > 1024, чтобы гарантировать, что привилегии root не потребуются. |
ssl-protocols
|
TLSv1.2, версия Ключ-Астром 1.247+ TLSv1.3
|
Поддерживаемые протоколы SSL. Может быть одним или списком значений, разделенных запятыми. Обратите внимание, что указание конкретной версии не означает автоматически поддержку всех предыдущих/младших версий, поэтому вам необходимо явно указать каждую версию.
|
excluded-ciphers
|
unset | Список исключенных шифров. Шифры определяются подстрокой, соответствующих хотя бы части имени шифра, например: excluded-ciphers = TLS_RSA_WITH,SHA$,TLS_ECDH
|
certificate-file
|
unset | Путь к файлу PKCS#12, содержащему сертификаты, которые будут использоваться веб-сервером АктивногоШлюза.
|
certificate-password
|
unset | Пароль к файлу сертификата. |
certificate-alias
|
unset | Понятное имя сертификата в файле PKCS#12.
|
Работа через HTTPS против HTTP
По умолчанию АктивныйШлюз работает безопасным образом, обслуживая входящие запросы по протоколу HTTPS. Это определяется свойством конфигурации port-ssl, которое можно настроить в файле custom.properties. Однако, если вы хотите, чтобы АктивныйШлюз использовал HTTP, вы должны указать свойство порта в custom.properties.
Обратите внимание, что безопасный способ используется по умолчанию и является рекомендуемым. Однако вы можете выбрать вариант HTTP из соображений производительности. Например, если у вас перед АктивнымШлюзом Кластера установлен балансировщик нагрузки и если балансировщик нагрузки прерывает входящие внешние SSL-соединения (см. третий сценарий развертывания).
Раздел [http.client]
Параметры связи, используемые для мониторинга AWS/VMware/Azure и для связи с кластером (если они не переопределены в [http.client.internal]). В частности, этот раздел содержит свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.
Раздел [http.client.internal]
Настройки, относящиеся только к связи с кластером Ключ-Астром.
В частности, этот раздел может содержать свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.
Если этот раздел не существует, связь с кластером Ключ-Астром определяется настройками в разделе [http.client]. Однако, если раздел [http.client.internal] существует, в котором конкретный параметр связи не указан, то для связи с кластером значение этого параметра считается заводским по умолчанию (не унаследовано от [http.client]).
Раздел [http.client.external]
Настройки связи для конкретных модулей: Cloud Foundry, Kubernetes, а также для Синтетического Мониторинга.
В частности, этот раздел может содержать свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.
Если в этом разделе указано proxy-off=true, то прокси для модулей нет. Если он содержит свойство proxy-host, то этот прокси будет использоваться для модулей.
Примечание. Параметры связи, указанные в [http.client], не всегда используются модулями по умолчанию: если конкретный параметр связи не указан в [http.client.external], то этот параметр — для Cloud Foundry, Kubernetes или Синтетического Мониторинга. — вернется к заводскому значению по умолчанию, а не к значению, указанному в [http.client].
Точно так же, если весь раздел [http.client.external] не существует, все параметры связи для Kubernetes и Cloud Foundry вернутся к заводским значениям по умолчанию; однако параметры синтетического мониторинга будут принимать значения, указанные в разделе [http.client].
