Firebase Uyarıları tetikleyicileri

Firebase, çok çeşitli proje ve uygulama yönetimi etkinlikleri için uyarı sağlar. Firebase'in size bu türde bir uyarı gönderebileceği durumlara ilişkin birkaç örnek olayı burada bulabilirsiniz:

• Crashlytics için, uygulamanızın kilitlenmelerinde önemli bir artış olursa sizi uyarabiliriz.
• Performans İzleme için, uygulamanızın başlangıç ​​süresi yapılandırılmış eşiğinizi aşarsa sizi uyarabiliriz.
• Uygulama Dağıtımı için, test kullanıcılarınızdan biri yeni bir iOS cihazı kaydederse sizi uyarabiliriz.

Proje üyesi tarafından ayarlanan uyarıya ve tercihlere bağlı olarak Firebase, bu tür uyarıları Firebase konsolunda gösterir veya e-posta yoluyla gönderir.

Bu sayfada, Cloud Functions for Firebase'de (2. nesil) uyarı olaylarını işleyen işlevlerin nasıl yazılacağı açıklanmaktadır.

O nasıl çalışır?

Bu kaynaklar tarafından yayılan uyarı olaylarına yanıt olarak işlevleri tetikleyebilirsiniz:

• Bir Uygulama Dağıtımı uyarı olayını yönetin
• Bir Crashlytics uyarı olayını işleme
• Bir Performans İzleme uyarı olayını işleme

Tipik bir yaşam döngüsünde, bir uyarı olayı tarafından tetiklenen bir işlev aşağıdakileri yapar:

1. Firebase'den belirli bir uyarı türünün gönderilmesini dinler/bekler.
2. Uyarı verildiğinde tetikler ve olayla ilgili belirli bilgileri içeren olay yükünü alır.
3. Olay yükünü işlemek için işlevinizin kodunu çağırır.

Uyarı olaylarında bir işlevi tetikleyin

Uyarı olaylarını işleyen bir işlev yazmak için firebase-functions/v2/alerts alt paketini kullanın. Aşağıdaki ürüne özel örnekler, Firebase'den bir ürün için bir uyarı gönderildiğinde bir Discord kanalına mesaj göndermek için bir işlevin bir web kancası kullandığı bir iş akışını göstermektedir.

Önemli: Bu örneklerin her biri , Firebase için Cloud Functions'ı zaten kurmuş olduğunuzu varsayar.

Bir Crashlytics uyarı olayını işleme

Aşağıdaki Crashlytics örneğinde, yeni bir ölümcül kilitlenme sorununun uyarı olayını işlemek için Cloud Functions for Firebase'i kullanıyorsunuz. Bu işlev, uyarı bilgilerini bir mesajda bir Discord kanalına gönderir.

Yeni bir ölümcül kilitlenme sorunu için örnek bildirim

İşlev, Firebase'in yeni bir önemli sorun yayınlamasına karşılık gelen olayı dinler:

Node.js

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

Python (önizleme)

@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

İşlev daha sonra döndürülen olay nesnesini ayrıştırır, olay yükünden faydalı bilgileri ayrıştırır ve Discord kanalına gönderilecek bir mesaj oluşturur:

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

    # 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

Son olarak işlev, oluşturulan mesajı bir HTTP isteği aracılığıyla Discord'a gönderir:

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);
}
index.js

Python (önizleme)

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

Yakalayabileceğiniz tüm Crashlytics uyarı olayları hakkında bilgi edinmek için Crashlytics uyarıları referans belgelerine gidin.

Bir Performans İzleme uyarı olayını işleme

Bu örnek, performans eşiği uyarı olaylarını dinleyen bir işlevi dışa aktarır:

Node.js

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

Python (önizleme)

@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

İşlev daha sonra döndürülen olay nesnesini ayrıştırır, olay yükünden faydalı bilgileri ayrıştırır ve Discord kanalına gönderilecek bir mesaj oluşturur:

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

    # 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

Son olarak işlev, oluşturulmuş mesajı bir HTTP isteği aracılığıyla Discord'a gönderir:

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);
}
index.js

Python (önizleme)

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

Yakalayabileceğiniz tüm performans uyarısı olayları hakkında bilgi edinmek için Performans İzleme uyarıları referans belgelerine gidin.

Bir Uygulama Dağıtımı uyarı olayını yönetin

Bu bölümdeki örnek, yeni test cihazı iOS cihaz uyarıları için bir işlevi nasıl yazacağınızı gösterir.

Bu örnekte işlev, bir test kullanıcısı yeni bir iOS cihazını her kaydettiğinde gönderilen olayları dinler. Yeni bir iOS cihazı kaydedildiğinde, temel hazırlık profilinizi o cihazın UDID'si ile güncellemeniz ve ardından uygulamayı yeniden dağıtmanız gerekir.

Node.js

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

Python (önizleme)

@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

İşlev daha sonra döndürülen nesneyi ayrıştırır, olay yükünden faydalı bilgileri ayrıştırır ve Discord kanalına gönderilecek bir mesaj oluşturur:

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

    # 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

Son olarak işlev, oluşturulmuş mesajı bir HTTP isteği aracılığıyla Discord'a gönderir:

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);
}
index.js

Python (önizleme)

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

Yakalayabileceğiniz tüm Uygulama Dağıtımı uyarı olayları hakkında bilgi edinmek için Uygulama Dağıtımı uyarıları referans belgelerine gidin.

App Distribution'dan uygulama içi geri bildirim Firebase uyarısı tarafından tetiklenen bir işlevin nasıl kullanılacağını öğrenmek için Jira'ya uygulama içi geri bildirim gönderme bölümüne bakın.