Устранение неполадок и часто задаваемые вопросы о мониторинге производительности

Как посмотреть сообщения журнала для событий, связанных с производительностью

1. Включите ведение журнала отладки для Performance Monitoring во время сборки, добавив элемент <meta-data> в файл AndroidManifest.xml приложения, как показано ниже.

   <application>
       <meta-data
         android:name="firebase_performance_logcat_enabled"
         android:value="true" />
   </application>

2. Проверьте, нет ли в сообщениях журнала ошибок.

3. Performance Monitoring помечает сообщения журнала тегом FirebasePerformance. С помощью фильтрации logcat можно просматривать данные о продолжительности трассировки и регистрации сетевых запросов HTTP/S. Для этого выполните следующую команду:

   adb logcat -s FirebasePerformance

4. Проверьте, есть ли в журналах следующие типы записей, указывающие на то, что Performance Monitoring регистрирует события производительности:

   • Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
   • Logging network request trace: URL

5. Нажмите на URL, чтобы посмотреть данные в консоли Firebase. Обновление данных на панели управления может занять несколько минут.

Если ваше приложение не регистрирует события производительности, ознакомьтесь с советами по устранению неполадок.

Я добавил SDK в приложение, но в консоли по-прежнему показывается сообщение о том, что нужно добавить SDK

Firebase может определить, успешно ли вы добавили Performance Monitoring SDK в приложение, когда получит от него информацию о событиях (например, о взаимодействии с приложением). Обычно в течение 10 минут после запуска приложения на панели управления производительностью в консоли Firebase появляется сообщение "Обнаружен SDK". После этого в течение 30 минут на панели управления появятся первые обработанные данные.

Если вы добавили последнюю версию SDK в приложение более 10 минут назад, но изменения не появились, проверьте сообщения в журнале, чтобы убедиться, что Performance Monitoring регистрирует события. Чтобы устранить неполадки с задержкой обнаружения SDK, выполните описанные ниже действия.

В консоли указано, что SDK обнаружен, но данные не отображаются

Performance Monitoring обрабатывает данные о событиях, связанных с эффективностью, прежде чем показывать их на панели "Эффективность".

Если с момента появления сообщения "Обнаружен пакет SDK" прошло более 24 часов и вы по-прежнему не видите данные, проверьте панель статуса Firebase на наличие известных сбоев. Если сбоя нет, обратитесь в службу поддержки Firebase.

Приложение не регистрирует события, связанные с производительностью

Если вы не видите сообщения журнала для событий производительности, попробуйте выполнить следующие действия по устранению неполадок:

1. Проверьте настройки плагина Gradle Performance Monitoring, выполнив следующие действия:

   1. Убедитесь, что вы правильно добавили плагин. В частности, проверьте следующее:

      • Вы добавили плагин (apply plugin: 'com.google.firebase.firebase-perf') в модуль (на уровне приложения) в файле build.gradle.
      • Вы добавили зависимость classpath для плагина (classpath 'com.google.firebase:perf-plugin:2.0.2') в файл build.gradle на уровне проекта.

   2. Убедитесь, что плагин не отключен с помощью следующих флагов:

      • instrumentationEnabled в файле build.gradle на уровне модуля (приложения).
      • firebasePerformanceInstrumentationEnabled в файле gradle.properties

2. Убедитесь, что SDK Performance Monitoring неотключен с помощью одного из следующих флагов в файле AndroidManifest.xml:

   • firebase_performance_collection_enabled
   • firebase_performance_collection_deactivated

3. Убедитесь, что Performance Monitoring не отключен во время выполнения.

4. Если вы не можете найти в приложении ничего, что было отключено, обратитесь в службу поддержки Firebase.

На панели эффективности отсутствуют данные трассировки экрана

Если вы не видите данных о трассировке отрисовки экрана, попробуйте выполнить следующие действия:

1. Убедитесь, что вы используете последнюю версию Android SDK (22.0.6). Трассировка отрисовки экрана доступна только в версии 15.2.0 и более поздних.

2. Убедитесь, что вы не отключили вручную аппаратное ускорение для экрана.

3. Убедитесь, что вы не используете DexGuard или Jack. Performance Monitoring несовместим со следующими цепочками инструментов:

   • DexGuard отключает автоматический сбор трассировок запуска приложения, его работы на переднем плане и в фоновом режиме. Однако любые трассировки пользовательского кода должны работать нормально, если в приложении используется DexGuard.

   • Jack устарел и обычно не должен использоваться в приложении.

