IBM DataPower Operations Dashboard v1.0.12.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

API Latency Report

API Latency

Available Filters

  • Time Range
  • Device
  • Domain
  • Catalog
  • Space
  • Product
  • Plan
  • API Name
  • API Version
  • App Name

Summary Table

Column
Description
KeyThe catalog name
doc_countNumber of times the catalog name appeared for the specified filters (time, device, etc)
KeyThe API Name
doc_countNumber of times the API name appeared for the catalog name
KeyThe API Version
doc_countNumber of times the API version appeared for the api name
KeyThe FE Response code
doc_countNumber of times the FE Response code appeared for the api version
KeyAverage Total Latency
doc_countAverage total latency for each response code 
KeyMax Total Latency
doc_countMax total latency for each response code 

Default Sort: First doc_count, Descending.


Device CPU Report

Devices ordered by average CPU

Available Filters

  • Time Range
  • Device 

Summary Table

ColumnDescription
DeviceThe device name
SamplesSamples recorded for the device
Average CPU (%)Average CPU utilization recorded across samples
Maximum CPU (%)Maximum CPU utilization recorded across samples

Default Sort: Average CPU (%), Descending.


Device Resources Report

All device resources samples

*The Device Resources report will return up to 10,000 rows

Available Filters

  • Time Range
  • Device 

Summary Table

Column
Description
Total Installed MemoryTotal installed memory in the monitored device
Used Memory (%)Used memory (Percent)
Sample TimeSample time
System LoadSystem load percentage
Used CPU (%)Used CPU percentage
Device NameThe device where the sample run

Default Sort: Sample Time, Ascending.


Domain Request Size Report

Domains ordered by total request size

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
DomainThe domain name
TransactionsNumber of transactions for the domain
Total Request Size (bytes)Total size of messages for the domain

Default Sort: Total Request Size (bytes), Descending.


Domain Total Transactions Report

Domains ordered by total number of transactions

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
DomainThe domain name
TransactionsNumber of transactions for the domain

Default Sort: Transactions, Descending.


Executed Transactions Report

List of all executed transactions

Available Filters

  • Time Range
  • Device 
  • Domain
  • Service

Summary Table 

Column
Description
TimeTransaction execution time
Transaction IDThe transaction id  
Client IPThe client IP of the machine (or load balancer) where this transaction started
DeviceThe device where the transaction run
DomainThe domain where the transaction run
Service NameService name

Default Sort: Time, Descending.


Message Codes Count Report

Message codes distribution

Available Filters

  • Time Range
  • Device 
  • Domain
  • Service

Summary Table 

Column
Description
KeyThe message code (for example 0x80e0068d)
doc_countNumber of times the message code appeared for the specified filters (time, device, etc)
KeyMessage Log level 
doc_countNumber of times the message code appeared for the log level

*There may be one or more log levels where the message appeared, each log level will be shown in the separate line.

Default Sort: First doc_count, Descending.


Service Average Latency Report

Average latency report per services

Available Filters

  • Time Range
  • Device 
  • Domain
  • Service

Summary Table

Column
Description
Service NameService name
ExecutionsNumber of service executions within time range.
Avg Front-End Request - Network Latency (ms.)Average front-end request network latency in milliseconds.
Avg Front-End Response - Network Latency (ms.)Average front-end response network latency in milliseconds.
Avg Gateway Response Latency (ms.)Average gateway response network latency in milliseconds.
Avg Service Elapsed Time (ms.)Average elapsed time in milliseconds in milliseconds.
Avg Back-End Request - Network Latency (ms.)Average back-end request network latency in milliseconds.
Avg Gateway Request Latency (ms.)Average gateway request network latency in milliseconds.
Avg Back-End Response - Network Latency (ms.)Average back-end response network latency in milliseconds.
Avg Backend Elapsed (ms.)Average back-end elapsed network latency in milliseconds.

Default Sort: Avg Service Elapsed Time (ms.), Descending.


Service Average Request Size

Average request size per service

Available Filters

  • Time Range
  • Device 
  • Domain
  • Service

Summary Table

Column
Description
Service NameService name
ExecutionsNumber of service executions within time range.
Average Request Size (bytes)Average request size in bytes.

Default Sort: Average Request Size (bytes), Descending.


Service Elapsed Time Report

Services ordered by average elapsed time

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
ServiceService name
TransactionsNumber of transactions for the service
Average Time (ms)Average elapsed time across all samples
Maximum Time (ms)Maximum elapsed time across all samples

Default Sort: Average Time (ms), Descending.


Service List Report

Detailed Service List

This report will produce output only when DPOD's service configuration sampling is enabled (it is enabled by default)

