Параметры АктивногоШлюза: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «== Основные правила работы с конфигурацией АктивногоШлюза == === Файлы конфигурации ActiveGate...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
== Основные правила работы с конфигурацией АктивногоШлюза ==
== Основные правила работы с конфигурацией АктивногоШлюза ==


=== Файлы конфигурации ActiveGate ===
=== Файлы конфигурации АктивногоШлюза ===
Многие параметры конфигурации ActiveGate (например, параметры подключения и прокси-сервера, шифры или параметры дампа памяти) хранятся в файлах свойств <code>config.properties</code> и <code>custom.properties</code>, которые расположены в каталоге конфигурации ActiveGate. Свойства, перечисленные в файлах свойств, применимы для АктивныхШлюзов Окружений и Кластера.
Многие параметры конфигурации АктивногоШлюза (например, параметры подключения и прокси-сервера, шифры или параметры дампа памяти) хранятся в файлах свойств <code>config.properties</code> и <code>custom.properties</code>, которые расположены в каталоге конфигурации АктивногоШлюза. Свойства, перечисленные в файлах свойств, применимы для АктивныхШлюзов Окружений и Кластера.


Файлы <code>config.properties</code> и <code>custom.properties</code> разделены на секции. Каждое название раздела заключено в квадратные скобки, например:
Файлы <code>config.properties</code> и <code>custom.properties</code> разделены на секции. Каждое название раздела заключено в квадратные скобки, например:
Строка 11: Строка 11:


=== config.properties ===
=== config.properties ===
Файл конфигурации <code>config.properties</code> содержит параметры установки ActiveGate по умолчанию и не может быть изменен. Примечание: Этот файл конфигурации перезаписывается при каждом обновлении ActiveGate.
Файл конфигурации <code>config.properties</code> содержит параметры установки АктивногоШлюза по умолчанию и не может быть изменен. Примечание: Этот файл конфигурации перезаписывается при каждом обновлении АктивногоШлюза.


=== custom.properties ===
=== custom.properties ===
Настройки, хранящиеся в <code>custom.properties</code>, переопределяют соответствующие настройки в <code>config.properties</code>, и во время обновления файл копируется в новую версию ActiveGate.
Настройки, хранящиеся в <code>custom.properties</code>, переопределяют соответствующие настройки в <code>config.properties</code>, и во время обновления файл копируется в новую версию АктивногоШлюза.


Файлы конфигурации разбиты на <code>[разделы]</code>, которые указаны в квадратных скобках.
Файлы конфигурации разбиты на <code>[разделы]</code>, которые указаны в квадратных скобках.
Строка 20: Строка 20:
Чтобы указать настраиваемые параметры в <code>custom.properties</code>, введите имена разделов и включите соответствующие свойства в эти разделы.
Чтобы указать настраиваемые параметры в <code>custom.properties</code>, введите имена разделов и включите соответствующие свойства в эти разделы.


Вы можете использовать файл <code>config.txt</code> в качестве справки при добавлении пользовательских настроек в файл <code>custom.properties</code>. Файл <code>config.txt</code>, который также находится в каталоге конфигурации ActiveGate, не используется ActiveGate, однако содержит справочный список возможных свойств конфигурации. Кроме того, вы можете сначала найти соответствующий раздел в файле <code>config.properties</code>, а затем скопировать заголовок раздела вместе с именами нужных свойств в <code>custom.properties</code>.
Вы можете использовать файл <code>config.txt</code> в качестве справки при добавлении пользовательских настроек в файл <code>custom.properties</code>. Файл <code>config.txt</code>, который также находится в каталоге конфигурации АктивногоШлюза, не используется АктивныйШлюз, однако содержит справочный список возможных свойств конфигурации. Кроме того, вы можете сначала найти соответствующий раздел в файле <code>config.properties</code>, а затем скопировать заголовок раздела вместе с именами нужных свойств в <code>custom.properties</code>.


После этого вы можете изменить записи в разделе по мере необходимости.
После этого вы можете изменить записи в разделе по мере необходимости.


=== launcheruserconfig.conf ===
=== launcheruserconfig.conf ===
Средство запуска ActiveGate — это наблюдающий процесс, который запускает виртуальную машину Java для вашего ActiveGate. Конфигурация лаунчера хранится в файле <code>launcheruserconfig.conf</code> в каталоге конфигурации ActiveGate. Он содержит свойства и параметры запуска, которые передаются виртуальной машине Java.
Средство запуска АктивногоШлюза — это наблюдающий процесс, который запускает виртуальную машину Java для вашего АктивногоШлюза. Конфигурация лаунчера хранится в файле <code>launcheruserconfig.conf</code> в каталоге конфигурации АктивногоШлюза. Он содержит свойства и параметры запуска, которые передаются виртуальной машине Java.


Файл <code>launcheruserconfig.conf</code> сохраняется во время обновлений ActiveGate.
Файл <code>launcheruserconfig.conf</code> сохраняется во время обновлений АктивногоШлюза.


=== Перезапуск ActiveGate ===
=== Перезапуск АктивногоШлюза ===
Если вы меняете конфигурацию ActiveGate, вы должны перезапустить основную службу ActiveGate, чтобы ваши изменения вступили в силу.
Если вы меняете конфигурацию АктивногоШлюза, вы должны перезапустить основную службу АктивногоШлюза, чтобы ваши изменения вступили в силу.


== Ограничения памяти ActiveGate ==
== Ограничения памяти АктивногоШлюза ==
Ограничения на использование памяти для ActiveGate можно указать в конфигурационном файле лаунчера <code>launcheruserconfig.conf</code>.
Ограничения на использование памяти для АктивногоШлюза можно указать в конфигурационном файле лаунчера <code>launcheruserconfig.conf</code>.


* Настройки ограничения памяти могут быть комбинацией:
* Настройки ограничения памяти могут быть комбинацией:
Строка 47: Строка 47:
  -Dsomecustomproperty=value</code>
  -Dsomecustomproperty=value</code>


== Диапазон портов ActiveGate ==
== Диапазон портов АктивногоШлюза ==
Средство запуска ActiveGate отслеживает процесс ActiveGate на локальном контрольном порту. Этот порт выбирается программой запуска из предопределенного диапазона портов, указанного в конфигурации программы запуска. Программа запуска находит свободный порт в заданном диапазоне, а затем передает номер порта процессу ActiveGate.
Средство запуска АктивногоШлюза отслеживает процесс АктивногоШлюза на локальном контрольном порту. Этот порт выбирается программой запуска из предопределенного диапазона портов, указанного в конфигурации программы запуска. Программа запуска находит свободный порт в заданном диапазоне, а затем передает номер порта процессу АктивногоШлюза.


