راه‌اندازی هشدارهای 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) => {

پایتون

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

درنهایت، تابع پیام ساخته‌شده را ازطریق درخواست HTTP به Discord ارسال می‌کند:

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}`);
}

پایتون

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 ارسال می‌کند:

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}`);
}

پایتون

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 ارسال می‌کند:

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}`);
}

پایتون

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 را ببینید.