Monitoring Agent for DataPower metrics

The metrics for Monitoring Agent for DataPower resource types collect data for monitoring with IBM Cloud Pak for Multicloud Management. Every Monitoring Agent for DataPower resource type defines a set of dimensions and metrics. The descriptions provide such information as data type, dimension key, and metric unit.

Resource dataPowerAppliance

DataPower Gateways. The following section lists the metrics, dimensions and components of Resource dataPowerAppliance.

Dimensions

The following dimensions are available for the resource.

Device Host

• Host name or IP address of the device.
• The type is string.

Model Type

• The IBM model type of the base system.
• The type is string.

Node

• Node.
• The type is string.

Serial

• The serial number of the device. This number is unique to each device.
• The type is string.

Version

• The currently running version of the firmware.
• The type is string.

Component: Agent Status

The Agent Status data set provides information about the agent instance. This information includes the communication status of the instance with the monitored DataPower appliances. The following section lists the metrics and dimensions of Component Agent Status.

Dimensions

The following dimensions are available for the component.

Agent Status Connection Status

• Connection status to the DataPower appliance.
• The type is int.

Agent Status Device

• Hostname or IP address of the DataPower appliance.
• The type is string.

Agent Status Node

• Node.
• The type is string.

Agent Status Resource Name

• Name of the monitored DataPower appliance.
• The type is string.

Agent Status Response Code

• Response code.
• The type is int.

Agent Status Response Message

• Response message.
• The type is string.

Component: CPU Usage

Information about the CPU usage of the monitored DataPower appliance. The following section lists the metrics and dimensions of Component CPU Usage.

Metrics

The following metrics are available for the component.

CPU Usage 10 sec (%)

• The average CPU usage of the monitored DataPower appliance in the last 10 seconds.
• The type is int.
• The unit is percent.

Dimensions

The following dimensions are available for the component.

CPU Usage Device Host

• Host name or IP address of the device.
• The type is string.

CPU Usage Node

• Node.
• The type is string.

Component: Ethernet Interface

Information about the device-specifc status of all Ethernet network interfaces on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component Ethernet Interface.

Dimensions

The following dimensions are available for the component.

Ethernet Interface Interface

• Name of the Ethernet interface.
• The type is int.

Ethernet Interface IP address

• IP address of the Ethernet interface.
• The type is string.

Ethernet Interface Node

• Node.
• The type is string.

Ethernet Interface Status

• The current link status of the interface. If there is no link, the interface does not respond to the network.
• The type is int.

Component: File System

Information about the file system usage of the monitored DataPower appliance. Data for these attributes is gathered from the dpStatusFilesystemStatus MIB object. The following section lists the metrics and dimensions of Component File System.

Metrics

The following metrics are available for the component.

File System Encrypted Usage (%)

• Usage of encrypted storage space on the device.
• The type is int.
• The unit is percent.

Dimensions

The following dimensions are available for the component.

File System Device Host

• Host name or IP address of the appliance.
• The type is string.

File System Node

• Node.
• The type is string.

Component: Firmware

Information about the firmware of the monitored DataPower appliance. The following section lists the metrics and dimensions of Component Firmware.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

Component: Hypervisor Status

Information about the hypervisor status of the virtual DataPower appliance. The following section lists the metrics and dimensions of Component Hypervisor Status.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

Hyper Visor Device Host

• Host name or IP address of the virtual device.
• The type is string.

Hyper Visor Edition

• The edition of the hypervisor (production, non-production or developers).
• The type is string.

Hyper Visor Hypervisor

• The hypervisor that this virtual appliance is running on.
• The type is string.

Hyper Visor Node

• Node.
• The type is string.

Hyper Visor UUID

• The UUID of this virtual appliance that is assigned by the hypervisor.
• The type is string.

Component: Log Notification

Use the LogNotification attributes to obtain information about the events from the monitored DataPower appliance. The following section lists the metrics and dimensions of Component Log Notification.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

Component: Memory

Information about the memory usage of the monitored DataPower appliance. The following section lists the metrics and dimensions of Component Memory.

Metrics

The following metrics are available for the component.

Memory Usage (%)

• The instantaneous memory usage as a percentage of the total memory.
• The type is int.
• The unit is percent.

