Runtime Dashboard

Runtime dashboard

A runtime dashboard is a system monitoring tool that

  • displays real-time summaries of business API (BAPI) activity and performance,

  • presents event statuses such as REST endpoint interactions and integration flows, and

  • shows device synchronization status with Configuration Management Database (CMDB).

At a high level, APIs are categorized into business APIs (BAPIs) and registered APIs (RAPIs). The Runtime Dashboard only displays information for BAPIs, not RAPIs. It offers a quick overview of these summaries:

  • API Summary: Summary of recent API calls, results, and performances. You can click View Details to access information about individual API call counts and call durations.

    The Runtime Dashboard only displays data from a Catalyst Center-to-ServiceNow API integration.

  • Event Summary: Catalyst Center events involving REST endpoints or integration flows. Click an event name (link) to open a slide-in pane with additional detailed event information.

  • CMDB Synchronization Summary: Summary that displays the Configuration Management Database (CMDB) synchronization status of devices selected from Inventory.

  • Integration Flow Summary: Summary of integration flow instances, results, and performance. Click the appropriate tab to view additional detailed information about either the REST-based or schedule-based integration flows.

Review the event summary

Follow these steps to review the Catalyst Center platform Event Summary.


Note

The Event Summary displays the total number of events published to external systems, based on the type of event. You can use the Event Summary to assist in monitoring and troubleshooting the Catalyst Center platform and its integration with other systems. Review the Event Summary in the Runtime Dashboard window in the Catalyst Center GUI.

Before you begin

  • Ensure bundles are enabled, configured, and activated in Bundles.

  • Enable associated event notifications for bundles in Event Settings.

For information about Bundles, see Bundle features. For information about Event Settings, see Configure event settings.

Procedure

Step 1

From the main menu, choose Platform > Runtime Dashboard.

Step 2

Choose a time interval for the event summary by clicking Last 1 Week at the top of the GUI menu bar.

You can view the event summary for the last six-hour, twelve-hour, or twenty-four-hour period, or for the last week.

Step 3

Review the Event Summary section in the Runtime Dashboard window.

Figure 1. Events Summary
Figure 37: Displays Event Summary window.

This information appears for any current events:

  • Events Published: Total number of events that are captured and published (displayed in the GUI) by the Catalyst Center platform.

  • Event Severity: Event totals by severity number from one to five.

  • Count: Number of events.

  • Events: The list shows events grouped by domain (category), with event name (as links), and count (number of events).

Note

 

Scroll to view the entire list using the scroll bar.

Step 4

Click an event name (link) to view additional detailed data.

For example, if the events Router Unreachable or BGP Tunnel Connectivity exist in your GUI window, click the link.

After clicking an event name (link), the system opens a slide-in pane.

Step 5

View a list of this type of event (history) in the slide-in pane.

Figure 2. Event history
Figure 38: Displays Event History window.

Each event includes these details.

  • Event ID: displays the Catalyst Center event identification number generated by Catalyst Center.

  • Source: indicates the location from where event originated. For example, the Catalyst Center platform or an IT Service Management (ITSM) system, such as ServiceNow.

  • Destination: indicates the location to which the event was directed. For example, the Catalyst Center platform or an ITSM system, such as ServiceNow.

  • ITSM Workflow: displays the type of ITSM workflow, such as an Incident or Problem.

  • ITSM Status: shows the current status of the event. For example, an event can have a status of Open, New, Closed, or N/A.

  • ITSM ID: displays the ITSM event identification number generated by the ITSM, such as ServiceNow.

  • ITSM Link: displays a link to the ITSM server for the ITSM event.

  • ITSM Last Updated Time: shows the last date and time of event update.

  • ITSM Entity Severity/Priority: indicates ITSM severity or priority assigned to the event.

  • Event Severity: indicates the Catalyst Center severity assigned to the event from one to five.

You can adjust the events that show in the table by clicking the Filter icon and using the filter, or by entering a keyword in Find.

Step 6

Click an event ID number (link) to view only data associated with that specific event.

When you click an event ID number (link), the system opens a slide-in pane.

Step 7

View the event ID data in the slide-in pane.

Figure 3. Event ID data
Figure 39: Displays Event ID data.

