Skip to content

Update Device Vitals and Crash/Error Reporting #2934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,26 +1,40 @@
---
id: app-crash-logs
title: App Crash Logs
sidebar_label: App Crash Logs
id: crash-error-reporting
title: Crash/Error Reporting
sidebar_label: Crash/Error Reporting
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The App Crash Logs feature on Sauce Labs' Real Device Cloud (RDC) platform facilitates the automatic capture and display of crash data, both during live and automated testing. This eliminates the necessity to integrate an SDK or connect crash reporting tools to our system.
<p><small><span className="sauceGreen">Real Devices Only</span></small></p>

Through the App Crash Logs feature, users gain access to a centralized view encompassing an array of app diagnostic signals. This expedites the debugging process for teams and reduces issue resolution time. Our primary objective is to establish expedited feedback loops for developers, enabling the early identification of risks and ensuring comprehensive coverage within the development cycle. With this enhanced capability, teams can effectively prioritize errors, crashes, and test failures based on complete data and context, focusing their efforts on the most critical issues.
The Crash/Error Reporting feature on Sauce Labs' Real Device Cloud (RDC) platform facilitates the automatic capture and display of crash data, both during live and automated testing. This eliminates the necessity to integrate an SDK or connect crash reporting tools to our system.

Through the Crash/Error Reporting feature, users gain access to a centralized view encompassing an array of app diagnostic signals. This expedites the debugging process for teams and reduces issue resolution time. Our primary objective is to establish expedited feedback loops for developers, enabling the early identification of risks and ensuring comprehensive coverage within the development cycle. With this enhanced capability, teams can effectively prioritize errors, crashes, and test failures based on complete data and context, focusing their efforts on the most critical issues.

Check warning on line 13 in docs/mobile-apps/features/mobile-app-diagnostics/crash-error-reporting.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/features/mobile-app-diagnostics/crash-error-reporting.md#L13

[sauce.WordList] Use 'in' instead of 'within'.
Raw output
{"message": "[sauce.WordList] Use 'in' instead of 'within'.", "location": {"path": "docs/mobile-apps/features/mobile-app-diagnostics/crash-error-reporting.md", "range": {"start": {"line": 13, "column": 373}}}, "severity": "WARNING"}

Our tool has the capability to detect and record fatal errors (crashes) that occur during the testing of both iOS and Android apps. Specifically for Android apps, this information is sent to [Error Reporting](/error-reporting/getting-started/), enabling the viewing of detailed call stack information. Furthermore, our interface also renders all non-fatal errors and warnings originating from the native application visible. This feature streamlines debugging and facilitates seamless integration with other Mobile App Diagnostics components, ultimately enhancing issue identification and resolution efficiency.

## What You'll Need

- A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up))
- A native Android, iOS, or iPadOS mobile app
- Make sure instrumentation is enabled, no other configuration is required.

## Viewing the App Crash Logs for Real Devices​
## Using Crash/Error Reporting for Real Devices

To use the Crash/Error Reporting feature, you must ensure that the functionality is enabled for your app.

1. In Sauce Labs, from the left navigation, click **App Management**.
<img src={useBaseUrl('img/mobile-apps/app-management.png')} alt="App Management" width="700"/>
2. Upload your mobile app.
<img src={useBaseUrl('img/mobile-apps/app-logs-8.png')} alt="App Logs" width="700"/>
3. After you’ve uploaded your app, locate it in the table and select **Settings** from the corresponding row.
<img src={useBaseUrl('img/mobile-apps/app-management-select-settings.png')} alt="Select Settings" width="700"/>
4. Under **Real Device Settings** first enable **Instrumentation** and then toggle **Crash/Error Reporting** on.
<img src={useBaseUrl('img/mobile-apps/crash-error-reporting-app-setting.png')} alt="Crash/Error Reporting App Setting" width="700"/>

## Viewing the App Crash Logs for Real Devices

The App Crash Logs feature is automatically activated when the [Instrumentation feature](/mobile-apps/features/mobile-app-diagnostics/interactions/#using-interactions-for-real-devices) is enabled. Upon detecting a crash, our system will exhibit an `App Crashed` label for the corresponding test result, regardless of the test's status.
Upon detecting a crash, our system will exhibit an `App Crashed` label for the corresponding test result, regardless of the test's status.

<br/><img src={useBaseUrl('img/mobile-apps/app-crash-scr1.png')} alt="Mobile app settings navigation" width="900"/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<p><small><span className="sauceGreen">Real Devices Only</span></small></p>

Device Vitals is a functionality that allows you to debug and observe an app’s performance during test execution for both, [Live](/mobile-apps/live-testing/live-mobile-app-testing/) and [Automated](/mobile-apps/automated-testing/) testing. With this feature, the app's performance is recorded during the test session and displayed for your test results.

## What You'll Need
Expand All @@ -17,17 +19,16 @@ Device Vitals is a functionality that allows you to debug and observe an app’s

## Using Device Vitals for Real Devices

By default, Device Vitals is enabled if the instrumentation feature is enabled.
To enable device instrumentation:
To use Device Vitals, you must ensure that the functionality is enabled for your app.

1. In Sauce Labs, from the left navigation, click **App Management**.
<img src={useBaseUrl('img/mobile-apps/app-logs5.png')} alt="App Logs" width="300"/>
<img src={useBaseUrl('img/mobile-apps/app-management.png')} alt="App Management" width="700"/>
2. Upload your mobile app.
<img src={useBaseUrl('img/mobile-apps/app-logs-8.png')} alt="App Logs" width="700"/>
3. After you’ve uploaded your app, hover your mouse over your app, then select **Settings**.
<img src={useBaseUrl('img/mobile-apps/app-logs-6.png')} alt="App Logs" width="700"/>
4. Under **Real Device Settings** toggle **Instrumentation** to **Enabled**.
<img src={useBaseUrl('img/mobile-apps/app-logs-7.png')} alt="App Logs" width="700"/>
3. After you’ve uploaded your app, locate it in the table and select **Settings** from the corresponding row.
<img src={useBaseUrl('img/mobile-apps/app-management-select-settings.png')} alt="Select Settings" width="700"/>
4. Under **Real Device Settings** first enable **Instrumentation** and then toggle **Device Vitals** on.
<img src={useBaseUrl('img/mobile-apps/device-vitals-app-setting.png')} alt="Device Vitals App Setting" width="700"/>

Now you can start your live or automated testing session. Your Device Vitals will be captured and be part of your test results.

Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1366,8 +1366,8 @@ module.exports = {
collapsed: true,
items: [
'mobile-apps/features/mobile-app-diagnostics/app-logs',
'mobile-apps/features/mobile-app-diagnostics/app-crash-logs',
'mobile-apps/features/mobile-app-diagnostics/device-vitals',
'mobile-apps/features/mobile-app-diagnostics/crash-error-reporting',
'mobile-apps/features/mobile-app-diagnostics/interactions',
'mobile-apps/features/mobile-app-diagnostics/view-tree',
'mobile-apps/features/network-capture',
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/mobile-apps/app-management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.