Google is committed to advancing racial equity for Black communities. See how.
Эта страница была переведа с помощью Cloud Translation API.
Switch to English

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

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

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

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

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

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

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

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

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

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

Добавить следы собственного кода

Используйте API отслеживания производительности ( Swift | Obj-C ), чтобы добавить пользовательские трассировки кода для отслеживания кода конкретного приложения.

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

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

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

Swift

// Add the Performance Monitoring module to your header
import FirebasePerformance

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

// code that you want to trace

trace.stop()

Цель-C

// Add the Performance Monitoring module to your header
@import FirebasePerformance;

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

// code that you want to trace

[trace stop];

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

Используйте API трассировки мониторинга производительности ( Swift | Obj-C ), чтобы добавить пользовательские метрики в трассировку пользовательского кода.

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

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

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

Swift

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.incrementMetric(named:"EVENT_NAME", by: 1)
// code that you want to trace (and log custom metrics)

trace.stop()

Цель-C

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace incrementMetric:@"EVENT_NAME" by:1];
// code that you want to trace (and log custom metrics)

[trace stop];

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

Используйте API трассировки мониторинга производительности ( Swift | Obj-C ) для добавления настраиваемых атрибутов в трассировки настраиваемого кода.

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

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

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

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

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

    Узнать больше об этом руководстве

Swift

let trace = Performance.startTrace(name: "CUSTOM_TRACE_NAME")

trace.setValue("A", forAttribute: "experiment")

// Update scenario.
trace.setValue("B", forAttribute: "experiment")

// Reading scenario.
let experimentValue:String? = trace.valueForAttribute("experiment")

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

// Read attributes.
let attributes:[String, String] = trace.attributes;

Цель-C

FIRTrace *trace = [FIRPerformance startTraceWithName:@"CUSTOM_TRACE_NAME"];

[trace setValue:@"A" forAttribute:@"experiment"];

// Update scenario.
[trace setValue:@"B" forAttribute:@"experiment"];

// Reading scenario.
NSString *experimentValue = [trace valueForAttribute:@"experiment"];

// Delete scenario.
[trace removeAttribute:@"experiment"];

// Read attributes.
NSDictionary <NSString *, NSString *> *attributes = [trace attributes];

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

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

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

изображение панели показателей Firebase Performance Monitoring

Чтобы добавить метрику в панель управления, перейдите на приборную панель Performance в Firebase консоли, а затем нажмите на вкладку Сводки. Щелкните пустую карточку метрики, затем выберите существующую метрику, чтобы добавить ее на панель инструментов. Щелкните на заполненной карточке метрики, чтобы дополнительные параметры, например заменить или удалить метрику.

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

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

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

Для просмотра этих следов, перейдите на приборную панель Performance в Firebase консоли, а затем нажмите на вкладку устройства.

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

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

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

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

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