Uploading debug symbols
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.
What you need
-
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.
-
To use this API you need to create a personal or team API key. It’s recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add individual permissions.
Preset Action Description DataQuerying LEGACY-ARCHIVE-QUERIES:EXECUTE
LOGS.DATA-API#HIGH:READDATA
LOGS.DATA-API#LOW:READDATA
METRICS.DATA-API#HIGH:READDATA
SPANS.DATA-API#HIGH:READDATA
SPANS.DATA-API#LOW:READDATAQuery Data from the Archive
Query Frequent Search Logs
Query Monitoring & Compliance Logs
Query Metrics
Query Frequent Search Spans
Query Monitoring & Compliance Spans
Find the 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 the 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 <cx_api_key> -a <application> -v <version> -f <folderPath> -e <env> -c <commitHash> -n <repoName> -o <orgName>
| Option | Description | Example |
|---|---|---|
-k, --private-key <cx_api_key> | The API key used to authenticate with the Coralogix API. | -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> | Select the https://api.:443 endpoint that corresponds to your Coralogix domain using the domain selector at the top of the page. | |
-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 the symbolicated stack traces
In your Error Tracking Screen, filter your errors by Mobile in the PLATFORM section.
Select the error of interest. In the Error Drill-Down, select the STACK TRACE tab. Displayed will be the stack trace divided into the threads.
Select the thread dropdown to view its frames.
Limitations
dSYM files are limited to 400 MB.