Dodaj niestandardowe monitorowanie dla określonego kodu aplikacji

Monitorowanie wydajności zbiera ślady , które pomagają monitorować wydajność aplikacji. Ślad to raport danych dotyczących wydajności zarejestrowanych między dwoma punktami w czasie w aplikacji.

Możesz tworzyć własne ślady, aby monitorować dane dotyczące wydajności powiązane z określonym kodem w aplikacji. Dzięki niestandardowemu śledzeniu kodu możesz zmierzyć, ile czasu zajmuje Twojej aplikacji wykonanie określonego zadania lub zestawu zadań, na przykład załadowanie zestawu obrazów lub wykonanie zapytania w bazie danych.

Domyślną metryką niestandardowego śledzenia kodu jest jego „czas trwania” (czas pomiędzy punktem początkowym i końcowym śledzenia), ale można również dodać metryki niestandardowe .

W kodzie definiujesz początek i koniec niestandardowego śledzenia kodu przy użyciu interfejsów API udostępnianych przez zestaw SDK do monitorowania wydajności.Śledzenie kodu niestandardowego można uruchomić w dowolnym momencie po jego utworzeniu i jest ono bezpieczne dla wątków.

Ponieważ domyślną metryką zbieraną dla tych śladów jest „czas trwania”, czasami nazywane są one „śladami czasu trwania”.

Możesz wyświetlić dane z tych śladów na podkarcie Ślady niestandardowe tabeli śladów, która znajduje się na dole panelu kontrolnego Wydajność (więcej informacji na temat korzystania z konsoli znajdziesz w dalszej części tej strony).

Atrybuty domyślne, atrybuty niestandardowe i metryki niestandardowe

Możesz dodatkowo skonfigurować niestandardowe śledzenie kodu, aby rejestrować niestandardowe metryki dla zdarzeń związanych z wydajnością, które występują w zakresie śledzenia. Można na przykład utworzyć niestandardowy wskaźnik liczby trafień i chybień w pamięci podręcznej lub liczby przypadków, w których interfejs użytkownika przestanie odpowiadać przez zauważalny okres czasu.

Niestandardowe atrybuty i niestandardowe metryki są wyświetlane w konsoli Firebase obok domyślnych atrybutów i domyślnych metryk dla śledzenia.

Dodaj niestandardowe ślady kodu

Użyj interfejsu API śledzenia monitorowania wydajności ( Swift | Obj-C ), aby dodać niestandardowe ślady kodu w celu monitorowania kodu określonej aplikacji.

Zwróć uwagę na następujące kwestie:

• Aplikacja może mieć wiele niestandardowych śladów kodu.
• Jednocześnie można uruchomić więcej niż jedno śledzenie kodu niestandardowego.
• Nazwy niestandardowych śladów kodu muszą spełniać następujące wymagania: brak początkowych i końcowych białych znaków, brak początkowego znaku podkreślenia ( _ ), a maksymalna długość to 100 znaków.
• Niestandardowe ślady kodu obsługują dodawanie niestandardowych metryk i atrybutów niestandardowych .

Aby rozpocząć i zatrzymać śledzenie niestandardowego kodu, zawiń kod, który chcesz śledzić, liniami kodu podobnymi do poniższych:

// 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()

// 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];

Dodaj niestandardowe metryki do niestandardowych śladów kodu

Użyj interfejsu API śledzenia monitorowania wydajności ( Swift | Obj-C ), aby dodać niestandardowe metryki do niestandardowych śladów kodu.

Zwróć uwagę na następujące kwestie:

• Nazwy metryk niestandardowych muszą spełniać następujące wymagania: nie mogą zawierać początkowych ani końcowych białych znaków, nie mogą mieć początkowego znaku podkreślenia ( _ ), a maksymalna długość to 100 znaków.
• Każdy niestandardowy ślad kodu może rejestrować do 32 metryk (w tym domyślną metrykę Czas trwania ).

Aby dodać niestandardową metrykę, za każdym razem, gdy wystąpi zdarzenie, dodaj wiersz kodu podobny do poniższego. Na przykład ta niestandardowa metryka zlicza zdarzenia związane z wydajnością, które występują w Twojej aplikacji, takie jak trafienia w pamięć podręczną lub ponowne próby.

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()

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

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

[trace stop];

Utwórz niestandardowe atrybuty dla niestandardowych śladów kodu

Użyj interfejsu API śledzenia monitorowania wydajności ( Swift | Obj-C ), aby dodać niestandardowe atrybuty do niestandardowych śladów kodu.

Aby użyć atrybutów niestandardowych, dodaj do aplikacji kod, który definiuje atrybut i kojarzy go z określonym śledzeniem kodu niestandardowego. Atrybut niestandardowy można ustawić w dowolnym momencie pomiędzy rozpoczęciem a zakończeniem śledzenia.

