Configure ActiveGate
To configure an ActiveGate setting (for example, proxy, port, or memory dumps), edit the custom.properties file, then restart ActiveGate. The custom.properties file is located in the ActiveGate configuration directory.
The custom.properties file is preserved during ActiveGate upgrade; it's copied in its entirety from your existing installation to the new one.
Keep in mind that custom.properties takes precedence over config.properties. Therefore, if a setting occurs in both files, the value of the setting in the custom.properties file will take precedence. Also, command line settings (if any) take precedence over those stored in custom.properties.
If you modify the custom.properties file, restart the ActiveGate to put your changes into effect.
The ActiveGate properties that you can configure are described in the following tables. These properties are applicable for both Environment ActiveGates and Cluster ActiveGates.
Section: [connectivity]
| Property | Default value | Description |
|---|---|---|
dnsEntryPoint |
unset | Define the entry point for the ActiveGate (for example, https://sg1.mydomain.com:9999). Via this URL, the ActiveGate is accessed by Dynatrace OneAgent. If not set, an auto-detected endpoint will be 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, otherwise your OneAgents won't be able to connect. |
networkZone |
unset | The network zone to which the ActiveGate belongs. An ActiveGate can be part of only one network zone. Restart of the ActiveGate is required when changing or first adding this parameter. After restart, a network zone is automatically created in Dynatrace. |
Section: [com.compuware.apm.webserver]
| Property | Default value | Description |
|---|---|---|
port-ssl |
9999 |
The port where the ActiveGate listens for traffic from OneAgent—used for 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 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 |
Supported SSL protocols. Can be one or a list of the following values:TLSv1, TLSv1.1, TLSv1.2 |
excluded-ciphers |
unset | List of additionally excluded ciphers (ciphers are defined by a substring matching at least a part of the cipher name, for example _DHE_) |
ActiveGate 1.165+
certificate-file |
unset | Path to PKCS#12 file containing certificates to be used by ActiveGate web server. Please also see Configuration of custom SSL certificate on ActiveGate. |
ActiveGate 1.165+
certificate-password |
unset | Password to open the certificate file. |
ActiveGate 1.165+
certificate-alias |
unset | Friendly name of the certificate in the PKCS#12 file. |
Section: [dump]
For more information, see Configure an ActiveGate for memory dump storage.
| Property | Default value | Description |
|---|---|---|
dumpDir |
dump |
Valid path of the storage directory used for dump storage |
maxSizeGb |
100 |
Storage quota in GBs. If full, the oldest dumps are overwritten until enough space is available to store a new dump. |
maxAgeDays |
7 |
Maximum age of a memory dump in days until the dump is automatically overwritten |
maxConcurrentUploads |
5 |
Maximum number of concurrent dump uploads from OneAgents |
downloadUrl |
unset | A custom download URL (for example, if ActiveGate is behind a load balancer or if ActiveGate only detects an IP address and the user requires an FQDN). The URL must contain the correct schema and port. |
Section: [http.client]
For details on proper use of [http.client] properties, see Setting up proxy for ActiveGate.
| Property | Default value | Description |
|---|---|---|
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. |
Section: [http.client.external]
For details on proper use of [http.client.external] properties, see Setting up proxy for ActiveGate.
| Property | Default value | Description |
|---|---|---|
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. |
Section: [collector]
| Property | Default value | Description |
|---|---|---|
MSGrouter |
true |
ActiveGate enables routing of OneAgent and other ActiveGate traffic through Dynatrace. |
LogDiskBufferPath |
/tmp/diskbuffer |
Local path for log buffer. The property default may be different depending on the operating system. |
restInterface |
true |
ActiveGate can be used to access the Dynatrace Environment API. To use your ActiveGate to make API calls with this feature, the URL must follow this pattern: https://<GATEWAY>/e/<ENVIRONMENT>/api/v1/<API> Only calls from the Environment API v1 are available with this feature. These call have /api/v1/ in the URL. Configuration API (/api/config/) and Environment API v2 (/api/v2/) are not available via ActiveGate. |
DumpSupported |
false |
ActiveGate allows you to temporarily store memory dumps from OneAgent. Additional configuration in section [dump] is required. |
ActiveGate 1.169+
trustedstore |
unset | Your trusted keystore (optional). The property trustedstore should contain the path to the file holding trusted certificates. That path should be relative to the ActiveGate SSL directory. Please also see Configuration of trusted root certificates on ActiveGate. |
ActiveGate 1.169+
trustedstore-password |
changeit |
Password of your trusted keystore (optional) which is encrypted during ActiveGate start. The obfuscated password is then stored in trustedstore-password-encr. |
ActiveGate 1.169+
trustedstore-type |
JKS |
Java default format of key and certificate databases (optional). The second supported format is PKCS12. |
ActiveGate modules
ActiveGate uses embedded modules to run a number of monitoring processes:
- API-based cloud and virtualization monitoring
- Oracle database insights
- ActiveGate extensions
- Dynatrace Synthetic tests from private synthetic locations
- mainframe monitoring
Learn more about ActiveGate purposes.
Note that you can't enable other modules using custom.properties if you installed your ActiveGate to create a private synthetic location or to monitor mainframe. In these cases, if you want to change your ActiveGate purpose, you have to reinstall ActiveGate.
You can also verify your ActiveGate configuration status in the Deployment status page.
Section: [aws_monitoring]
| Property | Default value | Description |
|---|---|---|
aws_monitoring_enabled |
Environment ActiveGate: false; Cluster ActiveGate: true |
Enables AWS monitoring module. |
Section: [azure_monitoring]
| Property | Default value | Description |
|---|---|---|
azure_monitoring_enabled |
Environment ActiveGate: true; Cluster ActiveGate: true |
Enables Microsoft Azure module. |
Section: [cloudfoundry_monitoring]
| Property | Default value | Description |
|---|---|---|
cloudfoundry_monitoring_enabled |
Environment ActiveGate: true; Cluster ActiveGate: true |
Enables Cloud Foundry module. |
Section: [kubernetes_monitoring]
| Property | Default value | Description |
|---|---|---|
kubernetes_monitoring_enabled |
Environment ActiveGate: true; Cluster ActiveGate: true |
Enables Kubernetes monitoring module. |
Section: [vmware_monitoring]
| Property | Default value | Description |
|---|---|---|
vmware_monitoring_enabled |
Environment ActiveGate: true; Cluster ActiveGate: true |
Enables VMWare monitoring module. |
Section [dbAgent]
| Property | Default value | Description |
|---|---|---|
dbAgent_enabled |
Environment ActiveGate: true; Not supported on Cluster ActiveGate |
Enables Oracle database insights module. |
Section [rpm]
| Property | Default value | Description |
|---|---|---|
rpm_enabled |
Environment ActiveGate: true; Not supported on Cluster ActiveGate |
Enables the Remote plugin module, which is used to run ActiveGate extensions. |
Section: [synthetic]
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, 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 private locations
To learn more about the proxy-related properties for a synthetic-enabled ActiveGate, see Set up a proxy for private synthetic monitoring.
| Property | Default value | Description |
|---|---|---|
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 |
synthetic_enabled |
false in the Default deployment mode. true in the Synthetic monitoring deployment mode. |
Enables the ActiveGate to execute monitors in private synthetic locations. |