Uploading Debug Symbols: iOS
Overview
As part of Error Tracking, Coralogix requires dSYM (debug information) files to interpret your stack traces. The symbolization process converts the stack traces in raw format back into readable function names, file names, and line numbers related to the crash.
To symbolicate your stack traces, locate and upload your .dSYM files to Coralogix using the coralogix-rum-cli upload-dsym
command.
Prerequisites
Before sending your data, verify that your S3 bucket has been properly set up and configured. For details on using an S3 bucket for data archiving, refer to the Coralogix documentation on S3 buckets.
Find dSYM files
Every iOS application generates .dSYM files for each module. These files are crucial for reducing the application's binary size, which in turn allows for quicker download speeds. Each version of the application comes with its own set of .dSYM files.
Upload dSYM files
Manually upload your dSYM file. If you have multiple dSYM files, they can be within a single zip with a maximum file size of 400 MB.
To manually upload your dSYM files:
coralogix-rum-cli upload-dsym -k <privateKey> -a <application> -v <version> -f <folderPath> -e <env> -c <commitHash> -n <repoName> -o <orgName>
Option | Description | Example |
---|---|---|
-k, --private-key <privateKey> | Logs Query API key used to authenticate with the Coralogix API. |
Navigate to Data Flow > API Keys > Logs Query Key.
| -k abc123xyz
| | -a, --application <application>
| Name of the application. | -a MyApp
| | -v, --version <version>
| The application version - must match the version used by RUM SDK. | -v 1.0.0
| | -f, --folder-path <folderPath>
| Path to the folder containing the source maps. | -f /path/to/dsym/files
| | -e, --env <env>
| Input the region associated with your Coralogix domain:
EU1: https://ng-api-grpc.coralogix.com:443, // eu-west-1 (Ireland)
EU2: https://ng-api-grpc.eu2.coralogix.com:443, // eu-north-1 (Stockholm)
US1: https://ng-api-grpc.coralogix.us:443, // us-east-2 (Ohio)
US2: https://ng-api-grpc.cx498.coralogix.com:443, // us-west-2 (Oregon)
AP1: https://ng-api-grpc.app.coralogix.in:443, // ap-south-1 (Mumbai)
AP2: https://ng-api-grpc.coralogixsg.com:443, // ap-southeast-1 (Singapore) | EU1
, AP2
| | -c, --commit-hash <commitHash>
| GitHub commit hash (optional). | -c 1a2b3c4d5e
| | -n, --repo-name <repoName>
| GitHub repository name (optional). | -n my-repo
| | -o, --org-name <orgName>
| GitHub organization name (optional). | -o my-org
| | -g, --generate <generate>
| Update the existing release or create a new one if not found (optional). | -g true
| | -h, --help
| Display help. | -h
|
View stack traces
STEP 1. In your Error Tracking Screen, filter your errors by Mobile in the PLATFORM section.
STEP 2. Click on the error of interest. In the Error Drill-Down, select the STACK TRACE tab. Displayed will be the stack trace divided into the threads.
STEP 3. Click on the thread drop-down to view its frames.
Limitations
dSYM files are limited to 400 MB.
Support
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to reach out to us via our in-app chat or by sending us an email to [email protected].