Параметры АктивногоШлюза - История изменений

IKuznetsov в 09:17, 8 января 2025

2025-01-08T09:17:37Z

← Предыдущая версия		Версия от 09:17, 8 января 2025
Строка 375:		Строка 375:
	\|unset		\|unset
	\|Определяет сетевую зону, к которой принадлежит АктивныйШлюз. АктивныйШлюз может принадлежать только одной сетевой зоне. Имя сетевой зоны представляет собой строку буквенно-цифровых символов, дефисов <code>(-)</code>, знаков подчеркивания <code>(_)</code> и точек <code>(.)</code>. Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени сетевой зоны. Длина строки ограничена 256 символами.		\|Определяет сетевую зону, к которой принадлежит АктивныйШлюз. АктивныйШлюз может принадлежать только одной сетевой зоне. Имя сетевой зоны представляет собой строку буквенно-цифровых символов, дефисов <code>(-)</code>, знаков подчеркивания <code>(_)</code> и точек <code>(.)</code>. Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени сетевой зоны. Длина строки ограничена 256 символами.
	После добавления или изменения этого параметра требуется перезапуск АктивногоШлюза. После перезапуска в ~~Ключе-Астром~~ автоматически создается сетевая зона.		После добавления или изменения этого параметра требуется перезапуск АктивногоШлюза. После перезапуска в АппОптима автоматически создается сетевая зона.
	\|}		\|}

IKuznetsov в 08:23, 8 января 2025

2025-01-08T08:23:36Z

← Предыдущая версия		Версия от 08:23, 8 января 2025
Строка 1:		Строка 1:
			'''''[[Установка и настройка]] / [[Установка и настройка\|Основные элементы АппОптима]] / [[АктивныйШлюз АппОптима]] / [[АктивныйШлюз АппОптима\|Подробнее об АктивныхШлюзах]] / [[Конфигурация АктивногоШлюза]] / Параметры АктивногоШлюза'''''

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

Строка 8:		Строка 10:
	MSGrouter = true		MSGrouter = true
	restInterface = true		restInterface = true
	DumpSupported = false~~</code>~~		DumpSupported = false

	=== config.properties ===		=== config.properties ===
Строка 45:		Строка 47:
	-healthcheck.heartbeat.portrange=60100:60200		-healthcheck.heartbeat.portrange=60100:60200
	-arguments_section.jvm		-arguments_section.jvm
	-Dsomecustomproperty=value~~</code>~~		-Dsomecustomproperty=value

	== Диапазон портов АктивногоШлюза ==		== Диапазон портов АктивногоШлюза ==
Строка 56:		Строка 58:
	-healthcheck.heartbeat.portrange=60100:60200		-healthcheck.heartbeat.portrange=60100:60200
	-arguments_section.jvm		-arguments_section.jvm
	-Dsomecustomproperty=value~~</code>~~		-Dsomecustomproperty=value

	== Пользовательские параметры для Java-процесса АктивногоШлюза ==		== Пользовательские параметры для Java-процесса АктивногоШлюза ==
Строка 69:		Строка 71:
	-healthcheck.heartbeat.portrange=60100:60200		-healthcheck.heartbeat.portrange=60100:60200
	-arguments_section.jvm		-arguments_section.jvm
	-Dsomecustomproperty=value~~</code>~~		-Dsomecustomproperty=value

	== Модули и разделы АктивногоШлюза ==		== Модули и разделы АктивногоШлюза ==
Строка 395:		Строка 397:
	Кэш файлов активируется автоматически при установке или обновлении АктивногоШлюза. Однако активация происходит только при соблюдении минимального требования к пространству в 512 МБ. Если минимальные требования к пространству не выполняются, кэширование автоматически деактивируется.		Кэш файлов активируется автоматически при установке или обновлении АктивногоШлюза. Однако активация происходит только при соблюдении минимального требования к пространству в 512 МБ. Если минимальные требования к пространству не выполняются, кэширование автоматически деактивируется.

	Файловый ~~кеш~~ можно настроить или отключить в конфигурации АктивногоШлюза, в файле <code>custom.properties</code>:		Файловый кэш можно настроить или отключить в конфигурации АктивногоШлюза, в файле <code>custom.properties</code>:

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

IKuznetsov в 11:24, 11 ноября 2024

2024-11-11T11:24:50Z

