Awarie usługi App Center (React Native)

Ważne

Program Visual Studio App Center ma zostać wycofany 31 marca 2025 r. Mimo że możesz nadal używać programu Visual Studio App Center do momentu jej pełnego wycofania, istnieje kilka zalecanych alternatyw, do których można rozważyć migrację.

Dowiedz się więcej o osiach czasu pomocy technicznej i alternatywach.

• Android
• iOS
• MAUI/Xamarin
• UWP
• WPF/WinForms
• React Native
• macOS
• tvOS
• Unity
• Cordova

Awarie centrum aplikacji automatycznie wygenerują dziennik awarii za każdym razem, gdy aplikacja ulegnie awarii. Dziennik jest najpierw zapisywany w magazynie urządzenia, a gdy użytkownik ponownie uruchomi aplikację, raport o awarii zostanie wysłany do Centrum aplikacji. Zbieranie awarii działa zarówno w przypadku aplikacji beta, jak i na żywo, tj. przesłanych do sklepu Google Play. Dzienniki awarii zawierają cenne informacje ułatwiające naprawienie awarii.

Jeśli zestaw SDK nie został jeszcze skonfigurowany w aplikacji, postępuj zgodnie z sekcją Wprowadzenie.

Wszędzie tam, gdzie używasz usługi App Center Crash, dodaj następujący import w górnej części pliku.

// Import App Center Crashes at the top of the file.
import Crashes from 'appcenter-crashes';

Generowanie awarii testowej

Usługa App Center Crash udostępnia interfejs API umożliwiający wygenerowanie awarii testowej w celu łatwego testowania zestawu SDK. Ten interfejs API może być używany tylko w aplikacjach testowych/beta i nie wykonuje żadnych czynności w aplikacjach produkcyjnych.

Crashes.generateTestCrash();

Można również łatwo wygenerować awarię języka JavaScript. Dodaj następujący wiersz do kodu, który zgłasza błąd języka JavaScript i powoduje awarię.

throw new Error('This is a test javascript crash!');

Porada

Aby ta awaria została wysłana do Centrum aplikacji, należy skompilować aplikację React Native w trybie wydania.

Uwaga

Obecnie usługa App Center nie obsługuje map źródłowych w celu ujednolicenia śladów stosu JavaScript dla aplikacji systemu Android React Native.

Uwaga

Najlepszym rozwiązaniem jest uniknięcie instrukcji JavaScript throw z wartością ciągu (np. throw 'message'), ponieważ React Native nie zachowuje pełnego stosu języka JavaScript w tym scenariuszu. Zamiast tego javaScript throwError (np. throw Error('message')).

Uzyskaj więcej informacji o poprzedniej awarii

Usługa App Center Crash ma dwa interfejsy API, które zapewniają więcej informacji na wypadek awarii aplikacji.

Czy w poprzedniej sesji aplikacja otrzymała ostrzeżenie o niskiej ilości pamięci?

W dowolnym momencie po uruchomieniu zestawu SDK możesz sprawdzić, czy aplikacja otrzymała ostrzeżenie o pamięci w poprzedniej sesji:

const hadLowMemoryWarning = await Crashes.hasReceivedMemoryWarningInLastSession();

Uwaga

W niektórych przypadkach urządzenie z małą ilością pamięci może nie wysyłać zdarzeń.

Czy aplikacja uległa awarii w poprzedniej sesji?

W dowolnym momencie po uruchomieniu zestawu SDK możesz sprawdzić, czy aplikacja uległa awarii w poprzednim uruchomieniu:

const didCrash = await Crashes.hasCrashedInLastSession();

Jest to przydatne w przypadku, gdy chcesz dostosować zachowanie lub interfejs użytkownika aplikacji po wystąpieniu awarii. Niektórzy deweloperzy zdecydowali się pokazać dodatkowy interfejs użytkownika, aby przeprosić swoich użytkowników lub chcieć skontaktować się po wystąpieniu awarii.

Szczegóły dotyczące ostatniej awarii

Jeśli aplikacja uległa awarii wcześniej, możesz uzyskać szczegółowe informacje o ostatniej awarii.

const crashReport = await Crashes.lastSessionCrashReport();

Dostosowywanie użycia awarii centrum aplikacji

Usługa App Center Crash udostępnia wywołania zwrotne dla deweloperów w celu wykonywania dodatkowych akcji przed i podczas wysyłania dzienników awarii do centrum aplikacji.

Przetwarzanie awarii w języku JavaScript

Aby Crash.setListener metody działały zgodnie z oczekiwaniami, należy sprawdzić, czy aplikacja została prawidłowo skonfigurowana.

1. Otwórz plik projektu ios/YourAppName/AppDelegate.m i sprawdź, czy masz [AppCenterReactNativeCrashes register]; zamiast [AppCenterReactNativeCrashes registerWithAutomaticProcessing];.
2. Otwórz plik projektu android/app/src/main/res/values/strings.xml i sprawdź, appCenterCrashes_whenToSendCrashes czy ustawiono wartość ASK_JAVASCRIPT.

Wszystkie różne wywołania zwrotne odbiornika zdarzeń są omawiane jeden po jednym w tym dokumencie, ale należy ustawić jeden odbiornik zdarzeń, który definiuje wszystkie wywołania zwrotne jednocześnie.

Czy awaria powinna zostać przetworzona?

Zaimplementuj to wywołanie zwrotne, jeśli chcesz zdecydować, czy należy przetworzyć konkretną awarię, czy nie. Na przykład może wystąpić awaria na poziomie systemu, którą chcesz zignorować i że nie chcesz wysyłać do centrum aplikacji.

Crashes.setListener({

    shouldProcess: function (report) {
        return true; // return true if the crash report should be processed, otherwise false.
    },

    // Other callbacks must also be defined at the same time if used.
    // Default values are used if a method with return parameter isn't defined.
});

Uwaga

Aby użyć tej funkcji, należy prawidłowo skonfigurować aplikację dla usługi Awaryjnej.

Ta funkcja zależy od awarii przetwarzania w języku JavaScript.

Poproś użytkownika o zgodę na wysłanie dziennika awarii

Jeśli prywatność użytkownika jest dla Ciebie ważna, przed wysłaniem raportu o awarii do Centrum aplikacji należy uzyskać potwierdzenie użytkownika. Zestaw SDK uwidacznia wywołanie zwrotne, które informuje usługę App Center Crash o oczekiwaniu na potwierdzenie użytkownika przed wysłaniem raportów o awarii.

Jeśli zdecydujesz się to zrobić, odpowiadasz za uzyskanie potwierdzenia użytkownika, np. za pośrednictwem monitu dialogowego z jedną z następujących opcji: Zawsze wysyłaj, Wysyłaj i nie wysyłaj. Na podstawie danych wejściowych poinformujesz centrum aplikacji o awarii, co należy zrobić, a awaria zostanie odpowiednio obsłużona.

Uwaga

Zestaw SDK nie wyświetla okna dialogowego. Aplikacja musi podać własny interfejs użytkownika, aby poprosić o zgodę użytkownika.

Poniższe wywołanie zwrotne pokazuje, jak poinformować zestaw SDK o oczekiwaniu na potwierdzenie użytkownika przed wysłaniem awarii:

Crashes.setListener({

    shouldAwaitUserConfirmation: function (report) {

        // Build your own UI to ask for user consent here. SDK doesn't provide one by default.

        // Return true if you built a UI for user consent and are waiting for user input on that custom UI, otherwise false.
        return true;
    },

    // Other callbacks must also be defined at the same time if used.
    // Default values are used if a method with return parameter isn't defined.
});

Jeśli zwrócisz truepolecenie , aplikacja musi uzyskać (przy użyciu własnego kodu) uprawnienie użytkownika i zaktualizować zestaw SDK przy użyciu następującego interfejsu API:

import Crashes, { UserConfirmation } from 'appcenter-crashes';

// Depending on the user's choice, call Crashes.notifyUserConfirmation() with the right value.
Crashes.notifyUserConfirmation(UserConfirmation.DONT_SEND);
Crashes.notifyUserConfirmation(UserConfirmation.SEND);
Crashes.notifyUserConfirmation(UserConfirmation.ALWAYS_SEND);

Uwaga

Aby użyć tej funkcji, skonfiguruj aplikację prawidłowo dla usługi Awaria. Funkcja zależy od awarii przetwarzania w języku JavaScript.

Uzyskiwanie informacji o stanie wysyłania dziennika awarii

Czasami chcesz znać stan awarii aplikacji. Typowy przypadek użycia polega na tym, że możesz pokazać interfejs użytkownika, który informuje użytkowników, że aplikacja przesyła raport o awarii lub w przypadku, gdy aplikacja ulega awarii szybko po uruchomieniu, chcesz dostosować zachowanie aplikacji, aby upewnić się, że dzienniki awarii można przesłać. Usługa App Center Crash ma trzy różne wywołania zwrotne, których można użyć w aplikacji, aby otrzymywać powiadomienia o tym, co się dzieje.

W tym celu zdefiniuj odbiornik zdarzeń w kodzie, jak pokazano w poniższym przykładzie:

Crashes.setListener({
    onBeforeSending: function (report) {
        // called after Crashes.process and before sending the crash.
    },
    onSendingSucceeded: function (report) {
        // called when crash report sent successfully.
    },
    onSendingFailed: function (report) {
        // called when crash report couldn't be sent.
    }

    // Other callbacks must also be defined at the same time if used.
    // Default values are used if a method with return parameter isn't defined.
});

Wszystkie wywołania zwrotne są opcjonalne. Nie musisz udostępniać wszystkich 3 metod w obiekcie odbiornika zdarzeń, na przykład można zaimplementować tylko onBeforeSendingmetodę .

Uwaga

Aby użyć tej funkcji, należy prawidłowo skonfigurować aplikację dla usługi Awaryjnej.

Ta funkcja zależy od awarii przetwarzania w języku JavaScript.

Uwaga

Jeśli Crashes.setListener jest wywoływany więcej niż raz, ostatni wygrywa; zastępuje odbiorniki wcześniej ustawione przez Crashes.setListener.

Odbieranie onSendingFailed oznacza, że wystąpił błąd niemożliwy do odzyskania, taki jak kod 4xx . Na przykład 401 oznacza, że wartość jest nieprawidłowa appSecret .

To wywołanie zwrotne nie jest wyzwalane, jeśli jest to problem z siecią. W takim przypadku zestaw SDK ponawia próbę (a także wstrzymuje ponawianie próby, gdy połączenie sieciowe nie działa). W przypadku wystąpienia problemów z siecią lub awarii punktu końcowego i ponowne uruchomienie aplikacji onBeforeSending zostanie ponownie wyzwolone po ponownym uruchomieniu procesu.

Dodawanie załączników do raportu o awarii

Możesz dodać załączniki binarne i tekstowe do raportu o awarii. Zestaw SDK wyśle je wraz z awarią, aby można było je zobaczyć w portalu centrum aplikacji. Następujące wywołanie zwrotne jest wywoływane bezpośrednio przed wysłaniem przechowywanej awarii z poprzednich uruchomień aplikacji. Nie będzie wywoływana, gdy wystąpi awaria. Upewnij się, że plik załącznika nie ma nazwy, minidump.dmp ponieważ nazwa jest zarezerwowana dla plików minidump. Oto przykład dołączania tekstu i obrazu do awarii:

import Crashes, { ErrorAttachmentLog } from 'appcenter-crashes';

Crashes.setListener({
    getErrorAttachments(report) {
        const textAttachment = ErrorAttachmentLog.attachmentWithText('Hello text attachment!', 'hello.txt');
        const binaryAttachment = ErrorAttachmentLog.attachmentWithBinary(`${imageAsBase64string}`, 'logo.png', 'image/png');
        return [textAttachment, binaryAttachment];
    }

    // Other callbacks must also be defined at the same time if used.
    // Default values are used if a method with return parameter isn't defined.
});

Parametr fileName jest opcjonalny (może być null) i jest używany tylko w portalu Centrum aplikacji. Z określonego wystąpienia awarii w portalu można wyświetlić załączniki i pobrać je. Jeśli określono nazwę pliku, będzie to nazwa pliku do pobrania, w przeciwnym razie nazwa pliku zostanie wygenerowana.

