Monitor your IBM DataPower gateways remotely to track device health and performance, and detect issues such as lost connectivity, high load, and network errors.
Get started
Overview
IBM DataPower gateways provide mission-critical service/application integration, security, and control. The IBM DataPower extension runs on an ActiveGate and connects to the XML Management Interface of your appliance to collect metrics in real time.
Requirements
ActiveGate with Extensions 2.0 enabled.
IBM DataPower appliance with the XML Management Interface enabled.
User with access permissions to the XML Management Interface.
Make sure that statistics are enabled in your DataPower instance.
If statistics are turned off, expect some metrics to be missing.
Activation and setup
Find the extension in Dynatrace Hub to start the installation.
To configure
Under Extensions on the left menu, select IBM DataPower.
Add a monitoring configuration.
This extension runs on an ActiveGate in an ActiveGate group of your choice.
XML Management Interface URL: Endpoint where the IBM DataPower XML Management Interface is exposed.
It should look like this: https://<hostname>:<port>/service/mgmt/current.
User: Used to authenticate against the XML Management Interface.
Must have permissions to query it.
Password: Password for the user above.
Require a valid SSL certificate: If enabled, the extension uses a secure SSL connection to connect to the XML Management Interface.
A valid certificate has to be defined in the parameter below.
Path to a CA_BUNDLE file or directory: If SSL connection is enabled, the absolute path to the SSL certificate to be used.
Monitoring rules: In this section, you can define rules to monitor or stop monitoring the different DataPower entities.
Include all entities: If enabled, it monitors all entities of this type.
If disabled, and no rules are added, no entities are monitored.
Monitoring rule: Defines a rule to monitor or ignore an entity.
Rules are evaluated in order.
Condition: Evaluation condition for the pattern.
Pattern: Substring used to match the condition above.
It does not accept regex.
Debug: Produces more verbose logs. Enable only when troubleshooting or support makes that recommendation.
Select which feature sets (metric groups) you want this configuration to collect.
Selecting too few won't give you the proper visibility, and you may miss out on essential performance data and key indicators that can be correlated between different objects.
Details
The extension has ten built-in metric events for the most relevant DataPower metrics and their thresholds.
These metric events are disabled by default, but you can enable them in Settings > Anomaly Detection > Metric events.
The metrics are:
Connectivity lost: Alert when connectivity is below 100% for a DataPower instance.
Crypto Engine failure: Alert when the crypto engine availability is below 100%.
Network receive errors: Alert when an interface has at least one network receive error.
Network transmit errors: Alert when an interface has at least one network transmit error.
High CPU load: Alert when CPU load is above 95% for a DataPower instance.
Critical load: Alert when a DataPower instance's load is above 90%.
Critical memory utilization: Alert when the memory load of a DataPower instance is above 60%.
Records lost: Alert when the number of records lost is at least 1.
Pending messages queue: Alert when the pending messages count exceeds 3000.
Service is down: Alert when a DataPower service's status is down.
Feature sets
When activating your extension using a monitoring configuration, you can limit monitoring to one of the feature sets. To work properly, the extension has to collect at least one metric after the activation.
In highly segmented networks, feature sets can reflect the segments of your environment. Then, when you create a monitoring configuration, you can select a feature set and a corresponding ActiveGate group that can connect to this particular segment.
All metrics that aren't categorized into any feature set are considered to be the default and are always reported.
A metric inherits the feature set of a subgroup, which in turn inherits the feature set of a group. Also, the feature set defined on the metric level overrides the feature set defined on the subgroup level, which in turn overrides the feature set defined on the group level.
Messaging
Metric name
Metric key
Description
Messaging request count total
IBM.DataPower.Messaging.requestCountTotal.count
—
Messaging error count total
IBM.DataPower.Messaging.errorCountTotal.count
—
Messaging response count total
IBM.DataPower.Messaging.responseCountTotal.count
—
Messaging end-to-end average duration
IBM.DataPower.Messaging.e2eAverageDuration
—
Messaging backend average duration
IBM.DataPower.Messaging.backendAverageDuration
—
Messaging DataPower client processing average duration
