IBM DataPower Operations Dashboard v1.0.21.x

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

Version 1 Current »

All of the reports include a header section at the top with the following information:

  • Report name

  • Description

  • Execution Time

  • Executing user

  • Time

  • Total results

🚀 Jump to a specific report:

API Latency Report | APIC

API Latency

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Catalog

  • Space

  • Product

  • Plan

  • API Name

  • API Version

  • App Name

  • Client IP

📑 Results Table

(info) Default sort: ‘Catalog’ column descending.

Column

Value

Catalog

The catalog name

Catalog Transactions

Number of times the catalog name appeared for the specified filters (e.g. Time, Device)

API

The API name

API Transactions

Number of times the API name appeared for the catalog name

API Version

The API version

API Version Transactions

Number of times the API version appeared for the API name

Frontend HTTP Response Code

The FE Response code

Frontend HTTP Response Code Transactions

Number of times the FE Response code appeared for the api version

Max Total Latency (ms.)

Max total latency

Avg Total Latency (ms.)

Average total latency

Device CPU Report | APIC GATEWAY

Devices ordered by average CPU

🎨 Available Filters

  • Time Range MUST

  • Device

📑 Results Table

(info) Default sort: ‘Average CPU (%)’ column descending.

Column

Value

Device

The device name

Device Samples

Samples recorded for the device

Maximum CPU (%)

Maximum CPU utilization recorded across samples

Average CPU (%)

Average CPU utilization recorded across samples

Device Resources Report | APIC GATEWAY

All device resources samples

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

🎨 Available Filters

  • Time Range MUST

  • Device

📑 Results Table

(info) Default sort: ‘Sample Time’ column ascending.

Column

Value

Device

The device name

Sample Time

Sample time

System Load

System load percentage

Total Installed Memory

Total installed memory in the monitored device

Used CPU (%)

Used CPU percentage

Used Memory (%)

Used memory percentage

Domain Request Size Report | GATEWAY

Domains ordered by total request size

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Client IP

📑 Results Table

(info) Default sort: ‘Total Request Size (bytes)’ column descending.

Column

Value

Domain

The domain name

Transactions

Number of transactions for the domain

Total Request Size (bytes)

Total size of messages for the domain

Domain Total Transactions Report | GATEWAY

Domains ordered by total number of transactions

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Client IP

📑 Results Table

(info) Default sort: ‘Transactions’ column descending.

Column

Value

Domain

The domain name

Transactions

Number of transactions for the domain

Executed Transactions Report | GATEWAY

List of all executed transactions

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Time’ column descending.

Column

Value

Client IP

The client IP of the machine (or load balancer) where this transaction started

Device

The device where the transaction run

Domain

The domain where the transaction run

Service Name

Service name

Time

Transaction execution time

Transaction ID

The transaction id

Message Codes Count Report | APIC GATEWAY

Message codes distribution

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Message Count’ column descending.

Column

Value

Message

The message code (for example 0x80e0068d)

Message Count

Number of times the message code appeared for the specified filters (e.g. Time, Device)

Severity

Message Log level

Severity Count

Number of times the message code appeared for the log level

Service Average Latency Report | GATEWAY

Average latency report per services

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Avg Service Elapsed Time (ms.)’ column descending.

Column

Value

Service

The service name

Transactions

Number of service executions within time range.

Avg Gateway Response Latency (ms.)

Average gateway response 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.

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 Front-End Response - Network Latency (ms.)

Average front-end response network latency in milliseconds.

Avg Service Elapsed Time (ms.)

Average elapsed time in milliseconds.

Avg Front-End Request - Network Latency (ms.)

Average front-end request network latency in milliseconds.

Service Average Request Size | GATEWAY

Average request size per service

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Average Request Size (bytes)’ column descending.

Column

Value

Service

The service name

Transactions

Number of service executions within time range.

Average Request Size (bytes)

Average request size in bytes.

Service Elapsed Time Report | GATEWAY

Services ordered by average elapsed time

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Client IP

📑 Results Table

(info) Default sort: ‘Average Time (ms)’ column descending.

Column

Value

Service

The service name

Transactions

Number of service executions within time range.

Maximum Time (ms)

Maximum elapsed time across all samples

Average Time (ms)

Average elapsed time across all samples

Service Latency Report - Extended | GATEWAY

Service Latency Report - Extended. Latency data for all transactions that ended successfully, similar to the Service Average Latency Report.

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Client IP

📑 Results Table

Column

Value

BE Req Network latency

Back-end request network latency in milliseconds

