Подключение Крашлитики для iOS

Краткое содержание

Включение сбора ошибок в конфигурации SDK
Для передачи ошибок в МТС Аналитику необходимо включить сбор ошибок через установку параметра crashReportingEnabled = true в конфигурации SDK.

Автоматическая загрузка dSYM-файлов при сборке с помощью Fastlane-плагина
Для автоматической загрузки dSYM-файлов:

Установите плагин upload_dsym_to_mtsa через Fastlane.
Укажите источник плагина и ссылку на репозиторий (обратитесь на analytics.support@mts.ru для доступа).
Добавьте действие upload_dsym_to_mtsa в Fastfile с параметрами flow_id, client_id, client_secret.

Использование прокси-сервера
Возможна настройка прокси-сервера через параметры proxy_user, proxy_pass, proxy_host, proxy_port. По умолчанию прокси не используется.

Конфигурация сервиса авторизации и получения ссылки для загрузки dSYM
Можно указать кастомные URL для аутентификации и загрузки: auth_service_url, fetch_upload_link_url. По умолчанию используются значения от API МТС.

Доступные параметры
В таблице перечислены все параметры, используемые в плагине, включая их описание и значения по умолчанию.

Смотреть данные
Статистика ошибок отображается в отчёте «Крашлитика» на платформе МТС Аналитики.

Версия 0.3.0

Информацию об ошибках в приложении можно передавать в МТС Аналитику, в сервис «Крашлитика».

Для расшифровки Stack Trace ошибок, переданных в Аналитику, важно связать их с маппинг-файлом. Для этого необходимо установить плагин.

Включение сбора ошибок в конфигурации SDK

Включите сбор ошибок, чтобы они начали поступать в Аналитику

configuration.crashReportingEnabled = true

Подробнее про конфигурацию библиотеки

Автоматическая загрузка dSYM-файлов при сборке с помощью Fastlane-плагина

Подключение плагина

Для автоматической загрузки dSYM-файлов необходим Fastlane:

Добавьте плагин в Fastlane, используя add_plugin

fastlane add_plugin upload_dsym_to_mtsa

Укажите источник плагина, выбрав пункт 1. Git URL из перечня.
Добавьте ссылку на репозиторий с плагином

Доступ

Для доступа к репозиторию обратитесь на analytics.support@mts.ru

https://gitlab.services.mts.ru/mts-analytics/ios/fastlane-dsym-uploader-plugin

Добавьте действие upload_dsym_to_mtsa в свой Fastfile

platform :ios do
  desc "Build an app and upload symbols to MTS Analytics"
  lane :build do
    # Ваши actions до
    gym(
      project: "YourApplication.xcodeproj",
      scheme: "YourApplication",
      configuration: "Release",
      export_method: "app-store" # Используйте необходимый export_method
    )
    upload_dsym_to_mtsa(
      flow_id: "aabb1111-2c2d-3e3f-4444-555566667777", 
      client_id: "XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX",
      client_secret: "XXXXXXXXXXXXXXXXXXXXXXXXXX"
    )
    # Ваши actions после
  end
end

Подробнее о плагинах в Fastlane

Заметка

Если вы не получили ID потока, отправьте письмо на analytics.support@mts.ru с темой «Получение Flow ID». Идентификатор нужен для отправки данных с вашего ресурса в МТС Аналитику.

Важно

Символы dSYM привязаны к конкретной сборке, и если в App Store загрузится другой билд (например, экспортированный через Xcode), они уже не подойдут. Используйте gym для сборки и экспорта приложения в App Store Connect.

Использование прокси-сервера

Вы можете передать собственную конфигурацию прокси-сервера через параметры upload_dsym_to_mtsa. По умолчанию прокси-сервер использоваться не будет.

Для этого передайте все необходимые параметры: proxy_user, proxy_pass, proxy_port, proxy_host

platform :ios do
  desc "Upload dSYM to MTS Analytics"
  lane :upload_dsym do
    upload_dsym_to_mtsa(
      dsym_path: "./YourApplication.app.dSYM.zip", 
      flow_id: "aabb1111-2c2d-3e3f-4444-555566667777", 
      client_id: "XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX",
      client_secret: "XXXXXXXXXXXXXXXXXXXXXXXXXX",
      proxy_user: "exampleuser",
      proxy_pass: "password",
      proxy_host: "proxy.example.com",
      proxy_port: 3030
    )
  end
end

Конфигурация сервиса авторизации и получения ссылки для загрузки dSYM

Вы можете передать:

URL собственного сервиса аутентификации SSO
URL сервиса получения ссылки на загрузку. По умолчанию будет использоваться api.mts.ru

Для этого передайте параметры auth_service_url и fetch_upload_link_url

platform :ios do
  desc "Upload dSYM to MTS Analytics"
  lane :upload_dsym do
    upload_dsym_to_mtsa(
      dsym_path: "./YourApplication.app.dSYM.zip", 
      flow_id: "aabb1111-2c2d-3e3f-4444-555566667777", 
      client_id: "XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX",
      client_secret: "XXXXXXXXXXXXXXXXXXXXXXXXXX",
      auth_service_url: "https://example.com/auth/oauth2/token",
      fetch_upload_link_url: "https://example.com/crash-manager/v1/dsymUploadURL"
    )
  end
end

Доступные параметры

Параметр	Описание	Значение по умолчанию
`flow_id: String`	ID потока	Нет
`client_id: String`	Client ID для авторизации	Нет
`client_secret: String`	Client Secret для авторизации	Нет
`dsym_path: String`	Опциональный параметр. Используйте, чтобы передавать свой путь до `.dSYM` / `.dSYM.zip` файла	Автоматически из контекста Fastlane
`auth_service_url: String`	Опциональный параметр. Используйте для кастомного сервиса авторизации	`https://api.mts.ru/auth/oauth2/token`
`fetch_upload_link_url: String`	Опциональный параметр. Используйте для кастомного получения presigned-ссылок для загрузки `dSYM`	`https://api.mts.ru/mtsa-crash-manager/v2/v1/mappingfileUploadUrl`
`proxy_host: String`	Опциональный параметр. Имя хоста прокси-сервера	Нет
`proxy_port: Integer`	Опциональный параметр. Порт прокси-сервера	Нет
`proxy_user: String`	Опциональный параметр. Имя пользователя для авторизации в прокси-сервере	Нет
`proxy_pass: String`	Опциональный параметр. Пароль для авторизации в прокси-сервере	Нет

Смотреть данные

Статистика будет отображаться в отчёте «Крашлитика».

Включение сбора ошибок в конфигурации SDK​

Автоматическая загрузка dSYM-файлов при сборке с помощью Fastlane-плагина​

Подключение плагина​

Использование прокси-сервера​

Конфигурация сервиса авторизации и получения ссылки для загрузки dSYM​

Доступные параметры​

Смотреть данные​