IBM Datapower

IBM Datapower

Enable remote monitoring of your DataPower gateways with this extension.

Extension

Product information
Release notes

Overview

DataPower gateways provide mission-critical service/application integration, security, and control. For these devices, Dynatrace offers remote monitoring through the DataPower ActiveGate extension. By ingesting key device data, the extension provides Dynatrace with real-time insight into device health and performance.

Now available in Extensions Framework 2.0, click on Add to environment to get started.

Get started

Requirements

Dynatrace version 1.269+
ActiveGate version 1.269+
ActiveGate with the Extensions 2.0 module 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.

Dynatrace configuration

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. Should look something like https://<hostname>:<port>/service/mgmt/current
User: Used to authenticate against the XML Management Interface. Must have permissions to query it.
Password: Password to user above.
Require a valid SSL certificate: If enabled, the extension will use a secure SSL connection to connect to the XML Management Interface. A valid certicate 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 will just monitor all entities of this type. If disabled, and no rules are added, no entities will be monitored.
- Monitoring rule: Defines a rule to either 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.
Lastly, select which feature sets (metric groups) you would like this configuration to collect. Selecting too few will not give you the proper visibility and you may miss out on important performance data, as well as key indicators that can be correlated between different objects.

Alerting

The extension comes wtih 10 built-in metric events for the most relevant Datapower metrics and their thresholds. These metric events are disabled by default, but you can navigate over to Settings, Anomaly Detection and Metric events to enable them. These 10 metrics events 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 1 network receive error.
Network transmit errors: Alert when an interface has at least 1 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 bove 90%.
Critical memory utilization: Alert when memory load of a Datapower instance is above 60%.
Records lost: Alert when amount of records lost is at least 1.
Pending messages queue: Alert when the pending messages count is above 3000.
Service is down: Alert when a Datapower service's status is down.

Provided by

Dynatrace

Support

By Dynatrace

Dynatrace support center

Subscribe to new releases

Copy to clipboard

Extension content

Content typeNumber of items included

screen entities lists

29

screen actions

24

document dashboard

1

metric metadata

123

screen metric tables

1

screen properties

11

generic type

12

screen chart groups

28

alerts

10

dashboards

1

generic relationship

11

list screen layout

12

screen layout

12

Feature sets

Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.

Feature setsNumber of metrics included

Metric name	Metric key	Description	Unit
Packets received	IBM.DataPower.Interface.receivePackets.count	Number of packets received per interface	Count
Bytes received	IBM.DataPower.Interface.receiveBps.count	Number of bytes received per interface	Byte
Errors received	IBM.DataPower.Interface.receiveErrors.count	Number of errors received per interface	Count
Dropped packages received	IBM.DataPower.Interface.receiveDrops.count	Number of received packages that have been dropped per interface	Count
Packets transmitted	IBM.DataPower.Interface.transmitPackets.count	Number of transmitted packages per interface	Count
Bytes transmitted	IBM.DataPower.Interface.transmitBps.count	Number of bytes transmitted per interface	Byte
Errors transmitted	IBM.DataPower.Interface.transmitErrors.count	Number of errors transmitted per interface	Count
Dropped packages transmitted	IBM.DataPower.Interface.transmitDrops.count	Number of transmitted packages that have been dropped per interface	Count
Collision count	IBM.DataPower.Interface.collisions.count	Number of collisions per interface	Count
Interface status	IBM.DataPower.Interface.status	Current status of the interface	Percent

Metric name	Metric key	Description	Unit
Log events processed	IBM.DataPower.LogTarget.process.count	Total amount of log events processed per log target	Count
Log events dropped	IBM.DataPower.LogTarget.drop.count	Total amount of log events dropped per log target	Count
Log events pending	IBM.DataPower.LogTarget.pending	Total amount of log events pending per log target	Count
Log requested memory	IBM.DataPower.LogTarget.requestedMemory	Requested memory of the log target	Byte

Metric name	Metric key	Description	Unit
Free - Encrypted	IBM.DataPower.Disk.freeEncrypted	Free and encrypted disk size	MegaByte
Total - Encrypted	IBM.DataPower.Disk.totalEncrypted	Total encrypted disk size	MegaByte
Free - Temporary	IBM.DataPower.Disk.freeTemporary	Free temporary disk size	MegaByte
Total - Temporary	IBM.DataPower.Disk.totalTemporary	Total temporary disk size	MegaByte
Free - Internal	IBM.DataPower.Disk.freeInternal	Free internal disk size	MegaByte
Total - Internal	IBM.DataPower.Disk.totalInternal	Total internal disk size	MegaByte