По умолчанию программа запуска будет использовать порты выше 50000 для мониторинга пульса. Для некоторых развертываний может потребоваться настроить для этой цели другие порты. Чтобы указать диапазон портов, который должен использовать модуль запуска ActiveGate, добавьте или измените свойство <code>-healthcheck.heartbeat.portrange</code> в файле конфигурации модуля запуска <code>launcheruserconfig.conf</code>, как в примере ниже.
По умолчанию программа запуска будет использовать порты выше 50000 для мониторинга пульса. Для некоторых развертываний может потребоваться настроить для этой цели другие порты. Чтобы указать диапазон портов, который должен использовать модуль запуска АктивногоШлюза, добавьте или измените свойство <code>-healthcheck.heartbeat.portrange</code> в файле конфигурации модуля запуска <code>launcheruserconfig.conf</code>, как в примере ниже.
  <code># Xmx settings 80% of available RAM + 0 MB
  <code># Xmx settings 80% of available RAM + 0 MB
  -java.xmx.absolute_part=0
  -java.xmx.absolute_part=0
Строка 58: Строка 58:
  -Dsomecustomproperty=value</code>
  -Dsomecustomproperty=value</code>


== Пользовательские параметры для Java-процесса ActiveGate ==
== Пользовательские параметры для Java-процесса АктивногоШлюза ==
Чтобы передать пользовательские параметры Java-процессу ActiveGate, укажите параметры в конфигурационном файле лаунчера launcheruserconfig.conf:
Чтобы передать пользовательские параметры Java-процессу АктивногоШлюза, укажите параметры в конфигурационном файле лаунчера launcheruserconfig.conf:


* Все строки после <code>-arguments_section.jvm</code> передаются в качестве аргументов JVM. Таким образом, указав опции <code>-D</code>, вы можете указать аргументы для ActiveGate.
* Все строки после <code>-arguments_section.jvm</code> передаются в качестве аргументов JVM. Таким образом, указав опции <code>-D</code>, вы можете указать аргументы для АктивногоШлюза.


Например:
Например:
Строка 71: Строка 71:
  -Dsomecustomproperty=value</code>
  -Dsomecustomproperty=value</code>


== Модули ActiveGate ==
== Модули и разделы АктивногоШлюза ==
Различные функциональные возможности, предоставляемые ActiveGate, называются модулями. Когда вы устанавливаете ActiveGate для определенной цели, устанавливается или включается другой набор модулей.
Различные функциональные возможности, предоставляемые АктивномуШлюзу, называются модулями. Когда вы устанавливаете АктивныйШлюз для определенной цели, устанавливается или включается другой набор модулей.


Модуль активен, если соответствующее свойство конфигурации указано со значением <code>true</code> в разделе конфигурации, посвященном модулю. Обратите внимание, однако, что вы не можете включить все модули, используя <code>custom.properties</code>, просто изменив значение свойства: если вы установили свой ActiveGate, чтобы он служил в качестве частного синтетического местоположения или для мониторинга мейнфрейма, и вам нужно изменить цель вашего ActiveGate , вам необходимо переустановить ActiveGate.
Модуль активен, если соответствующее свойство конфигурации указано со значением <code>true</code> в разделе конфигурации, посвященном модулю. Обратите внимание, однако, что вы не можете включить все модули, используя <code>custom.properties</code>, просто изменив значение свойства: если вы установили свой АктивныйШлюз, чтобы он служил в качестве частного синтетического местоположения или для мониторинга мейнфрейма, и вам нужно изменить цель вашего АктивногоШлюза , вам необходимо переустановить АктивныйШлюз.


Каждый модуль имеет соответствующий раздел в конфигурации
Каждый модуль имеет соответствующий раздел в конфигурации


В дополнение к разделам конфигурации, предназначенным для определенных функций ActiveGate, каждый модуль ActiveGate имеет собственный раздел в файлах конфигурации ActiveGate. Настройки, указанные в этом разделе, относятся именно к этому модулю. Это относится, например, к настройкам прокси. Однако не все настройки можно повторить таким образом и указать для модуля: каждый раздел модуля имеет только ограниченное количество принимаемых опций. '''НЕ копируйте параметры конфигурации между разделами, если только это не указано специально'''.
В дополнение к разделам конфигурации, предназначенным для определенных функций АктивногоШлюза, каждый модуль АктивногоШлюза имеет собственный раздел в файлах конфигурации АктивногоШлюза. Настройки, указанные в этом разделе, относятся именно к этому модулю. Это относится, например, к настройкам прокси. Однако не все настройки можно повторить таким образом и указать для модуля: каждый раздел модуля имеет только ограниченное количество принимаемых опций. '''НЕ копируйте параметры конфигурации между разделами, если только это не указано специально'''.


=== AWS ===
=== Модуль AWS ===
AWS-мониторинг
AWS-мониторинг


Строка 92: Строка 92:
|}
|}


=== Azure ===
=== Модуль Azure ===
Microsoft Azure monitoring
Мониторинг Microsoft Azure


'''Раздел: [azure_monitoring]'''
'''Раздел: [azure_monitoring]'''
Строка 104: Строка 104:
|}
|}


=== Module: Cloud Foundry ===
=== Модуль Cloud Foundry ===
Cloud Foundry monitoring
Мониторинг Cloud Foundry


'''Раздел: [cloudfoundry_monitoring]'''
'''Раздел: [cloudfoundry_monitoring]'''
Строка 115: Строка 115:
|Включает модуль Cloud Foundry. Возможные значения: <code>true</code> или <code>false</code>.
|Включает модуль Cloud Foundry. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}
This section can contain proxy settings for communication with Cloud Foundry. If this section contains <code>proxy-off = true</code>, then there is no proxy for communication with Cloud Foundry. If it contains the <code>proxy-host</code> property, then this is the proxy to be used for Cloud Foundry monitoring, rather than the proxy specified in <code>[http.client.external]</code>.
Этот раздел может содержать настройки прокси для связи с Cloud Foundry. Если в этом разделе указано <code>proxy-off=true</code>, то прокси для связи с Cloud Foundry отсутствует. Если он содержит свойство <code>proxy-host</code>, то для мониторинга Cloud Foundry будет использоваться именно этот прокси, а не прокси, указанный в <code>[http.client.external]</code>.