Zwróć uwagę na następujące kwestie:

• Nazwy atrybutów niestandardowych muszą spełniać następujące wymagania:

  • Żadnych początkowych i końcowych białych znaków, żadnego początkowego znaku podkreślenia ( _ ).
  • Bez odstępów
  • Maksymalna długość to 32 znaki
  • Dozwolone znaki w nazwie to AZ , az i _ .

• Każdy niestandardowy ślad kodu może zarejestrować do 5 niestandardowych atrybutów.

• Upewnij się, że atrybuty niestandardowe nie zawierają żadnych informacji umożliwiających identyfikację danej osoby w oczach Google.

  Dowiedz się więcej o tych wytycznych

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;

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];

Śledź, przeglądaj i filtruj dane dotyczące wydajności

Śledź określone wskaźniki na swoim pulpicie nawigacyjnym

Aby dowiedzieć się, jakie są trendy w zakresie kluczowych wskaźników, dodaj je do tablicy wskaźników u góry pulpitu nawigacyjnego Wydajność . Możesz szybko zidentyfikować regresje, obserwując zmiany z tygodnia na tydzień lub sprawdzając, czy ostatnie zmiany w kodzie poprawiają wydajność.

Aby dodać metrykę do tablicy metryk, wykonaj następujące kroki:

1. Przejdź do panelu Wydajność w konsoli Firebase.
2. Kliknij pustą kartę metryki, a następnie wybierz istniejącą metrykę, aby dodać ją do swojej tablicy.
3. Kliknij more_vert na wypełnionej karcie metryki, aby uzyskać więcej opcji, na przykład zastąpić lub usunąć metrykę.

Tablica metryk przedstawia zebrane dane metryk w czasie, zarówno w formie graficznej, jak i jako liczbowa zmiana procentowa.

Dowiedz się więcej o korzystaniu z panelu kontrolnego .

Wyświetl ślady i ich dane

Aby wyświetlić swoje ślady, przejdź do panelu Wydajność w konsoli Firebase, przewiń w dół do tabeli śladów, a następnie kliknij odpowiednią podkartę. W tabeli wyświetlane są najważniejsze metryki dla każdego śladu. Można nawet posortować listę według procentowej zmiany określonej metryki.

Monitorowanie wydajności udostępnia stronę rozwiązywania problemów w konsoli Firebase, która podkreśla zmiany wskaźników, co ułatwia szybkie rozwiązywanie problemów z wydajnością i minimalizowanie ich wpływu na aplikacje i użytkowników. Ze strony rozwiązywania problemów możesz skorzystać, gdy dowiesz się o potencjalnych problemach z wydajnością, na przykład w następujących scenariuszach:

• Wybierasz odpowiednie dane na pulpicie nawigacyjnym i zauważasz dużą deltę.
• Sortujesz tabelę śladów, aby wyświetlić największe delty na górze i widzisz znaczną zmianę procentową.
• Otrzymasz powiadomienie e-mail z powiadomieniem o problemie z wydajnością.

Dostęp do strony rozwiązywania problemów można uzyskać w następujący sposób:

• Na panelu metryki kliknij przycisk Wyświetl szczegóły metryki .
• Na dowolnej karcie metrycznej wybierz more_vert => Zobacz szczegóły . Strona rozwiązywania problemów wyświetla informacje o wybranej metryce.
• W tabeli śladów kliknij nazwę śledzenia lub dowolną wartość metryki w wierszu powiązanym z tym śladem.
• W alercie e-mailowym kliknij Zbadaj teraz .

Klikając nazwę śledzenia w tabeli śladów, możesz przejść do interesujących Cię metryk. Kliknij Przycisk add filtr , aby filtrować dane według atrybutu, na przykład:

• Filtruj według wersji aplikacji, aby wyświetlić dane o poprzedniej lub najnowszej wersji
• Filtruj według urządzenia , aby dowiedzieć się, jak starsze urządzenia obsługują Twoją aplikację
• Filtruj według kraju , aby upewnić się, że lokalizacja bazy danych nie ma wpływu na konkretny region

Dowiedz się więcej o przeglądaniu danych dotyczących śladów .

Następne kroki

• Dowiedz się więcej o używaniu atrybutów do sprawdzania danych dotyczących wydajności.

• Dowiedz się więcej o śledzeniu problemów z wydajnością w konsoli Firebase.

• Skonfiguruj alerty dotyczące zmian w kodzie, które pogarszają wydajność Twojej aplikacji. Możesz na przykład skonfigurować alert e-mail dla swojego zespołu, jeśli czas trwania śledzenia określonego kodu niestandardowego przekroczy ustawiony próg.

• Przeglądaj szczegółowe raporty sesji użytkowników , w których możesz zobaczyć konkretny ślad w kontekście osi czasu innych śladów zebranych podczas tej samej sesji.