Available Filters

  • Time Range
  • Device 

Summary Table 

ColumnDescription
FE Request Queue

Front  end Request Queue

BE Request Queue

Back end Request Queue

FE Service Name

Front end service name

FE Protocol

Front end protocol this service runs on. 

FE Port

Front end TCP port for this service

BE Qmgr Name

Back end Queue Manager for this service (when relevant)

FE URI

Front end URI for this service

FE Address

Front end IP Address for this service.

Domain

The domain this service is deployed on

FE Qmgr NameFront end Queue Manager for this service (when relevant)
Device

The device this service is deployed on

BE Response to QueueFront end Response Queue
Service NameThe service name
FE SOAP version

SOAP Version for this service (where applicable)

BE ProtocolBack end protocol this service runs on. 
FE Response to Queue

Front end Response Queue

BE URIBack end URI for this service
BE Service Type

Back end type of service. (for example, MultiProtocolGateway, XMLFirewallService, etc)

BE PortBack end TCP port for this service
FE QMGR Group

Front end Queue Manager Group for this service (when relevant)

BE AddressBack end IP Address for this service

Service Memory Report

Services ordered by average consumed memory

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
ServiceService name
SamplesNumber of samples for the service
Average Memory (KB)Average memory utilization across all samples
Maximum Memory (KB)Maximum memory utilization across all samples

Default Sort: Average Memory (KB), Descending.


Service Total Errors Report

Services ordered by total number of erroneous transactions

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
DeviceDevice name
ServiceService name
ErrorsTotal number of errors for the service in domain

Default Sort: Errors, Descending.


Service Total Successful Transactions Report

Services ordered by total number of successful transactions

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
ServiceService name
Successful TransactionsTotal number of successful transactions for the service

Default Sort: Successful Transactions, Descending.


Service Total Transactions Report

Services ordered by total number of transactions

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
ServiceService name
TransactionsTotal number of  transactions for the service

Default Sort: Transactions, Descending.


System Errors Report

Critical system error messages

Available Filters

  • Time Range
  • Device 

Summary Table

Column
Description
MessageThe error message key
Count

The number of errors encountered for this message-key

Default Sort: Count, Descending.


Error Details Table

Column
Description

Message

Message text
TimeThe timestamp (to milliseconds) the error was recorded at
Severity

Severity of the error.
Valid Values:

  • error
  • critic 

Device

The name of the device where the error was found

Category

WDP category of the message

Default Sort: Time, Descending.


Total API Executions Report

Total API Executions

Available Filters

  • Time Range
  • Device
  • Domain
  • Catalog
  • Space
  • Product
  • Plan
  • API Name
  • API Version
  • App Name

Summary Table

Column
Description
KeyThe catalog name
doc_countNumber of times the catalog name appeared for the specified filters (time, device, etc)
KeyThe API Name
doc_countNumber of times the API name appeared for the catalog name
KeyThe API Version
doc_countNumber of times the API version appeared for the api name
KeyThe FE Response code
doc_countNumber of times the FE Response code appeared for the api version

Default Sort:  First doc_count, Descending.


Transactions Above Elapsed Time

Transactions with elapsed time greater or equals to a threshold

Available Filters

  • Time Range
  • Device 
  • Domain
  • Service

Summary Table

Column
Description
Elapsed (ms.)The elapsed time in milliseconds of the transaction
TimeTransaction execution time
Transaction IDTransaction id
Client IPThe client IP of the machine (or load balancer) where this transaction started
Device NameDevice executing the transaction
Global Transaction IDGlobal transaction id
Domain NameThe domain on the device

Default Sort: Average Request Size (bytes), Descending.


URI Detailed Latency Report

Detailed URI Latency Report

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

ColumnDescription
Elapsed Time (ms)

The elapsed time in milliseconds of the transaction

DeviceThe device where the transaction Run
Service URIURI of the transaction
DomainThe domain where the transaction Run



URI Summary Latency Report

URI Request Summary Latency List

Available Filters

  • Time Range
  • Device 
  • Domain

Summary Table 

Column
Description
URIURI of the transaction
Total TransactionsHow many transactions run during the time for this URI
90% Percentile(ms)The latency in ms. of the 90% percentile of transactions for this URI
95% Percentile(ms)The latency in ms. of the 95% percentile of transactions for this URI
99% Percentile(ms)The latency in ms. of the 99% percentile of transactions for this URI
Average Time (ms)The latency average in ms. of all transactions for this URI
Minimum Time (ms)The latency in ms. of the transaction with the minimum latency for this URI
Maximum time(ms)The latency in ms. of the transaction with the maximum latency for this URI

Default Sort: Average Time (ms), Descending.


  • No labels