Firebase wysyła alerty o różnych zdarzeniach związanych z zarządzaniem projektami i aplikacjami. Oto kilka przykładowych zdarzeń, w których Firebase może wysyłać tego typu alerty:
- W przypadku Crashlytics możemy wysłać Ci powiadomienie, jeśli w Twojej aplikacji nastąpi gwałtowny wzrost liczby awarii.
- W przypadku Performance Monitoring możemy wysyłać alerty, gdy czas uruchamiania aplikacji przekroczy skonfigurowany próg.
- W przypadku App Distribution możemy wysłać Ci powiadomienie, jeśli jeden z testerów zarejestruje nowe urządzenie z iOS.
W zależności od alertu i ustawień określonych przez członka projektu Firebase wyświetla te typy alertów w konsoli Firebase lub wysyła je e-mailem.
Na tej stronie opisano, jak pisać funkcje w Cloud Functions for Firebase (2 generacji), które obsługują zdarzenia alertu.
Jak to działa?
Możesz uruchamiać funkcje w odpowiedzi na zdarzenia alertu emitowane przez te źródła:
- Przetwarzanie alertu App Distribution
- Obsługa zdarzenia alertu Crashlytics
- Obsługa zdarzenia alertu Performance Monitoring
W typowym cyklu życia funkcja wywoływana przez zdarzenie alertu wykonuje te czynności:
- Słucha lub czeka na określony typ alertu wysłanego z Firebase.
- Wywołuje się, gdy zostanie wysłany alert, i otrzymuje ładunek zdarzenia zawierający szczegółowe informacje o zdarzeniu.
- wywołuje kod funkcji w celu obsługi ładunku zdarzenia.
Wywoływanie funkcji po wystąpieniu zdarzeń alertu
Użyj podpakietu firebase-functions/v2/alerts
, aby napisać funkcję, która obsługuje zdarzenia alertów. Poniższe przykłady dotyczące konkretnych usług pokazują proces, w którym funkcja używa webhooka do publikowania wiadomości na kanale Discord, gdy Firebase wyemituje alert dotyczący danej usługi.
Obsługa zdarzenia Crashlytics
W tym przykładzie Crashlytics używasz funkcji Cloud Functions for Firebase do obsługi zdarzenia alertu dotyczącego nowego krytycznego problemu z zawieszaniem. Ta funkcja publikuje informacje o alertach w wiadomości na kanale Discord.
Funkcja nasłuchuje zdarzenia odpowiadającego opublikowaniu przez Firebase nowego problemu krytycznego:
Node.js
exports.postfatalissuetodiscord = onNewFatalIssuePublished(async (event) => {
Python
@crashlytics_fn.on_new_fatal_issue_published(secrets=["DISCORD_WEBHOOK_URL"])
def post_fatal_issue_to_discord(event: crashlytics_fn.CrashlyticsNewFatalIssueEvent) -> None:
"""Publishes a message to Discord whenever a new Crashlytics fatal issue occurs."""
Następnie funkcja analizuje zwrócony obiekt zdarzenia, wyodrębniając przydatne informacje z ładunku zdarzenia i tworząc wiadomość do opublikowania w kanale Discord:
Node.js
// construct a helpful message to send to Discord
const appId = event.appId;
const {id, title, subtitle, appVersion} = event.data.payload.issue;
const message = `
🚨 New fatal issue for ${appId} in version ${appVersion} 🚨
**${title}**
${subtitle}
id: \`${id}\`
`;
Python
# Construct a helpful message to send to Discord.
app_id = event.app_id
issue = event.data.payload.issue
message = f"""
🚨 New fatal issue for {app_id} in version {issue.app_version} 🚨
# {issue.title}
{issue.subtitle}
ID: `{issue.id}`
""".strip()
Na koniec funkcja wysyła utworzony komunikat do Discorda za pomocą żądania HTTP:
Node.js
const response = await postMessageToDiscord("Crashlytics Bot", message);
if (response.ok) {
logger.info(
`Posted fatal Crashlytics alert ${id} for ${appId} to Discord`,
event.data.payload,
);
} else {
throw new Error(response.error);
}
Python
response = post_message_to_discord("Crashlytics Bot", message, DISCORD_WEBHOOK_URL.value)
if response.ok:
print(f"Posted fatal Crashlytics alert {issue.id} for {app_id} to Discord.")
pprint.pp(event.data.payload)
else:
response.raise_for_status()
Więcej informacji o wszystkich zdarzeniach alertu Crashlytics, które możesz rejestrować, znajdziesz w dokumentacji referencyjnej dotyczącej alertów Crashlytics.
Obsługa zdarzenia Performance Monitoring
W tym przykładzie eksportowana jest funkcja, która nasłuchuje zdarzeń alertów progowych dotyczących wydajności:
Node.js
exports.postperformancealerttodiscord = onThresholdAlertPublished(
async (event) => {
Python
@performance_fn.on_threshold_alert_published(secrets=["DISCORD_WEBHOOK_URL"])
def post_performance_alert_to_discord(event: performance_fn.PerformanceThresholdAlertEvent) -> None:
"""Publishes a message to Discord whenever a performance threshold alert is fired."""
Następnie funkcja analizuje zwrócony obiekt zdarzenia, wyodrębniając przydatne informacje z ładunku zdarzenia i tworząc wiadomość do opublikowania na kanale Discord:
Node.js
// construct a helpful message to send to Discord
const appId = event.appId;
const {
eventName,
metricType,
eventType,
numSamples,
thresholdValue,
thresholdUnit,
conditionPercentile,
appVersion,
violationValue,
violationUnit,
investigateUri,
} = event.data.payload;
const message = `
⚠️ Performance Alert for ${metricType} of ${eventType}: **${eventName}** ⚠️
App id: ${appId}
Alert condition: ${thresholdValue} ${thresholdUnit}
Percentile (if applicable): ${conditionPercentile}
App version (if applicable): ${appVersion}
Violation: ${violationValue} ${violationUnit}
Number of samples checked: ${numSamples}
**Investigate more:** ${investigateUri}
`;
Python
# Construct a helpful message to send to Discord.
app_id = event.app_id
perf = event.data.payload
message = f"""
⚠️ Performance Alert for {perf.metric_type} of {perf.event_type}: **{perf.event_name}** ⚠️
App ID: {app_id}
Alert condition: {perf.threshold_value} {perf.threshold_unit}
Percentile (if applicable): {perf.condition_percentile}
App version (if applicable): {perf.app_version}
Violation: {perf.violation_value} {perf.violation_unit}
Number of samples checked: {perf.num_samples}
**Investigate more:** {perf.investigate_uri}
""".strip()
Na koniec funkcja wysyła skonstruowaną wiadomość do Discord za pomocą żądania HTTP:
Node.js
const response = await postMessageToDiscord(
"Firebase Performance Bot", message);
if (response.ok) {
logger.info(
`Posted Firebase Performance alert ${eventName} to Discord`,
event.data.payload,
);
} else {
throw new Error(response.error);
}
Python
response = post_message_to_discord("App Performance Bot", message,
DISCORD_WEBHOOK_URL.value)
if response.ok:
print(f"Posted Firebase Performance alert {perf.event_name} to Discord.")
pprint.pp(event.data.payload)
else:
response.raise_for_status()
Aby dowiedzieć się więcej o wszystkich zdarzeniach alertów dotyczących skuteczności, które możesz rejestrować, zapoznaj się z dokumentacją referencyjną dotyczącą alertów Performance Monitoring.
Obsługa zdarzenia alertu App Distribution
Przykład w tej sekcji pokazuje, jak napisać funkcję dla nowych alertów dotyczących urządzeń z iOS dla testerów.
W tym przykładzie funkcja nasłuchuje zdarzeń, które są wysyłane za każdym razem, gdy tester rejestruje nowe urządzenie z iOS. Po zarejestrowaniu nowego urządzenia z iOS musisz zaktualizować profil udostępniania o identyfikator UDID tego urządzenia, a potem rozpowszechnić aplikację.
Node.js
exports.postnewduuidtodiscord = onNewTesterIosDevicePublished(async (event) => {
Python
@app_distribution_fn.on_new_tester_ios_device_published(secrets=["DISCORD_WEBHOOK_URL"])
def post_new_udid_to_discord(event: app_distribution_fn.NewTesterDeviceEvent) -> None:
"""Publishes a message to Discord whenever someone registers a new iOS test device."""
Następnie funkcja analizuje zwrócony obiekt, wyodrębniając przydatne informacje z ładunku zdarzenia i tworząc wiadomość do opublikowania w kanale Discord:
Node.js
// construct a helpful message to send to Discord
const appId = event.appId;
const {
testerDeviceIdentifier,
testerDeviceModelName,
testerEmail,
testerName,
} = event.data.payload;
const message = `
📱 New iOS device registered by ${testerName} <${testerEmail}> for ${appId}
UDID **${testerDeviceIdentifier}** for ${testerDeviceModelName}
`;
Python
# Construct a helpful message to send to Discord.
app_id = event.app_id
app_dist = event.data.payload
message = f"""
📱 New iOS device registered by {app_dist.tester_name} <{app_dist.tester_email}> for {app_id}
UDID **{app_dist.tester_device_identifier}** for {app_dist.tester_device_model_name}
""".strip()
Na koniec funkcja wysyła skonstruowaną wiadomość do Discord za pomocą żądania HTTP:
Node.js
const response = await postMessageToDiscord("AppDistribution Bot", message);
if (response.ok) {
logger.info(
`Posted iOS device registration alert for ${testerEmail} to Discord`,
);
} else {
throw new Error(response.error);
}
Python
response = post_message_to_discord("App Distro Bot", message, DISCORD_WEBHOOK_URL.value)
if response.ok:
print(f"Posted iOS device registration alert for {app_dist.tester_email} to Discord.")
pprint.pp(event.data.payload)
else:
response.raise_for_status()
Więcej informacji o wszystkich zdarzeniach alertu App Distribution, które możesz rejestrować, znajdziesz w dokumentacji referencyjnej dotyczącej alertów App Distribution.
Aby dowiedzieć się, jak korzystać z funkcji wywoływanej przez alert Firebase z opiniami w aplikacji z App Distribution, przeczytaj artykuł Wysyłanie opinii z aplikacji do Jira.