The slide-in pane shows information of this single event.

  • Source: shows the location from where the event originated, such as the Catalyst Center platform.

  • Destination: indicates the location to which the event was directed to. For example, the REST Endpoint.

  • ITSM Workflow: shows the type of ITSM workflow, such as an Incident or Problem).

  • ITSM Status: indicates the current status of the event. For example, an event can have a status of Open, New, or Resolved.

  • ITSM ID: displays the ITSM event identification number.

  • ITSM Link: gives the link to the ITSM, such as ServiceNow.

  • ITSM Last Updated Time: indicates the last date and time of event update.

  • ITSM Entity Severity/Priority: displays the ITSM severity or priority assigned to the event.

  • Event Severity: shows the Catalyst Center severity assigned to the event from one to five.

To close the slide-in pane and return to the previous window, click the event link at the top left of the window.

To close the slide-in pane in the new window and return to the Runtime Dashboard, click the link at the top left again.

Step 8

(Optional) Click the ITSM Link to open up and access the ITSM program (ServiceNow Service Management GUI) and specific incident.

Figure 4. ServiceNow Incident
Figure 40: Displays ServiceNow incident.

Note

 

To make the Runtime event link to the ITSM program operational, set up the Catalyst Center platform integration to ServiceNow as described in the Cisco Catalyst Center ITSM Integration Guide.

Step 9

(Optional) Click the Cisco Catalyst tab in the ServiceNow Service Management GUI to review details about the event.

Figure 5. Cisco Catalyst tab
Figure 41: Displays Cisco DNA tab.

This information is available from the Cisco Catalyst tab:

  • Cisco Catalyst Center IP Address

  • Cisco 360 View

  • Cisco Catalyst Network Details

  • Cisco Catalyst Event Domain

  • Cisco Catalyst Event Details and Suggested Actions

  • Cisco Catalyst Event ID

  • Approval Status

Retry an ITSM event

You can retry, resend and reprocess an IT Service Management (ITSM) event from the Catalyst Center platform to an ITSM, such as ServiceNow, using the Event Summary window of the Catalyst Center GUI.

The Event Summary window in Runtime Dashboard displays the total number of events that are published to external systems, based on the type of event. Use the Event Summary to monitor and troubleshoot the Catalyst Center platform and its integration with other systems.

Before you begin

  • Enable, configure, and activate the necessary bundles in Bundles.

  • Enable associated event notifications for these bundles in Event Settings.

Procedure

Step 1

From the main menu, choose Platform > Runtime Dashboard.

Step 2

Choose a time interval for the event summary. Click Last 1 Week in the GUI menu bar.

You can view the event summary for the past six-hour, twelve-hour, or twenty-four-hour period, or for the week.

Step 3

Review the Event Summary section in the Runtime Dashboard window.

View these details about any of the current events.

  • Events Published: indicates the total number of events that are captured and published (displayed in the GUI) by the Catalyst Center platform.

  • Event Severity: shows event totals by severity number, from one to five.

  • Count: indicates the number of events.

  • Events: lists events by domain (category), event name (links), and count (the number of events).

Note

 

Use the scroll bar to view all events in the list.

Step 4

Click an ITSM event name (link) to view detailed data.

If the ITSM event SWIM Upgrade Request Creation Image Activation appears, click the link.

After you click an event name (link), a slide-in pane opens.

Step 5

Review the event history for this type of event in the slide-in pane.

Figure 6. Event history
Figure 42: List of events in slide-in panel.

Each event provides these details.

  • Event ID: Catalyst Center event identification number generated by Catalyst Center.

  • Source: location from where event originated. For example, the Catalyst Center platform or an ITSM system such as ServiceNow.

  • Destination: location for where the event was directed to. For example, the Catalyst Center platform or an ITSM system such as ServiceNow.

  • ITSM Workflow: type of ITSM workflow (for example, an Incident or Problem).

  • ITSM Status: current status of the event. For example, an event can have a status of Open, New, Closed, N/A, or Resolved.

  • ITSM ID: ITSM event identification number generated by the ITSM such as ServiceNow.

  • ITSM Link: link to ITSM server for the ITSM event.

  • ITSM Last Updated Time: last date and time of event update.

  • ITSM Entity Severity/Priority: ITSM severity or priority that is assigned to the event.

  • Event Severity: Catalyst Center severity that is assigned to the event, from one to five.