'''Note:''' If you have a <code>[cloudfoundry_monitoring]</code> section in your <code>custom.properties</code> file, you also need to have an <code>[http.client.external]</code> section, where you should specify all the remaining communication parameters that are to be used for Cloud Foundry communication.
'''Примечание'''. Если у вас есть раздел <code>[cloudfoundry_monitoring]</code> в вашем файле <code>custom.properties</code>, вам также необходимо иметь раздел <code>[http.client.external]</code>, где вы должны указать все остальные параметры связи <code>.rs</code>, которые будут использоваться для связи Cloud Foundry.


Set up proxy only for Cloud Foundry monitoring
=== Модуль Kubernetes ===
 
Мониторинг Kubernetes
=== Module: Kubernetes ===
Kubernetes monitoring


'''Раздел: [kubernetes_monitoring]'''
'''Раздел: [kubernetes_monitoring]'''
Строка 132: Строка 130:
|Включает модуль мониторинга Kubernetes. Возможные значения: <code>true</code> или <code>false</code>.
|Включает модуль мониторинга Kubernetes. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}
This section can contain proxy settings for communication with Kubernetes, along with other settings related to fine-tuning communication settings for Kubernetes monitoring.
Этот раздел может содержать параметры прокси-сервера для связи с Kubernetes, а также другие параметры, связанные с тонкой настройкой параметров связи для мониторинга Kubernetes.
 
If this section contains <code>proxy-off = true</code>, then there is no proxy for communication with Kubernetes. If it contains the <code>proxy-host</code> property, then this is the proxy to be used for Kubernetes monitoring, rather than the proxy specified in <code>[http.client.external]</code>.


'''Note:''' If you have a <code>[kubernetes_monitoring]</code> section in your <code>custom.properties</code> file, then you also need to have an <code>[http.client.external]</code> section, where you should specify all of the remaining communication parameters to be used for Kubernetes communication.
Если в этом разделе указано <code>proxy-off=true</code>, то прокси для связи с Kubernetes отсутствует. Если он содержит свойство <code>proxy-host</code>, то для мониторинга Kubernetes будет использоваться именно этот прокси, а не прокси, указанный в <code>[http.client.external]</code>.


Set up proxy only for Kubernetes monitoring
'''Примечание'''. Если у вас есть раздел <code>[kubernetes_monitoring]</code> в файле <code>custom.properties</code>, вам также потребуется раздел <code>[http.client.external]</code>, в котором вы должны указать все остальные параметры связи, которые будут использоваться для связи Kubernetes.


