diff --git a/docs/insights/overview.md b/docs/insights/overview.md index f21b25db6e..c084ae0a2f 100644 --- a/docs/insights/overview.md +++ b/docs/insights/overview.md @@ -7,7 +7,7 @@ description: Gain insight into test case health, test summaries and breakdowns a import useBaseUrl from '@docusaurus/useBaseUrl'; -The **Job Overview** page, accessible from the **Insights** heading, offers two frames of reference to view health of the aggregate of your tests. First is the Overview tab, which offers a visual overview of test case health over time, job summary, and job breakdown. Job Overview also gives you access to the Errors tab which details errors for all your tests over time. +The **Job Overview** page, accessible from the **Insights** heading, offers two frames of reference to view health of the aggregate of your jobs. First is the Overview tab, which offers a visual overview of job case health over time, job summary, and job breakdown. Job Overview also gives you access to the Errors tab which details errors for all your jobs over time. :::note The Extended Debugging feature offers access to HAR files and JavaScript console logs, assisting in the identification of flaky tests. For more details, refer to [Debugging Tests with JavaScript Console Logs and HAR Files (Extended Debugging)](/insights/debug). @@ -17,32 +17,32 @@ The Extended Debugging feature offers access to HAR files and JavaScript console 1. Click the **Insights** tab to expand its submenu. 1. Click **Job Overview**. -1. Apply [filters](scope.md#using-filters-to-adjust-the-scope-of-your-data) to narrow down the list of tests within a specific range. +1. Apply [filters](scope.md#using-filters-to-adjust-the-scope-of-your-data) to narrow down the list of jobs within a specific range. ## Job Overview Tab -The **Job Overview** page offers three data visualizations on the Overview tab to give you insight into your tests over time. +The **Job Overview** page offers three data visualizations on the Overview tab to give you insight into your jobs over time. ### Job Overview -The Job Overview visualization gives you a bar chart with a few different categories reprsented to give you an overview of how your test suite has performed over a given period of time. This bar chart is usually broken down into five categories. +The Job Overview visualization gives you a bar chart with a few different categories reprsented to give you an overview of how your suite has performed over a given period of time. This bar chart is usually broken down into five categories. -- Consistently Failing tests -- Consistently Passing tests -- Consistently Erroring tests -- Tests with Missing Status -- Inconsistent Resulting tests +- Consistently Failing +- Consistently Passing +- Consistently Erroring +- Jobs with Missing Status +- Inconsistent Resulting overview data visualization Using this data, you can identify if your test suite is performing as expected and where to debug if necessary. Clicking each of the headings will take you to that filter within the **Job History** page to drill down into the tests that are comprised in that filter. Use the filters above the visualization to identify builds, browsers, or platforms and the time-frame to surface test data that is most important to your organization. ### Job Summary -The Job Summary section gives you a pie chart, and associated raw numbers with percentages, of the fundamentals of your testing strategy over the selected period of time. This visualization also compares usage for the same time interval previous. For example, if you select 30 days from the filter you will see your current 30 days of tests compared to your last 30 days of tests in this visualization. Job Summary shows you proportions of: +The Job Summary section gives you a pie chart, and associated raw numbers with percentages, of the fundamentals of your testing strategy over the selected period of time. This visualization also compares usage for the same time interval previous. For example, if you select 30 days from the filter you will see your current 30 days of jobs compared to your last 30 days of jobs in this visualization. Job Summary shows you proportions of: - Total Runs -- Passed tests (Passed) -- Errored tests (Error) -- Failed tests (Failures) -- Completed tests (Completed) +- Passed +- Errored +- Failed +- Completed :::note Completed tests are sometimes aggregated due to not receiving a pass or failure declaration or intent. Be sure to [send all your pass/fail results](/basics/test-config-annotation/test-annotation#setting-passfail) to Sauce Labs to take advantage of Insights.