Let us know how you feel about this
last updated: 2015-11
Each application's Settings Page will look similar to this:
The main Xamarin Insights settings page allows control over basic functions of your application such as:
- Viewing or modifying the name of the application, as it is known to Xamarin Insights.
- Retrieving the API Key for the app.
- Setting up error notifications.
- Deleting the application from Xamarin Insights.
The settings menu also allows you to:
- Integrate 3rd party applications with your Xamarin Insights service.
- Set access permissions on a per app basis.
- Upload debug symbol files.
These will be described in more detail in the sections below.
Xamarin Insights is able to plug into external services and use them to notify you when an issue is reported to the service:
There are three possible types of Integrations available:
- Bug Tracker – Integration with your favorite bug tracker allows your team to spend more time focusing on fixing bugs. You can connect with Github, Visual Studio Team Services, Jira, and Pivotal Tracker, but note that you can only connect to one of these services at any one time.
- Notifications – Through Notifications, you can connect your app to a variety of external services and be notified when a new issue is opened, an issue is occurring repeated times in a small amount of time, or an issue's status changes.
- Webhooks – Webhooks allow external services to be notified when certain events happen in Xamarin Insights. When the events happen, we'll send a POST request to each of the URLs that you provide.
To add a new integration, select your service from the list and follow the instructions to add the integration to your application.
You can click the service's icon to change the settings for any created integration or you can enable or disable the integration by using the On/Off Switch.
Setting Access Permissions
From the Access tab of the Application Settings View, you can allow other licensed Xamarin developers access to the information collected on your application. For example, if you are part of a development team, you can allow other members of your team to have access.
To add a new user, enter the email address that they used for their Xamarin Developer Account into the Email Address Field and click Add Access.
The user will be sent an email advising them that they have been given access. From here, they can follow the link to open the Insights Dashboard and will be able to view the application's analytic and crash information, as well as being permitted to adjust settings.
Access can be revoked by clicking the Remove Access button by their name and approving their removal.
Uploading a dSYM File
The DSYMS tab of the Application Settings View allows you to optionally upload debug symbol files for Xamarin.iOS app.
When a Xamarin application crashes and the reports are fed back to the Xamarin Insights dashboard, it will contain information below the Xamarin.iOS layer (known as the “native” layer). The dSYM files are matched up with the crash symbols to give more specific feedback on what went wrong.
These will be used to create stack traces from crash reports sent by Xamarin Insights.
Once the dSYM file has been uploaded, any crash reports sent from that build will have stack traces automatically created.
If you have old crashes that were available in the system before the matching dSYM file was uploaded, those crashes will be reprocessed and the new data will be made available shortly.
If this facility is used, a new dSYM file must be uploaded for each new version of the application that is built and released.
Automating dSYM file uploads
Uploading the dSYM file can be automated by including the following line in your build script:
curl -F "dsym=@yourAppDsym.zip;type=application/zip" https://xaapi.xamarin.com/api/dsym?apikey=[yourApiKey]
Locating your dSYM File.
Once a device debug build has been generated, the dSYM files will be accessible in the following locations:
Your application's dSYM file will be located in the its
bin directory under device/Debug.
Before building your project, make sure to select the Build ad-hoc/enterprise package (IPA) option, which can be found by right-clicking your project name and browsing to Proprties > iOS IPA Options, as illustrated below:
Once the application has been built, right-click on the Project in the Solution Explorer and select Show IPA file on Build Server. The dSYM file will be located in this folder.
Note: The dSYM file should be zipped before it can be uploaded to the Insights Settings page.