Aby skonfigurować getErrorAttachments wywołanie zwrotne do pracy z funkcjami asynchronicznych/await ES2017, zamiast tego zwróć spełniona obietnicę. Poniższy przykład dołącza tekst i obraz do awarii w sposób asynchroniczny:

import Crashes, { ErrorAttachmentLog } from 'appcenter-crashes';

Crashes.setListener({
    getErrorAttachments(report) {
        return (async () => {
            const textContent = await readTextFileAsync(); // use your async function to read text file
            const binaryContent = await readBinaryFileAsync(); // use your async function to read binary file
            const textAttachment = ErrorAttachmentLog.attachmentWithText(textContent, 'hello.txt');
            const binaryAttachment = ErrorAttachmentLog.attachmentWithBinary(binaryContent, 'logo.png', 'image/png');
            return [textAttachment, binaryAttachment];
        })();
    }

    // Other callbacks must also be defined at the same time if used.
    // Default values are used if a method with return parameter isn't defined.
});

Uwaga

Aby użyć tej funkcji, należy prawidłowo skonfigurować aplikację dla usługi Awaryjnej.

Ta funkcja zależy od awarii przetwarzania w języku JavaScript.

Uwaga

Limit rozmiaru wynosi obecnie 1,4 MB w systemie Android i 7 MB w systemie iOS. Próba wysłania większego załącznika spowoduje wyzwolenie błędu.

Obsługiwane błędy

Centrum aplikacji umożliwia również śledzenie błędów przy użyciu obsługiwanych wyjątków za pomocą trackError metody . Aplikacja może opcjonalnie dołączyć właściwości lub/i załączniki do obsługiwanego raportu o błędach w celu zapewnienia dalszego kontekstu.

try {
    // Throw error.
} catch (error) {

    // Prepare properties.
    const properties = { 'Category' : 'Music', 'Wifi' : 'On' };

    // Prepare attachments.
    const textAttachment = ErrorAttachmentLog.attachmentWithText('Hello text attachment!', 'hello.txt');
    const attachments = [textAttachment];

    // Create an exception model from error.
    const exceptionModel1 = ExceptionModel.createFromError(error);

    // ..or generate with your own error data.
    const exceptionModel2 = ExceptionModel.createFromTypeAndMessage("type", "message", "stacktrace");

    // Track error with custom data.
    Crashes.trackError(exceptionModel1, properties, attachments);
    Crashes.trackError(exceptionModel1, properties, nil);
    Crashes.trackError(exceptionModel2, nil, attachments);
    Crashes.trackError(exceptionModel2, nil, nil);
}

Breakpad

Usługa App Center obsługuje awarie breakpadu z zestawu Android NDK w aplikacjach React Native.

Postępuj zgodnie z powyższymi normalnymi krokami konfiguracji, a następnie w przesłonięć MainActivity.javaOnCreate i dodaj konfigurację minidump i wywołaj kod macierzysty, który konfiguruje konfigurację breakpadu.

Przykład:

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    Crashes.getMinidumpDirectory().thenAccept(new AppCenterConsumer<String>() {
      @Override
      public void accept(String path) {
        // Path is null when Crashes is disabled.
        if (path != null) {
          // links to NDK
          setupBreakpadListener(path);
        }
      }
    });
  }

Włączanie lub wyłączanie awarii usługi App Center w czasie wykonywania

Możesz włączyć i wyłączyć awarie usługi App Center w czasie wykonywania. Jeśli ją wyłączysz, zestaw SDK nie będzie wykonywać żadnych raportów o awarii dla aplikacji.

await Crashes.setEnabled(false);

Aby ponownie włączyć awarie usługi App Center, użyj tego samego interfejsu API, ale przekaż true go jako parametr.

await Crashes.setEnabled(true);

Stan jest utrwalany w magazynie urządzenia w ramach uruchamiania aplikacji.

Sprawdzanie, czy w centrum aplikacji jest włączona awaria

Możesz również sprawdzić, czy usługa App Center Ulega awarii jest włączona, czy nie:

const enabled = await Crashes.isEnabled();