Crash for iOS

Overview

The Crash service of AppGallery Connect is a lightweight crash analysis service, in which Huawei provides a Crash SDK that can be quickly integrated into your app, without the need for coding. The service SDK can automatically collect crash data and report the data to AppGallery Connect when your app crashes, helping you understand how a specific app version performs, quickly locate the causes of crashes, and evaluate the impact of crashes.

What You Will Create

In this codelab, you will create an app integrated with the Crash service, use custom user IDs, logs, and key-value pairs to define your crash report, and intentionally create a crash event for your app to report. In this way, you can check crash report details.

What You Will Learn

Integrate the Crash service of AppGallery Connect.
Generate your own crash report to suit your service by customizing user IDs, logs, and key-value pairs.
View and analyze crashes on the Crash service page in AppGallery Connect.

Development Environment and Skill Requirements

A Mac with Xcode 11 or later installed
CocoaPods 1.10.0 or later installed
A HUAWEI ID, whose identity has been verified

Device Requirements

An iPhone or a simulator for testing

To integrate the Crash service of AppGallery Connect, you must complete the following preparations:

Create an app in AppGallery Connect.
Create an iOS project.
Integrate the SDK into your Xcode project.
For details, please refer to Integration Preparations.

Sign in to AppGallery Connect, click My projects, click your project card, and select an app for which you want to enable the Crash service from the drop-down list on the top.
Go to Quality > Crash. If you use the Crash service for the first time, click Enable now to enable HUAWEI Analytics first.

You need to integrate the Crash service SDK into your Xcode project with CocoaPods.

Sign in to AppGallery Connect and click My projects.
Click your project card and select an app for SDK integration from the app drop-down list on the top.
Go to Project settings > General information. In the App information area, download the agconnect-services.plist file.
Copy the agconnect-services.plist file to your project.
Open the CLI and navigate to the location of the Xcode project. Then, create a Podfile. Skip this step if a Podfile already exists.
```
cd project-directory 
pod init
```
Add the pod ‘AGConnectCrash' dependency to the Podfile.
```
target 'AGC-Crash-2' do 
pod 'AGConnectCrash' 
end
```
Install the pod and open the .xcworkspace file to view the project.
```
pod install
```

The following figure shows the result after installation.

You can create a page layout in your iOS project and design the UI according to the following figure, with a button required for making a crash.

Sample code:


override func viewDidLoad() { 
   super.viewDidLoad() 
 
   let crashButton = UIButton(frame: CGRect(x: 50, y: 80, width: 160, height: 50)) 
   crashButton.backgroundColor = UIColor.blue 
   crashButton.setTitle("Make Crash", for: .normal) 
   crashButton.addTarget(self, action: #selector(makeCrash), for: .touchUpInside) 
   self.view.addSubview(crashButton) 
 
   let customReportButton = UIButton(frame: CGRect(x: 50, y: 160, width: 160, height: 50)) 
   customReportButton.backgroundColor = UIColor.blue 
   customReportButton.setTitle("Custom Report", for: .normal) 
   customReportButton.addTarget(self, action: #selector(customReport), for: .touchUpInside) 
   self.view.addSubview(customReportButton) 
}

Import AGConnectCore to the AppDelegate class of the app, and call AGCInstance.startUp in the didFinishLaunchingWithOptions method for initialization.


import AGConnectCore 
 
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -&gt; Bool { 
AGCInstance.startUp() 
}

Call the method of making a crash in the Make Crash tap event.


@objc func makeCrash() { 
AGCCrash.sharedInstance().testIt() 
}

In the Custom Report tap event, call AGCCrash.sharedInstance().setUserId to set a user ID, call AGCCrash.sharedInstance().log to set logs, and call AGCCrash.sharedInstance().setCustomValue to set key-value pairs.


@objc func customReport() { 
AGCCrash.sharedInstance().setUserId("testuser") 
AGCCrash.sharedInstance().log(level: .debug, message: "set debug log") 
AGCCrash.sharedInstance().log(level: .info, message: "set info log") 
AGCCrash.sharedInstance().log(level: .warning, message: "set warning log") 
AGCCrash.sharedInstance().log(level: .error, message: "set error log") 
AGCCrash.sharedInstance().setCustomValue(value: "Hello world", key: "stringKey") 
AGCCrash.sharedInstance().setCustomValue(value: false, key: "booleanKey") 
AGCCrash.sharedInstance().setCustomValue(value: 1.1, key: "doubleKey") 
AGCCrash.sharedInstance().setCustomValue(value: 1.1, key: "floatKey") 
AGCCrash.sharedInstance().setCustomValue(value: 0, key: "intKey") 
AGCCrash.sharedInstance().setCustomValue(value: 11, key: "longKey") 
}

Click the Xcode run button to run your app on a mobile phone or simulator.
Click Custom Report to customize your crash report.
The crash data collection function is not enabled in debugging mode in Xcode. Therefore, before testing the crash data collection function of your app, stop debugging in Xcode, open the app, and tap Make Crash.
After a crash occurs, ensure that the network connection is normal, restart the app, and view crash information in AppGallery Connect.

Sign in to AppGallery Connect, click My projects, click the project card, and select your app.
On the Crash service page, click the Statistics tab to view the crash statistics of your app.
Click Search by user, and find the custom user ID.
Click a crash to view its details. On the details page that is displayed, you can click the Logs tab to check generated custom logs.
Click the Status tab to view information about custom key-value pairs.

You have successfully created an app integrated with the Crash service of AppGallery Connect and learned how to view and analyze crashes and custom crash reports in AppGallery Connect. You can also create your crash report in a required form, and check it in AppGallery Connect.

API Reference

Sample code

Code copied