Firebase Alerts-Trigger

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

• Ab dem Crashlytics können wir Sie benachrichtigen, wenn die Anzahl der Abstürze Ihrer App stark zunimmt.
• Für Performance Monitoring können wir dich benachrichtigen, wenn der Startzeitpunkt deiner App über deinem konfigurierten Grenzwert.
• 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:

• Umgang mit einem App Distribution-Benachrichtigungsereignis
• Crashlytics-Benachrichtigungsereignis verarbeiten
• Performance Monitoring-Benachrichtigungsereignis verarbeiten

In einem typischen Lebenszyklus führt eine durch ein Benachrichtigungsereignis ausgelöste Funktion Folgendes:

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, bestimmte Informationen über das Ereignis enthält.
3. Ruft den Code Ihrer Funktion auf, um die Ereignisnutzlast zu verarbeiten.

Funktion für Benachrichtigungsereignisse auslösen

Verwenden Sie das Unterpaket firebase-functions/v2/alerts, um eine Funktion zu schreiben, die Benachrichtigungsereignisse verarbeitet. Die folgenden produktspezifischen Beispiele veranschaulichen einen Workflow, bei dem eine Funktion über einen Webhook eine Nachricht in einem Discord-Kanal postet, wenn eine Benachrichtigung für dieses Produkt von Firebase gesendet wird.

Crashlytics-Benachrichtigungsereignisse verarbeiten

Im folgenden Crashlytics-Beispiel verwenden Sie Cloud Functions for Firebase, um bei einem neuen schwerwiegenden Absturzproblem behandelt. Diese Funktion sendet die Benachrichtigungsinformationen in einer Nachricht an einen Discord-Kanal.

Die Funktion wartet auf das Ereignis, das Firebase entspricht. Veröffentlichung eines neuen schwerwiegenden Problems:

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

@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. nutzbringende Informationen aus der Ereignisnutzlast geparst und eine Nachricht an die auf dem Discord-Kanal posten:

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

    # 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 sendet die Funktion die erstellte Nachricht über eine HTTP-Anfrage an Discord:

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

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 für Crashlytics-Benachrichtigungen.

Performance Monitoring-Benachrichtigungsereignisse verarbeiten

In diesem Beispiel wird eine Funktion exportiert, die auf Ereignisse von Benachrichtigungen zu Leistungsgrenzwerten achtet:

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

@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 analysiert dann das zurückgegebene Ereignisobjekt, liest nützliche Informationen aus der Ereignisnutzlast und erstellt eine Nachricht, die im Discord-Kanal gepostet wird:

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

    # 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:

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

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 Leistungsbenachrichtigungsereignissen, die erfasst werden können, finden Sie in der Referenzdokumentation für Performance Monitoring Benachrichtigungen.

App Distribution-Benachrichtigungsereignisse verarbeiten

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

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

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

@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 analysiert dann das zurückgegebene Objekt und parst nützliche Informationen aus dem Ereignis. und eine Nachricht für die Veröffentlichung im Discord-Kanal zu erstellen:

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

    # 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:

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

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 für 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.