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

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

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

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

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

Как это работает?

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

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

  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) => {
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

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

Наконец, функция отправляет сформированное сообщение в 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}`);
}
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

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

Обработка оповещения системы Performance Monitoring .

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

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

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

Наконец, функция отправляет сформированное сообщение в 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}`);
}
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

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

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

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

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

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

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

Наконец, функция отправляет сформированное сообщение в 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}`);
}
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

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

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