Инициализация библиотеки и проверка работы

На этой странице описано, как инициализировать библиотеку в коде игры и убедиться, что она загружает данные в Google Play. Дополнительную информацию о функциях библиотеки можно найти в справочной документации.

Инициализируйте библиотеку

В методе инициализации в начале игры инициализируйте библиотеку, создав экземпляр AndroidPerformanceTuner и вызвав его метод Start():

using Google.Android.PerformanceTuner;
using UnityEngine;

public class SomeBehaviour : MonoBehaviour
{
    AndroidPerformanceTuner<FidelityParams, Annotation> tuner =
            new AndroidPerformanceTuner<FidelityParams, Annotation>();

    void Start()
    {
        ErrorCode startErrorCode = tuner.Start();
        Debug.Log("Android Performance Tuner started with code: " + startErrorCode);

        tuner.onReceiveUploadLog += request =>
        {
            Debug.Log("Telemetry uploaded with request name: " + request.name);
        };
    }
}

Этого кода достаточно, чтобы запустить Android Performance Tuner и начать сбор данных в игре. Инструкции для регистрации в журнале указывают, когда запустился Android Performance Tuner и когда телеметрия была загружена в API Google Play Console. Позже вы найдете эти инструкции в журнале, чтобы убедиться, что плагин работает правильно.

Поздняя инициализация (только Vulkan)

Если ваша игра предназначена для Vulkan и использует Android Frame Pacing, Android Performance Tuner должен инициализироваться позже:

IEnumerator Start()
{
    yield return new WaitForEndOfFrame();
    ErrorCode startErrorCode = tuner.Start();
    Debug.Log("Android Performance Tuner started with code: " + startErrorCode);

    tuner.onReceiveUploadLog += request =>
    {
        Debug.Log("Telemetry uploaded with request name: " + request.name);
    };
}

Как проверить интервал между загрузками телеметрии

По умолчанию интервал между загрузками телеметрии в настройках плагина составляет 30 секунд. Этот интервал задан коротким, чтобы было проще проверить, правильно ли загружается телеметрия. При выпуске рабочей версии игры задайте большой интервал (например, 10 минут), чтобы игра не отправляла слишком много запросов к API. Это особенно важно для пользователей, у которых нет тарифа на мобильный интернет с безлимитным трафиком. Кроме того, большой интервал позволяет экономить заряд батареи.

Чтобы убедиться, что интервал равен 30 секундам, выполните следующие действия:

  1. Чтобы открыть настройки, выберите Google > Android Performance Tuner.
  2. Выберите вкладку Настройки инструментов и нажмите Использовать расширенные настройки.
  3. Убедитесь, что в поле Интервалы (минуты) указано значение 0,5.
Вкладка Instrumentation Settings (Настройки инструментирования) в плагине Android Performance Tuner для Unity, на которой для параметра Intervals (Интервалы) установлено значение 0,5 минуты
Вкладка Instrumentation settings (Настройки инструментирования) в плагине

Проверьте правильность работы

Если вы используете IL2CPP или удаление кода, ознакомьтесь с разделом Управление удалением кода.

Создайте игру для Android. Пока игра запускается на устройстве, откройте терминал на компьютере и запустите adb logcat:

adb logcat

В выходных данных adb logcat найдите TuningFork (внутреннее название библиотеки):

02-03 16:55:45.103 10511 10536 I TuningFork: Got settings from tuningfork/tuningfork_settings.bin
02-03 16:55:45.103 10511 10536 I TuningFork: Using local file cache at /data/user/0/com.Unity3d.BoatAttackDay/cache/tuningfork
02-03 16:55:45.105 10511 10536 I TuningFork: OpenGL version 3.2
02-03 16:55:45.105 10511 10536 I TuningFork: TuningFork.GoogleEndpoint: OK
02-03 16:55:45.106 10511 10611 I TuningFork: Creating directory /data/user/0/com.Unity3d.BoatAttackDay/cache/tuningfork
02-03 16:55:45.106 10511 10536 I TuningFork: TuningFork Settings:

[...]

