Firebase обеспечивает оповещения о широком спектре событий управления проектами и приложениями. Вот несколько примеров событий, когда Firebase может отправлять вам оповещения такого типа:
- Что касается Crashlytics , мы можем предупредить вас, если в вашем приложении резко увеличится количество сбоев.
- Что касается Performance Monitoring , мы можем предупредить вас, если время запуска вашего приложения превысит настроенный вами порог.
- Что касается App Distribution , мы можем предупредить вас, если один из ваших тестировщиков зарегистрирует новое устройство iOS.
В зависимости от оповещения и предпочтений, установленных участником проекта , Firebase отображает эти типы оповещений в консоли Firebase или отправляет их по электронной почте.
На этой странице описано, как писать функции в Cloud Functions for Firebase (2-го поколения), которые обрабатывают события оповещений.
Как это работает?
Вы можете запускать функции в ответ на события оповещений, создаваемые этими источниками:
- Обработка события оповещения App Distribution
- Обработка события оповещения Crashlytics
- Обработка события оповещения Performance Monitoring
В типичном жизненном цикле функция, запускаемая событием предупреждения, выполняет следующие действия:
- Прослушивает/ожидает отправки оповещений определенного типа от Firebase.
- Срабатывает при создании оповещения и получает полезную нагрузку события, содержащую конкретную информацию о событии.
- Вызывает код вашей функции для обработки полезных данных события.
Запуск функции при возникновении событий оповещения
Используйте подпакет firebase-functions/v2/alerts
чтобы написать функцию, которая обрабатывает события оповещений. В следующих примерах для конкретного продукта показан рабочий процесс, в котором функция использует вебхук для публикации сообщения на канал Discord, когда из Firebase отправляется предупреждение для этого продукта.
Обработка события оповещения Crashlytics
В следующем примере Crashlytics вы используете Cloud Functions for Firebase для обработки события оповещения о новой фатальной проблеме сбоя. Эта функция публикует информацию о предупреждении в сообщении на канал Discord.
Функция прослушивает событие, соответствующее публикации Firebase новой фатальной проблемы:
Node.js
exports.postfatalissuetodiscord = onNewFatalIssuePublished(async (event) => {
Питон
@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}\`
`;
Питон
# 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(response.error);
}
Питон
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) => {
Питон
@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}
`;
Питон
# 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(response.error);
}
Питон
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) => {
Питон
@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}
`;
Питон
# 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(response.error);
}
Питон
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 .