=== Module: Log Monitoring ===
=== Модуль Мониторинга логов ===
'''Раздел: [log_analytics_collector]'''
'''Раздел: [log_analytics_collector]'''
{| class="wikitable"
{| class="wikitable"
Строка 149: Строка 145:
|Включает модуль мониторинга логов. Возможные значения: <code>true</code> или <code>false</code>.
|Включает модуль мониторинга логов. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}
'''Раздел: [generic_ingest]'''  
'''Раздел: [generic_ingest]'''


Specifically for Log Monitoring, when configuring Generic Log Ingest, you can customize the log data queue properties. You can specify the temporary folder where the queued log data will be stored (default is the temporary folder currently configured on your system) and, change the maximum size of the queue that will be used in that folder (default size is 300 MB).
В частности, для мониторинга журналов при настройке универсального приема журналов можно настроить свойства очереди данных журнала. Вы можете указать временную папку, в которой будут храниться данные журнала очереди (по умолчанию это временная папка, настроенная в настоящее время в вашей системе), и изменить максимальный размер очереди, которая будет использоваться в этой папке (размер по умолчанию — 300 МБ).
{| class="wikitable"
{| class="wikitable"
!Свойство
!Свойство
Строка 166: Строка 162:
|}
|}


=== Module: VMware ===
=== Модуль VMware ===
VMware monitoring
Мониторинг VMware


'''Раздел: [vmware_monitoring]'''
'''Раздел: [vmware_monitoring]'''
Строка 175: Строка 171:
|-
|-
|<code>vmware_monitoring_enabled</code>
|<code>vmware_monitoring_enabled</code>
|Включает модуль мониторинга VMware. Возможные значения: истина или ложь.
|Включает модуль мониторинга VMware. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: Database insights ===
=== Модуль Анализа БД ===
Oracle database insights
Информация о базе данных Oracle


'''Раздел: [dbAgent]'''
'''Раздел: [dbAgent]'''
Строка 187: Строка 183:
|-
|-
|<code>dbAgent_enabled</code>
|<code>dbAgent_enabled</code>
|Enables Oracle database insights module. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль анализа базы данных Oracle. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: Extensions 1.0 ===
=== Модуль Расширений 1.0 ===
'''Раздел: [rpm]'''
'''Раздел: [rpm]'''
{| class="wikitable"
{| class="wikitable"
Строка 197: Строка 193:
|-
|-
|<code>rpm_enabled</code>
|<code>rpm_enabled</code>
|Enables the Remote plugin module, which is used to run ActiveGate extensions. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль удаленных плагинов, который используется для запуска расширений АктивногоШлюза. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: Extensions 2.0 ===
=== Модуль Расширений 2.0 ===
'''Раздел: [extension_controller]'''
'''Раздел: [extension_controller]'''
{| class="wikitable"
{| class="wikitable"
Строка 207: Строка 203:
|-
|-
|<code>extension_controller_enabled</code>
|<code>extension_controller_enabled</code>
|Enables the Extensions 2.0 module. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль Расширений 2.0. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: zRemote ===
=== Модуль zRemote ===
Install the zRemote module for z/OS monitoring
Установка модуля zRemote для мониторинга z/OS.


'''Раздел: [zremote]'''
'''Раздел: [zremote]'''
Строка 219: Строка 215:
|-
|-
|<code>zremote_enabled</code>
|<code>zremote_enabled</code>
|Enables the zRemote module. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль zRemote. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: Synthetic ===
=== Модуль Синтетики ===
Synthetic monitors from private Synthetic locations
Синтетические мониторы из частных синтетических локаций


'''Раздел: [synthetic]'''
'''Раздел: [synthetic]'''


Proxy settings for Synthetic Monitoring. If this section contains <code>proxy-off = true</code>, then there is no proxy for Synthetic Monitoring. If it contains the <code>proxy-host</code> property, then this is the proxy to be used for Synthetic Monitoring, rather than the proxy specified in <code>[http.client.external]</code> (or in <code>[http.client]</code>, if <code>[http.client.external]</code> is not defined).
Настройки прокси для синтетического мониторинга. Если в этом разделе указано <code>proxy-off=true</code>, то прокси для Синтетического мониторинга нет. Если он содержит свойство <code>proxy-host</code>, то этот прокси будет использоваться для синтетического мониторинга, а не прокси, указанный в <code>[http.client.external]</code> (или в <code>[http.client]</code>, если <code>[http.client.external]</code> не определено).
 
'''Note:''' If you have a <code>[synthetic]</code> section in your <code>custom.properties</code> file, you can have an <code>[http.client.external]</code> section, where you should specify all of the remaining communication parameters to be used for Synthetic Monitoring. Alternatively, you can specify the remaining communication settings in the <code>[http.client]</code> section.


'''However, if you do create the <code>[http.client.external]</code> section, you have to specify all of the communication parameters there. Otherwise, the communication parameters for monitored environments (Cloud Foundry, Kubernetes, or Synthetic Monitoring) will revert to their factory defaults.'''
'''Примечание'''. Если у вас есть раздел <code>[synthetic]</code> в вашем файле <code>custom.properties</code>, у вас может быть раздел <code>[http.client.external]</code>, в котором вы должны указать все остальные параметры связи, которые будут использоваться для синтетического мониторинга. Кроме того, вы можете указать остальные параметры связи в разделе <code>[http.client]</code>.


To learn more about the proxy-related properties for a Synthetic-enabled ActiveGate, see Set up a proxy for private synthetic monitoring.
'''Однако, если вы создаете раздел <code>[http.client.external]</code>, вы должны указать там все параметры связи. В противном случае параметры связи для отслеживаемых сред (Cloud Foundry, Kubernetes или Synthetic Monitoring) вернутся к заводским значениям по умолчанию.'''


Note that changing the <code>synthetic_enabled</code> property only works if you installed the ActiveGate to run Synthetic monitors from a private location. If you installed the ActiveGate to route traffic, monitor cloud environments, or monitor remote technologies with extensions or monitor mainframe, you have to reinstall the ActiveGate to use it for Synthetic Monitoring. For more information, see Create a private Synthetic location.
Обратите внимание, что изменение свойства <code>synthetic_enabled</code> работает только в том случае, если вы установили АктивныйШлюз для запуска синтетических мониторов из частного местоположения. Если вы установили АктивныйШлюз для маршрутизации трафика, мониторинга облачных сред или мониторинга удаленных технологий с помощью расширений или мониторинга мейнфрейма, вам необходимо переустановить АктивныйШлюз, чтобы использовать его для синтетического мониторинга.
{| class="wikitable"
{| class="wikitable"
!Свойство
!Свойство
Строка 242: Строка 236:
|-
|-
|<code>synthetic_enabled</code>
|<code>synthetic_enabled</code>
|<code>false</code> in the '''Default''' deployment mode
|<code>false</code> в режиме развертывания '''по умолчанию'''  
<code>true</code> in the '''Synthetic monitoring''' deployment mode
<code>true</code> в режиме развертывания '''Синтетический мониторинг'''
|Enables the ActiveGate to execute monitors from private Synthetic locations.
|Позволяет АктивномуШлюзу выполнять мониторы из частных синтетических местоположений.
|-
|-
|<code>synthetic_autoinstall</code>
|<code>synthetic_autoinstall</code>
|<code>true</code> to automatically update the Synthetic engine
|<code>true</code> для автоматического обновления движка Синтетики
|Automatically set to <code>true</code> at installation time for Synthetic-enabled ActiveGates.
|Автоматически устанавливается в <code>true</code> во время установки для синтетических АктивныхШлюзов.
|-
|-
|<code>proxy-server</code>
|<code>proxy-server</code>
|unset
|unset
|Proxy server address
|Адрес прокси-сервера
|-
|-
|<code>proxy-port</code>
|<code>proxy-port</code>
|unset
|unset
|Proxy port (numeric)
|Порт прокси (числовой)
|-
|-
|<code>proxy-user</code>
|<code>proxy-user</code>
|unset
|unset
|Proxy user name (optional)
|Имя пользователя прокси (необязательно)
|-
|-
|<code>proxy-password</code>
|<code>proxy-password</code>
|unset
|unset
|Proxy password (optional)  
|Пароль прокси (необязательно)  
The password provided in the <code>proxy-password</code> property
Пароль, указанный в свойстве <code>proxy-password</code>, обфусцируется после перезапуска АктивногоШлюза, а замаскированный пароль сохраняется в свойстве <code>proxy-password-encr</code>.
is obfuscated following ActiveGate restart and the obfuscated password
is stored in the <code>proxy-password-encr</code> property.
|-
|-
|<code>proxy-off</code>
|<code>proxy-off</code>
|unset
|unset
|Disable proxy communication between ActiveGate and tested resource.
|Отключить прокси-связь между АктивнымШлюзом и тестируемым ресурсом.
|-
|-
|<code>proxy-non-proxy-hosts</code>
|<code>proxy-non-proxy-hosts</code>
|unset
|unset
|Do not use proxy when communicating with these hosts.
|Не использовать прокси при общении с этими хостами.
|}
|}
'''Important'''
'''Важно'''


We recommend that you not edit the value of the <code>synthetic_autoupgrade_chromium</code> property in <code>custom.properties</code> because your changes might be overwritten.
Мы рекомендуем вам не изменять значение свойства <code>synthetic_autoupgrade_chromium</code> в <code>custom.properties</code>, поскольку ваши изменения могут быть перезаписаны.


<code>synthetic_autoupgrade_chromium</code> for autoupdating Chromium can be defined at the location level (for locations with Environment ActiveGates) either via the web UI or by using the PUT a location API call of the Synthetic locations API v2. For Cluster ActiveGates, you can configure this property via the PUT a location (Dynatrace Managed) API call of the Cluster API v2. This property is not defined for ActiveGates that haven't been assigned to a location. For Activates assigned to a location, the default value is <code>true</code>.
<code>synthetic_autoupgrade_chromium</code> для автообновления Chromium можно определить на уровне местоположения (для местоположений с АктивнымиШлюзами Окружений) либо через веб-интерфейс, либо с помощью вызова PUT API местоположения API синтетических местоположений v2. Для АктивногоШлюза Кластера это свойство можно настроить с помощью вызова PUT (Ключ-АстромManaged) API Кластера v2. Это свойство не определено для АктивныхШлюзов, которые не были назначены местоположению. Для Activates, назначенных местоположению, значением по умолчанию является <code>true</code>.


=== Module: Beacon forwarder ===
=== Модуль Beacon Forwarder ===
Using ActiveGate for Real User Monitoring
Использование АктивногоШлюза для реального мониторинга пользователей


'''Раздел: [beacon_forwarder]'''
'''Раздел: [beacon_forwarder]'''
Строка 292: Строка 284:
|-
|-
|<code>beacon_forwarder_enabled</code>
|<code>beacon_forwarder_enabled</code>
|Enables the Beacon forwarder module. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль Beacon Forwarder. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: HTTP Metric API ===
=== Модуль API HTTP-метрик ===
Metric ingestion: a simple way to push any custom metrics to Dynatrace
Прием метрик: простой способ передать любые пользовательские метрики в Ключ-Астром


'''Раздел: [metrics_ingest]'''
'''Раздел: [metrics_ingest]'''
Строка 304: Строка 296:
|-
|-
|<code>metrics_ingest_enabled</code>
|<code>metrics_ingest_enabled</code>
|Enables HTTP Metric API module which facilitates metric ingestion. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль HTTP Metric API, который упрощает прием метрик. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: Memory dumps ===
=== Модуль Дампов памяти ===
Triggering and downloading of memory dumps
Запуск и загрузка дампов памяти


'''Раздел: [collector]'''
'''Раздел: [collector]'''
Строка 316: Строка 308:
|-
|-
|<code>DumpSupported</code>
|<code>DumpSupported</code>
|Enables the memory dumps module. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль дампов памяти. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}
When your application experiences memory leaks or high object churn, it’s important that you get memory dumps so you can analyze these issues. In production environments, this is often a challenge when you can’t log into the environment and you have no other means of triggering memory dumps. Dynatrace enables you to both trigger and securely download memory dumps to the analysis tool of your choice.
Когда в вашем приложении возникают утечки памяти или большое количество объектов, важно получить дампы памяти, чтобы вы могли проанализировать эти проблемы. В производственных средах это часто становится проблемой, когда вы не можете войти в среду и у вас нет других средств запуска дампов памяти. Ключ-Астром позволяет вам запускать и безопасно загружать дампы памяти в инструмент анализа по вашему выбору.
 
See Configure ActiveGate for memory dump storage.


=== Module: OneAgent routing ===
=== Модуль Маршрутизации ЕдиныхАгентов ===
ActiveGate knows about the runtime structure of your Dynatrace environment and routes messages from OneAgents to the correct server endpoints. It handles message routing, buffering, compression, authentication and accessing of sealed networks.
АктивногоШлюза знает о структуре времени выполнения вашей среды и направляет сообщения от ЕдиныхАгентов на правильные конечные точки сервера. Он обрабатывает маршрутизацию сообщений, буферизацию, сжатие, аутентификацию и доступ к закрытым сетям.


'''Раздел: [collector]'''
'''Раздел: [collector]'''
Строка 331: Строка 321:
|-
|-
|<code>MSGrouter</code>
|<code>MSGrouter</code>
|Enables the OneAgent routing module, which routes of OneAgent and other ActiveGate traffic through Dynatrace. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль маршрутизации ЕдиныхАгентов, который направляет трафик ЕдиныхАгентов и другого АктивногоШлюза через Ключ-Астром. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: OTLP Ingest ===
=== Модуль OTLP-приёма ===
This module creates an endpoint on the ActiveGate that can receive OpenTelemetry trace data (traces and spans) in OTLP format. '''Раздел: [otlp_ingest]'''
Этот модуль создает конечную точку на АктивномШлюзе, которая может получать данные трассировки OpenTelemetry (трассы и интервалы) в формате OTLP.
 
'''Раздел: [otlp_ingest]'''
{| class="wikitable"
{| class="wikitable"
!Свойство
!Свойство
Строка 341: Строка 333:
|-
|-
|<code>otlp_ingest_enabled</code>  
|<code>otlp_ingest_enabled</code>  
|Enables OTLP ingest module which facilitates OpenTelemetry trace ingest. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль приема OTLP, который упрощает прием трассировки OpenTelemetry. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Module: REST API ===
=== Модуль REST API ===
'''Раздел: [collector]'''  
'''Раздел: [collector]'''  


You can use an ActiveGate to access the Dynatrace API. ActiveGate supports calls to all the Dynatrace API configuration and environment endpoints in both, v1 and v2 versions. To access the Dynatrace API using ActiveGate, use a URL in the following format: <code><nowiki>https://{your-ActiveGate-domain}/e/{your-environment-id}/api/</nowiki>...</code>
Вы можете использовать АктивныйШлюз для доступа к API Ключ-Астром. АктивныйШлюз поддерживает вызовы всех конечных точек конфигурации и среды API в версиях v1 и v2. Чтобы получить доступ к API Ключ-Астром с помощью АктивногоШлюза, используйте URL-адрес в следующем формате: <nowiki>https://{ваш-АктивныйШлюз-домен}/e/{идентификатор</nowiki> вашей среды}/api/...
{| class="wikitable"
{| class="wikitable"
!Свойство
!Свойство
Строка 353: Строка 345:
|-
|-
|<code>restInterface</code>
|<code>restInterface</code>
|Enables the REST API module, which facilitates access to Dynatrace API using REST. Possible values: <code>true</code> or <code>false</code>.
|Включает модуль REST API, упрощающий доступ к API Ключ-Астром с помощью REST. Возможные значения: <code>true</code> или <code>false</code>.
|}
|}


=== Load balancer address ===
=== Раздел Адреса балансировщика нагрузки ===
'''Раздел: [connectivity]'''
'''Раздел: [connectivity]'''
{| class="wikitable"
{| class="wikitable"
Строка 365: Строка 357:
|<code>dnsEntryPoint</code>
|<code>dnsEntryPoint</code>
|unset
|unset
|The entry points for the ActiveGate (for example, <code><nowiki>https://sg1.mydomain.com:9999</nowiki></code>). Dynatrace OneAgent accesses the ActiveGate via this URL (or list of URLs—the value of this property can be a comma-separated list). If not set, an auto-detected endpoint is used. This entry can be used if the ActiveGate is accessed via, for example, an external IP address or load balancer. Depending on your ActiveGate deployment, make sure you use the right prefix (<code>http</code> or <code>https</code>) or your OneAgents won't be able to connect. '''Note''': To avoid unnecessary DNS requests and enhance security, you can mark a domain name as a fully qualified domain name (FQDN) by appending a dot to the end of the URL. For example, <code>www.example.com.</code> is an absolute domain name. See Trailing Dots in Domain Names for more details.
|Точки входа для АктивногоШлюза (например, <code><nowiki>https://sg1.mydomain.com:9999</nowiki></code>). ЕдиныйАгент получает доступ к АктивномуШлюзу через этот URL-адрес (или список URL-адресов — значением этого свойства может быть список, разделенный запятыми). Если не задано, используется автоматически определяемая конечная точка. Эту запись можно использовать, если доступ к АктивномуШлюзу осуществляется, например, через внешний IP-адрес или балансировщик нагрузки. В зависимости от развертывания АктивногоШлюза убедитесь, что вы используете правильный префикс (<code>http</code> или <code>https</code>), иначе ваши ЕдиныеАгенты не смогут подключиться.
 
 
'''Примечание'''. Чтобы избежать ненужных DNS-запросов и повысить безопасность, вы можете пометить доменное имя как полное доменное имя (FQDN), добавив точку в конце URL-адреса. Например, <code>www.example.com</code> является абсолютным доменным именем.
|}
|}


=== Network zone ===
=== Раздел Сетевых зон ===
'''Раздел: [connectivity]'''
'''Раздел: [connectivity]'''
{| class="wikitable"
{| class="wikitable"
Строка 377: Строка 372:
|<code>networkZone</code>
|<code>networkZone</code>
|unset
|unset
|Defines the network zone to which the ActiveGate belongs. An ActiveGate can belong to only one network zone. The name of a network zone is a string of alphanumeric characters, hyphens (<code>-</code>), underscores (<code>_</code>), and dots (<code>.</code>). Dots are used as separators, so you must not use a dot as the first character of a network zone name. The length of the string is limited to 256 characters.
|Определяет сетевую зону, к которой принадлежит АктивныйШлюз. АктивныйШлюз может принадлежать только одной сетевой зоне. Имя сетевой зоны представляет собой строку буквенно-цифровых символов, дефисов <code>(-)</code>, знаков подчеркивания <code>(_)</code> и точек <code>(.)</code>. Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени сетевой зоны. Длина строки ограничена 256 символами.
ActiveGate restart is required after adding or changing this parameter. After restart, a network zone is automatically created in Dynatrace.
После добавления или изменения этого параметра требуется перезапуск АктивногоШлюза. После перезапуска в Ключе-Астром автоматически создается сетевая зона.
|}
|}


=== Group ===
=== Раздел Групп ===
'''Раздел: [collector]'''
'''Раздел: [collector]'''
{| class="wikitable"
{| class="wikitable"
Строка 390: Строка 385:
|<code>group</code>
|<code>group</code>
|unset
|unset
|ActiveGate group
|Группа АктивныхШлюзов
|}
|}


=== ActiveGate file cache ===
=== Раздел Файловый кэш АктивныхШлюзов ===
ActiveGate version 1.241+
Требуется АктивныйШлюз версии 1.241+


The ActiveGate file cache reduces traffic between the ActiveGate and the Dynatrace Cluster by allowing OneAgents to download automatic updates from the ActiveGate rather than the Cluster.
Файловый кэш АктивногоШлюза уменьшает трафик между АктивнымШлюзом и кластером, позволяя ЕдинымАгентам загружать автоматические обновления из АктивногоШлюза, а не из кластера.


The file cache is activated automatically when ActiveGate is installed or updated. However, activation occurs only when the '''minimum space requirement of 512 MB''' is met. If the minimum space requirement is not met, caching is automatically deactivated.
Кэш файлов активируется автоматически при установке или обновлении АктивногоШлюза. Однако активация происходит только при соблюдении минимального требования к пространству в 512 МБ. Если минимальные требования к пространству не выполняются, кэширование автоматически деактивируется.


The file cache can be fine-tuned or deactivated in ActiveGate configuration, in the <code>custom.properties</code> file:
Файловый кеш можно настроить или отключить в конфигурации АктивногоШлюза, в файле <code>custom.properties</code>:


'''Раздел: [generic_filecache]'''
'''Раздел: [generic_filecache]'''
Строка 410: Строка 405:
|<code>generic_filecache_enabled</code>
|<code>generic_filecache_enabled</code>
|<code>true</code>
|<code>true</code>
|Enables or disables ActiveGate file cache. Possible values: <code>true</code> or <code>false</code>.
|Включает или отключает файловый кеш АктивногоШлюза. Возможные значения: <code>true</code> или <code>false</code>.
|-
|-
|<code>generic_filecache_path</code>
|<code>generic_filecache_path</code>
|<code><ActiveGate temporary directory>/generic_filecache</code>
|<code><ActiveGate temporary directory>/generic_filecache</code>
|Path of the ActiveGate file cache directory. The directory will be created if it does not exist (if the file permissions allow it).
|Путь к каталогу файлового кэша АктивногоШлюза. Каталог будет создан, если он не существует (если это позволяют права доступа к файлу).
|-
|-
|<code>generic_filecache_size</code>
|<code>generic_filecache_size</code>
|<code>2147483648</code> (2 GB)
|<code>2147483648</code> (2 ГБ)
|The size of the ActiveGate file cache in bytes.
|Размер файлового кеша АктивногоШлюза в байтах.


ActiveGate file cache will use no more space than specified in the configuration. If available space is less than the size specified in the configuration, ActiveGate will use the available space.
Файловый кэш АктивногоШлюза будет занимать не больше места, чем указано в конфигурации. Если доступное пространство меньше размера, указанного в конфигурации, АктивныйШлюз будет использовать доступное пространство.
|-
|-
|<code>generic_filecache_max_age</code>
|<code>generic_filecache_max_age</code>
|<code>1209600000</code> (14 days)
|<code>1209600000</code> (14 дней)
|The maximum file age for files stored in the ActiveGate file cache, in milliseconds. File age is counted from the time that a file was last used (not from upload/creation time).
|Максимальный возраст файлов, хранящихся в файловом кэше АктивногоШлюза, в миллисекундах. Возраст файла отсчитывается с момента последнего использования файла (а не с момента загрузки/создания).


If a file is not used for the configured maximum age, the file will be automatically removed. Files are also removed from the cache before their maximum age if there is insufficient space for new files. The LRU (least recently used) files are removed first.
 
Если файл не используется для настроенного максимального возраста, файл будет автоматически удален. Файлы также удаляются из кеша до достижения максимального возраста, если для новых файлов недостаточно места. Файлы LRU (наименее использовавшиеся) удаляются первыми.
|}
|}


=== Раздел: [com.compuware.apm.webserver] ===
=== Раздел [com.compuware.apm.webserver] ===
{| class="wikitable"
{| class="wikitable"
!Свойство
!Свойство
Строка 437: Строка 433:
|<code>port-ssl</code>
|<code>port-ssl</code>
|<code>9999</code>
|<code>9999</code>
|The port where the ActiveGate listens for traffic from
|Порт, через который АктивныйШлюз прослушивает трафик ЕдиныхАгентов — используется для HTTPS-соединения.
OneAgent—used for the HTTPS connection. If you need to change the port value, see custom Plugin Module configuration
|-
|-
|<code>port</code>
|<code>port</code>
|unset
|unset
|The port where the ActiveGate listens for traffic from
|Порт, на котором АктивныйШлюз прослушивает трафик от ЕдиныхАгентов — используется для HTTP-соединения. По умолчанию он отключен.  
OneAgent—used for the HTTP connection. It is disabled by default.
В Linux рекомендуется значение > 1024, чтобы гарантировать, что привилегии root не потребуются.
On Linux, a value > 1024 is recommended, to ensure no root
privileges are required.
|-
|-
|<code>ssl-protocols</code>
|<code>ssl-protocols</code>
|<code>TLSv1.2</code>, Dynatrace version 1.247+ <code>TLSv1.3</code>
|<code>TLSv1.2</code>, версия Ключ-Астром 1.247+ <code>TLSv1.3</code>
|Supported SSL protocols. Can be one or a comma-separated list of values. Note that specifying a particular version does not automatically imply support for all the previous/lower versions—so you need to specify each version explicitly. The allowed values are:
|Поддерживаемые протоколы SSL. Может быть одним или списком значений, разделенных запятыми. Обратите внимание, что указание конкретной версии не означает автоматически поддержку всех предыдущих/младших версий, поэтому вам необходимо явно указать каждую версию.  
 
 
Допустимые значения:
<code>TLSv1</code>, <code>TLSv1.1</code>, <code>TLSv1.2</code>, <code>TLSv1.3</code>
<code>TLSv1</code>, <code>TLSv1.1</code>, <code>TLSv1.2</code>, <code>TLSv1.3</code>
'''Note:''' if you need <code>TLSv1.1</code> or earlier, also enable _SHA by removing it from the <code>excluded-ciphers</code> list—see below.
 
 
'''Примечание'''. Если вам требуется <code>TLSv1.1</code> или более ранняя версия, также включите <code>_SHA</code>, удалив его из списка исключенных шифров.
|-
|-
|<code>excluded-ciphers</code>
|<code>excluded-ciphers</code>
|unset
|unset
|A list of excluded ciphers. Ciphers are defined by a substring
|Список исключенных шифров. Шифры определяются подстрокой, соответствующих хотя бы части имени шифра, например: <code>excluded-ciphers = TLS_RSA_WITH,SHA$,TLS_ECDH</code>
matching at least a part of the cipher name, for example:
<code>excluded-ciphers = TLS_RSA_WITH,SHA$,TLS_ECDH</code>
|-
|-
|<code>certificate-file</code>
|<code>certificate-file</code>
|unset
|unset
|Path of the <code>PKCS#12</code> file containing certificates to be used by the ActiveGate web server. Also see Configuration of custom SSL certificate on ActiveGate.
|Путь к файлу <code>PKCS#12</code>, содержащему сертификаты, которые будут использоваться веб-сервером АктивногоШлюза.
|-
|-
|<code>certificate-password</code>
|<code>certificate-password</code>
|unset
|unset
|Password for the certificate file.
|Пароль к файлу сертификата.
|-
|-
|<code>certificate-alias</code>
|<code>certificate-alias</code>
|unset
|unset
|Friendly name of the certificate in the <code>PKCS#12</code> file.
|Понятное имя сертификата в файле <code>PKCS#12</code>.
|}
|}


==== Operating over HTTPS vs HTTP ====
==== Работа через HTTPS против HTTP ====
By default, ActiveGate operates in a secure way, by servicing incoming requests using HTTPS. This is specified by the <code>port-ssl</code> configuration property, which can be customized in the <code>custom.properties</code> file. However, if you want ActiveGate to use HTTP, you must specify the <code>port</code> property in the <code>custom.properties</code>.
По умолчанию АктивныйШлюз работает безопасным образом, обслуживая входящие запросы по протоколу HTTPS. Это определяется свойством конфигурации <code>port-ssl</code>, которое можно настроить в файле <code>custom.properties</code>. Однако, если вы хотите, чтобы АктивныйШлюз использовал <code>HTTP</code>, вы должны указать свойство порта в <code>custom.properties</code>.
 
Note that the secure way is the default and recommended one. However, you might want to choose the HTTP option for performance reasons. For example, if you have a load balancer installed in front of a Cluster ActiveGate and if the load balancer terminates incoming external SSL connections (see the third deployment scenario).
 
=== Раздел: [http.client] ===
Communication settings used for AWS/VMware/Azure monitoring and for communicating with the Dynatrace Cluster (unless overridden in <code>[http.client.internal]</code>). In particular, this section contains configuration properties related to proxy settings and connection timeouts.
 
Specify common proxy settings for Dynatrace Cluster communication and AWS/VMware/Azure monitoring.


=== Раздел: [http.client.internal] ===
Обратите внимание, что безопасный способ используется по умолчанию и является рекомендуемым. Однако вы можете выбрать вариант HTTP из соображений производительности. Например, если у вас перед АктивнымШлюзом Кластера установлен балансировщик нагрузки и если балансировщик нагрузки прерывает входящие внешние SSL-соединения (см. третий сценарий развертывания).
Settings specific to communication with the Dynatrace Cluster only.


In particular, this section can contain configuration properties related to proxy settings and connection timeouts.
=== Раздел [http.client] ===
Параметры связи, используемые для мониторинга AWS/VMware/Azure и для связи с кластером (если они не переопределены в <code>[http.client.internal]</code>). В частности, этот раздел содержит свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.


'''If this section does not exist, communication with the Dynatrace Cluster is defined by the settings in the <code>[http.client]</code> section'''. However, if the <code>[http.client.internal]</code> section does exist in which a particular communication setting is not listed, then, for the purpose of communicating with the Dynatrace Cluster, the value of that setting is '''assumed to be its factory default''' (it is '''not''' inherited from <code>[http.client]</code>).
=== Раздел [http.client.internal] ===
Настройки, относящиеся только к связи с кластером Ключ-Астром.


Set up proxy only for Dynatrace Cluster communication
В частности, этот раздел может содержать свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.


=== Раздел: [http.client.external] ===
'''Если этот раздел не существует, связь с кластером Ключ-Астром определяется настройками в разделе <code>[http.client]</code>'''. Однако, если раздел <code>[http.client.internal]</code> существует, в котором конкретный параметр связи не указан, то для связи с кластером значение этого параметра '''считается заводским по умолчанию''' (не унаследовано от <code>[http.client]</code>).
Communication settings for specific modules: Cloud Foundry, Kubernetes, and also for Synthetic Monitoring.


In particular, this section can contain configuration properties related to proxy settings and connection timeouts.
=== Раздел [http.client.external] ===
Настройки связи для конкретных модулей: Cloud Foundry, Kubernetes, а также для Синтетического Мониторинга.


If this section contains <code>proxy-off = true</code>, then there is no proxy for the modules. If it contains the <code>proxy-host</code> property, then this is the proxy to be used for the modules.
В частности, этот раздел может содержать свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.


'''Note:''' Communication settings specified in <code>[http.client]</code> are '''not always''' used as defaults for the modules: If a particular communication setting is '''not''' specified in <code>[http.client.external]</code>, then that setting—for Cloud Foundry, Kubernetes or Synthetic Monitoring—will revert to its factory default value, rather than to the value specified in <code>[http.client]</code>.
Если в этом разделе указано <code>proxy-off=true</code>, то прокси для модулей нет. Если он содержит свойство <code>proxy-host</code>, то этот прокси будет использоваться для модулей.


Similarly, if the entire <code>[http.client.external]</code> section does not exist, then all of the communication settings for Kubernetes and Cloud Foundry will revert to their factory default values; however, settings for Synthetic Monitoring will assume values as specified in the <code>[http.client]</code> section.
'''Примечание'''. Параметры связи, указанные в <code>[http.client]</code>, не всегда используются модулями по умолчанию: если конкретный параметр связи не указан в <code>[http.client.external]</code>, то этот параметр — для Cloud Foundry, Kubernetes или Синтетического Мониторинга. — вернется к заводскому значению по умолчанию, а не к значению, указанному в <code>[http.client]</code>.


Specify common proxy settings for Cloud Foundry, Kubernetes, and Synthetic Monitoring
Точно так же, если весь раздел <code>[http.client.external]</code> не существует, все параметры связи для Kubernetes и Cloud Foundry вернутся к заводским значениям по умолчанию; однако параметры синтетического мониторинга будут принимать значения, указанные в разделе <code>[http.client]</code>.

Текущая версия на 13:27, 27 сентября 2022

Основные правила работы с конфигурацией АктивногоШлюза

Файлы конфигурации АктивногоШлюза

Многие параметры конфигурации АктивногоШлюза (например, параметры подключения и прокси-сервера, шифры или параметры дампа памяти) хранятся в файлах свойств 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 в режиме развертывания по умолчанию

true в режиме развертывания Синтетический мониторинг

Позволяет АктивномуШлюзу выполнять мониторы из частных синтетических местоположений.
synthetic_autoinstall true для автоматического обновления движка Синтетики Автоматически устанавливается в true во время установки для синтетических АктивныхШлюзов.
proxy-server unset Адрес прокси-сервера
proxy-port unset Порт прокси (числовой)
proxy-user unset Имя пользователя прокси (необязательно)
proxy-password unset Пароль прокси (необязательно)

Пароль, указанный в свойстве proxy-password, обфусцируется после перезапуска АктивногоШлюза, а замаскированный пароль сохраняется в свойстве proxy-password-encr.

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), иначе ваши ЕдиныеАгенты не смогут подключиться.


Примечание. Чтобы избежать ненужных DNS-запросов и повысить безопасность, вы можете пометить доменное имя как полное доменное имя (FQDN), добавив точку в конце URL-адреса. Например, www.example.com является абсолютным доменным именем.

Раздел Сетевых зон

Раздел: [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 дней) Максимальный возраст файлов, хранящихся в файловом кэше АктивногоШлюза, в миллисекундах. Возраст файла отсчитывается с момента последнего использования файла (а не с момента загрузки/создания).


Если файл не используется для настроенного максимального возраста, файл будет автоматически удален. Файлы также удаляются из кеша до достижения максимального возраста, если для новых файлов недостаточно места. Файлы LRU (наименее использовавшиеся) удаляются первыми.

Раздел [com.compuware.apm.webserver]

Свойство Значение по умолчанию Описание
port-ssl 9999 Порт, через который АктивныйШлюз прослушивает трафик ЕдиныхАгентов — используется для HTTPS-соединения.
port unset Порт, на котором АктивныйШлюз прослушивает трафик от ЕдиныхАгентов — используется для HTTP-соединения. По умолчанию он отключен.

В Linux рекомендуется значение > 1024, чтобы гарантировать, что привилегии root не потребуются.

ssl-protocols TLSv1.2, версия Ключ-Астром 1.247+ TLSv1.3 Поддерживаемые протоколы SSL. Может быть одним или списком значений, разделенных запятыми. Обратите внимание, что указание конкретной версии не означает автоматически поддержку всех предыдущих/младших версий, поэтому вам необходимо явно указать каждую версию.


Допустимые значения: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3


Примечание. Если вам требуется TLSv1.1 или более ранняя версия, также включите _SHA, удалив его из списка исключенных шифров.

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].

Источник — https://doc.ruscomtech.ru/index.php?title=Параметры_АктивногоШлюза&oldid=1436