DevOps System Health dashboard

  • Release version: Washingtondc
  • Updated August 1, 2024
  • 3 minutes to read
  • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of DevOps System Health dashboard

    The DevOps System Health dashboard provides administrators with insight into the overall health of integrations and connectivity, as well as trends in inbound event processing. It is essential for monitoring the performance and status of a DevOps environment, available to users with thesndevops.adminrole, and requires DevOps data model version 1.33 or later.

    Show full answer Show less

    Key Features

    • Event Tracking: Monitor daily trends in event counts, including total counts and distributions by state and tool.
    • Connectivity Status: View the connectivity status of integrated tools with a dedicated report showing connection health and historical data.
    • Email Notifications: Receive weekly summaries of system health performance indicators, sent to users in the DevOps Report user group.
    • Interactive Charts: Analyze system health and inbound event processing through visual data representations, noting that scores may not reflect real-time statuses.

    Key Outcomes

    By utilizing the System Health dashboard, ServiceNow customers can effectively track and manage the health of their DevOps environment, ensuring timely responses to connectivity issues and event processing. The dashboard aids in proactive monitoring, thereby enhancing overall operational efficiency and reliability of integrations.

    The System Health dashboard lets the DevOps administrator view the overall health of integrations, connectivity status, as well as view trends of inbound event processing data.

    Role required: sn_devops.admin
    Note:
    The DevOps System Health dashboard is available only in DevOps data model 1.33 and later versions.
    Use the System Health dashboard to track the health, event status, and connectivity status of your DevOps environment. Interactive charts enable you to view and analyze the system health and inbound event processing details.
    Note:
    • Scores aren’t real-time. For example, if the chart displays that two events are in the waiting state, the events could have already moved to the completed state.
    • Because the scores are fetched from formula indicators, you can’t drill down to the records in the KPI page.
    Figure 1. DevOps System Health Dashboard
    DevOps System Health Dashboard

    Events

    From the DevOps Change Workspace, navigate to Administration > System health > System health dashboard.

    Report Type Description
    Event count Count trend Daily trending total count of DevOps events.

    The report displays the percentage and count, which is the last 7 running sum.

    Total count includes events from [sn_devops_inbound_event], [sn_devops_event], and the [sn_devops_processed_event] tables.

    Events by state Pie chart Total count DevOps events distributed by current state.
    Events by tool Pie chart Total count of DevOps events, distributed by tool.
    Retry count Count trend Daily trend of the count of total retried DevOps.

    The report displays the percentage and count variance in the last 24 hours.

    Processed count Count trend Daily trend of the total count of processed DevOps events.

    The report displays the percentage and count variance in the last 24 hours.

    Error count Count trend Daily trend of the total count of DevOps events in error state.

    The report displays the percentage and count variance in the last 24 hours.

    Waiting count Count trend Daily trend of the total count of DevOps events in waiting state.

    The report displays the percentage and count variance in the last 24 hours.

    Event trend Line trend Total trending count of DevOps events.

    The report displays the percentage and count variance in the last 24 hours.

    Processing duration Line trend Processing duration of events (in seconds) measured daily.

    Tool connectivity

    The Tool connectivity status report displays the connectivity status with details of all the integrated tools. The tool connectivity table displays the connection status for each connected tool. A background job tries to connect to the tools every hour and maintains the connection history. You can view the historical details under a new related list on the tools page.

    To see the report, from the DevOps Change Workspace, navigate to Administration > System health > Tool connectivity.

    Tool connectivity list.

    System health email notifications

    A base system DevOps Report group is added by default. An email notification summarizing the weekly System Health report is sent to the users in this DevOps Report user group that is specified in the Who will receive related list of the System Notifications > Email Notifications form, as configured in the base system DevOps Health Report notification. For more information, see Email notifications.
    Note:
    • Add users with DevOps Admin (sn_devops.admin) role to the DevOps Report user group.
    • You need to remove a user from the group to unsubscribe the user from receiving notifications.
    The base-system email notification contains and displays a comparative digest of key system health performance indicators as compared to their performance in the previous weekly report. The comparative data is sourced from relevant tables and calculated based on required indicators using the date range specified in weekly report. The comparative data and indicators always display with respect to the same tables and indicators vis-a-vis, the data collected against the relevant reports and indicator data for the previous week.

    To configure the frequency in which the base system email notification is sent out. Navigate to System Scheduler > Scheduled Jobs > Trigger DevOps Health Check Email Notification and select the Configure Job Notification related link, and make the schedule changes.

    If you want to modify the users who receive the email notification, modify the user group specified in the Groups field of the Who will receive section. Navigate to System Notification > Email > Notification > DevOps Health Script. For more information, see Add a user to a group.

    Use the Preview Notification option to check your notification.

    For example, you can see which users will or will not receive the notification, along with what instance details and period for which the notification is sent.

    Preview for System health notification email