На панели эффективности отсутствуют данные специальной трассировки

Вы видите данные об эффективности для автоматически собранных трассировок, но не для трассировок пользовательского кода? Попробуйте выполнить следующие действия:

1. Если вы добавили трассировки пользовательского кода с помощью Trace API, проверьте настройки трассировок, в частности:

   • Названия специальных показателей и трассировок специального кода должны соответствовать следующим требованиям: не содержать пробелов в начале и конце, не начинаться с символа подчеркивания (_) и иметь длину не более 32 символов.
   • Все трассировки должны быть запущены и остановлены. Не будут регистрироваться трассировки, которые не были запущены, не были остановлены или были остановлены до запуска.

2. Если вы добавили трассировку пользовательского кода с помощью аннотаций @AddTrace, проверьте настройки плагина Gradle Performance Monitoring:

   1. Убедитесь, что вы правильно добавили плагин. В частности, проверьте следующее:

      • Вы добавили плагин (apply plugin: 'com.google.firebase.firebase-perf') в модуль (на уровне приложения) в файле build.gradle.
      • Вы добавили зависимость classpath для плагина (classpath 'com.google.firebase:perf-plugin:2.0.2') в файл build.gradle на уровне проекта.

   2. Убедитесь, что плагинне отключен с помощью одного из следующих флагов:

      • instrumentationEnabled в файле build.gradle на уровне модуля (приложения).
      • firebasePerformanceInstrumentationEnabled в файле gradle.properties

3. Проверьте сообщения журнала, чтобы убедиться, что Performance Monitoring регистрирует ожидаемые трассировки пользовательского кода.

4. Если Performance Monitoring регистрирует события, но данные не появляются в течение 24 часов, обратитесь в службу поддержки Firebase.

Сводка производительности: отсутствуют данные о сетевых запросах

Если вы не видите данные о сетевых запросах, попробуйте выполнить следующие действия по устранению неполадок:

1. Для приложений Android плагин Gradle Performance Monitoring позволяет использовать инструменты, которые обеспечивают автоматический мониторинг сетевых запросов HTTP/S. Проверьте следующее:

   1. Убедитесь, что вы правильно добавили плагин. В частности, проверьте следующее:

      • Вы добавили плагин (apply plugin: 'com.google.firebase.firebase-perf') в модуль (на уровне приложения) в файле build.gradle.
      • Вы добавили зависимость classpath для плагина (classpath 'com.google.firebase:perf-plugin:2.0.2') в файл build.gradle на уровне проекта.

   2. Убедитесь, что плагинне отключен с помощью одного из следующих флагов:

      • instrumentationEnabled в файле build.gradle на уровне модуля (приложения).
      • firebasePerformanceInstrumentationEnabled в файле gradle.properties

2. Проверьте, совместима ли сетевая библиотека с устройством. Performance Monitoring автоматически собирает показатели для сетевых запросов, в которых используются следующие библиотеки: OkHttp 3.x.x, URLConnection из Java и Apache HttpClient.

   Обратите внимание, что вы можете добавить специальный мониторинг для сетевых запросов.

3. Обратите внимание:

   • В зависимости от поведения вашего кода и сетевых библиотек, которые он использует, Performance Monitoring может сообщать только о завершенных сетевых запросах. Это означает, что открытые подключения HTTP/S могут не регистрироваться.

   • Performance Monitoring несовместим с DexGuard и Jack.

     • DexGuard отключает мониторинг сетевых запросов HTTP/S.
     • Jack устарел и обычно не должен использоваться в приложении.

   • Performance Monitoring не сообщает о сетевых запросах с недействительными заголовками Content-Type. Однако сетевые запросы без заголовков Content-Type по-прежнему будут приниматься.

Данные о сетевых запросах не агрегируются должным образом

Подробнее о том, как Performance Monitoring агрегирует данные о сетевых запросах в соответствии с шаблонами URL…

Вы также можете попробовать шаблоны собственных URL.

Что случилось с разделом "Основные проблемы" на карточке "Эффективность" на главной странице проекта?

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

Селектор приложений в верхней части карточки "Эффективность" фильтрует записи оповещений в разделе Последние оповещения. Отображаются только три последних оповещения для выбранных приложений.

