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 DataPower extension.
Requirements
ActiveGate version 1.269+
Dynatrace version 1.310+
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
Under Extensions on the left menu, select IBM Datapower.
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.
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 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.
Object status
Metric name
Metric key
Description
Operational state
IBM.DataPower.operationalState
Operational state of a classes' object
Administrative state
IBM.DataPower.adminState
Administrative state of a classes' object
Link Aggregation
Metric name
Metric key
Description
Link Aggregation Status
IBM.DataPower.LinkAggregationStatus
—
Link Aggregation MII Status
IBM.DataPower.LinkAggregationMIIStatus
—
SLM Policy metrics
Metric name
Metric key
Description
SLM Policy messages
IBM.DataPower.SLMPolicy.messages
Number of messages processed by the statement
SLM Policy errors
IBM.DataPower.SLMPolicy.errors
Number of errors by the statement
SLM Policy throttled
IBM.DataPower.SLMPolicy.throttled
—
SLM Policy average time
IBM.DataPower.SLMPolicy.timeAverage
—
SLM Policy maximum time
IBM.DataPower.SLMPolicy.timeMaximum
—
SLM Policy minimum time
IBM.DataPower.SLMPolicy.timeMinimum
—
TCP Summary metrics
Metric name
Metric key
Description
TCP established connections
IBM.DataPower.TCP.established
Count of established TCP connections
TCP SYN Sent
IBM.DataPower.TCP.synSent
Count of SYN requests sent
TCP SYN Received
IBM.DataPower.TCP.synReceived
Count of SYN requests received
TCP FIN_WAIT_1 count
IBM.DataPower.TCP.finWait1
—
TCP FIN_WAIT_2 count
IBM.DataPower.TCP.finWait2
—
TCP TIME_WAIT
IBM.DataPower.TCP.timeWait
Count of TIME_WAIT
TCP Closed connections
IBM.DataPower.TCP.closed
Number of closed TCP connections
TCP CLOSE_WAIT
IBM.DataPower.TCP.closeWait
Count of CLOSE_WAIT
TCP LAST_ACK
IBM.DataPower.TCP.lastAck
Count of LAST_ACK
TCP Listen
IBM.DataPower.TCP.listen
—
TCP Closing
IBM.DataPower.TCP.closing
Number of TCP closing connections
Load Balancer metrics
Metric name
Metric key
Description
Load Balancer Group - Administrative state
IBM.DataPower.LoadBalancer.adminState
Administrative state of the load balancer group
Load Balancer - Administrative state
IBM.DataPower.LoadBalancer.memberState
Administrative state of the load balancer
Load Balancer - Operational state
IBM.DataPower.LoadBalancer.operationalState
Operational state of the load balancer
Performance metrics
Metric name
Metric key
Description
CPU load
IBM.DataPower.cpuload
—
Memory usage
IBM.DataPower.Memory.Usage
—
Memory total
IBM.DataPower.Memory.Total
—
Memory used
IBM.DataPower.Memory.Used
—
Memory free
IBM.DataPower.Memory.Free
—
Memory requested
IBM.DataPower.Memory.Req
—
MQQM metrics
Metric name
Metric key
Description
MQQM received faults
IBM.DataPower.MQQM.receiveFaults
Number of received faults in the MQ queue manager
MQQM received messages
IBM.DataPower.MQQM.received
Number of received messages in the MQ queue manager
MQQM sent faults
IBM.DataPower.MQQM.sendFaults
Number of sent faults in the MQ queue manager
MQQM sent messages
IBM.DataPower.MQQM.sent
Number of sent messages in the MQ queue manager
MQQM total connection limit
IBM.DataPower.MQQM.totalConnectionLimit
—
MQQM connections
IBM.DataPower.MQQM.totalConnections
Number of connections for the MQ queue manager
MQQM active connections
IBM.DataPower.MQQM.totalActiveConnections
Number of active connections for the MQ queue manager
MQQM idle connections
IBM.DataPower.MQQM.totalIdleConnections
Number of idle connections for the MQ queue manager
MQQM active frontend connections
IBM.DataPower.MQQM.activeFrontendConnections
Number of active frontend connections for the MQ queue manager
MQQM active backend connections
IBM.DataPower.MQQM.activeBackendConnections
Number of active backend connections for the MQ queue manager
Web Services
Metric name
Metric key
Description
Web service last response time
IBM.DataPower.WebService.lastResponseTime
—
Web service failed requests
IBM.DataPower.WebService.failedRequests.count
—
Web service total requests
IBM.DataPower.WebService.totalRequests.count
—
Web service successful requests
IBM.DataPower.WebService.successfulRequests.count
—
Web service time
IBM.DataPower.WebService.serviceTime.count
—
XML names
Metric name
Metric key
Description
XML name free percent
IBM.DataPower.XMLName.Free
—
XML name used count
IBM.DataPower.XMLName.Used
—
XML name maximum
IBM.DataPower.XMLName.Maximum
—
Usage metrics
Metric name
Metric key
Description
Connectivity
IBM.DataPower.connectivity
Percentage of successful connections
Crypto Engine Status
IBM.DataPower.cryptoEngineStatus
—
Active Subscribers
IBM.DataPower.activeSubscribers
Number of active subscribers
Records lost
IBM.DataPower.recordsLost.count
—
Pending records
IBM.DataPower.pendingRecordsQueue
Number of records pending in queue
Complete records
IBM.DataPower.completeRecordsQueue
Number of records completed
Pending messages
IBM.DataPower.worklist
—
Load
IBM.DataPower.load
—
Connections accepted
IBM.DataPower.connectionsAccepted
Per minute rate of connections accepted
Active transactions
IBM.DataPower.activeTransactions
—
Uptime
IBM.DataPower.Uptime
Total uptime of the device
Document metrics
Metric name
Metric key
Description
Document cache count
IBM.DataPower.XMLManager.documentCacheCount
Number of documents in the cache
Document count
IBM.DataPower.XMLManager.documentCount
Number of documents
Document cache size
IBM.DataPower.XMLManager.documentCacheSize
—
Document byte count
IBM.DataPower.XMLManager.documentByteCount
Number of documents in bytes
Document expired count
IBM.DataPower.XMLManager.documentExpiredCount
—
XML Manager metrics
Metric name
Metric key
Description
HTTP Connection requests
IBM.DataPower.XMLManager.Requests
Connection requests to the XML Manager
HTTP Connections reused
IBM.DataPower.XMLManager.Reuse
Connection reuses to the XML Manager
HTTP Connections created
IBM.DataPower.XMLManager.Create
Connections created to the XML Manager
HTTP Connection returns
IBM.DataPower.XMLManager.Return
Connection returns to the XML Manager
HTTP Connections offered
IBM.DataPower.XMLManager.Offered
Connections offered for the XML Manager
HTTP Connections destroyed
IBM.DataPower.XMLManager.Destroy
Connections destroyed to the XML Manager
Sensor metrics
Metric name
Metric key
Description
Power supply
IBM.DataPower.powerSupply
Current status of the power supply
Case open
IBM.DataPower.caseopen
Indicates if the case is open or not
Check intrusion
IBM.DataPower.checkintrusion
Indicates if check intrusion is active or not
System temperature
IBM.DataPower.systemTemp
—
CPU 1 temperature
IBM.DataPower.cpu1Temp
—
CPU 2 temperature
IBM.DataPower.cpu2Temp
—
CPU 1 RPM
IBM.DataPower.cpu1rpm
—
CPU 2 RPM
IBM.DataPower.cpu2rpm
—
Chassis 1 RPM
IBM.DataPower.chassis1rpm
—
Chassis 2 RPM
IBM.DataPower.chassis2rpm
—
Chassis 3 RPM
IBM.DataPower.chassis3rpm
—
Volt 5 sensor
IBM.DataPower.volt5
—
Volt 12 sensor
IBM.DataPower.volt12
—
Volt 33 sensor
IBM.DataPower.volt33
—
Disk metrics
Metric name
Metric key
Description
Free - Encrypted
IBM.DataPower.Disk.freeEncrypted
Free and encrypted disk size
Total - Encrypted
IBM.DataPower.Disk.totalEncrypted
Total encrypted disk size
Free - Temporary
IBM.DataPower.Disk.freeTemporary
Free temporary disk size
Total - Temporary
IBM.DataPower.Disk.totalTemporary
Total temporary disk size
Free - Internal
IBM.DataPower.Disk.freeInternal
Free internal disk size
Total - Internal
IBM.DataPower.Disk.totalInternal
Total internal disk size
Log metrics
Metric name
Metric key
Description
Log events processed
IBM.DataPower.LogTarget.process.count
Total amount of log events processed per log target
Log events dropped
IBM.DataPower.LogTarget.drop.count
Total amount of log events dropped per log target
Log events pending
IBM.DataPower.LogTarget.pending
Total amount of log events pending per log target
Log requested memory
IBM.DataPower.LogTarget.requestedMemory
Requested memory of the log target
RAID metrics
Metric name
Metric key
Description
Total - RAID
IBM.DataPower.RAID.totalSize
Total RAID Size
Free - RAID
IBM.DataPower.RAID.freeSpace
Free RAID Size
Gateway Peering
Metric name
Metric key
Description
Api Security Token Peering
IBM.DataPower.Gateway.apiRateLimitingPeering
—
Api Rate Limiting Peering
IBM.DataPower.Gateway.apiSecurityTokenPeering
—
Task metrics
Metric name
Metric key
Description
Task load
IBM.DataPower.Task.load
—
Task pending messages
IBM.DataPower.Task.workList
—
Task CPU usage
IBM.DataPower.Task.CPU
—
Task Memory usage
IBM.DataPower.Task.Memory
—
Task file count
IBM.DataPower.Task.FileCount
—
Interface metrics
Metric name
Metric key
Description
Packets received
IBM.DataPower.Interface.receivePackets.count
Number of packets received per interface
Bytes received
IBM.DataPower.Interface.receiveBps.count
Number of bytes received per interface
Errors received
IBM.DataPower.Interface.receiveErrors.count
Number of errors received per interface
Dropped packages received
IBM.DataPower.Interface.receiveDrops.count
Number of received packages that have been dropped per interface
Packets transmitted
IBM.DataPower.Interface.transmitPackets.count
Number of transmitted packages per interface
Bytes transmitted
IBM.DataPower.Interface.transmitBps.count
Number of bytes transmitted per interface
Errors transmitted
IBM.DataPower.Interface.transmitErrors.count
Number of errors transmitted per interface
Dropped packages transmitted
IBM.DataPower.Interface.transmitDrops.count
Number of transmitted packages that have been dropped per interface
Collision count
IBM.DataPower.Interface.collisions.count
Number of collisions per interface
Interface status
IBM.DataPower.Interface.status
Current status of the interface
Service metrics
Metric name
Metric key
Description
Calls per minute
IBM.DataPower.Service.httpTransactionThroughput
—
Total transaction time
IBM.DataPower.Service.httpTransactionsTime
Total amount of time used on transactions per service
DataPower extension.
ActiveGate with Extensions 2.0 enabled.