Dodaj niestandardowe monitorowanie dla określonego kodu aplikacji

Monitorowanie wydajności zbiera ślady , aby pomóc Ci monitorować wydajność Twojej aplikacji. Ślad to raport danych o wydajności przechwyconych między dwoma punktami w czasie w Twojej aplikacji.

Możesz tworzyć własne ślady, aby monitorować dane dotyczące wydajności powiązane z określonym kodem w Twojej 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 wysłanie zapytania do bazy danych.

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

W swoim kodzie definiujesz początek i koniec niestandardowego śledzenia kodu przy użyciu interfejsów API udostępnianych przez zestaw SDK do monitorowania wydajności.

Niestandardowe śledzenie kodu można rozpocząć w dowolnym momencie po ich utworzeniu i są one bezpieczne dla wątków.

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

Możesz przeglądać dane z tych śladów na podkarcie Śledzenia niestandardowe w tabeli śledzenia, która znajduje się na dole pulpitu nawigacyjnego Wydajność (więcej informacji o korzystaniu z konsoli znajduje się w dalszej części tej strony).

Atrybuty domyślne, atrybuty niestandardowe i metryki niestandardowe

W przypadku niestandardowych śladów kodu funkcja Performance Monitoring automatycznie rejestruje domyślne atrybuty (typowe metadane, takie jak wersja aplikacji, kraj, urządzenie itp.), dzięki czemu można filtrować dane śledzenia w konsoli Firebase. Możesz także dodawać i monitorować niestandardowe atrybuty (takie jak poziom gry lub właściwości użytkownika).

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. Na przykład możesz utworzyć niestandardową metrykę dla liczby trafień i chybień w pamięci podręcznej lub liczby przypadków braku odpowiedzi interfejsu użytkownika 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 śledzenia.

Dodaj niestandardowe ślady kodu

Użyj interfejsu Performance Monitoring Trace API, aby dodać niestandardowe ślady kodu w celu monitorowania określonego kodu aplikacji.

Uwaga:

• Aplikacja może mieć wiele niestandardowych śladów kodu.
• W tym samym czasie można uruchomić więcej niż jedno niestandardowe śledzenie kodu.
• Nazwy niestandardowych śladów kodu muszą spełniać następujące wymagania: brak spacji na początku lub końcu, znak podkreślenia na początku ( _ ) i maksymalna długość to 100 znaków.
• Niestandardowe ślady kodu obsługują dodawanie niestandardowych metryk i niestandardowych atrybutów .

Aby rozpocząć i zatrzymać niestandardowe śledzenie kodu, otocz kod, który chcesz śledzić, kodem podobnym do następującego:

Trace customTrace = FirebasePerformance.instance.newTrace('custom-trace');
await customTrace.start();

// Code you want to trace

await customTrace.stop();

Dodaj niestandardowe metryki do niestandardowych śladów kodu

Użyj interfejsu API śledzenia monitorowania wydajności, aby dodać niestandardowe metryki do niestandardowych śladów kodu.

Uwaga:

• Nazwy metryk niestandardowych muszą spełniać następujące wymagania: brak spacji na początku lub końcu, znak podkreślenia ( _ ) na początku i maksymalna długość to 100 znaków.
• Każdy niestandardowy ślad kodu może rejestrować do 32 metryk (w tym domyślną metrykę czasu trwania ).

Aby dodać niestandardową metrykę, dodaj wiersz kodu podobny do poniższego za każdym razem, gdy wystąpi zdarzenie. 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ęci podręcznej lub ponowne próby.

Trace customTrace = FirebasePerformance.instance.newTrace("custom-trace");
await customTrace.start();

// Code you want to trace

customTrace.incrementMetric("metric-name", 1);

// More code

await customTrace.stop();

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

Aby użyć atrybutów niestandardowych, dodaj do aplikacji kod, który definiuje atrybut i kojarzy go z określonym niestandardowym śladem kodu. Atrybut niestandardowy można ustawić w dowolnym momencie między rozpoczęciem śledzenia a zatrzymaniem śledzenia.

Uwaga:

• Nazwy atrybutów niestandardowych muszą spełniać następujące wymagania: brak spacji na początku i końcu, znak podkreślenia ( _ ) na początku i maksymalna długość to 32 znaki.

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

• Nie należy używać atrybutów niestandardowych, które zawierają informacje umożliwiające Google identyfikację osoby.

Trace trace = FirebasePerformance.instance.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();

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

Śledź określone metryki na swoim pulpicie nawigacyjnym

Aby dowiedzieć się, jak kształtują się Twoje kluczowe dane, dodaj je do swojej tablicy wskaźników u góry panelu wydajności . Możesz szybko zidentyfikować regresje, obserwując zmiany z tygodnia na tydzień lub sprawdzając, czy ostatnie zmiany w kodzie poprawiają wydajność.

Aby dodać dane do swojej tablicy metryk, przejdź do panelu Performance w konsoli Firebase, a następnie kliknij kartę Panel . Kliknij pustą kartę metryki, a następnie wybierz istniejącą metrykę, aby dodać ją do swojej tablicy. Kliknij pionowy wielokropek ( ⋮ ) na wypełnionej karcie danych, aby wyświetlić więcej opcji, takich jak zastąpienie lub usunięcie danych.

Tablica metryk pokazuje zebrane dane metryk w czasie, zarówno w formie graficznej, jak i liczbowej zmiany procentowej.

Dowiedz się więcej o korzystaniu z pulpitu nawigacyjnego .

Zobacz ślady i ich dane

Aby wyświetlić ślady, przejdź do pulpitu wydajności w konsoli Firebase, przewiń w dół do tabeli śladów, a następnie kliknij odpowiednią kartę podrzędną. W tabeli przedstawiono niektóre najważniejsze metryki dla każdego śladu, a nawet można posortować listę według zmiany procentowej dla określonej metryki.

Jeśli klikniesz nazwę śladu w tabeli śladów, możesz kliknąć różne ekrany, aby eksplorować ślad i przejść do interesujących Cię metryk. Na większości stron możesz użyć przycisku Filtruj (w lewym górnym rogu ekranu), 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 Twojej bazy danych nie ma wpływu na określony region

Dowiedz się więcej o przeglądaniu danych dla swoich śladów .

Następne kroki

• Dowiedz się więcej o używaniu atrybutów do sprawdzania danych o 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 obniżają wydajność Twojej aplikacji. Na przykład możesz skonfigurować alert e-mail dla swojego zespołu, jeśli czas trwania określonego niestandardowego śledzenia kodu przekroczy ustawiony próg.