IBM DataPower monitoring
This extension documentation is now deprecated and will no longer be updated. We recommend using the new IBM Datapower extension for improved functionality and support.
Learn how to monitor DataPower devices using the DataPower ActiveGate extension.
Starting with Dynatrace OneAgent and ActiveGate version 1.231, we are upgrading the Extension Framework (also referred to as the plugins framework) from Python 3.6 to Python 3.8.
- Consequences: Some Dynatrace extensions running in your environment may stop working and require redeployment of a new version prepared for Python 3.8.
- Symptoms:
- No data is provided for affected metrics on dashboards, alerts, and custom device pages populated by the affected extension metrics.
- Extension logs display errors. Most often this will manifest itself as Python
ModuleNotFoundError
in the PluginAgent log. - Sometimes the Python virtual machine crashes.
- Impact: This issue affects only those extensions that use native libraries called from Python code distributed with the extension.
For remediation details, see Dynatrace Extensions.
Prerequisites
- A DataPower appliance with the XML Management Interface enabled.
- A user with access to the XML Management Interface.
- An Environment ActiveGate (version 1.155+) that has the ActiveGate plugin module installed and isn't used for synthetic or mainframe monitoring.
- ActiveGate version 1.175+ is ready to accept and run extensions. If you are running an earlier version of ActiveGate, see Install ActiveGate plugin module for instructions on installing the plugin module.
- For Environment ActiveGate installation instructions, see Dynatrace ActiveGate.
- One environment ActiveGate can typically support 30-50 DataPower devices.
Extension installation
-
In Dynatrace Hub, select IBM Datapower.
-
Select Download to get the extension ZIP file. Don't rename the file.
-
Unzip the ZIP file to the
plugin_deployment
directory of your ActiveGate host. -
In Dynatrace, go to Settings > Monitoring > Monitored technologies and select Add new technology monitoring > Add ActiveGate extension.
-
Select Upload extension and upload the ZIP file.
-
Enter the endpoint information requested for connecting to DataPower device:
Setting
Details
Endpoint name
Enter a meaningful endpoint name. The name will only be visible on the configuration page.
User
The username for the account connecting to the XML Management Interface.
Password
The password for the account.
URL to the XML Management Interface
The domain name entered will be used for differentiating the devices if there are multiple devices.
Require a valid SSL certificate
Select if a valid SSL certificate is required. Even if the certificate validation is disabled, the extension will communicate via HTTPS if the device is configured for that.
Path to a
CA_BUNDLE
file or directoryThe absolute path to self-signed certificates of trusted CAs.
Pass a client certificate to the DataPower server
In addition to the username and password, also authenticate by passing a client certificate to DataPower.
Path to the client certificate file
The absolute path to the client certificate file. Only used if passing a client certificate.
Path to the client certificate key optional
The absolute path to the client certificate key. Leave this blank if no key is required. Only used if passing a client certificate.
Enable debug logging
Select this only if a Dynatrace product expert requests it to investigate an issue.
Comma-separated domains
Allows for filtering of domains that are to be monitored.
Comma-separated services
Allows for filtering of services that are to be monitored.
Comma-separated interfaces
Allows for filtering of interfaces that are to be monitored.
Comma-separated tasks
Allows for filtering of tasks that are to be monitored.
Comma-separated XML managers
Allows for filtering of XML managers that are to be monitored.
Comma-separated log targets
Allows for filtering of log targets that are to be monitored.
Comma-separated additional IPs
Allows for adding additional IP addresses to the created custom device. This can be used if all used IPs aren't automatically discovered.
Name of the group
If the device is part of a cluster, enter the name here to group the devices in the Dynatrace web UI.
Troubleshoot ActiveGate extensions
See Troubleshoot ActiveGate extensions.
Metrics
The IP address of all network interfaces and the ports used by the services is automatically captured, as are the following metrics:
Device
- Availability %
- CPU load %
- Crypto Engine % Fully operational
Disk
- Free encrypted
- Total encrypted
- Free temporary
- Total temporary
- Free internal
- Total internal
Log events (split by domain and log target)
- Processed
- Dropped
- Pending
Network (split by interface)
- Connections accepted
- Received throughput
- Transmitted throughput
- Received packets
- Transmitted packets
- Received dropped packets
- Transmitted dropped packets
- Received errors
- Transmitted errors
Services (split by service and domain)
- Service calls (only collected for proxy services, and only if statistics are enabled)
- Response time (only collected for proxy services, and only if statistics are enabled)
- Availability (definition: enabled, but status is not up)
System usage
- Load %
- Pending messages in queue
Tasks (split by tasks)
- Load %
- Pending messages in queue
- CPU %
- Memory %
- File count
WSM Agent (split by domains)
- Active subscribers
- Records lost
- Pending records queue
- Complete records queue
XML Manager
- HTTP connection requests