Параметры АктивногоШлюза

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

Файлы конфигурации ActiveGate

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

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

[collector]
MSGrouter = true
restInterface = true
DumpSupported = false

config.properties

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

custom.properties

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

Файлы конфигурации разбиты на [разделы], которые указаны в квадратных скобках.

Чтобы указать настраиваемые параметры в custom.properties, введите имена разделов и включите соответствующие свойства в эти разделы.

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

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

launcheruserconfig.conf

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

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

Перезапуск ActiveGate

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

Ограничения памяти ActiveGate

Ограничения на использование памяти для ActiveGate можно указать в конфигурационном файле лаунчера 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

Диапазон портов ActiveGate

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

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

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

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

Например:

# 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

Модули ActiveGate

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

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

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

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

AWS

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

Раздел: [aws_monitoring]

Свойство	Описание
aws_monitoring_enabled	Включает модуль мониторинга AWS. Возможные значения: true или false.

Azure

Microsoft Azure monitoring

Раздел: [azure_monitoring]

Свойство	Описание
azure_monitoring_enabled	Включает модуль Microsoft Azure. Возможные значения: true или false.

Module: Cloud Foundry

Cloud Foundry monitoring

Раздел: [cloudfoundry_monitoring]

Свойство	Описание
cloudfoundry_monitoring_enabled	Включает модуль Cloud Foundry. Возможные значения: true или false.

This section can contain proxy settings for communication with Cloud Foundry. If this section contains proxy-off = true, then there is no proxy for communication with Cloud Foundry. If it contains the proxy-host property, then this is the proxy to be used for Cloud Foundry monitoring, rather than the proxy specified in [http.client.external].

Note: If you have a [cloudfoundry_monitoring] section in your custom.properties file, you also need to have an [http.client.external] 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]

Свойство	Описание
kubernetes_monitoring_enabled	Включает модуль мониторинга Kubernetes. Возможные значения: true или false.

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 proxy-off = true, then there is no proxy for communication with Kubernetes. If it contains the proxy-host property, then this is the proxy to be used for Kubernetes monitoring, rather than the proxy specified in [http.client.external].

Note: If you have a [kubernetes_monitoring] section in your custom.properties file, then you also need to have an [http.client.external] 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]

Свойство	Описание
log_analytics_collector_enabled	Включает модуль мониторинга логов. Возможные значения: true или false.

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

Свойство	Значение по умолчанию	Описание
disk_queue_path	Текущая общесистемная временная папка	Указывает путь к временной папке, в которой будут храниться данные журнала, поставленные в очередь.
disk_queue_max_size_mb	300 МБ	Задает максимальный размер данных журнала в очереди, которые можно хранить во временной папке.

Module: VMware

VMware monitoring

Раздел: [vmware_monitoring]

Свойство	Описание
vmware_monitoring_enabled	Включает модуль мониторинга VMware. Возможные значения: истина или ложь.

Module: Database insights

Oracle database insights

Раздел: [dbAgent]

Свойство	Описание
dbAgent_enabled	Enables Oracle database insights module. Possible values: true or false.

Module: Extensions 1.0

Раздел: [rpm]

Свойство	Описание
rpm_enabled	Enables the Remote plugin module, which is used to run ActiveGate extensions. Possible values: true or false.

Module: Extensions 2.0

Раздел: [extension_controller]

Свойство	Описание
extension_controller_enabled	Enables the Extensions 2.0 module. Possible values: true or false.

Module: zRemote

Install the zRemote module for z/OS monitoring

Раздел: [zremote]

Свойство	Описание
zremote_enabled	Enables the zRemote module. Possible values: true or false.

Module: Synthetic

Synthetic monitors from private Synthetic locations

Раздел: [synthetic]

Proxy settings for Synthetic Monitoring. If this section contains proxy-off = true, then there is no proxy for Synthetic Monitoring. If it contains the proxy-host property, then this is the proxy to be used for Synthetic Monitoring, rather than the proxy specified in [http.client.external] (or in [http.client], if [http.client.external] is not defined).

Note: If you have a [synthetic] section in your custom.properties file, you can have an [http.client.external] 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 [http.client] section.

However, if you do create the [http.client.external] 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 synthetic_enabled 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.

