Pipeline overview

Use the Pipeline Overview tab to see the overall status and trend of your pipeline, and gain insights into what might be causing failures.

Pipeline overview widgets

Select a pipeline from the top bar to see its overview data in the central pane.

Tip: If you do not see the Overview pane, select the pipeline root node in the left pane's tree view.

  • The Overview widgets show summary information about the selected pipeline's latest or most recent pipeline runs. By default, the dashboard shows how many failed tests and builds are currently being investigated, which tests are problematic, and which application areas are affected.

    Press + to add other widgets from the DevOps & Analytics widget gallery or create your own widgets. For example, you could add widgets that show code coverage per package and file, as well as code coverage trends over time, based on code coverage reports from Jenkins. For details, see Track code coverage in pipeline runs.

    Tip: To remove a widget, click the widget menu button in the right corner of the widget, and select Remove.

  • The Pipeline Issue Summary cards show you the most critical problems in the selected pipeline so you know what to fix first. ALM Octane analyzes information regarding failed tests, problematic tests, build failure classification, related committers, and more. This data is then used to give CI owners actionable information, to fix failed pipelines quickly. For details, see Pipeline Issue Summary cards, below.

  • Application modules with failed test runs: 

    See which application modules have the most failing tests.

    Lists the application modules currently associated with automated tests that failed in this pipeline run. The widget shows how many of the tests assigned to the application module failed.

    Note: To use this widget, automated tests must be assigned to application modules. For details, see Assign items to application modules.

  • Failed builds classification:

    Displays the number of failed builds included in this pipeline run, broken down by type of failure. You can also see how many of the failures are currently assigned to someone for investigation.

    To use this widget, failed builds must be classified in the Builds tab. Classification can be done automatically by ALM Octane, or manually, based on your own failure analysis. For details, see Analyze builds.

  • Application modules affected by commits: 

    Displays the number of application modules that were affected by the commits in the selected pipeline run, as well as the number of defects, quality stories and user stories affected by the commits. Click the number of application modules to drill to the relevant details.

Tip: Some builds might not be included.

You can configure hiding builds failures resulting from specific pipeline steps. For details, see Configure steps: Ignore or hide results of specific steps.

To check whether a step's builds are hidden, look at the step in the pipeline's Topology tab:

Back to top

Track code changes

If your CI server is set up to work with an SCM system, open a pipeline run to see commit changes and backlog items associated with that run. 

Based on the SCM data, ALM Octane helps you analyze the effects of the changes on your product, and identify Hotspots in your code. Hotspots are sensitive areas of code that are risky to change.

For details, see Track changes committed to your Source Control Management system.

Back to top

Pipeline Issue Summary cards

ALM Octane analyzes information regarding failed tests, problematic tests, build failure classification, related committers, and more. The Pipeline Issue Summary cards give CI owners actionable information to fix failed pipelines quickly.

ALM Octane categorizes pipeline failures into the following types: Compilation, Environment, Quality, or Security issues. The cards for each of these are displayed in order of urgency. Each card shows you the problem and its root cause, the users directly related to the problem, and the percentage of issues being handled. This information tells you if a problem needs immediate attention and whom to contact in order to deal with it.

Note: To provide data for some of the Pipeline Issue Summary cards, you need to manually classify failed builds. For details, see Build failure classification.

Compilation Issues

Compilation issues include any failure with at least one build which failed due to compilation issues. Related users includes anyone who may have caused the issue (generally committers in the pipeline run), as well as anyone assigned in the compilation build's Who's on it field.

For each build that was classified as a compilation issue, the card shows if it failed in an earlier run, so you know when the failure started. The bottom of the card indicates the percentage of builds that have someone assigned in the Who's on it? field, indicating that the problem is being handled.

You can click on the number of builds, or on a specific build name, to drill to the relevant details.

Environment Issues

Environment Issues include any build failures classified as Environment issues. The cards are divided into subgroups based on the out-of-the-box tags (such as Environment - Database, and Environment - Network), or custom tags you added. Each card shows all the problematic jobs in the relevant category, with the oldest jobs listed first.

Related users includes anyone assigned in the relevant builds' Who's on it? field. The bottom of the card indicates the percentage of builds that have someone assigned in the Who's on it? field.

You can click on the number of builds, or on a specific build name, to drill to the relevant details.

Quality Issues

If any tests failed in a pipeline run, and the build is not classified as a compilation or environment issue, you will see a Quality Issue card. The cards are divided into two types: Quality - Builds with most failed tests, and Quality - Committers related to most test failures.

Tip: Admins can define a percentage threshold that determines which test failures are displayed on the card. For details, see the FAILURE_ANALYSIS_INSIGHT_TEST_FAILURE_THRESHOLD configuration parameter under FAILURE_ANALYSIS_INSIGHT_TEST_FAILURE_THRESHOLD.

You want to focus your attention on test failures that are stable and indicate a regression that needs to be fixed quickly. The Quality - Builds with most failed tests card therefore shows you the number of test failures that are stable, out of the total test failures. These are either tests that are failing consistently or failed for the first time in this run.

Related users include any committers who may have caused the issue or anyone assigned in the test runs' Who's on it? field. The bottom of the card indicates the percentage of tests in these builds that have someone assigned in the Who's on it field.

You can click on the number of builds, or on a specific build name, to drill to the details of stable test failures.

The Quality - Committers related to most test failures card shows you which committers are related to the most test failures. Committers are listed in order of the number of stable test failures that they impacted, so you know whom to contact to resolve problems.

The bottom of the card indicates the percentage of tests that are being handled, regardless of who is handling them.

You can click on a line showing a number of tests to drill to the details on test failures related to the selected committer.

Security Issues

If your pipeline collects security testing results, you can see the number of open vulnerabilities found in the scan triggered by the selected pipeline run, as well as their severities. Open vulnerabilities are those whose state is not Closed or Not an issue. Click the number to open the Vulnerabilities tab for the pipeline run.

For details, see Track security vulnerabilities.

Back to top

See also: