Firebase Alerts-Trigger

Firebase bietet Benachrichtigungen für eine Vielzahl von Ereignissen im Zusammenhang mit der Projekt- und App-Verwaltung. Hier sind einige Beispiele für Ereignisse, bei denen Firebase diese Art von Benachrichtigung senden kann:

  • Bei Crashlytics können wir Sie benachrichtigen, wenn die Anzahl der Abstürze Ihrer App drastisch zunimmt.
  • Bei Performance Monitoring können wir Sie benachrichtigen, wenn die Startzeit Ihrer App den konfigurierten Grenzwert überschreitet.
  • Bei App Distribution können wir Sie benachrichtigen, wenn einer Ihrer Tester ein neues iOS-Gerät registriert.

Je nach Benachrichtigung und den vom Projektmitglied festgelegten Einstellungen werden diese Benachrichtigungen in der Firebase Console angezeigt oder per E-Mail gesendet.

Auf dieser Seite wird beschrieben, wie Sie Funktionen in Cloud Functions for Firebase (2. Generation) schreiben, die Benachrichtigungsereignisse verarbeiten.

Funktionsweise

Sie können Funktionen als Reaktion auf Benachrichtigungsereignisse auslösen, die von diesen Quellen ausgegeben werden:

Der typische Lebenszyklus einer Funktion, die durch ein Benachrichtigungsereignis ausgelöst wird, sieht so aus:

  1. Wartet auf einen bestimmten Benachrichtigungstyp, der von Firebase ausgegeben wird.
  2. Wird ausgelöst, wenn die Benachrichtigung ausgegeben wird, und empfängt die Ereignisnutzlast, die spezifische Informationen zum Ereignis enthält.
  3. Ruft den Code Ihrer Funktion auf, um die Ereignisnutzlast zu verarbeiten.

Funktion bei Benachrichtigungsereignissen auslösen

Verwenden Sie das Unterpaket firebase-functions/v2/alerts, um eine Funktion zu schreiben, die Ereignisse für Benachrichtigungen verarbeitet. Die folgenden produktspezifischen Beispiele zeigen einen Workflow, bei dem eine Funktion einen Webhook verwendet, um eine Nachricht in einem Discord-Channel zu posten, wenn eine Benachrichtigung für dieses Produkt von Firebase ausgegeben wird.

Crashlytics-Benachrichtigungsereignis verarbeiten

Im folgenden Crashlytics-Beispiel wird Cloud Functions for Firebase verwendet, um ein Benachrichtigungsereignis für ein neues schwerwiegendes Absturzproblem zu verarbeiten. Diese Funktion postet die Benachrichtigungsinformationen in einer Nachricht in einem Discord-Kanal.

Beispiel für eine Absturzbenachrichtigung in Discord

Beispielbenachrichtigung für ein neues schwerwiegendes Absturzproblem

Die Funktion wartet auf das Ereignis, das dem Veröffentlichen eines neuen schwerwiegenden Problems durch Firebase entspricht:

Node.js

exports.postfatalissuetodiscord = onNewFatalIssuePublished(async (event) => {
index.js

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."""
main.py

Die Funktion parst dann das zurückgegebene Ereignisobjekt, extrahiert nützliche Informationen aus der Ereignisnutzlast und erstellt eine Nachricht, die im Discord-Kanal gepostet werden soll:

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}\`
`;
index.js

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()
main.py

Schließlich wird die erstellte Nachricht über eine HTTP-Anfrage an Discord gesendet:

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);
}
index.js

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()
main.py

Informationen zu allen Crashlytics-Benachrichtigungsereignissen, die Sie erfassen können, finden Sie in der Referenzdokumentation zu Crashlytics-Benachrichtigungen.

Performance Monitoring-Benachrichtigungsereignis verarbeiten

In diesem Beispiel wird eine Funktion exportiert, die auf Ereignisse für Leistungs-Schwellenwertbenachrichtigungen wartet:

Node.js

exports.postperformancealerttodiscord = onThresholdAlertPublished(
    async (event) => {
index.js

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."""
main.py

Die Funktion parst dann das zurückgegebene Ereignisobjekt, extrahiert nützliche Informationen aus der Ereignisnutzlast und erstellt eine Nachricht, die im Discord-Channel gepostet werden soll:

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}
    `;
index.js

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()
main.py

Schließlich sendet die Funktion die erstellte Nachricht über eine HTTP-Anfrage an Discord:

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);
}
index.js

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()
main.py

Informationen zu allen Ereignissen für Leistungsbenachrichtigungen, die Sie erfassen können, finden Sie in der Referenzdokumentation zu Performance Monitoring-Benachrichtigungen.

App Distribution-Warnereignis verarbeiten

Im Beispiel in diesem Abschnitt wird gezeigt, wie Sie eine Funktion für neue Benachrichtigungen für Tester auf iOS-Geräten schreiben.

In diesem Beispiel wartet die Funktion auf Ereignisse, die jedes Mal gesendet werden, wenn ein Tester ein neues iOS-Gerät registriert. Wenn ein neues iOS-Gerät registriert wird, müssen Sie Ihr Nutzerverwaltungsprofil mit der UDID dieses Geräts aktualisieren und die App dann neu verteilen.

Node.js

exports.postnewduuidtodiscord = onNewTesterIosDevicePublished(async (event) => {
index.js

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."""
main.py

Die Funktion parst dann das zurückgegebene Objekt, um nützliche Informationen aus der Ereignisnutzlast zu extrahieren und eine Nachricht zu erstellen, die auf dem Discord-Kanal gepostet werden soll:

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}
`;
index.js

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()
main.py

Schließlich sendet die Funktion die erstellte Nachricht über eine HTTP-Anfrage an Discord:

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);
}
index.js

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()
main.py

Informationen zu allen App Distribution-Benachrichtigungsereignissen, die Sie erfassen können, finden Sie in der Referenzdokumentation zu App Distribution-Benachrichtigungen.

Informationen zur Verwendung einer Funktion, die durch eine Firebase-Benachrichtigung zu In-App-Feedback von App Distribution ausgelöst wird, finden Sie unter In-App-Feedback an Jira senden.