Install the zRemote module

The zRemote module processes monitoring data received from the zLocal and routes that data, compressed and encrypted, via its local ActiveGate to Dynatrace. Hence, the zRemote module offloads much of the processing work from the CICS, IMS, and z/OS Java code modules incurred in instrumenting subsystems and applications to an open system.

You can customize the zRemote module to enable optional features like Host groups and Db2 SQL statement fetch.

Hardware requirements

The hardware requirements of the machine where the zRemote module runs depend on the number of anticipated CICS and IMS transactions to be monitored per second. See the hardware requirements for x86-64 and s390 architecture machines below.

  • For CICS and IMS development environments: a small or medium-sized machine.
  • For CICS and IMS production environments: a large or extra-large machine.
  • For z/OS Java environments: a small or medium-sized machine.
Hardware requirements
Small (DEV)
Medium (DEV)
Large (PROD)
X-Large (PROD)

Anticipated monitored CICS/IMS transactions per second

4,000

7,500

15,000

30,000

Required CPU cores on x86-64 architecture (Xeon E5-2600 series)

2

4

8

16

Required IFL processors on s390 architecture

1

1

1

2

Required memory

4GB

6GB

8GB

16GB

Required disk space

20GB

20GB

20GB

20GB

  • The hardware requirements are for the case when the zRemote module and its ActiveGate are used for mainframe monitoring only.
  • Multiple zDC subsystems can be connected to a single zRemote as long as the number of monitored transactions matches the hardware requirements.

System requirements

We recommend installing the zRemote module on an IBM Z or LinuxONE mainframe, on an supported Linux operating system for s390. The following system requirements apply:

  • The zDC subsystem and the zRemote module to which it connects must be located within the same data center to avoid performance and security issues.
    • The zRemote will write a warning to its logs after a connection latency of 3 seconds.
    • The zRemote will drop the connection after a connection latency of 10 seconds.
  • The zRemote only supports a host-based ActiveGate installation configured for a single environment.
  • Monitoring of the host running the zRemote with OneAgent is only supported in full-stack monitoring mode.

Supported operating systems

You can install the zRemote module on any Linux operating system (except Amazon Linux) and Windows operating system listed below.

Linux distributionVersionsCPU architectures
Amazon Linux21, 20232ARM64 (AArch64), x86-64
CentOS7.9x86-64
Oracle Linux7.9, 8.9, 8.10, 9.3, 9.4x86-64
8.10, 9.4ARM64 (AArch64)
Red Hat Enterprise Linux7.9, 8.6, 8.8, 8.9, 8.10, 9.0, 9.2, 9.3, 9.4s390, x86-64
8.9, 8.10, 9.3, 9.4ARM64 (AArch64)
Rocky Linux8.9, 8.10, 9.3, 9.4x86-64
8.10, 9.4ARM64 (AArch64)
SUSE Enterprise Linux15.5, 15.6s390, x86-64
15.6ARM64 (AArch64)
Ubuntu16.04, 18.04, 20.04, 22.04, 24.04x86-64
20.04, 22.04, 24.04ARM64 (AArch64), s390
1
Not supported for the zRemote module
2
Not supported for the zRemote module. To run ActiveGate extensions, the ActiveGate needs the "libcrypt.so.1" library from the "libxcrypt-compat.rpm" package, which is not installed by default on Amazon Linux 2023.
Windows distributionVersionsCPU architectures
Windows10, 11x86-64
Windows Server2016, 2019, 2022x86-64

Installer overview

The overview outlines the key components of the zRemote application, the zRemote configuration, and their default installation directories. Non-persistent directories are replaced during updates and uninstallation.

zRemote application

All of the following directories are not retained in the event of a zRemote update or uninstallation. If you make changes here, they will be overwritten or deleted.

Directory
Component
Description

agent/lib64

noneagentz

The zRemote binary

agent/lib64

oneagentzwatchdog

A binary that provides the service capabilities for the zRemote service and controls resource limits

agent/lib64

oneagentdumpproc

A binary that supports creating dumps when the main application crashes

agent/lib64/zos-s390-64/<version>

dtzagent

A binary deployed to the UNIX part of the mainframe to support OneAget communications. For more details, see Install the zDC subsystem

agent/lib64/zos-s390-64/<version>

libdtzagent.so

A binary deployed to the UNIX part of the mainframe to support agent communications. For more details, see Install the zDC subsystem

agent/conf

ruxitagent.conf

The default zRemote configuration file

agent/conf

oneagentzwatchdog.ini

The default watchdog configuration file

agent/conf

.pem

Application certificates

agent

installer.version

The installer version of the zRemote binary, which is usually the same as the zRemote version

agent

zremote

Linux only The service script for running the zRemote application

uninstallation.sh

Linux only The service script for uninstalling the zRemote application.

It removes everything except the persistent user configuration and log files.

zRemote configuration

All of the following directories are not retained during zRemote update or uninstallation. If you make changes here, they will be overwritten or deleted.

Directory
Component
Description

agent

runtime

Contains the connection details as specified by your Dynatrace environment.

config

instance.properties

Contains the ID of the currently registered instance.

config

version.properties

Contains the full version number of the zRemote module.

state

Contains the address of the last successful server connection to indicate a properly established connection.

The following directories are retained in case of update or uninstallation. You can make changes here. For more details, see Customize the zRemote module.

Directory
Component
Description

agent/conf

zremoteagentuserconfig.conf

The configuration file for zRemote module customization

agent/conf

watchdoguserconfig.conf

The configuration file for watchdog customization

Installation

The zRemote module is downloaded and installed automatically during the ActiveGate installation procedure on Linux or Windows.

  1. Sign in to Dynatrace. In Dynatrace Hub, select ActiveGate > Set up.

  2. On the Install Environment ActiveGate page, select Linux or Windows.

  3. Linux only Select installer type s390 (recommended) or x86/64.

  4. Select the purpose Install the zRemote module for z/OS monitoring, download the installer, and start the installation procedure.

  5. optional Customize the listening port selection.

    By default, the zRemote module listens on port 8898 for connections from the zLocal running as part of the zDC. To listen on a different port, set the zdclistenerport parameter to your port in the zremoteagentuserconfig.conf file. Make sure this port is not blocked by a firewall.

For details on the default installation settings, see ActiveGate default installation settings for Linux or Windows.

For details on customizing the installation, see customize ActiveGate installation on Linux or Windows.

Logging

The zRemote logs are created on the machine where the zRemote module is installed, in the default directories for Linux and Windows. You can view the zRemote logs either directly on the machine hosting the zRemote or by requesting them from Dynatrace via the OneAgent diagnostics workflow.

The actual zRemote log should contain the following messages:

  • Log messages that are sent from all CICS/IMS code modules and the zDC.
  • Log messages that are sent from the zLocal.

Update and maintenance

To stay current, you can update the zRemote module automatically to a newer version by using the ActiveGate auto-update procedure.

To manually update the zRemote module

Operations

To stop, start, or restart the zRemote module, you can use the following commands.