← Предыдущая версия		Версия от 11:24, 11 ноября 2024
Строка 5:		Строка 5:

	Файлы <code>config.properties</code> и <code>custom.properties</code> разделены на секции. Каждое название раздела заключено в квадратные скобки, например:		Файлы <code>config.properties</code> и <code>custom.properties</code> разделены на секции. Каждое название раздела заключено в квадратные скобки, например:
	<~~code>~~[collector]		<[collector]
	MSGrouter = true		MSGrouter = true
	restInterface = true		restInterface = true
Строка 40:		Строка 40:

	Например:		Например:
	<~~code>~~# Xmx settings 83% of available RAM + 0 MB		<# Xmx settings 83% of available RAM + 0 MB
	-java.xmx.absolute_part=0		-java.xmx.absolute_part=0
	-java.xmx.relative_part=83		-java.xmx.relative_part=83
Строка 51:		Строка 51:

	По умолчанию программа запуска будет использовать порты выше 50000 для мониторинга пульса. Для некоторых развертываний может потребоваться настроить для этой цели другие порты. Чтобы указать диапазон портов, который должен использовать модуль запуска АктивногоШлюза, добавьте или измените свойство <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		<# Xmx settings 80% of available RAM + 0 MB
	-java.xmx.absolute_part=0		-java.xmx.absolute_part=0
	-java.xmx.relative_part=83		-java.xmx.relative_part=83
Строка 64:		Строка 64:

	Например:		Например:
	<~~code>~~# Xmx settings 80% of available RAM + 0 MB		<# Xmx settings 80% of available RAM + 0 MB
	-java.xmx.absolute_part=0		-java.xmx.absolute_part=0
	-java.xmx.relative_part=83		-java.xmx.relative_part=83
Строка 273:		Строка 273:
	Мы рекомендуем вам не изменять значение свойства <code>synthetic_autoupgrade_chromium</code> в <code>custom.properties</code>, поскольку ваши изменения могут быть перезаписаны.		Мы рекомендуем вам не изменять значение свойства <code>synthetic_autoupgrade_chromium</code> в <code>custom.properties</code>, поскольку ваши изменения могут быть перезаписаны.

	<code>synthetic_autoupgrade_chromium</code> для автообновления Chromium можно определить на уровне местоположения (для местоположений с АктивнымиШлюзами Окружений) либо через веб-интерфейс, либо с помощью вызова PUT API местоположения API синтетических местоположений v2. Для АктивногоШлюза Кластера это свойство можно настроить с помощью вызова PUT (~~Ключ-АстромManaged~~) API Кластера v2. Это свойство не определено для АктивныхШлюзов, которые не были назначены местоположению. Для Activates, назначенных местоположению, значением по умолчанию является <code>true</code>.		<code>synthetic_autoupgrade_chromium</code> для автообновления Chromium можно определить на уровне местоположения (для местоположений с АктивнымиШлюзами Окружений) либо через веб-интерфейс, либо с помощью вызова PUT API местоположения API синтетических местоположений v2. Для АктивногоШлюза Кластера это свойство можно настроить с помощью вызова PUT (АппОптимаManaged) API Кластера v2. Это свойство не определено для АктивныхШлюзов, которые не были назначены местоположению. Для Activates, назначенных местоположению, значением по умолчанию является <code>true</code>.

	=== Модуль Beacon Forwarder ===		=== Модуль Beacon Forwarder ===
Строка 288:		Строка 288:

	=== Модуль API HTTP-метрик ===		=== Модуль API HTTP-метрик ===
	Прием метрик: простой способ передать любые пользовательские метрики в ~~Ключ-Астром~~		Прием метрик: простой способ передать любые пользовательские метрики в АппОптима

	'''Раздел: [metrics_ingest]'''		'''Раздел: [metrics_ingest]'''
Строка 310:		Строка 310:
	\|Включает модуль дампов памяти. Возможные значения: <code>true</code> или <code>false</code>.		\|Включает модуль дампов памяти. Возможные значения: <code>true</code> или <code>false</code>.
	\|}		\|}
	Когда в вашем приложении возникают утечки памяти или большое количество объектов, важно получить дампы памяти, чтобы вы могли проанализировать эти проблемы. В производственных средах это часто становится проблемой, когда вы не можете войти в среду и у вас нет других средств запуска дампов памяти. ~~Ключ-Астром~~ позволяет вам запускать и безопасно загружать дампы памяти в инструмент анализа по вашему выбору.		Когда в вашем приложении возникают утечки памяти или большое количество объектов, важно получить дампы памяти, чтобы вы могли проанализировать эти проблемы. В производственных средах это часто становится проблемой, когда вы не можете войти в среду и у вас нет других средств запуска дампов памяти. АппОптима позволяет вам запускать и безопасно загружать дампы памяти в инструмент анализа по вашему выбору.

	=== Модуль Маршрутизации ЕдиныхАгентов ===		=== Модуль Маршрутизации ЕдиныхАгентов ===
