Install the zRemote module
The zRemote module processes binary data from the OneAgent code modules that are channeled by zLocal and relays aggregated binary data to a Dynatrace ActiveGate. The zRemote module can run in a Windows or Linux environment and thereby offloads much of the OneAgent processing from the code modules incurred in instrumenting applications.
You can customize the zRemote module to enable optional features like Host groups and SQL statement fetch.
Sizing guidelines
The sizing of the box where the zRemote module runs depend on the anticipated CICS/IMS transactions per second 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.
For pure Java monitoring, a small or medium-sized box should be fine.
Hardware requirements | Small (DEV) | Medium (DEV) | Large (PROD) | X-Large (PROD) |
---|---|---|---|---|
Anticipated CICS/IMS 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
To monitor a z/OS LPAR, including technologies such as CICS, IMS, and Java, you need both
- an Environment ActiveGate with enabled zRemote module. This Environment ActiveGate is responsible for installing the zRemote module, updating the zRemote module, and providing the network interface. It cannot be used for any other purposes.
- any ActiveGate with enabled OneAgent routing module. It is reponsible for routing the aggregated binary data from the zRemote module encrypted and compressed to Dynatrace.
You can install the zRemote module as part of the Environment ActiveGate on any Linux or Windows operating system that is supported by ActiveGate. We recommend a local installation of the zRemote module within your data center to avoid any performance or security issues in z/OS monitoring.
- Installation of the zRemote module on AWS (Amazon Linux) is not supported.
- A containerized ActiveGate deployments is not supported by the zRemote module.
- An Environment ActiveGate configured for multiple environments is not supported by the zRemote module.
- Both the Environment ActiveGate with the zRemote module and the ActiveGate with the OneAgent routing module must be in the same subnet.
zRemote module
The zRemote module is downloaded and installed automatically during the Environment ActiveGate installation procedure on Linux or Windows.
-
Sign in to Dynatrace, select Deploy Dynatrace from the navigation menu and select Install ActiveGate.
-
On the Install Environment ActiveGate page, select Linux or Windows.
-
Select the ActiveGate purpose Route z/OS traffic to Dynatrace, download the installer, and start the installation procedure.
-
optional ActiveGate version 1.237+ Customize the ActiveGate user via the ActiveGate
USER
option. -
Connect the zRemote module to a zLocal via IP address.
-
optional The zRemote module 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 theruxitagent.conf
file. You must ensure that this port is not blocked by a firewall. -
Connect the zRemote module to any ActiveGate where the OneAgent routing module is enabled via IP address or DNS.
- ActiveGate version 1.237+ The zRemote module (
oneagentz
process) starts as the ActiveGate default user or the customized user. - ActiveGate version 1.237+ Access to log and configuration directories and files is restricted to that user. Common access has been removed (750 for directories, 640 for files).
- To access log and configuration directories and files, elevated permissions (sudo) are required. This might affect custom scripts.
OneAgent routing module
The OneAgent routing module is downloaded and installed automatically during any Environment ActiveGate installation procedure or Cluster ActiveGate installation procedure.
Use your preferred installation procedure and select the ActiveGate purpose Route OneAgent traffic to Dynatrace.
Maintainance
If needed, you can use the following commands to stop, start, or restart the zRemote module.
You need root privileges to execute these commands.
To query the current status of the zRemote module:
service zremote status
To stop, start, or restart the zRemote module:
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, the zRemote module can be maintained using the Services tab of the Windows Task Manager. You can also use the following command:
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:
sc query "Dynatrace zRemote"