You can adjust the events that are displayed in the table by clicking the Filter icon and using the filter, or by entering a keyword in the Find field.

Step 6

Determine which ITSM events must be resent and reprocessed.

If an ITSM event displays N/A for ITSM Workflow, ITSM Status, or ITSM ID and the source is ServiceNow, and the destination is Catalyst Center, retry the event. A check box appears under the Filter column for these events.

Step 7

Check the check box in the Filter column to select an ITSM event and enable the Retry button.

Step 8

Click Retry.

After the event is resent to the ITSM destination, one of these may occur:

  • Retry Success: appropriate values are displayed in the ITSM Workflow, ITSM Status, and ITSM ID columns for the event. For example, RFC in the ITSM Workflow column, New in the ITSM Status column, and an alphanumeric ID for the ITSM ID.

  • Retry Failure: if the event retry fails, then the ITSM event will still display N/A as a value for ITSM Workflow, ITSM Status, or ITSM ID. See the next step for working with a second retry failure.

Step 9

(Optional) After another retry failure, in the Catalyst Center GUI, click the menu icon and choose Platform > Developer Toolkit > APIs > Ecosystem Integrations > ITSM > Get Failed ITSM Events.

Access this API method to retrieve information about the ITSM integration failure.

Step 10

Click Try It and enter the instance ID (instanceId) for the failed event from the Runtime Dashboard.

Step 11

Click Run.

You can retrieve this response data using the API:

  • eventStatus: ITSM (ServiceNow) event status.

  • errorCode: ITSM (ServiceNow) event error code.

  • errorDescription: description of the ITSM (ServiceNow) event error.

  • responseReceivedFromITSMSystem: ITSM (ServiceNow) response.

Use the information retrieved by the API to understand and correct the event failure.

Review API summary

Before you begin

  • Enable, configure, and activate the bundles that generate the events you want to monitor.

  • Locate and manage these in the Bundles list.

For information about Bundles, see Bundle features.

Procedure

Step 1

From the main menu, choose Platform > Runtime Dashboard.

Step 2

To select a time interval for the API summary, click Last 1 Week at the upper right side of the GUI.

You can view the API summary for the last six-hour, twelve-hour, or twenty-four-hour period, or for the last week.

Step 3

Review the API Summary field.

You see these details in the API Summary field.

  • Call Status: displays the total number of API calls and status display. Green represents successful API calls, and red represents unsuccessful API calls.

  • Completed Call Performance: this section lists API calls in alphabetical order with completed-call performance in seconds: low, average, high.

  • View Details: use this link to view additional API details.

Step 4

Click View Details to see more details about the APIs.

The All APIs calls slide-in pane opens.

Step 5

Review these details in the All APIs calls slide-in pane.

  • API name

  • API version

  • API call count table

    Note

     

    The table includes the total number of API calls, number of successful API calls (green icon), and number of unsuccessful API calls (red icon).

  • API call duration table

    Note

     

    The table includes minimum, maximum, and average duration.

To adjust the APIs that display in the tables, click the Filter icon and apply a filter, or enter a keyword in the Find field.

Review the CMDB synchronization summary

Follow this procedure to review the Catalyst Center platform CMDB Synchronization Summary. The CMDB Synchronization Summary displays the synchronization status of inventory device data to ServiceNow, which helps you monitor and troubleshoot device data synchronization issues.

To check the CMDB Synchronization Summary, use the Runtime Dashboard window in the Catalyst Center GUI.

Figure 7. Catalyst Center Platform Runtime window
Screenshot of the Runtime Dashboard displaying the CMDB Synchronization Summary, including device status, failures, and summary metrics.

Before you begin

  • Ensure that bundles are enabled, configured, and activated in the Bundles section.

  • Enable associated event notifications for these bundles in Event Settings.

    For details about bundles and event settings, see Bundle features and Configure event settings.

Procedure

Step 1

From the main menu, choose Platform > Runtime Dashboard.

Step 2