Dimensions

The following dimensions are available for the component.

Memory Device Host

• Host name or IP address of the device.
• The type is string.

Memory Node

• Node.
• The type is string.

Component: Object Count

Information about the number of objects in different states deployed on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component Object Count.

Metrics

The following metrics are available for the component.

Object Count Inactive Objects

• Number of inactive objects deployed on the device.
• The type is int.
• The unit is objects.

Dimensions

The following dimensions are available for the component.

Object Count Device Host

• Host name or IP address of the device.
• The type is string.

Object Count Node

• Node.
• The type is string.

Component: Performance Object Status

The Performance Object Status attribute group contains information that reflects the status of other attribute groups so you can see the status of all performance objects that make up this application all at once. Each of these other performance attribute groups is represented by a row in this table (or other type of view). The status for an attribute group reflects the result of the last attempt to collect data for that attribute group, so you can see whether the agent is collecting data correctly. Unlike other attribute groups, the Performance Object Status attribute group does not reflect the state of the monitored application. This attribute group is most often used to determine why data is not available for one of the performance attribute groups. The following section lists the metrics and dimensions of Component Performance Object Status.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

Component: SQL Connection Status

Information about the receive throughput, in kibibytes per second, for all network interfaces on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component SQL Connection Status.

Metrics

The following metrics are available for the component.

Received Throughput Last 1 min ( kibibytes/sec)

• The average receive throughput over the last minute.
• The type is int.
• The unit is kibibytes/second.

Dimensions

The following dimensions are available for the component.

Received Throughput Device Host

• Host name or IP address of the device.
• The type is string.

Received Throughput Interface Name

• The management name of this interface.
• The type is string.

Received Throughput Interface Type

• The type of this interface.
• The type is int.

Received Throughput Node

• Node.
• The type is string.

Component: System Usage

Information about the system load of the monitored DataPower appliance. The following section lists the metrics and dimensions of Component System Usage.

Metrics

The following metrics are available for the component.

System Usage Load (%)

• The percentage of total load on the device during the measurement interval. A load above 90 shows that the device is at or near load capacity.
• The type is int.
• The unit is percent.

System Usage Work List

• The number of pending work items including internal communication in the queue for processing by the appliance. This attribute might include such activities as off-box logging and stylesheet or WSDL retrieval from remote locations. Off-box logging is error logging to a server that is separate from the DataPower appliance.
• The type is int.
• The unit is workitems.

Dimensions

The following dimensions are available for the component.

System Usage Device Host

• Host name or IP address of the device.
• The type is string.

System Usage Node

• Node.
• The type is string.

Component: TCP Connections

Information about the agent instance. This information includes the communication status of the instance with the monitored DataPower appliances. The following section lists the metrics and dimensions of Component TCP Connections.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

TCP Connection Device Host

• Host name or IP address of the device.
• The type is string.

TCP Connection Domain

• For TCP connections that were created by a configuration object this value indicates the domain that the configuration object that created the listener is in. Only applies to connections in the listen state.
• The type is string.

TCP Connection Local IP

• The local IP address of this TCP connection. For connections in the listen state, an IP address of 0.0.0.0 means that connections will be accepted at any IP address of the system. A specific IP address indicates that connections will only be accepted at that IP address.
• The type is string.

TCP Connection Local Port

• The local TCP port number of this TCP connection.
• The type is int.

TCP Connection Name

• The name of the configuration object that created the listener. Only applies to TCP connections in the listen state.
• The type is string.

TCP Connection Node

• Node.
• The type is string.

TCP Connection Remote IP

• The remote IP address of this TCP connection. The value is 0.0.0.0 for connections in the listen state. The value is a specific IP address for established connections.
• The type is string.

TCP Connection Remote Port

• The remote TCP port number of this TCP connection.
• The type is int.

TCP Connection State

• The state of the TCP connection as defined in RFC 793.
• The type is int.

TCP Connection Type

• The type of configuration object that created the listener. For all connections not in the listen state this value will be configBase.
• The type is int.

Component: TCP Summary

Information about the count of all current TCP connections or activities on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component TCP Summary.

Metrics

The following metrics are available for the component.

TCP Summary Closed

• The number of TCP connections in the closed state. This state represents no connection state at all.
• The type is int.
• The unit is connections.

