Триггеры оповещений Firebase

Firebase позволяет настроить оповещения о различных событиях, связанных с управлением проектами и приложениями. Вот несколько примеров событий, при которых Firebase может отправлять вам оповещения этого типа:

  • Для Crashlytics мы можем отправлять вам уведомления, если в приложении резко увеличится количество сбоев.
  • Для Performance Monitoring мы можем отправлять вам уведомления, если время запуска приложения превышает заданный вами порог.
  • Для App Distribution мы можем отправлять вам уведомления, если один из ваших тестировщиков зарегистрирует новое iOS-устройство.

В зависимости от типа оповещения и настроек, заданных участником проекта, Firebase показывает такие оповещения в консоли Firebase или отправляет их по электронной почте.

На этой странице рассказывается, как писать функции в Cloud Functions for Firebase (второе поколение), которые обрабатывают события оповещений.

Принципы работы

Функции можно запускать в ответ на события оповещений, исходящие из следующих источников:

В типичном жизненном цикле функция, активируемая событием оповещения, выполняет следующие действия:

  1. Ожидает, пока Firebase не отправит оповещение определенного типа.
  2. Срабатывает при отправке оповещения и получает полезную нагрузку события, содержащую информацию о нем.
  3. Вызывает код функции для обработки полезной нагрузки события.

Как настроить триггер функции на события оповещений

Используйте подпакет firebase-functions/v2/alerts, чтобы написать функцию, которая обрабатывает события оповещений. В приведенных ниже примерах для разных продуктов показан рабочий процесс, в котором функция использует веб-перехватчик, чтобы опубликовать сообщение в канале Discord, когда Firebase отправляет оповещение для этого продукта.

Как обрабатывать событие оповещения Crashlytics

В следующем примере Crashlytics используется Cloud Functions for Firebase для обработки события оповещения о новой критической ошибке. Эта функция отправляет информацию об оповещении в виде сообщения в канал Discord.

Пример уведомления о сбое в Discord

Пример уведомления о новой критической ошибке

Функция отслеживает событие, соответствующее публикации Firebase новой критической ошибки:

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

Затем функция анализирует возвращенный объект события, извлекая полезную информацию из полезной нагрузки события и создавая сообщение для публикации в канале 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()

Наконец, функция отправляет созданное сообщение в Discord с помощью 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(`Discord returned status code ${response.status}`);
}

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()

Чтобы узнать обо всех событиях оповещений Crashlytics, которые можно отслеживать, ознакомьтесь со справочной документацией по оповещениям Crashlytics.

Как обрабатывать событие оповещения Performance Monitoring

В этом примере экспортируется функция, которая прослушивает события оповещений о превышении порогового значения производительности:

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

Затем функция анализирует возвращенный объект события, извлекая полезную информацию из полезной нагрузки события и создавая сообщение для публикации в канале 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()

Наконец, функция отправляет созданное сообщение в Discord с помощью 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(`Discord returned status code ${response.status}`);
}

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()

Чтобы узнать обо всех событиях, связанных с оповещениями об эффективности, которые можно отслеживать, ознакомьтесь со справочной документацией по оповещениям Performance Monitoring.

Как обрабатывать событие оповещения App Distribution

В примере ниже показано, как написать функцию для уведомлений о новых устройствах тестировщиков iOS.

В этом примере функция прослушивает события, которые отправляются каждый раз, когда тестировщик регистрирует новое iOS-устройство. При регистрации нового iOS-устройства необходимо обновить профиль инициализации, добавив в него UDID устройства, а затем повторно распространить приложение.

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

Затем функция анализирует возвращенный объект, извлекая полезную информацию из полезной нагрузки события и создавая сообщение для публикации в канале 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()

Наконец, функция отправляет созданное сообщение в Discord с помощью 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(`Discord returned status code ${response.status}`);
}

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()

Чтобы узнать обо всех событиях оповещений App Distribution, которые можно отслеживать, ознакомьтесь со справочной документацией по оповещениям App Distribution.

Чтобы узнать, как использовать функцию, активируемую оповещением Firebase о отзыве в приложении из App Distribution, ознакомьтесь со статьей Как отправлять отзывы в приложении в Jira.