BE Res Network latency

Back-end response network latency in milliseconds.

Backend Elapsed

Back-end elapsed network latency in milliseconds.

DataPower Total

DataPower total elapsed network latency in milliseconds.

Device

The device name where the transaction run.

Domain

The domain name where the transaction run.

Elapsed Time (ms)

The service elapsed network latency in milliseconds.

FE Req Network latency

Front-end request network latency in milliseconds.

FE Res Network latency

Front-end response network latency in milliseconds.

Inside DataPower Req Latency

DataPower request latency.

Inside DataPower Res Latency

DataPower response latency.

Service

The service name

Service URI

The service URI

Transaction ID

The transaction ID

Service List Report | GATEWAY

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 MUST

  • Device

  • Domain

  • Service

📑 Results Table

Column

Value

BE Address

Back end IP address for this service

BE Port

Back end TCP port for this service

BE Protocol

Back end protocol this service runs on

BE Qmgr Name

Back end queue manager for this service (when relevant)

BE Request Queue

Back end request queue

BE Response to Queue

Back end response queue

BE Service Type

Back end type of service (e.g. ‘MultiProtocolGateway’, ‘XMLFirewallService’)

BE URI

Back end URI for this service

Device

The device name

Domain

The domain name

FE Address

Front end IP address for this service

FE Port

Front end TCP port for this service

FE Protocol

Front end protocol this service runs on

FE QMGR Group

Front end queue manager group for this service (when relevant)

FE Qmgr Name

Front end queue manager for this service (when relevant)

FE Request Queue

Front end request queue

FE Response to Queue

Front end response queue

FE SOAP version

SOAP version for this service (when applicable)

FE Service Name

Front end service name

FE URI

Front end URI for this service

Service Name

The service name.

Service Memory Report | GATEWAY

Services ordered by average consumed memory

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

📑 Results Table

(info) Default sort: ‘Average Memory (KB)’ column descending.

Column

Value

Service

The service name

Samples

Number of samples for the service

Maximum Memory (KB)

Maximum memory utilization across all samples

Average Memory (KB)

Average memory utilization across all samples

Service Request/Response Size Stats Report | GATEWAY

Service Request/Response Size Statistics

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Transactions’ column descending.

Column

Value

Device

The device name

Device Transactions

Total number of transactions for this gateway

Domain

The domain name

Domain Transactions

Total number of transactions for this domain

Service

The service name

Service Transactions

Total number of transactions for this service

Min Response Size (bytes)

Minimum response size in bytes.

Max Request Size (bytes)

Minimum request size in bytes.

Avg Response Size (bytes)

Average response size in bytes.

Max Response Size (bytes)

Max response size in bytes.

Avg Request Size (bytes)

Average request size in bytes.

Min Request Size (bytes)

Minimum request size in bytes.

Service Total Errors Report | GATEWAY

Services ordered by total number of erroneous transactions

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Errors’ column descending.

Column

Value

Service

The service name

Errors

Total number of errors for the service in domain

Service Total Successful Transactions Report | GATEWAY

Services ordered by total number of successful transactions

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Successful Transactions’ column descending.

Column

Value

Service

The service name

Successful Transactions

Total number of successful transactions for the service

Service Total Transactions Report | GATEWAY

Services ordered by total number of transactions

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Transactions’ column descending.

Column

Value

Service

The service name

Transactions

Total number of  transactions for the service

Service and URI Total Transactions Report | GATEWAY

Services and URIs ordered by number of transactions

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Transactions’ column descending.

Column

Value

Service

The service name

Service Transactions

Total number of  transactions for the service

URI

The service URI

URI Transactions

Total number of  transactions for the URI

System Errors Report | APIC GATEWAY

Critical system error messages

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Summary Results Table

(info) Default sort: ‘Count’ column descending.

Column

Value

Message

The error message text

Count

The number of errors encountered for this message-text

📑 Error Details Table

(info) Default sort: ‘Time’ column descending.

Column

Value

Category

WDP category of the message

Device

The name of the device where the error was found

Message

Message text

Severity

Severity of the error. Valid Values:

  • error

  • critic 

Time

The time (DD/MM/YYYY HH:MM:SS.SSS) the error was recorded at

Top Documents Count per Agent per Interval | APIC GATEWAY

Time intervals with highest number of documents per Syslog agent

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

🗃️ Parameters

Name

Description

Default value

interval

Sample interval - for example 1s=1 second, 1m= 1 minute

1s

howManyResults

Number of top intervals to return, the max value is 65535

100

📑 Results Table

