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 पर भेजता है:

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 पर भेजता है:

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

परफ़ॉर्मेंस की चेतावनी वाले उन सभी इवेंट के बारे में जानने के लिए जिन्हें कैप्चर किया जा सकता है, alerts के लिए Performance Monitoring रेफ़रंस दस्तावेज़ देखें.

एक चेतावनी वाले इवेंट को हैंडल करनाApp Distribution

इस सेक्शन में दिए गए उदाहरण में, नए टेस्टर के iOS डिवाइस की चेतावनियों के लिए फ़ंक्शन लिखने का तरीका बताया गया है.

इस उदाहरण में, यह फ़ंक्शन उन इवेंट को सुनता है जो हर बार तब भेजे जाते हैं, जब कोई टेस्टर नया iOS डिवाइस रजिस्टर करता है. जब कोई नया iOS डिवाइस रजिस्टर किया जाता है, तो आपको अपने प्रोविज़निंग प्रोफ़ाइल को उस डिवाइस के यूडीआईडी से अपडेट करना होता है. इसके बाद, ऐप्लिकेशन को फिर से डिस्ट्रिब्यूट करना होता है.

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 पर भेजता है:

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 चेतावनियों के लिए रेफ़रंस दस्तावेज़ देखें.

App Distribution से, इन-ऐप्लिकेशन फ़ीडबैक की Firebase चेतावनी से ट्रिगर होने वाले फ़ंक्शन का इस्तेमाल करने का तरीका जानने के लिए, Jira पर इन-ऐप्लिकेशन फ़ीडबैक भेजना लेख पढ़ें.App Distribution