Metric name	Metric key	Description	Unit
Power supply	IBM.DataPower.powerSupply	Current status of the power supply	Percent
Case open	IBM.DataPower.caseopen	Indicates if the case is open or not	Percent
Check intrusion	IBM.DataPower.checkintrusion	Indicates if check intrusion is active or not	Percent
System temperature	IBM.DataPower.systemTemp	-	Count
CPU 1 temperature	IBM.DataPower.cpu1Temp	-	Count
CPU 2 temperature	IBM.DataPower.cpu2Temp	-	Count
CPU 1 RPM	IBM.DataPower.cpu1rpm	-	Count
CPU 2 RPM	IBM.DataPower.cpu2rpm	-	Count
Chassis 1 RPM	IBM.DataPower.chassis1rpm	-	Count
Chassis 2 RPM	IBM.DataPower.chassis2rpm	-	Count
Chassis 3 RPM	IBM.DataPower.chassis3rpm	-	Count
Volt 5 sensor	IBM.DataPower.volt5	-	Count
Volt 12 sensor	IBM.DataPower.volt12	-	Count
Volt 33 sensor	IBM.DataPower.volt33	-	Count

Metric name	Metric key	Description	Unit
HTTP Connection requests	IBM.DataPower.XMLManager.Requests	Connection requests to the XML Manager	Count
HTTP Connections reused	IBM.DataPower.XMLManager.Reuse	Connection reuses to the XML Manager	Count
HTTP Connections created	IBM.DataPower.XMLManager.Create	Connections created to the XML Manager	Count
HTTP Connection returns	IBM.DataPower.XMLManager.Return	Connection returns to the XML Manager	Count
HTTP Connections offered	IBM.DataPower.XMLManager.Offered	Connections offered for the XML Manager	Count
HTTP Connections destroyed	IBM.DataPower.XMLManager.Destroy	Connections destroyed to the XML Manager	Count

Metric name	Metric key	Description	Unit
Document cache count	IBM.DataPower.XMLManager.documentCacheCount	Number of documents in the cache	Count
Document count	IBM.DataPower.XMLManager.documentCount	Number of documents	Count
Document cache size	IBM.DataPower.XMLManager.documentCacheSize	-	Count
Document byte count	IBM.DataPower.XMLManager.documentByteCount	Number of documents in bytes	KibiByte
Document expired count	IBM.DataPower.XMLManager.documentExpiredCount	-	Count

Metric name	Metric key	Description	Unit
Connectivity	IBM.DataPower.connectivity	Percentage of successful connections	Percent
Crypto Engine Status	IBM.DataPower.cryptoEngineStatus	-	Percent
Active Subscribers	IBM.DataPower.activeSubscribers	Number of active subscribers	Count
Records lost	IBM.DataPower.recordsLost.count	-	Count
Pending records	IBM.DataPower.pendingRecordsQueue	Number of records pending in queue	Count
Complete records	IBM.DataPower.completeRecordsQueue	Number of records completed	Count
Pending messages	IBM.DataPower.worklist	-	Count
Load	IBM.DataPower.load	-	Percent
Connections accepted	IBM.DataPower.connectionsAccepted	Per minute rate of connections accepted	PerMinute
Active transactions	IBM.DataPower.activeTransactions	-	Count
Uptime	IBM.DataPower.Uptime	Total uptime of the device	Second

Metric name	Metric key	Description	Unit
XML name free percent	IBM.DataPower.XMLName.Free	-	Percent
XML name used count	IBM.DataPower.XMLName.Used	-	Count
XML name maximum	IBM.DataPower.XMLName.Maximum	-	Count

Metric name	Metric key	Description	Unit
Web service last response time	IBM.DataPower.WebService.lastResponseTime	-	MilliSecond
Web service failed requests	IBM.DataPower.WebService.failedRequests.count	-	Count
Web service total requests	IBM.DataPower.WebService.totalRequests.count	-	Count
Web service successful requests	IBM.DataPower.WebService.successfulRequests.count	-	Count
Web service time	IBM.DataPower.WebService.serviceTime.count	-	MilliSecond

