Добавьте собственный мониторинг для конкретного кода приложения.


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

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

Метрикой по умолчанию для пользовательской трассировки кода является ее «длительность» (время между начальной и конечной точками трассировки), но вы также можете добавить собственные метрики .

В своем коде вы определяете начало и конец пользовательской трассировки кода с помощью API, предоставляемых пакетом SDK Performance Monitoring .Для приложений Android вы также можете отслеживать определенные методы с помощью аннотации @AddTrace .Трассировки пользовательского кода можно запустить в любое время после их создания, и они потокобезопасны.

Поскольку метрикой по умолчанию, собираемой для этих трассировок, является «длительность», их иногда называют «длительность трассировок».

Данные из этих трассировок можно просмотреть на подвкладке «Пользовательские трассировки» таблицы трассировок, которая находится в нижней части панели мониторинга «Производительность» (подробнее об использовании консоли см. далее на этой странице).

Атрибуты по умолчанию, специальные атрибуты и специальные показатели.

Для трассировок пользовательского кода Performance Monitoring автоматически регистрирует атрибуты по умолчанию (общие метаданные, такие как версия приложения, страна, устройство и т. д.), чтобы вы могли фильтровать данные для трассировки в консоли Firebase . Вы также можете добавлять и отслеживать пользовательские атрибуты (например, уровень игры или свойства пользователя).

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

Пользовательские атрибуты и пользовательские метрики отображаются в консоли Firebase вместе с атрибутами по умолчанию и метрикой по умолчанию для трассировки.

Добавить пользовательские трассировки кода

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

Обратите внимание на следующее:

  • Приложение может иметь несколько трассировок пользовательского кода.
  • Одновременно может выполняться более одной трассировки пользовательского кода.
  • Имена для трассировок пользовательского кода должны соответствовать следующим требованиям: отсутствие начальных или конечных пробелов, отсутствие начального символа подчеркивания ( _ ), а максимальная длина — 100 символов.
  • Трассировки пользовательского кода поддерживают добавление пользовательских метрик и пользовательских атрибутов .

Чтобы запустить и остановить трассировку пользовательского кода, оберните код, который вы хотите отслеживать, строками кода, подобными следующим (в этом примере используется имя пользовательской трассировки test_trace ):

Kotlin+KTX

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace

myTrace.stop()
MainActivity.kt

Java

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.Trace;

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace

myTrace.stop();
MainActivity.java

(Необязательно) Отслеживайте определенные методы с помощью @AddTrace.

Приложения Android также поддерживают аннотацию @AddTrace для отслеживания пользовательского кода. Используя эту функцию, трассировка начинается в начале указанного метода и останавливается после его завершения, включая все, что вызывается этим методом.

Например, вы можете создать собственную трассировку кода под названием onCreateTrace , которая запускается при вызове метода onCreate() .

Kotlin+KTX

// Import these Performance Monitoring classes at the top of your `.kt` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
// the `enabled` argument is optional and defaults to true
@AddTrace(name = "onCreateTrace", enabled = true)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
}
MainActivity.kt

Java

// Import these Performance Monitoring classes at the top of your `.java` file
import com.google.firebase.perf.FirebasePerformance;
import com.google.firebase.perf.metrics.AddTrace;

// Add the `@AddTrace` annotation above the method you want to trace
@Override
@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
}
MainActivity.java

Добавление пользовательских метрик в пользовательские трассировки кода

Используйте API трассировки Performance Monitoring , чтобы добавлять пользовательские метрики в пользовательские трассировки кода.

Обратите внимание на следующее:

  • Имена специальных метрик должны соответствовать следующим требованиям: отсутствие начальных и конечных пробелов, отсутствие начального символа подчеркивания ( _ ), а максимальная длина — 100 символов.
  • Каждая трассировка пользовательского кода может записывать до 32 метрик (включая метрику «Длительность» по умолчанию).

Чтобы добавить специальную метрику, добавляйте строку кода, аналогичную следующей, каждый раз, когда происходит событие. Например, эта пользовательская метрика подсчитывает события, связанные с производительностью, которые происходят в вашем приложении, такие как попадания и промахи в кэше (используя примеры имен событий item_cache_hit и item_cache_miss и приращение 1 ).

Kotlin+KTX

val myTrace = Firebase.performance.newTrace("test_trace")
myTrace.start()