Строка 321:		Строка 321:
	\|-		\|-
	\|<code>MSGrouter</code>		\|<code>MSGrouter</code>
	\|Включает модуль маршрутизации ЕдиныхАгентов, который направляет трафик ЕдиныхАгентов и другого АктивногоШлюза через ~~Ключ-Астром~~. Возможные значения: <code>true</code> или <code>false</code>.		\|Включает модуль маршрутизации ЕдиныхАгентов, который направляет трафик ЕдиныхАгентов и другого АктивногоШлюза через АппОптима. Возможные значения: <code>true</code> или <code>false</code>.
	\|}		\|}

Строка 339:		Строка 339:
	'''Раздел: [collector]'''		'''Раздел: [collector]'''

	Вы можете использовать АктивныйШлюз для доступа к API ~~Ключ-Астром~~. АктивныйШлюз поддерживает вызовы всех конечных точек конфигурации и среды API в версиях v1 и v2. Чтобы получить доступ к API ~~Ключ-Астром~~ с помощью АктивногоШлюза, используйте URL-адрес в следующем формате: <nowiki>https://{ваш-АктивныйШлюз-домен}/e/{идентификатор</nowiki> вашей среды}/api/...		Вы можете использовать АктивныйШлюз для доступа к API АппОптима. АктивныйШлюз поддерживает вызовы всех конечных точек конфигурации и среды API в версиях v1 и v2. Чтобы получить доступ к API АппОптима с помощью АктивногоШлюза, используйте URL-адрес в следующем формате: <nowiki>https://{ваш-АктивныйШлюз-домен}/e/{идентификатор</nowiki> вашей среды}/api/...
	{\| class="wikitable"		{\| class="wikitable"
	!Свойство		!Свойство
Строка 345:		Строка 345:
	\|-		\|-
	\|<code>restInterface</code>		\|<code>restInterface</code>
	\|Включает модуль REST API, упрощающий доступ к API ~~Ключ-Астром~~ с помощью REST. Возможные значения: <code>true</code> или <code>false</code>.		\|Включает модуль REST API, упрощающий доступ к API АппОптима с помощью REST. Возможные значения: <code>true</code> или <code>false</code>.
	\|}		\|}

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

Строка 477:		Строка 477:

	=== Раздел [http.client.internal] ===		=== Раздел [http.client.internal] ===
	Настройки, относящиеся только к связи с кластером ~~Ключ-Астром~~.		Настройки, относящиеся только к связи с кластером АппОптима.

	В частности, этот раздел может содержать свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.		В частности, этот раздел может содержать свойства конфигурации, связанные с настройками прокси-сервера и тайм-аутами соединения.

	'''Если этот раздел не существует, связь с кластером ~~Ключ-Астром~~ определяется настройками в разделе <code>[http.client]</code>'''. Однако, если раздел <code>[http.client.internal]</code> существует, в котором конкретный параметр связи не указан, то для связи с кластером значение этого параметра '''считается заводским по умолчанию''' (не унаследовано от <code>[http.client]</code>).		'''Если этот раздел не существует, связь с кластером АппОптима определяется настройками в разделе <code>[http.client]</code>'''. Однако, если раздел <code>[http.client.internal]</code> существует, в котором конкретный параметр связи не указан, то для связи с кластером значение этого параметра '''считается заводским по умолчанию''' (не унаследовано от <code>[http.client]</code>).

	=== Раздел [http.client.external] ===		=== Раздел [http.client.external] ===

RGolovanov в 13:27, 27 сентября 2022

2022-09-27T13:27:24Z

Внесённые изменения

RGolovanov в 13:16, 27 сентября 2022

2022-09-27T13:16:24Z

Внесённые изменения

RGolovanov: Новая страница: «== Основные правила работы с конфигурацией АктивногоШлюза == === Файлы конфигурации ActiveGate...»

2022-09-27T12:46:24Z

Новая страница: «== Основные правила работы с конфигурацией АктивногоШлюза == === Файлы конфигурации ActiveGate...»

Новая страница

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

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

Файлы <code>config.properties</code> и <code>custom.properties</code> разделены на секции. Каждое название раздела заключено в квадратные скобки, например:
<code>[collector]
MSGrouter = true
restInterface = true
DumpSupported = false</code>

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

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

