Obsługa błędów i komunikaty dotyczące społecznościowego oprogramowania sprzęgającego

Ze względu na wygodę użytkowników kod powinien prawidłowo obsługiwać błędy. Wyświetlanie użytkownikom komunikatów o błędach z praktycznego opisu czynności, które należy wykonać, w rozwiązaniu problemu.

W tym dokumencie opisujemy błędy, które mogą wystąpić w oprogramowaniu sprzęgającym, oraz opisaliśmy, oraz jak prawidłowo obsługiwać błędy oprogramowania sprzęgającego.

Informacja: aby dowiedzieć się więcej o obsłudze wyjątków w JavaScripcie, zapoznaj się z artykułem try...catch instrukcje.

Rodzaje błędów

Typy i przyczyny błędów, które mogą napotkać użytkownik podczas korzystania z zwykle można zaliczyć je do jednej z tych 3 kategorii:

1. wewnętrzne błędy oprogramowania sprzęgającego
2. zewnętrzne błędy oprogramowania sprzęgającego
3. Błędy Looker Studio

Oprogramowanie sprzęgające powinno obsługiwać wewnętrzne i zewnętrzne błędy oprogramowania sprzęgającego Google Play. Te błędy występują z powodu kodu utworzonego przez dewelopera.

Błąd wewnętrzny oprogramowania sprzęgającego

Podczas wykonywania tego oprogramowania występują błędy wewnętrzne oprogramowania sprzęgającego. Jeśli na przykład plik oprogramowanie sprzęgające nie może przeanalizować odpowiedzi interfejsu API podczas wykonywania zadania getData(). Błędy te należy przewidzieć i wyjaśnić je w przyjazny dla użytkownika sposób w odpowiednich przypadkach.

Więcej informacji na temat obsługi wewnętrznych błędów oprogramowania sprzęgającego znajdziesz w artykule Sprawdzone metody postępowania z błędami oprogramowania sprzęgającego

Zewnętrzny błąd oprogramowania sprzęgającego

Po wykonaniu tego oprogramowania występują zewnętrzne błędy oprogramowania sprzęgającego. Na przykład, gdy plik Żądanie getData() dotyczące 3 pól zwraca dane tylko dla dwóch. Mimo że Oprogramowanie sprzęgające zakończyło wykonanie, nie spełniło żądania z Lookera Studio. Może to zapobiec szczegółowym testom.