TCP Summary Established

• The number of TCP connections in the established state. Connections in this state have completed all handshakes and can transfer data in either direction.
• The type is int.
• The unit is connections.

TCP Summary Listen

• The number of TCP connections in the listen state. Connections in the listen state are waiting for a connection request from any remote TCP and port.
• The type is int.
• The unit is connections.

TCP Summary Synchronize Received

• The number of TCP connections in the syn-received state. Connections in this state are waiting for a confirming connection request acknowledgment after both receiving and sending a connection request.
• The type is int.
• The unit is connections.

TCP Summary Synchronize Sent

• The number of TCP connections in the syn-sent state. Connections in this state are waiting for a matching connection request after sending a connection request.
• The type is int.
• The unit is connections.

TCP Summary Time Wait

• The number of TCP connections in the time-wait state. Connections in this state are waiting for enough time to pass to be sure that the remote TCP received the acknowledgment of its connection termination request.
• The type is int.
• The unit is connections.

Dimensions

The following dimensions are available for the component.

TCP Summary Device Host

• Host name or IP address of the device.
• The type is string.

TCP Summary Node

• Node.
• The type is string.

Component: Transmitted Throughput

Information about the transmit throughput, in kibibytes per second, for all network interfaces on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component Transmitted Throughput.

Metrics

The following metrics are available for the component.

Transmitted Throughput Last 1 min (kibibytes/s)

• The average transmit throughput over the last minute.
• The type is int.
• The unit is kibbytes/second.

Dimensions

The following dimensions are available for the component.

Transmitted Throughput Interface Name

• The management name of this interface.
• The type is string.

Transmitted Throughput Interface Type

• The type of this interface.
• The type is int.

Transmitted Throughput Node

• Node.
• The type is string.

Resource dataPowerDomain

Information about the status of the domain. The following section lists the metrics, dimensions and components of Resource dataPowerDomain.

Metrics

The following metrics are available for the resource.

Dimensions

The following dimensions are available for the resource.

Device

• Device.
• The type is string.

Name

• The name of the domain.
• The type is string.

Node

• Node.
• The type is string.

Quiesce State

• Showsthe quiesce state of the domain. Individually quiesced services within a domain are not reported here..
• The type is string.

Component: Domain Memory

DomainsMemoryStatus attributes to obtain details of memory usage all domains. The following section lists the metrics and dimensions of Component Domain Memory.

Metrics

The following metrics are available for the component.

Domain Memory 1 min (KB)

• The peak memory usage by services of this domain over the previous minute.
• The type is int.
• The unit is kilobytes.

Domain Memory 1 to 12 hours (KB)

• The peak memory usage by services of this domain in the interval between 1 and 12 hours ago.
• The type is int.
• The unit is kilobytes.

Domain Memory 1 to 5 min (KB)

• The peak memory usage by services of this domain in the interval between 1 and 5 minutes ago.
• The type is int.
• The unit is kilobytes.

Domain Memory 10 to 60 min (KB)

• The peak memory usage by services of this domain in the interval between 10 minutes and 1 hour ago.
• The type is int.
• The unit is kilobytes.

Domain Memory 12 to 24 hours (KB)

• The peak memory usage by services of this domain in the interval between 12 hours and 1 day ago.
• The type is int.
• The unit is kilobytes.

Domain Memory 5 to 10 min (KB)

• The peak memory usage by services of this domain in the interval between 5 and 10 minutes ago.
• The type is int.
• The unit is megabytes.

Domain Memory Current (KB)

• Current total memory being used by all services of this domain.
• The type is int.
• The unit is kilobytes.

Domain Memory Doc Caches

• Total memory usage by all document caches in this domain.
• The type is int.
• The unit is caches.

Domain Memory Lifetime (KB)

• The peak memory usage by services of this domain over its lifetime.
• The type is int.
• The unit is kilobytes.

Domain Memory Stylesheet Caches

• Total memory usage by all stylesheet caches in this domain.
• The type is int.
• The unit is kilobytes.

Dimensions

The following dimensions are available for the component.

Domain Memory Device Host

• Hostname or IP address of the DataPower device.
• The type is string.

Domain Memory Domain

• The name of the domain.
• The type is string.