02-03 16:55:45.116 10511 10536 I Unity   : Tuningfork started with code: Ok
02-03 16:55:45.107 10511 10536 I TuningFork: TuningFork initialized
02-03 16:55:45.107 10511 10536 I UnityTuningfork: Swappy backend: 1
02-03 16:55:45.107 10511 10536 I TuningFork: Creating directory /data/user/0/com.Unity3d.BoatAttackDay/cache/tuningfork/V1
02-03 16:55:45.110 10511 10613 I TuningFork: OpenGL version 3.2
02-03 16:55:45.110 10511 10613 I TuningFork:Web: Connecting to: https://performanceparameters.googleapis.com/v1/applications/com.Unity3d.BoatAttackDay/apks/1:generateTuningParameters

Если вы допустили ошибку при настройке плагина, например забыли указать ключ API, в журналах инициализации появится сообщение об ошибке:

02-03 16:49:44.970  8815  8831 I TuningFork: Got settings from tuningfork/tuningfork_settings.bin
02-03 16:49:44.971  8815  8831 I TuningFork: Using local file cache at /data/user/0/com.Unity3d.BoatAttackDay/cache/tuningfork
02-03 16:49:44.972  8815  8831 I TuningFork: OpenGL version 3.2
02-03 16:49:44.972  8815  8831 W TuningFork.GE: The API key in Tuning Fork TFSettings is invalid
02-03 16:49:44.972  8815  8831 E TuningFork: TuningFork.GoogleEndpoint: FAILED
02-03 16:49:44.973  8815  8831 I Unity   : Tuningfork started with code: BadParameter

Убедитесь, что Android Performance Tuner загружает телеметрию. Если вы видите в журналах TuningFork initialized, подождите ещё немного и найдите журналы, указывающие на то, что телеметрия загружается.

02-03 16:58:00.552 10511 10611 I TuningFork:Web: Connecting to: https://performanceparameters.googleapis.com/v1/applications/com.Unity3d.BoatAttackDay/apks/1:uploadTelemetry
02-03 16:58:00.898 10511 10611 I TuningFork:Web: Response code: 200
02-03 16:58:00.898 10511 10611 I TuningFork:Web: Response message: OK
02-03 16:58:00.899 10511 10611 I TuningFork.GE: UPLOAD request returned 200 {}

Вы также можете найти в журналах строку "Connecting to:". Через несколько строк после этого сообщения будет указан код ответа.

Если вы не видите журналы загрузки телеметрии, убедитесь, что в настройках Android Performance Tuner задан небольшой интервал между загрузками, например 30 секунд.

Управление удалением кода

Google.Protobuf.dll использует рефлексию. При удалении кода может быть удален и нужный код. Чтобы этого не произошло, в плагине есть файл link.xml, в котором указано, какие символы нужно сохранить. Если вам нужны функции protobuf, использующие рефлексию, и у вас включено удаление кода, добавьте эту информацию в файл link.xml, чтобы сохранить символы.

Дополнительную информацию об удалении управляемого кода можно найти в документации Unity.

Если вам нужно сохранить все символы в protobuf, добавьте в проект файл link.xml со следующим содержимым:

<linker>
  <assembly fullname="Google.Protobuf" preserve="all"/>
</linker>

Предварительная компиляция (AOT)

Предварительная компиляция требуется для серверной части IL2CPP и версий Unity 2017 и 2018 (но не для более поздних версий Unity).

AOT-компилятор может не генерировать код для универсальных методов. Вам нужно заставить компилятор сгенерировать код, необходимый для protobuf, добавив следующий метод:

using Google.Protobuf.Reflection;
using UnityEngine.Scripting;

...

// Don't call this method.
[Preserve]
void ExampleOfForceReflectionInitializationForProtobuf()
{
    FileDescriptor.ForceReflectionInitialization<Scene>();
    FileDescriptor.ForceReflectionInitialization<ShadowType>();
    FileDescriptor.ForceReflectionInitialization<LevelType>();
    ...
    // Add FileDescriptor.ForceReflectionInitialization<T> for each generated enum.
    // You can find the list of enums in DevTuningfork.cs -> enum section
    // or in the list of enums in Google -> Android Performance Tuner.
}

Дополнительную информацию об ограничениях скриптов можно найти в документации Unity.