(info) Default sort: ‘Document Per Interval’ column descending.

Column

Value

Agent

Syslog agent name

Messages

Syslog messages per agent

Epoch Time

Epoch Time starting the interval

Document Per Interval

Syslog documents per interval (report interval parameter)

Top Documents Count per Interval | APIC GATEWAY

Time intervals with highest number of documents

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

🗃️ Parameters

Name

Description

Default value

interval

Sample interval - for example 1s=1 second, 1m= 1 minute

1s

howManyResults

Number of top intervals to return, the max value is 65535

100

📑 Results Table

(info) Default sort: ‘Document Per Interval’ column descending.

Column

Value

Epoch Time

Epoch Time starting the interval

Document Per Interval

Syslog documents per interval (report interval parameter)

Top Transactions Count per Interval | APIC GATEWAY

Time intervals with highest number of transactions (default is 1 second)

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

🗃️ Parameters

Name

Description

Default value

interval

Sample interval - for example 1s=1 second, 1m= 1 minute

1s

howManyResults

Number of top intervals to return, the max value is 65535

100

📑 Results Table

(info) Default sort: ‘Transactions per Interval’ column descending.

Column

Value

Epoch Time

The device name

Transactions per Interval

Transactions per interval (report interval parameter)

Total API Executions Report | APIC

Total API Executions

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Catalog

  • Space

  • Product

  • Plan

  • API Name

  • API Version

  • App Name

  • Client IP

📑 Results Table

(info) Default sort: ‘Catalog Transactions’ column descending.

Column

Value

Catalog

The catalog name

Catalog transactions

Number of times the catalog name appeared for the specified filters (e.g. ‘Time’, ‘Device’)

API

The API name

API Transactions

Number of times the API name appeared for the catalog name

API Version

The API version

API Version Transactions

Number of times the API version appeared for the API name

Frontend HTTP Response Code

The FE Response code

Frontend HTTP Response Code Transactions

Number of times the FE Response code appeared for the api version

Transactions Above Elapsed Time | GATEWAY

Transactions with elapsed time greater or equals to a threshold

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

🗃️ Parameters

Name

Description

Default value

minElapsedTime

Minimum elapsed time of the transaction

100

📑 Results Table

(info) Default sort: ‘Average Request Size (bytes)’ column descending.

Column

Value

Client IP

The client IP of the machine (or load balancer) where this transaction started

Device

Device executing the transaction

Domain

The domain on the device

Elapsed (ms.)

The elapsed time in milliseconds of the transaction

Global Transaction ID

The global transaction ID

Service

The service name

Time

The time (DD/MM/YYYY HH:MM:SS.SSS) the error was recorded at

Transaction ID

The transaction ID

Transactions Latency Statistics Report | GATEWAY

Transactions Latency Statistics. Detailed transaction latency separated for each gateway, domain and service

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Maximum Time (ms)’ column (per domain, per device) descending.

Column

Value

Device

The device name

Device Transactions

Total number of transactions for this device

Device Avg Time (ms)

Average latency in ms. for all transactions in this device

Domain

The domain name

Domain Transactions

Total number of transactions for this domain

Service

The service name

Service Transactions

Total number of transactions for this service

Minimum Time (ms)

The minimum transaction time for this service

Avg Time (ms)

The average transaction time for this service

Avg Time on DP (ms)

Average latency in ms. for all transactions of this service

90% Percentile (ms)

The latency in ms. of the 90% percentile of transactions for this service

95% Percentile (ms)

The latency in ms. of the 95% percentile of transactions for this service

99% Percentile (ms)

The latency in ms. of the 99% percentile of transactions for this service

Maximum Time (ms)

The maximum transaction time for this service

Domain Avg Time (ms)

Average latency in ms. for all transactions in this domain

URI Detailed Latency Report | GATEWAY

Detailed URI Latency Report

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

Column

Value

Device

The device where the transaction Run

Domain

The domain where the transaction Run

Elapsed Time (ms)

The elapsed time in milliseconds of the transaction

Service URI

URI of the transaction

URI Summary Latency Report | GATEWAY

URI Request Summary Latency List

🎨 Available Filters

  • Time Range MUST

  • Device

  • Domain

  • Service

  • Client IP

📑 Results Table

(info) Default sort: ‘Average Time (ms)’ column descending.

Column

Value

URI

URI of the transaction

Total Transactions

How 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

Maximum Time (ms)

The latency in ms. of the transaction with the maximum latency 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

  • No labels

Copyright © 2015 MonTier Software (2015) Ltd.