Domain Memory Node

• Nodes.
• The type is string.

Component: MQ Manager Configuration

Information about MQ Queue Manager configurations for all domains on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component MQ Manager Configuration.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

Queue Manager

• Name of the queue manager.
• The type is string.

Queue Manager Admin State

• Configured Queue Manager Administration State.
• The type is string.

Queue Manager Domain

• Name of the application domain.
• The type is string.

Queue Manager Node

• Node.
• The type is string.

Queue Manager Remote Queue Manager Host

• Configured Remote Host.
• The type is string.

Queue Manager Remote Queue Manager Name

• Configured Remote Queue Manager.
• The type is string.

Component: Queue Connections

Information about MQ connection status for all domains on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component Queue Connections.

Metrics

The following metrics are available for the component.

Queue Connection Back-end Active Connections

• Number of active connections for the back-end side.
• The type is int.
• The unit is connections.

Queue Connection Front-end Active Connections

• Number of active connections for the front-end side.
• The type is int.
• The unit is connections.

Dimensions

The following dimensions are available for the component.

Queue Connection Domain

• Name of the application domain.
• The type is string.

Queue Connection Node

• Node.
• The type is string.

Queue Connection Queue Manager

• Name of the queue manager.
• The type is string.

Component: SQL Connection Status

Information about SQL connection status for all SQL data sources on the monitored DataPower appliance. The following section lists the metrics and dimensions of Component SQL Connection Status.

Metrics

The following metrics are available for the component.

SQL Connection Active Connections

• Number of active connections.
• The type is int.
• The unit is connections.

Dimensions

The following dimensions are available for the component.

SQL Connection Domain

• Name of the application domain.
• The type is string.

SQL Connection Node

• Node.
• The type is string.

SQL Connection SQL Data Source

• Name of the SQL data source.
• The type is string.

Component: WSM Agent Status

Use the WSMAgentStatus attributes to obtain status of the WSM Agent per application domain.Data for these attributes is gathered from the dpStatusWSMAgentStatus MIB object. The following section lists the metrics and dimensions of Component WSM Agent Status.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

Resource dataPowerService

DataPower Services. The following section lists the metrics, dimensions and components of Resource dataPowerService.

Metrics

The following metrics are available for the resource.

Service Memory Status 1 min (KB)

• The peak memory usage by the service over the previous minute.
• The type is int.
• The unit is kilobytes.

Dimensions

The following dimensions are available for the resource.

Service Memory Status Domain

• Name of the domain.
• The type is string.

Service Memory Status Name

• Name of the service.
• The type is string.

Service Memory Status Node

• Node.
• The type is string.

Component: HTTP Mean Transaction Times

Information about the HTTP mean transaction times of the monitored DataPower appliance. The following section lists the metrics and dimensions of Component HTTP Mean Transaction Times .

Metrics

The following metrics are available for the component.

HTTP Mean Transaction Times Last 1 min (msec)

• The mean transaction time over the last minute.
• The type is int.
• The unit is milliseconds.

Dimensions

The following dimensions are available for the component.

HTTP Mean Transaction Times Domain

• Name of the application domain.
• The type is string.

HTTP Mean Transaction Times Node

• Node.
• The type is string.

HTTP Mean Transaction Times Proxy

• Name of the proxy service.
• The type is string.

HTTP Mean Transaction Times Type

• Type of the service.
• The type is int.

Component: HTTP Transaction Rates

Use the HTTPTransactions2 attributes to obtain information about the HTTP transaction rate of the monitored DataPower appliance. The following section lists the metrics and dimensions of Component HTTP Transaction Rates.

Metrics

The following metrics are available for the component.

HTTP Transaction Rates Last 1 min (txs per sec)

• The transaction rate over the last minute.
• The type is int.
• The unit is transactions/second.

Dimensions

The following dimensions are available for the component.

HTTP Transaction Rates Device Host

• Host name or IP address of the device.
• The type is string.

HTTP Transaction Rates Domain

• Name of the application domain.
• The type is string.

HTTP Transaction Rates Node

• Node.
• The type is string.

HTTP Transaction Rates Proxy

• Name of the proxy service.
• The type is string.

HTTP Transaction Rates Type

• Type of the service.
• The type is int.