Dodawanie niestandardowego monitorowania na potrzeby określonego kodu aplikacji


Monitorowanie wydajności zbiera ślady, aby ułatwić Ci monitorowanie wydajności aplikacji. Ślad to raport danych o wydajności zarejestrowanych między 2 momentami w Twojej aplikacji.

Możesz tworzyć własne ścieżki, aby monitorować dane o wydajności powiązane z konkretnym kodem w aplikacji. Dzięki ścieżce niestandardowego kodu możesz mierzyć, ile czasu zajmuje aplikacji wykonanie określonego zadania lub zestawu zadań, np. wczytywanie zestawu obrazów lub wysyłanie zapytania do bazy danych.

Domyślnym wskaźnikiem niestandardowego śledzenia kodu jest jego „czas trwania” (czas między punkt początkowy i końcowy śledzenia), ale możesz dodać danych niestandardowych.

W kodzie definiujesz początek i koniec niestandardowego śledzenia kodu za pomocą interfejsów API udostępnianych przez pakiet SDK do monitorowania wydajności.

Śledzenie niestandardowego kodu można rozpocząć w dowolnym momencie po jego utworzeniu.

Domyślnym wskaźnikiem zbieranym w przypadku tych ścieżek jest „czas trwania”, dlatego są one czasami nazywane „ścieżkami czasu trwania”.

Dane z tych logów możesz wyświetlić na podkarcie Niestandardowe logi czasu. znajdującą się u dołu panelu Skuteczność (dowiedz się więcej o za pomocą konsoli na tej stronie).

Atrybuty domyślne, atrybuty niestandardowe i dane niestandardowe

W przypadku śladów niestandardowego kodu Monitorowanie wydajności automatycznie rejestruje domyślne atrybuty (popularne metadane, takie jak wersja aplikacji, kraj, urządzenie itp.), dzięki czemu możesz filtrować dane śladu w konsoli Firebase. Ty może też dodawać i monitorować atrybuty niestandardowe. (np. poziom gry lub właściwości użytkownika).

Możesz też skonfigurować śledzenie niestandardowego kodu, aby rejestrować dane niestandardowe dotyczące zdarzeń związanych z wydajnością, które występują w zakresie śledzenia. Możesz na przykład utworzyć dane niestandardowe dotyczące liczby trafień i błędów w pamięci podręcznej lub liczby razy, kiedy interfejs nie odpowiadał na żądania przez zauważalny okres czasu.

Atrybuty i dane niestandardowe są widoczne w konsoli Firebase obok atrybutów i danych domyślnych dotyczących śledzenia.

Dodaj niestandardowe logi czasu kodu

Użyj interfejsu Performance Monitoring Trace API, aby dodać niestandardowe logi kodu, które pozwolą Ci monitorować określony kod aplikacji.

Pamiętaj:

  • Aplikacja może mieć wiele ścieżek śledzenia kodu niestandardowego.
  • Możesz uruchamiać jednocześnie więcej niż 1 śledzenie kodu niestandardowego.
  • Nazwy niestandardowych logów czasu kodu muszą spełniać te wymagania: bez spacji na początku ani na końcu, bez znaku podkreślenia (_), a maksymalna długość to 100 znaków.
  • Niestandardowe logi czasu obsługują dodawanie niestandardowych danych atrybuty niestandardowe.

Aby rozpocząć i zatrzymać śledzenie kodu niestandardowego, użyj kodu podobnego do tego:

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

// Code you want to trace

await customTrace.stop();

Dodawanie niestandardowych wskaźników do niestandardowych logów czasu kodu

Używanie interfejsu Performance Monitoring Trace API , aby dodać niestandardowe wskaźniki do niestandardowych logów czasu kodu.

Pamiętaj:

  • Nazwy danych niestandardowych muszą spełniać te wymagania: bez spacji na początku ani na końcu, bez znaku podkreślenia (_), a maksymalna długość to 100 znaków.
  • Każdy ślad niestandardowego kodu może rejestrować maksymalnie 32 rodzaje danych (w tym domyślne dane Czas trwania).

Aby dodać dane niestandardowe, dodaj wiersz kodu podobnego do tego za każdym razem, gdy wystąpi zdarzenie. Te dane niestandardowe zliczają np. zdarzenia związane z wydajnością, które występują w aplikacji, np. trafienia do 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();

Tworzenie niestandardowych atrybutów do śledzenia niestandardowego kodu

Aby używać atrybutów niestandardowych, dodaj do aplikacji kod, który je definiuje wiąże go z określonym niestandardowym śladem kodu. Możesz określić w dowolnym momencie od rozpoczęcia śledzenia do jego zakończenia.

Pamiętaj:

  • Nazwy atrybutów niestandardowych muszą spełniać te wymagania: nie mogą zawierać spacji na początku ani na końcu, nie mogą zaczynać się od znaku podkreślenia (_), a ich maksymalna długość to 32 znaki.

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

  • Nie używaj atrybutów niestandardowych, które zawierają informacje umożliwiające 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();

Śledzenie, wyświetlanie i filtrowanie danych o skuteczności

Śledzenie określonych danych w panelu

Aby dowiedzieć się, jak zmieniają się Twoje kluczowe dane, dodaj je do panelu danych u góry panelu Skuteczność. Możesz szybko wykrywać regresje, obserwując zmiany tydzień do tygodnia lub sprawdzając, czy ostatnie zmiany w kodzie poprawiają skuteczność.

Aby dodać rodzaj danych do tablicy wskaźników, otwórz panel Skuteczność. w konsoli Firebase, a następnie kliknij kartę Panel informacyjny. Kliknij pustą kartę danych, a potem wybierz istniejące dane, które chcesz dodać do tablicy. Kliknij branżę. wielokropek () na wypełnionej karcie wskaźnika, aby zobaczyć więcej opcji, takich jak zastąpić lub usunąć dane.

Tablica danych pokazuje zebrane dane w ciągu czasu, zarówno w formie graficznej, jak i w postaci liczbowej zmiany procentowej.

Dowiedz się więcej o korzystaniu z panelu.

Wyświetlanie ścieżek i ich danych

Aby wyświetlić ścieżki, otwórz w konsoli Firebase panel Skuteczność, przewiń w dół do tabeli ścieżek, a potem kliknij odpowiednią kartę podrzędną. Tabela zawiera najważniejsze dane dotyczące każdego śledzenia. Możesz nawet posortować listę według procentowej zmiany konkretnego rodzaju danych.

Jeśli klikniesz nazwę logu czasu w tabeli logów czasu, możesz kliknąć różnych ekranów, aby zbadać ślad i przeanalizować interesujące Cię dane. 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:

  • Aby wyświetlić dane o poprzedniej lub najnowszej wersji, użyj filtra Wersja aplikacji.
  • Filtruj według kategorii Urządzenie, aby dowiedzieć się, jak starsze urządzenia obsługują Twoją aplikację.
  • Filtruj według kraja, aby mieć pewność, że lokalizacja bazy danych nie wpływa na konkretny region.

Dowiedz się więcej o wyświetlaniu danych dotyczących logów czasu.

Następne kroki

  • Więcej informacji o za pomocą atrybutów, by analizować dane o skuteczności.

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

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