Check the CMDB Synchronization Summary field, which displays these details.

  • Devices from inventory: displays the total number of devices from Inventory collected from Catalyst Center.

  • Devices synchronized: shows the list of devices that were successfully synchronized with ServiceNow.

  • Failures: shows the number of failed synchronization attempts between Catalyst Center and ServiceNow.

    Click Learn More for additional information.

  • Unknown Synch Errors: shows the number of partially successful synchronization attempts between Catalyst Center and ServiceNow

    Click Learn More for additional information.

  • Synchronization Attempt: displays details about when the last synchronization attempt was made between Catalyst Center and ServiceNow.

Step 3

(Optional) Click the Learn More link for any synchronization failure.

Step 4

Check the device’s synchronization failure data on the screen.

This information appears in a table.

  • Device ID: is the device identification number.

  • Host Name: name of the host to which the device is connected.

  • Device Type: type of device, such as a switch, a router, or an access point.

  • MAC Address: is the MAC address of the device.

  • Management IP Address: the management address of the device that can be used to access and troubleshoot the device.

  • Serial Number: serial number of the device.

Step 5

Click the DeviceID link to review additional information about the device in the Inventory window.

Review the integration flow summary

Review the Catalyst Center platform Integration Flow Summary. Use the Integration Flow Summary to monitor the performance of the Catalyst Center platform integration flows. Use this information to monitor or troubleshoot Catalyst Center platform and its integration with other systems.

You review the Integration Flow Summary using the Runtime Dashboard window in the Catalyst Center GUI.

Figure 8. Catalyst Center Platform Runtime Dashboard window
Integration Flow Summary

Before you begin

Enable, configure, and activate the bundles that provide the events you want to monitor in Bundles to display data in the Integration Flow Summary fields (two tabs). For information about Bundles, see Bundle features.

Procedure

Step 1

From the main menu, choose Platform > Runtime Dashboard.

Step 2

Click Last 1 Week at the upper right side of the GUI menu bar to choose a time interval for the integration flow summary.

You can view the integration flow summary for the last six-hour, twelve-hour, or twenty-four-hour period, or for the last week.

Step 3

Review the details in the Integration Flow Summary field.

  • REST-Based: displays domain, integration flow name and link, version, instance totals, instance status (successful [green], fail [red], in progress [blue]), and performance that gives the minimum, maximum, and average call performance times (in milliseconds).

  • Schedule-Based: displays domain, integration flow name and link, version, instance totals, instance status (successful [green], fail [red], in progress [blue]), and performance that gives the minimum, maximum, and average call performance times (in milliseconds).

Step 4

Click the REST-Based tab to view a summary of data generated by REST-based integration flows

Step 5

Review the REST-Based data.

Click an integration flow name (link) to see more details about the instances. This information appears in a slide-in pane:

  • Instance ID: identification number (and link) of the instance to the integration flow.

    Note

     

    You can configure an instance to more than one integration flow.

  • Status: status of the instance (success or fail).

  • Start Time: start date and time of the instance call.

  • End Time: end date and time of the instance call.

  • Duration: duration of the call in seconds.

Step 6

Click an instance ID (link) to view its details.

The slide-in pane shows these additional information.

  • RUN SUMMARY: start and end times and dates, time taken, status.

  • ERRORS: error responses (if any).

  • LOGS: log entries (if available).

Click the X icon to close the slide-in pane and return to the previous screen.

Step 7

Click the Schedule-Based tab to view a summary of data generated by schedule-based integration flows.

Step 8

Review the Schedule-Based data.

Click an integration flow name (link) to view additional information about the instances. This additional information appears in a slide-in pane:

  • Instance ID: identification number of the instance within the integration flow.

  • Status: status of the instance (success or fail).

  • Start Time: start date and time of the instance call.

  • End Time: end date and time of the instance call.

  • Duration: duration of call, in seconds.

Step 9

Click an individual instance ID (link) to view detailed information about it.

The slide-in pane displays these details.

  • RUN SUMMARY: start and end times and dates, time taken, status.

  • ERRORS: error responses (if any).

  • LOGS: log entries (if available).

Click the X icon to close the slide-in pane and return to the previous window.