Zewnętrzne błędy oprogramowania sprzęgającego można zwykle naprawić, sprawdzając szczegóły błędu (jeśli oraz debugowanie kodu w celu wykrycia problemu. Więcej informacji na temat: aby debugować oprogramowanie sprzęgające, przeczytaj artykuł Debugowanie kodu.

Błąd narzędzia Looker Studio

Błędy Looker Studio to błędy niezwiązane z kodem oprogramowania sprzęgającego. Przykład: jeśli użytkownik próbuje użyć wykresu ciągu czasowego ze źródłem danych bez daty/godziny.

Jeśli błąd nie jest bezpośrednio związany z oprogramowaniem sprzęgającym, nie ma żadnego działania. dla programisty oprogramowania sprzęgającego. Dodatkową pomoc użytkownicy mogą znaleźć na stronie Centrum pomocy Looker Studio.

Wyświetlam komunikaty o błędach

Wyświetlam szczegóły błędu na podstawie stanu administratora

Jeśli oprogramowanie sprzęgające zgłosi błąd, Looker Studio wyświetli komunikat o błędzie w zależności od stanu administratora.

• Jeśli użytkownik jest administratorem, zobaczy wszystkie szczegóły. Obejmuje to m.in. komunikat o błędzie, typ błędu i zrzut stosu.
• Jeśli użytkownik nie jest administratorem, zobaczy szczegóły tylko wtedy, gdy zawiera komunikat łatwy w obsłudze. Więcej informacji o wyświetlaniu błędu wiadomości wysyłane do użytkowników bez uprawnień administracyjnych znajdziesz w artykule Wyświetlanie błędów zgłaszanych przez użytkowników.

.

Ważne: wdrożenie isAdminUser() umożliwia wskazanie administratorów zapewniających odpowiedni poziom szczegóły są wyświetlane użytkownikom oprogramowania sprzęgającego.

Zgłaszane błędy napotykane przez użytkowników

Domyślnie szczegóły błędu widzą tylko administratorzy oprogramowania sprzęgającego. Dzięki temu zapobiegamy przypadkowe ujawnienie informacji poufnych, takich jak klucz interfejsu API w stosie stosu. śledzić. Aby wyświetlić komunikaty o błędach użytkownikom bez uprawnień administratora, użyj funkcji newUserError() z Usługa Apps Script Looker Studio.

Przykład:

try {
  // API request that can be malformed.
  getDataFromAPI();
} catch (e) {
  DataStudioApp.createCommunityConnector()
      .newUserError()
      .setDebugText('Error fetching data from API. Exception details: ' + e)
      .setText('There was an error communicating with the service. Try again later, or file an issue if this error persists.')
      .throwException();

}

W tym przykładzie setText() ustawia tekst, który będzie wyświetlany wszystkim użytkownikom. a setDebugText() ustawia tekst, który będzie widoczny tylko dla administratorów.

Sprawdzone metody postępowania z błędami oprogramowania sprzęgającego

Postaraj się wykryć i poprawić jak najwięcej błędów w trakcie uruchomienia kodu oprogramowania sprzęgającego. Są to na przykład typowe operacje, które mogą które powodują błędy lub są niepożądane:

• Nieudana próba pobrania adresu URL (błędy tymczasowe, przekroczenia limitu czasu)
• Brak dostępnych danych dla żądanego okresu
• Nie można przeanalizować ani sformatować danych z interfejsu API
• Tokeny autoryzacji zostały unieważnione

Obsługa błędów możliwych do naprawienia

Punkty wykonania oprogramowania sprzęgającego, które mogą ulec awarii, ale które można odzyskać, powinny być obsługiwane. Jeśli na przykład żądania do interfejsu API zakończą się niepowodzeniem z przyczyny niekrytycznej (np. podczas zrzucania obciążenia serwera), należy ponowić próbę, zanim wystąpi błąd.

Wyłapywanie i zgłaszanie błędów

Błędy nieodwracalne należy wykryć i wyrzucić ponownie. błąd ponownego zgłoszenia, powinno pomóc użytkownikom zrozumieć, dlaczego wystąpił błąd. czy problem można rozwiązać. należy podać szczegółowe informacje dotyczące działań naprawczych.

Zapoznaj się z sekcją zrzucanie błędów dotyczących użytkowników.

Rejestrowanie błędów w usłudze Stackdriver

Używaj usługi Stackdriver do rejestrowania błędów i innych komunikatów. Ułatwia to zrozumienie błędów, debugowanie problemów i wykrywanie nieobsługiwanych wyjątków.

Aby dowiedzieć się więcej o usłudze Stackdriver Error Reporting, o tym, jak włączyć logowanie wyjątków oraz jak bezpiecznie identyfikować użytkowników do celów debugowania – zapoznaj się z artykułem Korzystanie z usługi Stackdriver Logging.

WYCOFANY: użyj prefiksu DS_USER:, aby wyświetlać bezpieczne komunikaty o błędach

Uwaga: ta funkcja została wycofana i zostanie usunięta w czerwcu 2019 r. Migruj do newUserError(). Zapoznaj się z sekcją zrzucanie błędów dotyczących użytkowników.

Aby ułatwić użytkownikom korzystanie z komunikatów o błędach, dodaj do przykładu Prefiks DS_USER: z komunikatami o błędach. Ten prefiks służy do identyfikowania bezpiecznych przeznaczone dla użytkowników bez uprawnień administracyjnych i nie są zawarte w rzeczywistym komunikacie o błędzie.

W poniższych przykładach komunikat o błędzie zostanie wyświetlony: użytkownicy bez uprawnień administracyjnych, w przypadku których komunikat o błędzie będzie wyświetlany tylko administratorowi użytkownicy:

data-studio/errors.gs

Wyświetl w GitHubie

// Admin and non-admin users will see the following error.
try {
  // Code that might fail.
} catch (e) {
  throw new Error('DS_USER:This will be shown to admin & non-admin.');
}

// Only admin users will see the following error.
try {
  // Code that might fail.
} catch (e) {
  throw new Error('This message will only be shown to admin users');
}

Uwaga: prefiks DS_USER: wskazuje tylko bezpieczne wiadomości dla użytkowników bez uprawnień administratora, w konkretnym komunikacie o błędzie wyświetlanym użytkownikom.