Metric name	Metric key	Description	Unit
MQQM received faults	IBM.DataPower.MQQM.receiveFaults	Number of received faults in the MQ queue manager	Count
MQQM received messages	IBM.DataPower.MQQM.received	Number of received messages in the MQ queue manager	Count
MQQM sent faults	IBM.DataPower.MQQM.sendFaults	Number of sent faults in the MQ queue manager	Count
MQQM sent messages	IBM.DataPower.MQQM.sent	Number of sent messages in the MQ queue manager	Count
MQQM total connection limit	IBM.DataPower.MQQM.totalConnectionLimit	-	Count
MQQM connections	IBM.DataPower.MQQM.totalConnections	Number of connections for the MQ queue manager	Count
MQQM active connections	IBM.DataPower.MQQM.totalActiveConnections	Number of active connections for the MQ queue manager	Count
MQQM idle connections	IBM.DataPower.MQQM.totalIdleConnections	Number of idle connections for the MQ queue manager	Count
MQQM active frontend connections	IBM.DataPower.MQQM.activeFrontendConnections	Number of active frontend connections for the MQ queue manager	Count
MQQM active backend connections	IBM.DataPower.MQQM.activeBackendConnections	Number of active backend connections for the MQ queue manager	Count

Metric name	Metric key	Description	Unit
CPU load	IBM.DataPower.cpuload	-	Percent
Memory usage	IBM.DataPower.Memory.Usage	-	Percent
Memory total	IBM.DataPower.Memory.Total	-	KiloByte
Memory used	IBM.DataPower.Memory.Used	-	KiloByte
Memory free	IBM.DataPower.Memory.Free	-	KiloByte
Memory requested	IBM.DataPower.Memory.Req	-	KiloByte

Metric name	Metric key	Description	Unit
Load Balancer Group - Administrative state	IBM.DataPower.LoadBalancer.adminState	Administrative state of the load balancer group	Count
Load Balancer - Administrative state	IBM.DataPower.LoadBalancer.memberState	Administrative state of the load balancer	Count
Load Balancer - Operational state	IBM.DataPower.LoadBalancer.operationalState	Operational state of the load balancer	Count

Metric name	Metric key	Description	Unit
Link Aggregation Status	IBM.DataPower.LinkAggregationStatus	-	Percent
Link Aggregation MII Status	IBM.DataPower.LinkAggregationMIIStatus	-	Percent

Metric name	Metric key	Description	Unit
SLM Policy messages	IBM.DataPower.SLMPolicy.messages	Number of messages processed by the statement	Count
SLM Policy errors	IBM.DataPower.SLMPolicy.errors	Number of errors by the statement	Count
SLM Policy throttled	IBM.DataPower.SLMPolicy.throttled	-	Count
SLM Policy average time	IBM.DataPower.SLMPolicy.timeAverage	-	MilliSecond
SLM Policy maximum time	IBM.DataPower.SLMPolicy.timeMaximum	-	MilliSecond
SLM Policy minimum time	IBM.DataPower.SLMPolicy.timeMinimum	-	MilliSecond

Metric name	Metric key	Description	Unit
TCP established connections	IBM.DataPower.TCP.established	Count of established TCP connections	Count
TCP SYN Sent	IBM.DataPower.TCP.synSent	Count of SYN requests sent	Count
TCP SYN Received	IBM.DataPower.TCP.synReceived	Count of SYN requests received	Count
TCP FIN_WAIT_1 count	IBM.DataPower.TCP.finWait1	-	Count
TCP FIN_WAIT_2 count	IBM.DataPower.TCP.finWait2	-	Count
TCP TIME_WAIT	IBM.DataPower.TCP.timeWait	Count of TIME_WAIT	Count
TCP Closed connections	IBM.DataPower.TCP.closed	Number of closed TCP connections	Count
TCP CLOSE_WAIT	IBM.DataPower.TCP.closeWait	Count of CLOSE_WAIT	Count
TCP LAST_ACK	IBM.DataPower.TCP.lastAck	Count of LAST_ACK	Count
TCP Listen	IBM.DataPower.TCP.listen	-	Count
TCP Closing	IBM.DataPower.TCP.closing	Number of TCP closing connections	Count

Metric name	Metric key	Description	Unit
Operational state	IBM.DataPower.operationalState	Operational state of a classes' object	Count
Administrative state	IBM.DataPower.adminState	Administrative state of a classes' object	Count

