Install the zRemote module

The zRemote processes data from the OneAgent code modules that are channeled by zLocal and relays the aggregated data to Dynatrace ActiveGate. The zRemote can run in a Windows or Linux environment and thereby offloads much of the OneAgent processing from the code modules incurred in instrumenting IBM Z applications.

Sizing guidelines

The sizing of the box where the zRemote runs depend on the anticipated transactions/sec that should be processed by the zRemote. Please see the general guidelines below for planning the sizing.

For development environments, a small or medium-sized box should be fine
For production environments, we recommend at least a large or extra-large box

Hardware requirements	Small (DEV)	Medium (DEV)	Large (PROD)	X-Large (PROD)
Anticipated transactions/sec	4,000	7,500	15,000	30,000
Required CPU cores (e.g., Xeon E5-2600 series)	2	4	8	16
Required memory	4GB	6GB	8GB	16GB
Required disk space	20GB	20GB	20GB	20GB

Installation

The zRemote is downloaded and installed automatically during the ActiveGate installation procedure. You only need to select the Route z/OS traffic to Dynatrace option during the ActiveGate installation. No further configuration of the zRemote is required, as it obtains all necessary settings from the ActiveGate.

You can install the zRemote on any Linux or Windows operating system that is supported by Dynatrace ActiveGate. However, we recommend a local installation of the zRemote within your data center to avoid any performance or security issues in IBM Z monitoring. Installation of the zRemote on AWS (Amazon Linux) is not supported.

By default, the zRemote listens on port 8898 for connections from the zLocal running as part of the zDC. You can change it to listen on a different port by using the zdclistenerport parameter in the ruxitagent.conf file. You should ensure that this port is not blocked by a firewall.

Note

The zRemote isn't supported by Environment ActiveGates that are configured for multi-environment support.
The zRemote must route z/OS traffic to another ActiveGate, which in turn routes the traffic to Dynatrace.

Host groups

Host groups are helpful when you need to organize multiple LPARs connecting to a single zRemote. A LPAR can be assigned to a host group by setting the [HostGroup] attribute in the zremoteagentuserconfig.conf file. A LPAR can belong to only one host group.

Location of the zremoteagentuserconfig.conf file:

LinuxWindows

txt
/var/lib/dynatrace/zremote/agent/conf/zremoteagentuserconfig.conf

txt
C:/ProgramData/dynatrace/zremote/agent/conf/zremoteagentuserconfig.conf

To assign a LPAR to a host group, specify the group name in between a pair of [HostGroup] attributes. The [HostGroup] attribute pair can occur anywhere in the zremoteagentuserconfig.conf file.

dns
[HostGroup]
<LPAR_Name1>=<HostGroupName>
<LPAR_Name2>=<HostGroupName>
[HostGroup]

The LPAR name is the 8 characters logical partition name defined in the LPARNAME() parameter in IEASYMxx member in z/OS.

Tip

The LPAR name is also displayed in the Properties and tags section on the host screen.

The following requirements apply to the <HostGroupName> string:

Can contain only alphanumeric characters, hyphens (-), underscores (_), and dots (.)
Must not start with dt.
Maximum length is 100 characters

Combining three LPARs to a single host group

In this example, we add three LPARs—LPARA, LPARB, and LPARC to a single host group TEST_HOST.

dns
[HostGroup]
LPARA=TEST_HOST
LPARB=TEST_HOST
LPARC=TEST_HOST
[HostGroup]

Assigning three LPARs to different host groups

In this example we assign each LPAR to a separate host group.

dns
[HostGroup]
LPARA=TEST_HOST
LPARB=PROD_HOST
LPARC=PERF_HOST
[HostGroup]

Note

In host settings, only the General, Monitoring mode, and Detected processes are applicable for a host group pertaining to a z/OS host.
ActiveGate version 1.213+ Store your host group settings only in the zremoteagentuserconfig.conf file and migrate your host group settings from the ruxitagent.conf file.

Stop and restart the zRemote service

Under unusual circumstances, it may be necessary to stop or restart the zRemote service. You can use the following commands to stop/restart the zRemote service.

LinuxWindows

You need root privileges to execute these commands.

To query the current status of the zRemote service:

bash
service zremote status

To stop, start, or restart the zRemote service:

bash
service zremote stop|start|restart|forcestop

The difference between stop and forcestop is that the stop command instructs the process to execute its controlled shutdown routine, while forcestop forces the process shutdown.

You need admin privileges to execute these commands.

On Windows, stopping/starting the zRemote service can be done using the Services tab of the Windows Task Manager. You can also use the following command:

bash
sc stop|start|restart "Dynatrace zRemote"

The sc command is asynchronous, so you need to query the status of the service, to determine when it has fully stopped:

bash
sc query "Dynatrace zRemote"

Uninstall the zRemote

Although the zRemote is installed automatically during ActiveGate installation, it isn't removed when the ActiveGate is removed. You must uninstall the zRemote separately.

LinuxWindows

You need root priviliges to execute this command.

bash
/bin/sh /opt/dynatrace/zremote/uninstall.sh

As the zRemote is managed by a standard MSI installation package, it can be uninstalled via the standard Windows list of installed programs, or via the usual command-line and Powershell commands for un-installing programs.