Customize OneAgent installation on AIX

The AIX installer can be used with command-line parameters when you can't use the default settings. Note that all parameters listed below are optional.

Passing installation parameters

For example:

Dynatrace-OneAgent-AIX.sh –-set-host-group=My.HostGroup_123-456

Removed installation parameters

Convert to the newer --set-param=<value> parameters now. The equivalent PARAM=<value> parameters are not supported by the OneAgent installer starting with version 1.213.

Removed PARAM=<value> parameter New --set-param=<value> parameter
SERVER --set-server
TENANT --set-tenant
TENANT_TOKEN --set-tenant-token
PROXY --set-proxy
HOST_GROUP --set-host-group
DISABLE_SYSTEM_LOGS_ACCESS --set-system-logs-access-enabled
INFRA_ONLY --set-infra-only

Communication endpoint

Default value: environment specific

The address of the OneAgent communication endpoint, which is a Dynatrace component that OneAgent sends data to. Depending on your deployment, it can be a Dynatrace Cluster or ActiveGate. If you install OneAgent using the Dynatrace Deploy page, this is already set to the correct value. To change it, use the IP address or a name. Add the port number following a colon.

To set the communication endpoint, pass it as a parameter value:

--set-server=https://100.20.10.1:443

OneAgent and Dynatrace Cluster automatically maintain a working connection. If an endpoint detail changes, the cluster notifies OneAgent of the change and OneAgent automatically updates the endpoint you set using the --set-server to the new working value.

If you need to change the endpoint after installation, use --set-server in the OneAgent command-line interface.

Environment ID

Default value: environment specific

The Dynatrace environment ID you received with your activation email. If you install OneAgent using the Dynatrace Deploy page, this is already set to the correct value. If you're selling Dynatrace-based services, use this option to set your customers' IDs from the pool of IDs you purchased from Dynatrace.

To set the environment ID, pass it as a parameter value:

--set-tenant=mySampleEnv

If you need to change the tenant after installation, use --set-tenant in the OneAgent command-line interface.

Token

Default value: environment specific

The tenant token that is used for authentication when OneAgent connects to the communication endpoint to send data. If you install OneAgent using the Dynatrace Deploy page, this is already set to the correct value.

To set a token, pass it as a parameter value:

--set-tenant-token=abcdefghij123456

See Access tokens to learn how to obtain a token.

If you need to change the tenant token after installation, use --set-tenant-token in the OneAgent command-line interface.

Network zones

Default value: unset

To learn about network zone naming rules and other reference information, see Network zones.

Use the --set-network-zone parameter to instruct OneAgent to communicate via the specified network zone:

--set-network-zone=your.network.zone

If you need to change the network zone assignment after installation, use --set-network-zone in OneAgent command-line interface.

Proxy

Default value: unset

The address of the proxy server. Use the IP address or a name, and add the port number following a colon. For an authenticating proxy you can specify a username and password like this username:password@172.1.1.128:8080 where both username and password need to be URL encoded.

To set a proxy, pass it as a parameter value:

--set-proxy=172.1.1.128:8080

Dynatrace also supports IPv6 addresses.

If you need to change the proxy address after installation, use --set-proxy in the OneAgent command-line interface.

Port range

Default value: 50000:50100

Use the --set-watchdog-portrange=<arg> parameter to change the watchdog listening port range to <arg>. The <arg> must contain two port numbers separated by a colon (:). For example 50000:50100. The maximum supported port range is from 1024 to 65535. The port range must cover at least 4 ports. The port number starting the range must be lower. For example:

--set-watchdog-portrange=50000:50100

If you need to change port range after installation, use --set-watchdog-portrange in OneAgent command-line interface.

Host group

Default value: unset

The name of a group you want to assign the host to. For details, see Organize your environment using host groups. Host group string requirements:

  • Can contain only alphanumeric characters, hyphens, underscores, and periods
  • Must not start with dt.
  • Maximum length is 100 characters

To assign a host to the host group, pass the host group name as a parameter value:

–-set-host-group=My.HostGroup_123-456

To remove the host from a group, you must uninstall OneAgent or pass an empty value –-set-host-group="" when running a OneAgent update. You can't remove the host from a group using the HOST_GROUP parameter when updating OneAgent. For more information, see OneAgent configuration via command-line interface.

Infrastructure monitoring mode

Default value: false

Activates Infrastructure monitoring mode, in place of full-stack monitoring mode. With this approach, you receive infrastructure-only health data, with no application or user performance data.

To enable Infrastructure monitoring mode, set the parameter to:

--set-infra-only=true`   

To disable Infrastructure monitoring mode, set the parameter to:

```http
--set-infra-only=false

If you need to change, enable, or disable Infrastructure monitoring mode after installation, use --set-infra-only in OneAgent command-line interface or set it using the Host settings page.

Custom host name

Default value: unset

Use the --set-host-name to override an automatically detected host name. The host name value must not contain the <, >, &, CR (carriage return), and LF (line feed) characters and the maximum length is 256 characters.

To set the host name:

--set-host-name=myhostname

If you need to change the host name after installation, use --set-host-name in OneAgent command-line interface.

Custom host metadata

Default value: unset

Once configured, custom metadata is displayed as a set of properties at the bottom of the Properties and tags section of the host overview page. The property values must not contain the = (except key-value delimiter) and whitespace characters. The maximum length is 256 characters including the key-value delimiter.

To add or change host properties:

