AppDynamics needs the dSYM file for the application to produce human-readable stack traces for crash snapshots. For details about why you should do this, see Get Human-Readable Crash Snapshots.
If you update the application, you need to provide the new dSYM file for the new application version. The dSYM file contains a UUID that links it to a specific Xcode build, so AppDynamics can unambiguously match the correct dSYM file with an incoming crash report with no additional information.
To upload the dSYM file, you do the following:
- set up your environment to upload the file automatically each time you build or upload the file manually
Enable the dSYM File
To enable the agent to provide human-readable information in the crash snapshots that are produced if the application crashes, compile with the
DWARF with dSYM file option to create a debug symbols file for the application.
To enable dSYM
- In Xcode, select your project in the Project Navigator.
- In the target list, select the target that builds your application.
- Select the Build Settings tab.
In the Build Options section, make sure that the Debugging Information Format is set to
DWARF with dSYM File.
Upload the dSYM File to AppDynamics Automatically with Each Build
Automating the upload of your dSYM file reduces the number of manual steps required for each build and ensures that all builds have appropriate dSYM files available for AppDynamics to use.
- In Xcode, select your project from the Project Navigator.
- Click on the application target.
- Select the Build Phase tab in the Settings editor.
- Click the + icon in the upper left corner of the main panel.
- Select New Run Script Phase from the dropdown.
In the script box, add the following lines:
There are also some optional parameters you can set if desired. To set them, add the following line(s) after the second
exportstatement above. Set to
The last statement should be used to set the URL for an on-prem version of the EUM Server.
Upload the dSYM File to AppDynamics Manually
- Get the dSYM file from Xcode
- Upload the dSYM file to AppDynamics using the UI
Upload the dSYM File to AppDynamics Using the API
- Check Uploaded dSYMs Using the REST API
Get the dSYM file from Xcode
- In Xcode, run the Xcode build: Product > Build.
View the log navigator: View > Navigators > Show Report Navigator.
Older versions of Xcode used Show Log Navigator.
- Click the log entry for the most recent build.
- Near the end of the log, find and mouse over the log entry named
- Click the button on the right side of the entry to expand it.
The end of the displayed command is the path to the dSYM file.
- Navigate to this dSYM file in the Finder.
- Right-click on the dSYM file and choose Compress.
- Upload to AppDynamics the
.zipfile that Finder generates.
Upload the dSYM file to AppDynamics Using the UI
- From the Mobile App menu, click Configuration.
- Click Mobile App Configuration >.
- From dSYM Mappings, click Upload dSYM package file for iOS crashes.
- From the XCode dSYM package upload dialog, click Choose File.
The uploader expects a file with a
- In the file browser locate the zipped dSYM file for the application that you are instrumenting and click Open.
- Click Upload.
Upload the dSYM File to AppDynamics Using the REST API
The API uses HTTP basic authentication. The username is your EUM account name and the password is your EUM license key.
Set up your HTTP basic authentication credentials
In the upper-right corner of the Controller UI, click the gear icon () and choose License.
- From the Account Usage tab, scroll down to the User Experience section.
- Click Show next to License Key to display the EUM license key. This is your password for authentication.
- URL-encode the EUM account name and the EUM license key.
Send the dSYM file
Send the dSYM as a zip archive in the body of a
PUT request to the following URI:
You must set a Content-Type header,
-H Content-Type:application/octet-stream, and your URL-encoded EUM account name (the username) and EUM license key (the password) to the call.
Sample Request and Response
This is a sample request and response using the REST API.
The following example uses
curl to send a dSYMm file named
UISampleApp.app.dSYM.zip. The username (the EUM account name) is "Example account " and the password (the EUM license key) is "Example-License-Key-4e8ec2ae6cfe". The plus signs replace spaces in the account name when the account name is URL-encoded.
The successful output of the sample request looks like this:
Check Uploaded dSYMs Using the REST API
You can check to make sure that your dSYMs have successfully uploaded using two REST APIs.
- Get a list of the UUIDs for the last 50 dSYMs you have uploaded
- Check if a specific dSYM has been uploaded
List of the Last 50 dSYMs uploaded
dsymQuery method allows you to retrieve a list of UUIDs for up to the last 50 dSYM files that have been uploaded to your account, along with the time they were uploaded. The response is displayed as JSON, by upload time, with the most recent first.
Set up your authentication as described in Upload the dSYM File to AppDynamics Using the REST API.
Create a GET request of the form:
where the value for
--useris the authentication string you created in Upload the dSYM File to AppDynamics Using the REST API,
api.eum-appdynamics.com:443for SaaS-based EUM Cloud accounts or as configured for on-premises EUM Servers.
Check for specific dSYM by UUID
checkForDSymFile method allows you to check if a specific dSYM by UUID has been uploaded. The upload time is returned in the response.
- Set up your authentication as described in Upload the dSYM File to AppDynamics Using the REST API.
Create a GET request of the form:
where the value for
--useris the authentication string you created in Upload the dSYM File to AppDynamics Using the REST AP,
api.eum-appdynamics.com:443for SaaS-based EUM Cloud accounts or as configured for on-premises EUM Servers, and
UUID_to_checkis the UUID of the dSYM in which you are interested.