// code that you want to trace (and log custom metrics)
val item = cache.fetch("item")
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1)
} else {
    myTrace.incrementMetric("item_cache_miss", 1)
}

myTrace.stop()
MainActivity.kt

Java

Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
myTrace.start();

// code that you want to trace (and log custom metrics)
Item item = cache.fetch("item");
if (item != null) {
    myTrace.incrementMetric("item_cache_hit", 1);
} else {
    myTrace.incrementMetric("item_cache_miss", 1);
}

myTrace.stop();
MainActivity.java

Создание пользовательских атрибутов для пользовательских трассировок кода.

Используйте API трассировки Performance Monitoring , чтобы добавлять пользовательские атрибуты в пользовательские трассировки кода.

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

Обратите внимание на следующее:

  • Имена настраиваемых атрибутов должны соответствовать следующим требованиям:

    • Нет начальных или конечных пробелов, нет начального символа подчеркивания ( _ ).
    • Нет пробелов
    • Максимальная длина — 32 символа.
    • Допустимые символы для имени: AZ , az и _ .

  • Каждая трассировка пользовательского кода может записывать до 5 пользовательских атрибутов.

  • Убедитесь, что пользовательские атрибуты не содержат никакой информации, которая лично идентифицирует человека для Google.

    Подробнее об этом руководстве…

Kotlin+KTX

Firebase.performance.newTrace("test_trace").trace {
    // Update scenario.
    putAttribute("experiment", "A")

    // Reading scenario.
    val experimentValue = getAttribute("experiment")

    // Delete scenario.
    removeAttribute("experiment")

    // Read attributes.
    val traceAttributes = this.attributes
}
MainActivity.kt

Java

Trace trace = FirebasePerformance.getInstance().newTrace("test_trace");

// Update scenario.
trace.putAttribute("experiment", "A");

// Reading scenario.
String experimentValue = trace.getAttribute("experiment");

// Delete scenario.
trace.removeAttribute("experiment");

// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();
MainActivity.java

Отслеживайте, просматривайте и фильтруйте данные о производительности

Отслеживайте конкретные показатели на панели управления

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

изображение доски показателей в <span class= Панель мониторинга производительности Firebase" />

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

  1. Перейдите на панель мониторинга производительности в консоли Firebase .
  2. Нажмите пустую карточку показателя, затем выберите существующий показатель, чтобы добавить его на доску.
  3. Нажмите на заполненной карточке показателя, чтобы просмотреть дополнительные параметры, например заменить или удалить показатель.

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

Узнайте больше об использовании панели мониторинга .

Просмотр трассировок и их данных

Чтобы просмотреть трассировки, перейдите на панель мониторинга «Производительность» в консоли Firebase , прокрутите вниз до таблицы трассировок и щелкните соответствующую вложенную вкладку. В таблице отображаются некоторые основные метрики для каждой трассы, и вы даже можете отсортировать список по процентному изменению определенной метрики.

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

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

Вы можете получить доступ к странице устранения неполадок следующими способами:

  • На панели мониторинга показателей нажмите кнопку «Просмотреть сведения о метрике» .
  • На любой карточке показателя выберите => Посмотреть подробности . На странице устранения неполадок отображается информация о выбранной вами метрике.
  • В таблице трассировок щелкните имя трассировки или любое значение метрики в строке, связанной с этой трассировкой.
  • В уведомлении по электронной почте нажмите «Провести расследование» .

Щелкнув имя трассировки в таблице трассировок, вы сможете перейти к интересующим метрикам. Нажмите кнопку Кнопка фильтра для фильтрации данных по атрибуту, например:

изображение <span class= Данные мониторинга производительности Firebase фильтруются по атрибуту" />
  • Фильтруйте по версии приложения , чтобы просмотреть данные о предыдущей версии или последней версии.
  • Отфильтруйте по устройству, чтобы узнать, как старые устройства обрабатывают ваше приложение.
  • Фильтруйте по стране , чтобы убедиться, что расположение вашей базы данных не влияет на определенный регион.

Узнайте больше о просмотре данных для ваших трассировок .

Следующие шаги

  • Узнайте больше об использовании атрибутов для проверки данных о производительности.

  • Узнайте больше о том, как отслеживать проблемы с производительностью в консоли Firebase .

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

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