--set-host-property=AppName --set-host-property=Environment=Dev

You can add or change more than one property in the same command.

If you need to change the host metadata after installation, use --set-host-property OneAgent command-line interface.

Custom host tags

Default value: unset

Once configured, the tags are displayed at the top of the Properties and tags section of the host overview page. The property values must not contain the = (except key-value delimiter) and whitespace characters. The maximum length is 256 characters including the key-value delimiter.

To add or change host tags:

--set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk

You can add or change more than one tag in the same command. It is allowed to define tags with the same key but different values.

If you need to change the host tags after installation, use --set-host-tag in OneAgent command-line interface.

Host ID source

Default value: auto

This feature is currently supported only for Citrix Virtual Apps and Desktops.

It's particularly important to keep you host ID static in dynamic virtual environments where hosts are recreated on a daily basis.

To define the source for host ID generation, use --set-host-id-source and set it to one of the predefined values:

  • auto let Dynatrace generate the host ID automatically
  • ip-addresses generate host ID based on the host IP address
  • ip-addresses;namespace=<namespace> if you monitor multiple environments, you can split the hosts with identical IPs using a different namespace for each environment. The namespace can contain only alphanumeric characters, hyphens, underscores, and periods; the maximum length is 256 characters.

For example, to set the host ID source to ip-addresses and assign it to a namespace called test, run the OneAgent installer with the following parameter:

--set-host-id-source="ip-addresses;namespace=test"

Installation path

The INSTALL_PATH parameter allows installation to a different directory. For example:

/bin/sh Dynatrace-OneAgent-AIX-1.0.0.sh INSTALL_PATH=/data/dynatrace/agent

The installer creates the symbolic link /opt/dynatrace/oneagent > /data/dynatrace/agent and the OneAgent installation files are placed in the specified directory (in this example, /data/dynatrace/agent). Note that this symbolic link needs to be removed manually after OneAgent is uninstalled.

Note: The INSTALL_PATH parameter doesn't control the OneAgent log and configuration files directories. To customize the log path, use the LOG_PATH parameter.

Custom directory requirements

Your custom installation directory must meet the following requirements:

  • For security reasons, the directory must be dedicated to OneAgent purposes only. No other software can have access to it.

  • You must not share or nest in one another the installation, storage, and log directories.

  • The value must be an absolute path and must not point to the root volume directory.

  • The value must not be an already existing symbolic link.

  • The value must not be a child directory of /var/lib/dynatrace.

Log path

OneAgent version 1.213

Default value: /var/log/dynatrace/oneagent

The LOG_PATH parameter allows you to customize your OneAgent log directory, which is /var/log/dynatrace/oneagent by default. For example:

/bin/sh Dynatrace-OneAgent-AIX-1.0.0.sh LOG_PATH=/data/dynatrace/logs

The installer creates the symbolic link /var/log/dynatrace/oneagent > /data/dynatrace/logs and the OneAgent installation files are placed in the specified directory (in this example, /data/dynatrace/logs). Note that this symbolic link needs to be removed manually after OneAgent is uninstalled.

Custom directory requirements

Your custom log path must meet the following requirements:

  • For security reasons, the directory must be dedicated to OneAgent purposes only. No other software can have access to it.

  • You must not share or nest in one another the installation, storage, and log directories.

  • The value must be an absolute path and must not point to the root volume directory.

  • The value must not be an already existing symbolic link.

  • The value must not be a child directory of /var/lib/dynatrace.

  • The value must not point to /opt/dynatrace/oneagent/log, which is the default log location for OneAgent versions earlier than 1.203

Changing location

If you use the parameter to change the location for an already installed OneAgent:

  • Existing files are not migrated to the new location

  • After you set or change the LOG_PATH parameter, you must restart deep-monitored processes, so that OneAgents monitoring them can pick up the new path to store logs.

Data storage

OneAgent version 1.199

Default value: /var/lib/dynatrace/oneagent/datastorage

DATA_STORAGE parameter allows you to define a directory dedicated to storing large runtime data produced by OneAgent in full-stack monitoring mode, such as crash reports or memory dumps.
For example:

/bin/sh Dynatrace-OneAgent-Linux.sh DATA_STORAGE=/data/dynatrace/runtime

Custom directory requirements

Your custom data storage directory must meet the following requirements:

  • For security reasons, the directory must be dedicated to OneAgent purposes only. No other software can have access to it.

  • You must not share or nest in one another the installation, storage, and log directories.

  • The value must be an absolute path and must not point to the root volume directory.

  • The value must not be an already existing symbolic link.

  • The value must not be a child directory of /var/lib/dynatrace.

Changing location

If you use the parameter to change the location for an already installed OneAgent:

  • Existing files are not migrated to the new location

  • After you set or change the DATA_STORAGE parameter, you must restart deep-monitored processes, so that OneAgents monitoring them can pick up the new path to store runtime data. Otherwise, memory dumps and other runtime data won't be saved. You will be notified to restart a corresponding process on the Process overview page.

Access to system logs

OneAgent downloads AIX system logs for the purpose of diagnosing issues that may be caused by conditions in your environment. For details, see System logs downloaded by OneAgent.

To disable access to logs:

--set-system-logs-access-enabled=false

To enable access to logs:

--set-system-logs-access-enabled=true

If you need to change this access after installation, use the OneAgent command-line interface:

Note that this is a self-diagnostics setting that is not related to Log Monitoring.