Свойство	Значение по умолчанию	Описание
synthetic_enabled	false in the Default deployment mode true in the Synthetic monitoring deployment mode	Enables the ActiveGate to execute monitors from private Synthetic locations.
synthetic_autoinstall	true to automatically update the Synthetic engine	Automatically set to true at installation time for Synthetic-enabled ActiveGates.
proxy-server	unset	Proxy server address
proxy-port	unset	Proxy port (numeric)
proxy-user	unset	Proxy user name (optional)
proxy-password	unset	Proxy password (optional) The password provided in the proxy-password property is obfuscated following ActiveGate restart and the obfuscated password is stored in the proxy-password-encr property.
proxy-off	unset	Disable proxy communication between ActiveGate and tested resource.
proxy-non-proxy-hosts	unset	Do not use proxy when communicating with these hosts.

Important

We recommend that you not edit the value of the synthetic_autoupgrade_chromium property in custom.properties because your changes might be overwritten.

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

Module: Beacon forwarder

Using ActiveGate for Real User Monitoring

Раздел: [beacon_forwarder]

Свойство	Описание
beacon_forwarder_enabled	Enables the Beacon forwarder module. Possible values: true or false.

Module: HTTP Metric API

Metric ingestion: a simple way to push any custom metrics to Dynatrace

Раздел: [metrics_ingest]

Свойство	Описание
metrics_ingest_enabled	Enables HTTP Metric API module which facilitates metric ingestion. Possible values: true or false.

Module: Memory dumps

Triggering and downloading of memory dumps

Раздел: [collector]

Свойство	Описание
DumpSupported	Enables the memory dumps module. Possible values: true or false.

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]

Свойство	Описание
MSGrouter	Enables the OneAgent routing module, which routes of OneAgent and other ActiveGate traffic through Dynatrace. Possible values: true or false.

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]

Свойство	Описание
otlp_ingest_enabled	Enables OTLP ingest module which facilitates OpenTelemetry trace ingest. Possible values: true or false.

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: https://{your-ActiveGate-domain}/e/{your-environment-id}/api/...

Свойство	Описание
restInterface	Enables the REST API module, which facilitates access to Dynatrace API using REST. Possible values: true or false.

Load balancer address

Раздел: [connectivity]

Свойство	Значение по умолчанию	Описание
dnsEntryPoint	unset	The entry points for the ActiveGate (for example, https://sg1.mydomain.com:9999). 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 (http or https) 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, www.example.com. is an absolute domain name. See Trailing Dots in Domain Names for more details.

Network zone

Раздел: [connectivity]

Свойство	Значение по умолчанию	Описание
networkZone	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 (-), underscores (_), and dots (.). 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]

Свойство	Значение по умолчанию	Описание
group	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 custom.properties file:

Раздел: [generic_filecache]

Свойство	Значение по умолчанию	Описание
generic_filecache_enabled	true	Enables or disables ActiveGate file cache. Possible values: true or false.
generic_filecache_path	<ActiveGate temporary directory>/generic_filecache	Path of the ActiveGate file cache directory. The directory will be created if it does not exist (if the file permissions allow it).
generic_filecache_size	2147483648 (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.
generic_filecache_max_age	1209600000 (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]

Свойство	Значение по умолчанию	Описание
port-ssl	9999	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
port	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.
ssl-protocols	TLSv1.2, Dynatrace version 1.247+ TLSv1.3	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: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3 Note: if you need TLSv1.1 or earlier, also enable _SHA by removing it from the excluded-ciphers list—see below.
excluded-ciphers	unset	A list of excluded ciphers. Ciphers are defined by a substring matching at least a part of the cipher name, for example: excluded-ciphers = TLS_RSA_WITH,SHA$,TLS_ECDH
certificate-file	unset	Path of the PKCS#12 file containing certificates to be used by the ActiveGate web server. Also see Configuration of custom SSL certificate on ActiveGate.
certificate-password	unset	Password for the certificate file.
certificate-alias	unset	Friendly name of the certificate in the PKCS#12 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 port-ssl configuration property, which can be customized in the custom.properties file. However, if you want ActiveGate to use HTTP, you must specify the port property in the custom.properties.

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 [http.client.internal]). 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 [http.client] section. However, if the [http.client.internal] 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 [http.client]).

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 proxy-off = true, then there is no proxy for the modules. If it contains the proxy-host property, then this is the proxy to be used for the modules.

Note: Communication settings specified in [http.client] are not always used as defaults for the modules: If a particular communication setting is not specified in [http.client.external], then that setting—for Cloud Foundry, Kubernetes or Synthetic Monitoring—will revert to its factory default value, rather than to the value specified in [http.client].

Similarly, if the entire [http.client.external] 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 [http.client] section.

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