Подробнее о настройке оповещений о проблемах с производительностью…

Почему в консоли больше нельзя задавать пороговые значения для проблем?

Performance Monitoring поддерживает оповещения о показателях, превышающих заданные пороговые значения. Чтобы избежать путаницы с настраиваемыми порогами для показателей эффективности, мы удалили возможность настраивать пороги для проблем.

Что случилось с информацией в разделах "Сведения" и "Показатели" в консоли Firebase?

Мы заменили страницы "Сведения" и "Показатели" на новый централизованный интерфейс, чтобы вам было удобнее устранять неполадки. Новый интерфейс устранения неполадок предлагает те же основные функции, что и разделы "Сведения" и "Показатели". Подробнее о том, как посмотреть больше данных для определенной трассировки…

Почему количество образцов не соответствует моим ожиданиям?

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

Чтобы управлять объемом собираемых данных, Performance Monitoring использует следующие варианты выборки:

• Ограничение частоты запросов на устройстве. Чтобы устройство не отправляло внезапные всплески трассировок, мы ограничили количество трассировок кода и трассировок сетевых запросов, отправляемых с устройства, до 300 событий каждые 10 минут. Такой подход защищает устройство от зацикливания, которое может привести к отправке большого количества данных об эффективности, и не позволяет одному устройству искажать результаты измерений.

• Динамическая выборка. Performance Monitoring ежедневно собирает ограниченное количество трассировок кода и сетевых запросов для каждого приложения у всех пользователей. На устройствах извлекается динамическая частота выборки (с помощью Firebase Remote Config), чтобы определить, должно ли случайное устройство записывать и отправлять трассировки. Устройство, не выбранное для выборки, не отправляет никаких событий. Динамическая частота выборки зависит от приложения и регулируется таким образом, чтобы общий объем собранных данных не превышал лимит.

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

  Сеансы пользователей отправляют дополнительные подробные данные с устройства пользователя, поэтому для сбора и отправки данных требуется больше ресурсов. Чтобы свести к минимуму влияние сеансов пользователей, Performance Monitoring также может ограничить количество сеансов.

• Ограничение частоты запросов на стороне сервера. Чтобы приложения не превышали лимит выборки, Performance Monitoring может использовать выборку на стороне сервера, чтобы отбрасывать некоторые события, полученные от устройств. Хотя такое ограничение не влияет на эффективность наших показателей, оно может привести к незначительным изменениям в статистике, в том числе к следующим:

  • Количество трассировок может отличаться от количества выполненных фрагментов кода.
  • Трассировки, тесно связанные в коде, могут иметь разное количество образцов.

Что случилось с вкладкой Проблемы в консоли?

Вместо вкладки "Проблемы" мы добавили оповещения, которые автоматически сообщают о превышении заданных вами пороговых значений. Вам больше не нужно вручную проверять консоль Firebase, чтобы узнать статус порога. Подробнее о настройке оповещений о проблемах с производительностью…

Что случилось с вкладками На устройстве и Сеть в консоли? Как посмотреть трассировки, которые были на этих страницах?

Мы изменили раздел Performance Monitoring в консоли Firebase. Теперь на вкладке Панель управления собраны основные показатели и все ваши трассировки. В рамках редизайна мы удалили страницы На устройстве и Сеть.

В таблице трассировок в нижней части вкладки Панель управления представлена вся информация, которая была на вкладках На устройстве и Сеть, но с некоторыми дополнительными функциями, в том числе возможностью сортировать трассировки по процентному изменению определенного показателя. Чтобы посмотреть все показатели и данные для определенной трассировки, нажмите на ее название в таблице трассировок.

Посмотреть трассировки можно на следующих вкладках таблицы трассировок:

• Трассировки сетевых запросов (стандартные и специальные) – вкладка Сетевые запросы.
• Трассировки пользовательского кода – вкладка Специальные трассировки
• Трассировки запуска приложения, работы приложения на переднем плане и работы приложения в фоновом режиме – вкладка Собственные трассировки.
• Трассировка отрисовки экрана – вкладка Отрисовка экрана
• Трассировки загрузки страниц – вкладка Загрузка страницы

Подробную информацию о таблице трассировок и просмотре показателей и данных можно найти на странице обзора консоли (iOS+ | Android | веб).

Почему количество медленных и зависших кадров не соответствует моим ожиданиям?

