Dodawanie niestandardowego monitorowania na potrzeby określonego kodu aplikacji

iOS+ Android Sieć Flutter

Performance Monitoring zbiera ślady, aby ułatwić Ci monitorowanie skuteczności aplikacji. Ślad to raport danych o skuteczności, który jest rejestrowany w aplikacji między 2 momentami w czasie.

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 w przypadku niestandardowego logu czasu jest jego „długość” (czas między punktem początkowym a końcowym logu czasu), ale możesz też dodać dane niestandardowe.

W kodzie definiujesz początek i koniec śledzenia niestandardowego kodu za pomocą interfejsów API dostępnych w pakiecie SDK Performance Monitoring. Ścieżki niestandardowego kodu można uruchomić w dowolnym momencie po ich utworzeniu i są one bezpieczne dla wątku.

Ponieważ domyślne dane zbierane dla tych logów czasu to „czas trwania”, czasami są one nazywane „śladami czasu trwania”.

Dane z tych ścieżek możesz wyświetlać na karcie Ścieżki niestandardowe w tabeli ścieżek, która znajduje się u dołu panelu Skuteczność (więcej informacji o używaniu konsoli znajdziesz dalej na tej stronie).

Uwaga: zbyt szybkie uruchamianie i zatrzymywanie ścieżek może wymagać dużych zasobów, dlatego nie zalecamy tworzenia ścieżek kodu niestandardowego z wysoką częstotliwością (np. raz na każdy obraz w grach).

Atrybuty domyślne, atrybuty niestandardowe i dane niestandardowe

