Operations Dashboard

A guide to Operations Dashboard tracing capability within IBM® Cloud Pak for Integration.

Overview

New in version 2019.3.2.2 The ability to trace transactions through IBM Cloud Pak for Integration is provided by the Operational Dashboard.

Trace data cannot be collected from Integration products deployed outside of the IBM Cloud Pak for Integration platform.

Note: You must purchase an additional license to remove the usage limitations of this add-on capability. Without this license, the following limitations are valid.
  • Trace data for the IBM Cloud Pak for Integration Operations Dashboard generated from any of the IBM Cloud Pak for Integration products cannot be exported or used outside of the IBM Cloud Pak for Integration Operations Dashboard.
  • Spans are available for a limited duration based on the following conditions:
    • Maximum duration of two hours
    • When the total number of spans within the IBM Cloud Pak for Integration platform reaches one million.
    If any of these conditions are reached, new spans will replace existing spans that have met the established limit. Trace data consists of multiple spans each containing runtime execution data from one or more IBM Cloud Pak for Integration products.
See Product activation to remove these limits.

Installation

You install the Operations Dashboard through the Platform Navigator. Follow the Installation Guide to complete the installation.

Capability registration

Any running or new capabilities deployed with tracing enabled require registration with the Dashboard. See Register Capability for more information.

Using the Operations Dashboard

Once installed, you access the Operations Dashboard through the Platform Navigator. Click the menu icon and then Tracing.

Platform Navigator

The Operations Dashboard collects data from all the registered capabilities (such as MQ) in real time. By default, ten percent (10%) of traffic is sampled. See Sampling policy to change this value.

Here are the navigation options.

Table 1. Options
Dashboard icon Overview Aggregate data dashboards. User-defined filters can be added to the display.
Investigate icon Investigate Transactions trace information available on a per-trace basis, across capabilities.
Reports icon Reports/Alerts Reports and alerts.
Manage icon Manage Manage settings, such as capability registrations, access security and activation key.

Overview

Click the Dashboard icon Overview icon. Here you see a set of dashboard data displays. These displays are automatically generated.

Op Dashboard

Click Filter icon Add Filter to control the data included in the displays. See Filters.

Click the share icon icon to export or share data. The data can be emailed or accessed through a URL. See SMTP.

Click the Refresh icon icon to refresh the display.

Click the Options icon icon to set the interval to automatically refresh the display.

Investigating traces

Click the Investigate icon Investigate icon. A list of available traces appears.

Traces

 

You can search, filter, refresh, save and page through the listed traces. Click any trace to see detailed information about that trace. A trace consists of one or more spans. For more information about spans, see OpenTracing spans. A span has elapsed time (start and finish), and context information (baggage/tags). Each span has some different latency meaning. For example, for App Connect there will be a span to measure just the start of the MSGFlow, another one for the entire message flow, and another for each node the send and receive HTTP or MQ. Hover over a span to see additional information.

 

Traces

Click Filter icon Add Filter to select the data to display. See Filters.

Click the share icon icon to export or share data The data can be emailed or accessed through a URL. See SMTP.

Click the Refresh icon icon to refresh the display.

Click the Options icon icon to set the interval to automatically refresh the display.

Reports and alerts

Click the Reports icon Reports icon. A list of available reports and alerts appears.

Reports

Note: Reports are automatically generated.

You need to provide some configuration values to use reports and alerts. See Parameters.

Click the share icon icon to export or share report data The report can be emailed or accessed through a URL created for the report. Note you must configure an SMTP connection to send emails. See SMTP.

Click the Refresh icon icon to refresh the display.

Click the Options icon icon to set the interval to automatically refresh the display.

Management

Click the Manage icon Manage icon. Here you can manage capability registrations, system parameters and monitor system health.

Manage

  • Registration requests

    Click Registration requests to manage requests by capabilities to provide data. See Register Capability for more information.

  • Sampling policy

    Click Sampling Policy to change the percentage of traffic. The maximum value is 100. The default is 10.

  • Security

    Access to the Dashboard is controlled by Roles. are defined using teams that are assigned with Kubernetes namespaces or a custom CRN. See Create and manage teams for more information about teams.

  • Product activation

    Click Product activation to upload the necessary key to upgrade the product to unlimited capability. You need to obtain an activation key from Passport Advantage®. Click Upgrade to enter the activation key.

    Activation

  • SMTP settings

    Click System Parameters > SMTP to enable sending email. A valid configuration is required to send email.

  • Reports and Alerts settings

    Click System Parameters > Reports & Alerts to configure sending reports and alerts.

Filters

Filters select the data to display. Click Add Filter to create a new filter. Click existing filters to modify or remove the filter.

You can exclude data from the display by creating a filter, which by default includes that data, and then inverting the filter by clicking the filter and selecting Invert.

Invert filter

Note these filters work at the span rather than trace level. In some cases, a span contained in the trace may match the filter and is included (or excluded) from the display while other spans from the same trace do not match the filter. As long as one span matches, the trace will still appear in the displayed list.

Here is a list of commonly used filters.

Table 2. General Filters
General Filter Use and effect
Time Spans occurring at the designated time
Integration capability (product) Limit to one of App Connect, API Connect, or MQ
Operation The operation of the span. For example, the URI of an API, the name of the message queue in MQ, the name of the message flow in App Connect, the type of the API assembly or message flow node
Span duration Duration equal to or greater than value
Is error 'True' will filter only spans that reported errors
Is root span The root/first span of a trace. In each trace there is only one root span that started that trace.
Trace ID / Span ID Match trace or span by ID
Table 3. App Connect Filters
App Connect Filter Use and effect
Integration node name Specify node name
Integration server name Specify server name
Application name Specify application name
Flow name Specify flow name
Node type Specify node type
Node label Specify node type
Trace ID / Span ID Match trace or span by ID
Table 4. API Connect Filters
API Connect Filter Use and effect
Appliance Specify appliance name
Domain Specify domain name
Provider org Specify provider org name
Catalog name Specify catalog name
API name Specify API name
API version Specify API version
Transaction ID Specify Transaction ID
Table 5. MQ Filters
MQ Filter Use and effect
Queue manager name Specify queue manager name
MQ operation Specify operation name
MQMD message ID Specify message ID
Comp code Specify comp code
Reason code Specify reason code

You can use multiple filters to target very specific spans.