Try it free

IBM Datapower extension

  • Latest Dynatrace
  • Extension
  • Published Oct 27, 2025

Enable remote monitoring of your DataPower gateways.

Get started

Overview

Monitor remotely, and gain real-time insights into device health and performance of your IBM DataPower gateway that provides mission-critical service/application integration, security, and control with the IBM Datapower DataPower extension.

Requirements

  • ActiveGate version 1.269+
  • Dynatrace version 1.310+
  • ActiveGate 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. Some metrics will be missing if statistics are turned off.

Activation and setup

Find the extension in Dynatrace Hub to start the installation.

To configure

  1. Under Extensions on the left menu, select IBM Datapower.

  2. Add a monitoring configuration. This is an ActiveGate extension and runs on an ActiveGate of 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.

  3. 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 by going to Settings > Anomaly Detection > Metric events to enable them.

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 amount 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.

Performance metrics
Metric nameMetric keyDescription
CPU loadIBM.DataPower.cpuload—
Memory usageIBM.DataPower.Memory.Usage—
Memory totalIBM.DataPower.Memory.Total—
Memory usedIBM.DataPower.Memory.Used—
Memory freeIBM.DataPower.Memory.Free—
Memory requestedIBM.DataPower.Memory.Req—
RAID metrics
Metric nameMetric keyDescription
Total - RAIDIBM.DataPower.RAID.totalSizeTotal RAID Size
Free - RAIDIBM.DataPower.RAID.freeSpaceFree RAID Size
Interface metrics
Metric nameMetric keyDescription
Packets receivedIBM.DataPower.Interface.receivePackets.countNumber of packets received per interface
Bytes receivedIBM.DataPower.Interface.receiveBps.countNumber of bytes received per interface
Errors receivedIBM.DataPower.Interface.receiveErrors.countNumber of errors received per interface
Dropped packages receivedIBM.DataPower.Interface.receiveDrops.countNumber of received packages that have been dropped per interface
Packets transmittedIBM.DataPower.Interface.transmitPackets.countNumber of transmitted packages per interface
Bytes transmittedIBM.DataPower.Interface.transmitBps.countNumber of bytes transmitted per interface
Errors transmittedIBM.DataPower.Interface.transmitErrors.countNumber of errors transmitted per interface
Dropped packages transmittedIBM.DataPower.Interface.transmitDrops.countNumber of transmitted packages that have been dropped per interface
Collision countIBM.DataPower.Interface.collisions.countNumber of collisions per interface
Interface statusIBM.DataPower.Interface.statusCurrent status of the interface
Gateway Peering
Metric nameMetric keyDescription
Api Security Token PeeringIBM.DataPower.Gateway.apiRateLimitingPeering—
Api Rate Limiting PeeringIBM.DataPower.Gateway.apiSecurityTokenPeering—
Api Gateway PeeringIBM.DataPower.Gateway.apiGatewayPeering—
Api Gatewayscript PeeringIBM.DataPower.Gateway.apiGatewayscriptPeering—
Api Probe PeeringIBM.DataPower.Gateway.apiProbePeering—
Api Subscription PeeringIBM.DataPower.Gateway.apiSubscriptionPeering—
Messaging
Metric nameMetric keyDescription
Messaging request count totalIBM.DataPower.Messaging.requestCountTotal.count—
Messaging error count totalIBM.DataPower.Messaging.errorCountTotal.count—
Messaging response count totalIBM.DataPower.Messaging.responseCountTotal.count—
Messaging end-to-end average durationIBM.DataPower.Messaging.e2eAverageDuration—
Messaging backend average durationIBM.DataPower.Messaging.backendAverageDuration—
Messaging DataPower client processing average durationIBM.DataPower.Messaging.dpClientProcessingAverageDuration—
Messaging DataPower server processing average durationIBM.DataPower.Messaging.dpServerProcessingAverageDuration—
Messaging end-to-end duration measurementsIBM.DataPower.Messaging.e2eDurationMeasurements.count—
Messaging backend duration measurementsIBM.DataPower.Messaging.backendDurationMeasurements.count—
Messaging DataPower client processing duration measurementsIBM.DataPower.Messaging.dpClientProcessingDurationMeasurements.count—
Messaging DataPower server processing duration measurementsIBM.DataPower.Messaging.dpServerProcessingDurationMeasurements.count—
Load Balancer metrics
Metric nameMetric keyDescription
Load Balancer Group - Administrative stateIBM.DataPower.LoadBalancer.adminStateAdministrative state of the load balancer group
Load Balancer - Administrative stateIBM.DataPower.LoadBalancer.memberStateAdministrative state of the load balancer
Load Balancer - Operational stateIBM.DataPower.LoadBalancer.operationalStateOperational state of the load balancer
default
Metric nameMetric keyDescription
ConnectivityIBM.DataPower.connectivityPercentage of successful connections
Active SubscribersIBM.DataPower.activeSubscribersNumber of active subscribers
Sensor metrics
Metric nameMetric keyDescription
Power supplyIBM.DataPower.powerSupplyCurrent status of the power supply
Case openIBM.DataPower.caseopenIndicates if the case is open or not
Check intrusionIBM.DataPower.checkintrusionIndicates if check intrusion is active or not
System temperatureIBM.DataPower.systemTemp—
CPU 1 temperatureIBM.DataPower.cpu1Temp—
CPU 2 temperatureIBM.DataPower.cpu2Temp—
CPU 1 RPMIBM.DataPower.cpu1rpm—
CPU 2 RPMIBM.DataPower.cpu2rpm—
Chassis 1 RPMIBM.DataPower.chassis1rpm—
Chassis 2 RPMIBM.DataPower.chassis2rpm—
Chassis 3 RPMIBM.DataPower.chassis3rpm—
Volt 5 sensorIBM.DataPower.volt5—
Volt 12 sensorIBM.DataPower.volt12—
Volt 33 sensorIBM.DataPower.volt33—
Stylesheet metrics
Metric nameMetric keyDescription
Stylesheet cache sizeIBM.DataPower.XMLManager.stylesheetCacheSize—
Stylesheet cache countIBM.DataPower.XMLManager.stylesheetCacheCount—
Stylesheet document countIBM.DataPower.XMLManager.stylesheetDocumentCount—
Stylesheet pending countIBM.DataPower.XMLManager.stylesheetPendingCount—
Stylesheet bad countIBM.DataPower.XMLManager.stylesheetBadCount—
Stylesheet duplicate countIBM.DataPower.XMLManager.stylesheetDuplicateCount—
Stylesheet executionsIBM.DataPower.XMLManager.stylesheetExecutions—
Object status
Metric nameMetric keyDescription
Operational stateIBM.DataPower.operationalStateOperational state of a classes' object
Administrative stateIBM.DataPower.adminStateAdministrative state of a classes' object
Service metrics
Metric nameMetric keyDescription
Calls per minuteIBM.DataPower.Service.httpTransactionThroughput—
Total transaction timeIBM.DataPower.Service.httpTransactionsTimeTotal amount of time used on transactions per service
Service statusIBM.DataPower.Service.status—
Link Aggregation
Metric nameMetric keyDescription
Link Aggregation StatusIBM.DataPower.LinkAggregationStatus—
Link Aggregation MII StatusIBM.DataPower.LinkAggregationMIIStatus—
Disk metrics
Metric nameMetric keyDescription
Free - EncryptedIBM.DataPower.Disk.freeEncryptedFree and encrypted disk size
Total - EncryptedIBM.DataPower.Disk.totalEncryptedTotal encrypted disk size
Free - TemporaryIBM.DataPower.Disk.freeTemporaryFree temporary disk size
Total - TemporaryIBM.DataPower.Disk.totalTemporaryTotal temporary disk size
Free - InternalIBM.DataPower.Disk.freeInternalFree internal disk size
Total - InternalIBM.DataPower.Disk.totalInternalTotal internal disk size
Log metrics
Metric nameMetric keyDescription
Log events processedIBM.DataPower.LogTarget.process.countTotal amount of log events processed per log target
Log events droppedIBM.DataPower.LogTarget.drop.countTotal amount of log events dropped per log target
Log events pendingIBM.DataPower.LogTarget.pendingTotal amount of log events pending per log target
Log requested memoryIBM.DataPower.LogTarget.requestedMemoryRequested memory of the log target
XML Manager metrics
Metric nameMetric keyDescription
HTTP Connection requestsIBM.DataPower.XMLManager.RequestsConnection requests to the XML Manager
HTTP Connections reusedIBM.DataPower.XMLManager.ReuseConnection reuses to the XML Manager
HTTP Connections createdIBM.DataPower.XMLManager.CreateConnections created to the XML Manager
HTTP Connection returnsIBM.DataPower.XMLManager.ReturnConnection returns to the XML Manager
HTTP Connections offeredIBM.DataPower.XMLManager.OfferedConnections offered for the XML Manager
HTTP Connections destroyedIBM.DataPower.XMLManager.DestroyConnections destroyed to the XML Manager
TCP Summary metrics
Metric nameMetric keyDescription
TCP established connectionsIBM.DataPower.TCP.establishedCount of established TCP connections
TCP SYN SentIBM.DataPower.TCP.synSentCount of SYN requests sent
TCP SYN ReceivedIBM.DataPower.TCP.synReceivedCount of SYN requests received
TCP FIN_WAIT_1 countIBM.DataPower.TCP.finWait1—
TCP FIN_WAIT_2 countIBM.DataPower.TCP.finWait2—
TCP TIME_WAITIBM.DataPower.TCP.timeWaitCount of TIME_WAIT
TCP Closed connectionsIBM.DataPower.TCP.closedNumber of closed TCP connections
TCP CLOSE_WAITIBM.DataPower.TCP.closeWaitCount of CLOSE_WAIT
TCP LAST_ACKIBM.DataPower.TCP.lastAckCount of LAST_ACK
TCP ListenIBM.DataPower.TCP.listen—
TCP ClosingIBM.DataPower.TCP.closingNumber of TCP closing connections
Web Services
Metric nameMetric keyDescription
Web service last response timeIBM.DataPower.WebService.lastResponseTime—
Web service failed requestsIBM.DataPower.WebService.failedRequests.count—
Web service total requestsIBM.DataPower.WebService.totalRequests.count—
Web service successful requestsIBM.DataPower.WebService.successfulRequests.count—
Web service timeIBM.DataPower.WebService.serviceTime.count—
Task metrics
Metric nameMetric keyDescription
Task loadIBM.DataPower.Task.load—
Task pending messagesIBM.DataPower.Task.workList—
Task CPU usageIBM.DataPower.Task.CPU—
Task Memory usageIBM.DataPower.Task.Memory—
Task file countIBM.DataPower.Task.FileCount—
MQQM metrics
Metric nameMetric keyDescription
MQQM received faultsIBM.DataPower.MQQM.receiveFaultsNumber of received faults in the MQ queue manager
MQQM received messagesIBM.DataPower.MQQM.receivedNumber of received messages in the MQ queue manager
MQQM sent faultsIBM.DataPower.MQQM.sendFaultsNumber of sent faults in the MQ queue manager
MQQM sent messagesIBM.DataPower.MQQM.sentNumber of sent messages in the MQ queue manager
MQQM total connection limitIBM.DataPower.MQQM.totalConnectionLimit—
MQQM connectionsIBM.DataPower.MQQM.totalConnectionsNumber of connections for the MQ queue manager
MQQM active connectionsIBM.DataPower.MQQM.totalActiveConnectionsNumber of active connections for the MQ queue manager
MQQM idle connectionsIBM.DataPower.MQQM.totalIdleConnectionsNumber of idle connections for the MQ queue manager
MQQM active frontend connectionsIBM.DataPower.MQQM.activeFrontendConnectionsNumber of active frontend connections for the MQ queue manager
MQQM active backend connectionsIBM.DataPower.MQQM.activeBackendConnectionsNumber of active backend connections for the MQ queue manager
XML names
Metric nameMetric keyDescription
XML name free percentIBM.DataPower.XMLName.Free—
XML name used countIBM.DataPower.XMLName.Used—
XML name maximumIBM.DataPower.XMLName.Maximum—
Usage metrics
Metric nameMetric keyDescription
Crypto Engine StatusIBM.DataPower.cryptoEngineStatus—
Records lostIBM.DataPower.recordsLost.count—
Pending recordsIBM.DataPower.pendingRecordsQueueNumber of records pending in queue
Complete recordsIBM.DataPower.completeRecordsQueueNumber of records completed
Pending messagesIBM.DataPower.worklist—
LoadIBM.DataPower.load—
Connections acceptedIBM.DataPower.connectionsAcceptedPer minute rate of connections accepted
Active transactionsIBM.DataPower.activeTransactions—
UptimeIBM.DataPower.UptimeTotal uptime of the device
SLM Policy metrics
Metric nameMetric keyDescription
SLM Policy messagesIBM.DataPower.SLMPolicy.messagesNumber of messages processed by the statement
SLM Policy errorsIBM.DataPower.SLMPolicy.errorsNumber of errors by the statement
SLM Policy throttledIBM.DataPower.SLMPolicy.throttled—
SLM Policy average timeIBM.DataPower.SLMPolicy.timeAverage—
SLM Policy maximum timeIBM.DataPower.SLMPolicy.timeMaximum—
SLM Policy minimum timeIBM.DataPower.SLMPolicy.timeMinimum—
Document metrics
Metric nameMetric keyDescription
Document cache countIBM.DataPower.XMLManager.documentCacheCountNumber of documents in the cache
Document countIBM.DataPower.XMLManager.documentCountNumber of documents
Document cache sizeIBM.DataPower.XMLManager.documentCacheSize—
Document byte countIBM.DataPower.XMLManager.documentByteCountNumber of documents in bytes
Document expired countIBM.DataPower.XMLManager.documentExpiredCount—
Hub

Explore in Dynatrace Hub

Enable remote monitoring of your DataPower gateways.

Related tags
NetworkPythonGatewayIBMInfrastructure Observability