Metric name	Metric key	Description	Unit
Total - RAID	IBM.DataPower.RAID.totalSize	Total RAID Size	KiloByte
Free - RAID	IBM.DataPower.RAID.freeSpace	Free RAID Size	KiloByte

Metric name	Metric key	Description	Unit
Calls per minute	IBM.DataPower.Service.httpTransactionThroughput	-	PerMinute
Total transaction time	IBM.DataPower.Service.httpTransactionsTime	Total amount of time used on transactions per service	MilliSecond
Service status	IBM.DataPower.Service.status	-	Percent

Metric name	Metric key	Description	Unit
Stylesheet cache size	IBM.DataPower.XMLManager.stylesheetCacheSize	-	Count
Stylesheet cache count	IBM.DataPower.XMLManager.stylesheetCacheCount	-	Count
Stylesheet document count	IBM.DataPower.XMLManager.stylesheetDocumentCount	-	Count
Stylesheet pending count	IBM.DataPower.XMLManager.stylesheetPendingCount	-	Count
Stylesheet bad count	IBM.DataPower.XMLManager.stylesheetBadCount	-	Count
Stylesheet duplicate count	IBM.DataPower.XMLManager.stylesheetDuplicateCount	-	Count
Stylesheet executions	IBM.DataPower.XMLManager.stylesheetExecutions	-	Count

Metric name	Metric key	Description	Unit
Task load	IBM.DataPower.Task.load	-	Percent
Task pending messages	IBM.DataPower.Task.workList	-	Count
Task CPU usage	IBM.DataPower.Task.CPU	-	Percent
Task Memory usage	IBM.DataPower.Task.Memory	-	Percent
Task file count	IBM.DataPower.Task.FileCount	-	Count

Metric name	Metric key	Description	Unit
Api Security Token Peering	IBM.DataPower.Gateway.apiRateLimitingPeering	-	Percent
Api Rate Limiting Peering	IBM.DataPower.Gateway.apiSecurityTokenPeering	-	Percent

Related to IBM Datapower

ActiveGate

Route traffic, monitor clouds and remote technologies & run Synthetic monitors

Full version history

To have more information on how to install the downloaded package, please follow the instructions on this page.

ReleaseDate

Full version history

Adds device.address dimension to all ingested metrics.
Adds RAID metrics feature set and metrics (Chart can be found in DataPower Instance UA Screen):
- IBM.DataPower.RAID.totalSize
- IBM.DataPower.RAID.freeSpace
Adds Gateway Peering metrics feature set and metrics (Chart can be found in Datapower Domain UA Screen):
- IBM.DataPower.Gateway.apiRateLimitingPeering
- IBM.DataPower.Gateway.apiSecurityTokenPeering
Fixes MQQM metrics for versions 9+.

Full version history

Fixed a bug where MQ metrics were not being captured correctly for versions 9 and above of Datapower.
Fixed a bug where the metric IBM.DataPower.LoadBalancer.adminState was not being linked to any entity.

Full version history

Added 3rd gen dashboard

Full version history

Fixed a bug where data stopped being ingested for older versions of Datapower

Full version history

✨ New in this version:

Added support for MQ Manager metrics for IBM Datapower version 9+.
Added support for API Gateway service metrics.

🐛 Fixed in this version:

Fixed a bug where object status metrics were not being captured correctly.

Full version history

Fixed issue where username/password fields were still appearing if credential vault toggle was on.

Full version history

🚀 Improved in this version:

Increased maximum number of splits per metric from 1000 to unlimited.

✨ New in this version:

Added support for configuring credentials directly from the credential vault.
Added 5 new metrics for Web Services, with their relevant generic entity, relationships and chart:
- IBM.DataPower.WebService.lastResponseTime
- IBM.DataPower.WebService.failedRequests.count
- IBM.DataPower.WebService.totalRequests.count
- IBM.DataPower.WebService.successfulRequests.count
- IBM.DataPower.WebService.serviceTime.count

🐛 Fixed in this version:

Properly escape special characters to prevent invalid lines.
Automatically shrink dimension values to avoid exceeding the limit.

Full version history

Fixed a bug where the relationship between a datapower instance and a datapower task was inexistent

Full version history

Disabling feature sets now prevents the extension from performing the queries related to the metrics included in said feature sets.

Full version history

Attention: This version brings breaking changes to existing configurations, meaning you will need to re-create your configurations from scratch when updating them.