Кадры с медленной отрисовкой и зависшие кадры рассчитываются исходя из частоты обновления экрана устройства 60 Гц. Если частота обновления устройства ниже 60 Гц, каждый кадр будет отрисовываться медленнее, поскольку в секунду отрисовывается меньше кадров. Если рендеринг выполняется медленнее, то в отчете будет больше медленных или зависших кадров, поскольку больше кадров будет отрисовываться медленнее или зависать. Однако если частота обновления устройства выше 60 Гц, каждый кадр будет отрисовываться быстрее. Это может привести к тому, что будет регистрироваться меньше медленных или зависших кадров. Это текущее ограничение SDK Performance Monitoring.

Почему я не вижу трассировку фрагментов?

Чтобы отслеживать эффективность фрагментов в дополнение к действиям в приложении, убедитесь, что в вашем приложении используется Performance Monitoring Android SDK версии 20.1.0 или более поздней. Подробнее о том, как добавить в приложение функцию мониторинга производительности…

Как понять, какие трассировки связаны с фрагментами и действиями?

Каждая трассировка фрагмента и действия основана на имени класса, заданном в приложении. Каждая трассировка экрана содержит префикс st, за которым следует название класса. В консоли Firebase префикс удаляется. Подробнее о данных об эффективности отрисовки экрана в приложениях для Android и iOS …

Почему фрагментов трассировки меньше, чем других трассировок?

Performance Monitoring проводит выборку событий для всех событий, собранных на устройстве. Это позволяет нам собирать с устройств пользователей минимальное количество событий, необходимое для получения показателей эффективности.

Как узнать о проблемах с производительностью отрисовки в моем приложении?

Performance Monitoring позволяет настроить оповещения для важных показателей. Для сгенерированных трассировок отрисовки экрана можно настроить оповещения, которые будут отправляться, когда процент медленных и зависших кадров превысит заданное вами пороговое значение.

После включения плагина Gradle Performance Monitoring время сборки увеличилось. Как улучшить этот показатель?

Performance Monitoring для Android использует инструментарий байт-кода, чтобы предоставлять некоторые готовые функции, например мониторинг сетевых запросов HTTP/S. В процессе компиляции необходимо пройти по всем классам приложения (включая зависимости), чтобы добавить в код инструменты, которые помогут измерять производительность сетевых запросов.

Вот некоторые факторы, которые могут привести к увеличению времени сборки:

• Количество курсов или файлов
• Размер каждого из этих классов (количество строк кода).
• Конфигурация вашего устройства
• Первая сборка и последующие сборки (обычно они выполняются быстрее).

Чтобы оптимизировать время сборки, попробуйте разбить код на модули.

Начиная с версии 1.3.3 плагина Performance Monitoring мы сосредоточились на значительном улучшении обработки инкрементной сборки и кеширования входных данных библиотеки. Чтобы воспользоваться последними улучшениями времени сборки, используйте последнюю версию плагина (2.0.2).

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

Что делать, если при сборке возникают ошибки из-за несовместимости библиотек с плагином Gradle Performance Monitoring?

Performance Monitoring для Android использует инструментарий байт-кода, чтобы предоставлять некоторые готовые функции, например мониторинг сетевых запросов HTTP/S. В процессе компиляции необходимо пройти по всем классам приложения (включая зависимости), чтобы добавить в код инструменты, которые помогут измерять производительность сетевых запросов.

Если после интеграции с плагином Performance Monitoring возникают ошибки сборки, например JSR/RET are not supported with computeFrames option, это может быть связано с тем, что у вас также есть зависимость от библиотеки, несовместимой с плагином Gradle Performance Monitoring.

Чтобы обойти эту проблему, вы можете исключить несовместимые классы или библиотеки из процесса инструментирования. Для этого выполните следующие действия:

1. Обновите плагин Gradle до последней версии Performance Monitoring (минимум v1.4.0).
2. Обновите плагин Android Gradle до версии 7.2.0 или более поздней.
3. Добавьте в файл build.gradle на уровне модуля (приложения) следующий флаг, чтобы исключить несовместимые классы и библиотеки из инструментации:

   android {
     // ...
     androidComponents {
       onVariants(selector().all(), {
           instrumentation.excludes.add("example.incompatible.library")
       })
     }
   }

   Чтобы узнать больше о свойстве exclude API Instrumentation плагина Android Gradle, ознакомьтесь с разделом Инструментарий.