W przypadku logów z niestandardowego kodu Performance Monitoring automatycznie rejestruje domyślne atrybuty (popularne metadane, takie jak wersja aplikacji, kraj, urządzenie itp.), dzięki czemu możesz filtrować dane w logach w konsoli Firebase. Możesz też dodawać i monitorować atrybuty niestandardowe (takie jak poziom gry czy 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 przypadku 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 Firebaseobok atrybutów i danych domyślnych dotyczących ścieżki.

Atrybut to wartość ciągu znaków, która pomaga filtrować i dzielić dane w konsoli. Dane to wartości liczbowe, które można przedstawić na wykresie i mierzyć w czasie.

Dodaj niestandardowe logi czasu kodu

Użyj interfejsu Trace API Performance Monitoring (Swift) | Obj-C, aby dodać niestandardowe logi czasu na potrzeby monitorowania konkretnego kodu 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 ścieżek kodu niestandardowego muszą spełniać te wymagania: nie mogą zawierać spacji na początku ani na końcu, znaku podkreślenia (_) na początku, a ich maksymalna długość to 100 znaków.
• Ścieżki niestandardowego kodu umożliwiają dodawanie danych niestandardowych i atrybutów niestandardowych.

Aby rozpocząć i zatrzymać śledzenie niestandardowego kodu, owiń kod, który chcesz śledzić, wierszami kodu podobnymi do tych:

Swift

Uwaga: ta usługa Firebase nie jest dostępna w przypadku docelowych systemów macOS, Mac Catalyst i watchOS.

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

Objective-C

Uwaga: ta usługa Firebase nie jest dostępna na systemy docelowe macOS, Mac Catalyst i watchOS.

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

Dodawanie danych niestandardowych do niestandardowych logów kodu

Użyj interfejsu Performance Monitoring Trace API (Swift | Objective-C), aby dodać do niestandardowych logów kodu dane niestandardowe.

Pamiętaj:

• Nazwy danych niestandardowych muszą spełniać te wymagania: nie mogą zawierać znaków niedrukowalnych ani spacjów na początku ani na końcu, nie mogą też zaczynać się od znaku podkreślenia (_). Ich maksymalna długość to 100 znaków.
• Każdy niestandardowy ślad kodu może rejestrować maksymalnie 32 wskaźniki (wliczając 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.

Swift

Uwaga: ta usługa Firebase nie jest dostępna w przypadku docelowych systemów macOS, Mac Catalyst i watchOS.

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

Objective-C

Uwaga: ta usługa Firebase nie jest dostępna w przypadku docelowych systemów macOS, Mac Catalyst i watchOS.

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

Tworzenie niestandardowych atrybutów do śledzenia niestandardowego kodu

Użyj interfejsu Performance Monitoring Trace API (Swift | Obj-C), aby dodać atrybuty niestandardowe do niestandardowych logów kodu.

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

Pamiętaj:

• Nazwy atrybutów niestandardowych muszą spełniać te wymagania:

  • Bez spacji na początku i na końcu, bez znaku podkreślenia (_) na początku
  • Brak pokoi
  • Maksymalna długość to 32 znaki
  • Dozwolone znaki w nazwie to A-Z, a-z i _.

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

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

  Więcej informacji o tej wytycznej

  Zbieranie danych użytkownika: usługa Performance Monitoring sama nie gromadzi żadnych informacji umożliwiających identyfikację, takich jak imiona i nazwiska, adresy e-mail czy numery telefonów. Deweloperzy mogą zbierać dodatkowe dane za pomocą Performance Monitoring przez utworzenie niestandardowych atrybutów w niestandardowych logach czasu kodu. Dane zbierane za pomocą Performance Monitoring nie powinny zawierać informacji umożliwiających identyfikację osoby przez Google.

  Oto przykład komunikatu logu, który nie zawiera informacji umożliwiających identyfikację:

  trace.putAttribute("experiment", "A");

  Oto przykład atrybutu niestandardowego, który zawiera informacje umożliwiające identyfikację (nie używaj tego typu atrybutu w aplikacji):

  trace.putAttribute("email", user.getEmailAddress());

  Dane, które zawierają informacje umożliwiające identyfikację, podlegają usunięciu bez powiadomienia.

Swift

Uwaga: ta usługa Firebase nie jest dostępna w przypadku docelowych systemów macOS, Mac Catalyst i watchOS.

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;

Objective-C

Uwaga: ta usługa Firebase nie jest dostępna na systemy docelowe macOS, Mac Catalyst i watchOS.

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

Ś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 z tygodnia na tydzień, lub sprawdzać, czy ostatnie zmiany w kodzie poprawiają skuteczność.

Panel Monitorowanie wydajności Firebase” />

Aby dodać dane do panelu danych:

1. Otwórz panel wydajności w konsoli Firebase.
2. Kliknij pustą kartę danych, a potem wybierz istniejące dane, które chcesz dodać do tablicy.
3. Kliknij na karcie wskaźnika, aby wyświetlić więcej opcji, na przykład zastąpić lub usunąć wskaźnik.

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 panel Skuteczność w konsoli Firebase, przewiń w dół do tabeli ścieżek i kliknij odpowiednią kartę. Tabela zawiera wybrane dane dotyczące każdego śladu. Możesz nawet posortować listę według zmiany procentowej konkretnego rodzaju danych.

Performance Monitoring udostępnia w konsoli Firebase stronę rozwiązywania problemów, na której wyróżnione są zmiany danych, co ułatwia szybkie rozwiązywanie problemów z wydajnością i minimalizowanie ich wpływu na aplikacje i użytkowników. Strony rozwiązywania problemów możesz używać, gdy dowiesz się o potencjalnych problemach z wydajnością, na przykład w takich sytuacjach:

• Wybierasz odpowiednie dane na panelu i zauważysz dużą różnicę.
• W tabeli śladów sortowanie odbywa się w taki sposób, aby największe wartości różnicy były wyświetlane u góry, a Ty widzisz znaczną zmianę procentową.
• Otrzymasz e-maila z powiadomieniem o problemie ze skutecznością.

Dostęp do strony rozwiązywania problemów możesz uzyskać na kilka sposobów:

• Na panelu danych kliknij przycisk Wyświetl szczegóły danych.
• Na dowolnej karcie wskaźnika kliknij => Wyświetl szczegóły. Na stronie rozwiązywania problemów wyświetlają się informacje o wybranych danych.
• W tabeli „Ścieżki” kliknij nazwę ścieżki lub dowolną wartość danych w wierszu powiązanym z tą ścieżką.
• W powiadomieniu e-mail kliknij Zbadaj teraz.

Po kliknięciu nazwy śledzenia w tabeli śledzenia możesz rozwinąć interesujące Cię dane. Aby filtrować dane według atrybutu, kliknij przycisk Filtr, na przykład:

Dane Monitorowania wydajności Firebase są filtrowane według atrybutu" />

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

Dowiedz się więcej o wyświetlaniu danych dotyczących prześledowań.

Następne kroki

• Dowiedz się więcej o używaniu atrybutów do sprawdzania danych o skuteczności.

• Dowiedz się więcej o śledzeniu problemów ze skutecznoś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 zespołu, jeśli czas trwania określonego śledzenia kodu niestandardowego przekroczy ustawiony przez Ciebie próg.

• wyświetlać szczegółowe raporty o sesjach użytkowników, w których można zobaczyć konkretny ślad w kontekście innych śladów zebranych w ramach tej samej sesji;