Monitoring IBM DataPower

Supported versions

Confirmed support for metrics and configuration data for versions: 2018.4 and 10.0.

Prerequisites

For Instana agent to be able to monitor IBM DataPower appliance, resource monitoring needs to be enabled, such as REST management interface and statistics.

Configuration

You need to configure the following fields in the agent configuration file <agent_install_dir>/etc/instana/configuration.yaml:

Local

com.instana.plugin.ibmdatapower:
  enabled: true
  poll_rate: 5
  instances:  
    local: 
      port: '5554'       # DataPower instance REST management interface port (required)
      username: 'admin'  # User account to connect to DataPower (required)
      password: 'admin'  # User password to connect to DataPower (required)

Remote

com.instana.plugin.ibmdatapower:
  enabled: true
  poll_rate: 5
  instances:                   # Multiple DataPower instances can be specified
    10.0.0.1:                  # Remote DataPower Host or IP address
      port: '5554'             # DataPower instance REST management interface port (required)
      username: 'dpUser'       # User account to connect to DataPower (required)
      password: 'dpPassword'   # User password to connect to DataPower (required)
      cluster: 'clusterName'   # The cluster to group multiple DataPower instances (optional)
    datapower-inst.ibm.com:    # Remote DataPower Host or IP address
      port: '443'              # DataPower instance REST management interface port (required)
      username: 'dpUser'       # User account to connect to DataPower (required)
      password: 'dpPassword'   # User password to connect to DataPower (required)
      cluster: 'clusterName'   # The cluster to group multiple DataPower instances (optional)

If cluster is configured, the remote DataPower instance will then be shown as a separate box in the specified availabilityZone.

Metrics collection

Performance metrics

Appliances

Metric Description
System Load The percentage of total load on the device during the measurement interval.
CPU Usage The average CPU usage of the monitored DataPower appliance in the last 10 seconds.
Memory Usage The instantaneous memory usage as a percentage of the total memory.
Encreypted Filesystem Usage Usage of encrypted storage space on the device.
Connection Accepted The number of TCP accepted connections.
Work List The number of pending work items including internal communication in the queue for processing by the appliance.
Quiesced Domains Indicates the quiesce state of the domain.
Inactive Objects Number of inactive objects deployed on the device.
TCP Summary Established The number of TCP connections in the established state.
TCP Summary Syn Sent The number of TCP connections in the syn-sent state.
TCP Summary Syn Received The number of TCP connections in the syn-received state.
TCP Summary Fin Wait1 The number of TCP connections in the fin-wait-1 state.
TCP Summary Fin Wait2 The number of TCP connections in the fin-wait-2 state.
TCP Summary Closed The number of TCP connections in the closed state.
TCP Summary Close Wait The number of TCP connections in the close-wait state.
TCP Summary Time Wait The number of TCP connections in the close-wait state.
TCP Summary Last Ack The number of TCP connections in the last-ack state.
TCP Summary Listen The number of TCP connections in the listen state.
TCP Summary Closing The number of TCP connections in the closing state.

Domains

Metric Description
Current Memory Usage The instantaneous memory usage as a percentage of the total memory within this domain.

Ethernet Interfaces

Metric Description
RX Bytes Bytes of traffic that is received.
RX Drops Number of received packets that are dropped.
TX Bytes Bytes of traffic that is transmitted.
TX Drops Number of packets that are dropped during transmission.
Received Per Second The number of packets that are received on the network interface per second.
Transmit Per Second The number of packets that are received on the transmitted interface per second.

MQ Queue Manager

Metric Description
Back-End Active Connections Number of active connections for the back-end side.
Front-End Active Connections Number of active connections for the front-end side.

Services

Metric Description
Current Memory Usage The current memory usage by the service in the interval between 1 and 5 minutes ago.
Mean Transaction Time The mean transaction time over the last 10 minutes.
Throughput The transaction rate over the last 10 minutes.

Sql Datasource

Metric Description
Active Connections Name of the SQL data source.

Health Signatures

For each sensor, there is a curated knowledgebase of health signatures that are evaluated continuously against the incoming metrics and are used to raise issues or incidents depending on user impact.

Built-in events trigger issues or incidents based on failing health signatures on entities, and custom events trigger issues or incidents based on the thresholds of an individual metric of any given entity.

For information about built-in events for the Datapower sensor, see the Built-in events reference.

Troubleshooting

DataPower instance not shown in UI

On the Monitoring Issue list, please find out the DataPower related events and check the solution according to the issue type.

Variable not defined

Monitoring issue type: ibmdatapower_var_not_defined

There are one or more required items missing in the configuration. Make sure that your DataPower instance port, username and password are set in the configuration.yaml.

Variable has an invalid value

Monitoring issue type: ibmdatapower_var_invalid_value

One or more required items have an invalid value in the configuration. Make sure that your DataPower instance port, username and password are set correctly in the configuration.yaml.

Connection Error

Monitoring issue type: ibmdatapower_connection_error

The DataPower Sensor could not connect to the DataPower instance after many retries. Make sure that your DataPower instance port, username and password are set correctly in the configuration.yaml.

Other Exception

Monitoring issue type: ibmdatapower_exception_error

The DataPower Sensor encountered an uncommon exception that is not yet documented. This might mean there is an issue with the Instana Agent or DataPower.