Если при сборке возникают ошибки из-за несовместимых библиотек, сообщите об этом на GitHub, чтобы мы могли исключить эти библиотеки из инструментации в плагине Performance Monitoring.

Экспорт данных Performance Monitoring в BigQuery занимает больше времени, чем ожидалось. Данные не обновляются в реальном времени?

Если вы включили интеграцию BigQuery для Firebase Performance Monitoring, ваши данные будут экспортированы в BigQuery через 12–24 часа после окончания дня (по тихоокеанскому времени).

Например, данные за 19 апреля будут доступны в BigQuery 20 апреля в период с 12:00 до 00:00 (все даты и время указаны по тихоокеанскому времени).

Сколько пользовательских шаблонов URL можно создать?

Для одного приложения можно создать до 400 специальных шаблонов URL, а для домена этого приложения – до 100.

Что означает "данные об эффективности в реальном времени"?

Firebase Performance Monitoring обрабатывает собранные данные об эффективности по мере их поступления, поэтому в консоли Firebase они отображаются почти в реальном времени. Обработанные данные появляются в консоли через несколько минут после сбора, поэтому мы говорим о "почти реальном времени".

Чтобы обрабатывать данные почти в реальном времени, убедитесь, что в вашем приложении используется версия SDK, совместимая с обработкой в реальном времени.

Как получать данные об эффективности приложения почти в реальном времени?

Чтобы воспользоваться преимуществами обработки данных в режиме, близком к реальному времени, убедитесь, что в вашем приложении используется версия SDK Performance Monitoring, совместимая с этой функцией.

Ниже перечислены версии SDK, совместимые с данными в реальном времени:

• iOS – 7.3.0 или более поздней версии.
• tvOS – 8.9.0 или более поздняя версия.
• Android – версия 19.0.10 или более поздняя (или Firebase Android BoM – версия 26.1.0 или более поздняя).
• Веб-версия – 7.14.0 или более поздняя.

Мы всегда рекомендуем использовать последнюю версию SDK, но любая из перечисленных выше версий позволит Performance Monitoring обрабатывать ваши данные практически в реальном времени.

Какие версии Performance Monitoring SDK совместимы с режимом реального времени?

Ниже перечислены версии SDK, совместимые с обработкой данных в реальном времени:

• iOS – 7.3.0 или более поздней версии.
• tvOS – 8.9.0 или более поздняя версия.
• Android – версия 19.0.10 или более поздняя (или Firebase Android BoM – версия 26.1.0 или более поздняя).
• Веб-версия – 7.14.0 или более поздняя.

Мы всегда рекомендуем использовать последнюю версию SDK, но любая из перечисленных выше версий позволит Performance Monitoring обрабатывать ваши данные практически в реальном времени.

Что произойдет, если я не обновлю приложение, чтобы использовать версию SDK, совместимую с режимом реального времени?

Если в вашем приложении используется версия SDK, несовместимая с отчетами в реальном времени, вы все равно сможете просматривать данные о его эффективности в консоли Firebase. Однако данные об эффективности будут показываться с задержкой примерно в 36 часов с момента сбора.

Я перешел на версию SDK, совместимую с данными в реальном времени, но некоторые пользователи по-прежнему используют старые версии моего приложения. Будут ли их данные об эффективности показываться в консоли Firebase?

Да! Независимо от того, какая версия SDK используется в экземпляре приложения, вы будете видеть данные о производительности всех пользователей.

Однако если вы смотрите недавние данные (не старше 36 часов), то они относятся к пользователям экземпляров приложений, в которых используется версия SDK, совместимая с отчетами в реальном времени. Старые данные включают данные об эффективности всех версий приложения.

Почему я не вижу данные о производительности в реальном времени?

Чтобы просматривать данные об эффективности в реальном времени, убедитесь, что в вашем приложении используется версия SDK Performance Monitoring, совместимая с обработкой данных в реальном времени.

• iOS – 7.3.0 или более поздней версии.
• tvOS – 8.9.0 или более поздняя версия.
• Android – версия 19.0.10 или более поздняя (или Firebase Android BoM – версия 26.1.0 или более поздняя).
• Веб-версия – 7.14.0 или более поздняя.

Мы всегда рекомендуем использовать последнюю версию SDK, но любая из перечисленных выше версий позволит Performance Monitoring обрабатывать ваши данные практически в реальном времени.