New additions:

A total of 65 metrics split between 9 feature sets
Charts where relevant for the above metrics
Topology for MQ Managers and SLM Policies, entities introduced with the new metrics, including their relationships to the rest of the topology
Configuration parameters for filtering the above entities
Configuration parameter to accept client certificate configuration
Configuration parameter bucket size for configuring how many endpoints should run on each - ActiveGate of the selected ActiveGate group for better balancing

Full version history

Fixed a bug where metrics were not attached to any entity

Full version history

Fix an issue where sometimes the connectivity metric was not pushed correctly

Full version history

Fixed a bug where the availability metric was not ingested correctly when Datapower worked with too many IPs

Full version history

Fixed a bug where Load Balancer entities where not being generated

Full version history

Fixed a bug where MINT lines were too long to be ingested
Fixed a bug where incorrect timezone/timestamp would prevent metrics from being ingested

Full version history

Added option for exclude rules instead of only include.
Added support for multiple endpoint configuration.
- This changes the activation schema which will prevent you from updating your older configurations to this new version. You will need to create your configurations from scratch.
Fixed a bug with topology where entities of different domains were being merged.

Full version history

Modified the overview dashboard to show interface traffic instead of status, as the status is missing from many datapower installations.

Full version history

Added new metric IBM.DataPower.activeTransactions and added graph for it on the DataPower instance screen.
Extension no longer pushes events but pushes logs instead.
- This new feature allows you to create your own alerting based on these logs.
- A new configuration parameter has been included to control log ingestion to either enable or disable it.
  - Because of this new parameter, old configurations of the extension cannot be migrated to this version and instead you have to re-create them from scratch.
Fixed a bug where non-existing load balancer metrics would crash the entire extension.

Full version history

Fixed a bug where interface metrics where never captured

Full version history

Extension conversion to Extensions Framework 2.0:

Added custom topology for Datapower entities and their relationships
Added screens for all the entities
Added metric metadata
Added metric events for alerting
Added out of the box dashboard
Added feature sets
Added metrics for interfaces, services, load balancers and admin/oper status of objects
Replaced regex with Dynatrace-friendly rules
Removed configuration for client certificate

All metrics ingested by the new extension are prefixed with IBM.DataPower and drop the builtin:tech prefix. Any older configuration such as metric events or dashboards that use the old metric key will need to be replaced with the new one.

Discover recent additions to Dynatrace

Problems

Analyze abnormal system behavior and performance problems detected by Davis AI.

Logs

Explore all your logs without writing a single query.

Security Investigator

Fast and precise forensics for security and logs on Grail data with DQL queries.

Business Flow

Track, analyze, and optimize your critical business processes.

Cost & Carbon Optimization

Track, analyze, and optimize your IT carbon footprint and public cloud costs.

Davis Anomaly Detection

Detect anomalies in timeseries using the Davis AI

Analyze your data

Understand your data better with deep insights and clear visualizations.

Notebooks

Create powerful, data-driven documents for custom analytics and collaboration.

Dashboards

Transform complex data into clear visualizations with custom dashboards.

Automate your processes

Turn data and answers into actions, securely, and at scale.

Workflows

Automate tasks in your IT landscape, remediate problems, and visualize processes

Jira

Create, query, comment, transition, and resolve Jira tickets within workflows.

Slack

Automate Slack messaging for security incidents, attacks, remediation, and more.

Secure your cloud application

See vulnerabilities and attacks in your environment.

Security Overview

Get a comprehensive overview of the security of your applications.

Code-Level Vulnerabilities

Detect vulnerabilities in your code in real time.

Threats & Exploits

Understand, triage, and investigate application security findings and alerts.

Are you looking for something different?

We have hundreds of apps, extensions, and other technologies to customize your environment

Leverage our newest innovations of Dynatrace Saas

Kick-start your app creation

Kick-start your app creation

Whether you’re a beginner or a pro, Dynatrace Developer has the tools and support you need to create incredible apps with minimal effort.

Go to Dynatrace Developer

Upgrading from Dynatrace Managed to SaaS

Upgrading from Dynatrace Managed to SaaS

Drive innovation, speed, and agility in your organization by seamlessly and securely upgrading.

Log Management and Analytics

Log Management and Analytics

Innovate faster and more efficiently with unified log management and log analytics for actionable insights and automation.