Проект Countly-SDK-OHOS

Введение в проект

• Название проекта: Countly-SDK-OHOS.
• Серия: OpenHarmony, сторонние компоненты для адаптации и переноса.
• Функция: решение для анализа продуктов, отслеживания производительности и поведения пользователей.
• Состояние переноса проекта: основные функции реализованы.
• Вызовы: отсутствуют.
• Версия разработки: SDK6, DevEco Studio2.2 beta1.
• Базовая версия: Release 20.11.8.

Демонстрация эффекта

Демонстрация эффекта отсутствует.

Инструкция по установке

Чтобы добавить зависимость в файл build.gradle на уровне модуля, выполните следующие шаги:

1. Включите репозиторий Maven:

// Добавляем maven-репозиторий
repositories {
    maven {
        url 'https://s01.oss.sonatype.org/content/repositories/releases/'
    }
}

2. Добавьте зависимость библиотеки:

dependencies {
    implementation 'com.gitee.chinasoft_ohos:countly-sdk-ohos:1.0.0'   
}

После этого проект можно запустить в SDK6 и DevEco Studio 2.2 beta1. Если проект не запускается, удалите файлы .gradle, .idea, build и build.gradle и создайте новый проект с использованием вашей версии. Затем скопируйте соответствующие файлы из нового проекта в корневую папку.

Руководство по использованию

Перед использованием любых функций необходимо инициализировать SDK. Это можно сделать в AbilityPackage или MainAbility в методе onStart.

Минимальная настройка Самый простой способ запуска SDK — использовать следующий вызов: Countly.sharedInstance().init(new CountlyConfig(this, COUNTLY_APP_KEY, COUNTLY_SERVER_URL)); Здесь можно указать контекст ohos, appKey и URL сервера Countly.

Для настройки SDK во время инициализации используется объект конфигурации CountlyConfig. Настройка выполняется путём создания объекта и вызова его функций. После этого объект конфигурации передаётся методу init.

Предоставление appKey AppKey также называется «appKey». Он используется для идентификации приложения, которое отслеживает эту информацию. AppKey можно получить, создав новое приложение в Countly Dashboard и перейдя в раздел управления приложениями.

Обратите внимание, что следует использовать appKey (находится в разделе «Управление» → «Приложения»), а не API key. Использование API key не будет иметь эффекта.

Предоставление URL сервера Если вы используете пробную версию сервера Countly Enterprise Edition, используйте https://try.count.ly, https://us-try.count.ly или https://asia-try.count.ly. Это домены, используемые для доступа к пробной версии панели инструментов.

Если вы одновременно используете Community Edition и Enterprise Edition, укажите свой домен или IP-адрес, например, https://example.com или https://IP (если настроен SSL).

Ведение журнала в SDK При интеграции нашего SDK рекомендуется включить ведение журнала. Если ведение журнала включено, наш SDK будет выводить сообщения о своём внутреннем состоянии и проблемах, с которыми он столкнулся. Эти сообщения можно фильтровать в logcat и использовать внутренние вызовы журнала ohos.

Чтобы включить ведение журнала, вызовите setLoggingEnabled в классе config:

CountlyConfig config = (new CountlyConfig(appC, COUNTLY_APP_KEY, COUNTLY_SERVER_URL)); config.setLoggingEnabled(true);

Device ID Вся отслеживаемая информация связана с Device ID. Device ID является уникальным идентификатором пользователя.

Сначала необходимо определить, какой метод генерации Device ID использовать. Существует несколько вариантов:

Самый простой метод — позволить Countly SDK обрабатывать Device ID без проблем. Затем можно использовать следующий вызов. Будет использоваться стратегия по умолчанию, которая сейчас является OpenUDID (не забудьте завершить настройку OpenUDID, как описано ниже).

CountlyConfig config = (new CountlyConfig(appC, COUNTLY_APP_KEY, COUNTLY_SERVER_URL)); Countly.sharedInstance().init(config);

Если есть Device ID, вы можете указать его самостоятельно (каждый Device ID должен быть уникальным). Это может быть электронная почта или другой внутренний идентификатор, используемый системой.

CountlyConfig config = (new CountlyConfig(appC, COUNTLY_APP_KEY, COUNTLY_SERVER_URL)); config.setDeviceId("YOUR_DEVICE_ID"); Countly.sharedInstance().init(config);

Вы можете использовать Google Advertising ID для генерации Device ID.

CountlyConfig config = (new CountlyConfig(appC, COUNTLY_APP_KEY, COUNTLY_SERVER_URL)); config.setIdMode(DeviceId.Type.ADVERTISING_ID); Countly.sharedInstance().init(config);

Что касается Google Advertising ID, убедитесь, что ваш проект включает функции Google Play services 4.0+. Также обратите внимание, что когда сервисы Google Play недоступны на устройстве, Advertising ID автоматически возвращается к OpenUDID для предотвращения потери Advertising ID. Вы также можете явно использовать OpenUDID:

CountlyConfig config = (new CountlyConfig(appC, COUNTLY_APP_KEY, COUNTLY_SERVER_URL)); config.setIdMode(DeviceId.Type.OPEN_UDID); Countly.sharedInstance().init(config);

Добавление обратных вызовов После вызова Countly.sharedInstance().init(...) необходимо добавить следующие вызовы во все действия:

В onStart вызовите Countly.sharedInstance().onStart(this), который указывает на текущее действие.

В onStop вызовите Countly.sharedInstance().onStop().

Если необходимо отслеживать изменения ориентации, в onConfigurationChanged вызовите Countly.sharedInstance().onConfigurationChanged(newConfig).

Если не добавлены вызовы onStart и onStop, некоторые функции не будут работать, например, автоматическое отслеживание сеансов. Countly onStart должен вызываться в abilities onStart, его нельзя вызывать в любом другом месте, иначе приложение получит исключение.

Обязательные разрешения приложения Кроме того, если в файле манифеста нет разрешений, убедитесь, что установлены INTERNET и доступ к сети. Эти вызовы должны выглядеть следующим образом: "reqPermissions": [ { "name": "ohos.permission.INTERNET" }, { "name": "ohos.permission.GET_NETWORK_INFO" } ]

Отчёт о сбоях Countly SDK for OHOS может собирать отчёты о сбоях, которые можно позже проверить и решить на сервере.

Включение автоматического отчёта о сбоях Чтобы включить автоматический отчёт о сбоях, вызовите следующую функцию для объекта config. После init это включит отчёт о сбоях, который автоматически перехватит необработанные исключения Java. Как только приложение снова запустится и запустит SDK, они будут отправлены на панель инструментов.

config.enableCrashReporting();

Добавление пользовательских сегментов в отчёты о сбоях Вы можете добавлять пользовательские сегменты ключ/значение в отчёты о сбоях. Например, вы можете установить версию конкретной библиотеки или фреймворка, используемой в приложении. Затем вы можете выяснить, существует ли какая-либо связь между этими сегментами и отчётами о сбоях.

Используйте следующую функцию:

config.setCustomCrashSegment(Map<String, String> segments)

Доступ к функциям, связанным со сбоями В SDK вы можете просматривать все функции, связанные со сбоями, из возвращённого интерфейса:

Countly.sharedInstance().crashes()

Добавление хлебных крошек По всему приложению вы можете оставить хлебные крошки сбоев, которые описывают шаги, предпринятые в вашем приложении перед сбоем. Они будут отправляться вместе с отчётом о сбое после возникновения сбоя.

Следующая команда добавит хлебную крошку сбоя:

Countly.sharedInstance().crashes().addCrashBreadcrumb(String record)