Файлы конфигурации разбиты на <code>[разделы]</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>.

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

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

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

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

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

* Настройки ограничения памяти могут быть комбинацией:
** <code>-java.xmx.relative_part</code> — процента доступной оперативной памяти
** <code>-java.xmx.absolute_part</code> — абсолютного значения объема памяти в МБ.

Например:
<code># 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</code>

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

По умолчанию программа запуска будет использовать порты выше 50000 для мониторинга пульса. Для некоторых развертываний может потребоваться настроить для этой цели другие порты. Чтобы указать диапазон портов, который должен использовать модуль запуска ActiveGate, добавьте или измените свойство <code>-healthcheck.heartbeat.portrange</code> в файле конфигурации модуля запуска <code>launcheruserconfig.conf</code>, как в примере ниже.
<code># 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</code>

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

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

Например:
<code># 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</code>

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

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

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

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

=== AWS ===
AWS-мониторинг

'''Раздел: [aws_monitoring]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>aws_monitoring_enabled</code>
|Включает модуль мониторинга AWS. Возможные значения: <code>true</code> или <code>false</code>.
|}

=== Azure ===
Microsoft Azure monitoring

'''Раздел: [azure_monitoring]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>azure_monitoring_enabled</code>
|Включает модуль Microsoft Azure. Возможные значения: <code>true</code> или <code>false</code>.
|}

=== Module: Cloud Foundry ===
Cloud Foundry monitoring

'''Раздел: [cloudfoundry_monitoring]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>cloudfoundry_monitoring_enabled</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>.

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

Set up proxy only for Cloud Foundry monitoring

=== Module: Kubernetes ===
Kubernetes monitoring

'''Раздел: [kubernetes_monitoring]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>kubernetes_monitoring_enabled</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.

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.

Set up proxy only for Kubernetes monitoring

=== Module: Log Monitoring ===
'''Раздел: [log_analytics_collector]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>log_analytics_collector_enabled</code>
|Включает модуль мониторинга логов. Возможные значения: <code>true</code> или <code>false</code>.
|}
'''Раздел: [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).
{| class="wikitable"
!Свойство
!Значение по умолчанию
!Описание
|-
|<code>disk_queue_path</code>
|Текущая общесистемная временная папка
|Указывает путь к временной папке, в которой будут храниться данные журнала, поставленные в очередь.
|-
|<code>disk_queue_max_size_mb</code>
|300 МБ
|Задает максимальный размер данных журнала в очереди, которые можно хранить во временной папке.
|}

=== Module: VMware ===
VMware monitoring

'''Раздел: [vmware_monitoring]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>vmware_monitoring_enabled</code>
|Включает модуль мониторинга VMware. Возможные значения: истина или ложь.
|}

=== Module: Database insights ===
Oracle database insights

'''Раздел: [dbAgent]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>dbAgent_enabled</code>
|Enables Oracle database insights module. Possible values: <code>true</code> or <code>false</code>.
|}

=== Module: Extensions 1.0 ===
'''Раздел: [rpm]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<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>.
|}

=== Module: Extensions 2.0 ===
'''Раздел: [extension_controller]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>extension_controller_enabled</code>
|Enables the Extensions 2.0 module. Possible values: <code>true</code> or <code>false</code>.
|}

=== Module: zRemote ===
Install the zRemote module for z/OS monitoring

'''Раздел: [zremote]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>zremote_enabled</code>
|Enables the zRemote module. Possible values: <code>true</code> or <code>false</code>.
|}

=== Module: Synthetic ===
Synthetic monitors from private Synthetic locations

'''Раздел: [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).

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

To learn more about the proxy-related properties for a Synthetic-enabled ActiveGate, see Set up a proxy for private 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.
{| class="wikitable"
!Свойство
!Значение по умолчанию
!Описание
|-
|<code>synthetic_enabled</code>
|<code>false</code> in the '''Default''' deployment mode
<code>true</code> in the '''Synthetic monitoring''' deployment mode
|Enables the ActiveGate to execute monitors from private Synthetic locations.
|-
|<code>synthetic_autoinstall</code>
|<code>true</code> to automatically update the Synthetic engine
|Automatically set to <code>true</code> at installation time for Synthetic-enabled ActiveGates.
|-
|<code>proxy-server</code>
|unset
|Proxy server address
|-
|<code>proxy-port</code>
|unset
|Proxy port (numeric)
|-
|<code>proxy-user</code>
|unset
|Proxy user name (optional)
|-
|<code>proxy-password</code>
|unset
|Proxy password (optional)
The password provided in the <code>proxy-password</code> property
is obfuscated following ActiveGate restart and the obfuscated password
is stored in the <code>proxy-password-encr</code> property.
|-
|<code>proxy-off</code>
|unset
|Disable proxy communication between ActiveGate and tested resource.
|-
|<code>proxy-non-proxy-hosts</code>
|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> 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>.

=== Module: Beacon forwarder ===
Using ActiveGate for Real User Monitoring

'''Раздел: [beacon_forwarder]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>beacon_forwarder_enabled</code>
|Enables the Beacon forwarder module. Possible values: <code>true</code> or <code>false</code>.
|}

=== Module: HTTP Metric API ===
Metric ingestion: a simple way to push any custom metrics to Dynatrace

'''Раздел: [metrics_ingest]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>metrics_ingest_enabled</code>
|Enables HTTP Metric API module which facilitates metric ingestion. Possible values: <code>true</code> or <code>false</code>.
|}

=== Module: Memory dumps ===
Triggering and downloading of memory dumps

'''Раздел: [collector]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>DumpSupported</code>
|Enables the memory dumps module. Possible values: <code>true</code> or <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]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<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>.
|}

=== Module: OTLP Ingest ===
This module creates an endpoint on the ActiveGate that can receive OpenTelemetry trace data (traces and spans) in OTLP format. '''Раздел: [otlp_ingest]'''
{| class="wikitable"
!Свойство
!Описание
|-
|<code>otlp_ingest_enabled</code>
|Enables OTLP ingest module which facilitates OpenTelemetry trace ingest. Possible values: <code>true</code> or <code>false</code>.
|}

=== Module: REST API ===
'''Раздел: [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>
{| class="wikitable"
!Свойство
!Описание
|-
|<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>.
|}

=== Load balancer address ===
'''Раздел: [connectivity]'''
{| class="wikitable"
!Свойство
!Значение по умолчанию
!Описание
|-
|<code>dnsEntryPoint</code>
|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.
|}

=== Network zone ===
'''Раздел: [connectivity]'''
{| class="wikitable"
!Свойство
!Значение по умолчанию
!Описание
|-
|<code>networkZone</code>
|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.
ActiveGate restart is required after adding or changing this parameter. After restart, a network zone is automatically created in Dynatrace.
|}

=== Group ===
'''Раздел: [collector]'''
{| class="wikitable"
!Свойство
!Значение по умолчанию
!Описание
|-
|<code>group</code>
|unset
|ActiveGate group
|}

=== ActiveGate file cache ===
ActiveGate version 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.

The file cache can be fine-tuned or deactivated in ActiveGate configuration, in the <code>custom.properties</code> file:

'''Раздел: [generic_filecache]'''
{| class="wikitable"
!Свойство
!Значение по умолчанию
!Описание
|-
|<code>generic_filecache_enabled</code>
|<code>true</code>
|Enables or disables ActiveGate file cache. Possible values: <code>true</code> or <code>false</code>.
|-
|<code>generic_filecache_path</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>2147483648</code> (2 GB)
|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>1209600000</code> (14 days)
|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.
|}

=== Раздел: [com.compuware.apm.webserver] ===
{| class="wikitable"
!Свойство
!Значение по умолчанию
!Описание
|-
|<code>port-ssl</code>
|<code>9999</code>
|The port where the ActiveGate listens for traffic from
OneAgent—used for the HTTPS connection. If you need to change the port value, see custom Plugin Module configuration
|-
|<code>port</code>
|unset
|The port where the ActiveGate listens for traffic from
OneAgent—used for the HTTP connection. It is disabled by default.
On Linux, a value > 1024 is recommended, to ensure no root
privileges are required.
|-
|<code>ssl-protocols</code>
|<code>TLSv1.2</code>, Dynatrace version 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:
<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>excluded-ciphers</code>
|unset
|A list of excluded ciphers. Ciphers are defined by a substring
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>
|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>certificate-password</code>
|unset
|Password for the certificate file.
|-
|<code>certificate-alias</code>
|unset
|Friendly name of the certificate in the <code>PKCS#12</code> file.
|}

==== Operating over HTTPS vs 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>.

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] ===
Settings specific to communication with the Dynatrace Cluster only.

In particular, this section can contain configuration properties related to proxy settings and connection timeouts.

'''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>).

Set up proxy only for Dynatrace Cluster communication

=== Раздел: [http.client.external] ===
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.

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

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.

Specify common proxy settings for Cloud Foundry, Kubernetes, and Synthetic Monitoring