Firebase सूचना के ट्रिगर

Firebase कई तरह के प्रोजेक्ट और ऐप्लिकेशन मैनेजमेंट इवेंट के लिए सूचना देता है. Firebase आपको इस तरह की चेतावनी कब भेज सकता है, इसके लिए यहां कुछ इवेंट के उदाहरण दिए गए हैं:

• Crashlytics के लिए, आपके ऐप्लिकेशन के क्रैश की संख्या में अचानक बढ़ोतरी होने पर हम आपको सूचना दे सकते हैं.
• परफ़ॉर्मेंस मॉनिटर करने की सुविधा के लिए, अगर आपके ऐप्लिकेशन के शुरू होने का समय, कॉन्फ़िगर की गई थ्रेशोल्ड से ज़्यादा होता है, तो हम आपको इसकी सूचना दे सकते हैं.
• अगर आपका कोई टेस्टर, नया iOS डिवाइस रजिस्टर करता है, तो App Distribution के लिए हम आपको सूचना दे सकते हैं.

सूचना और प्रोजेक्ट के सदस्य की सेट की गई प्राथमिकताओं के आधार पर, Firebase इस तरह की सूचनाएं Firebase कंसोल में दिखाता है या उन्हें ईमेल से भेजता है.

इस पेज में Firebase के लिए Cloud Functions (2nd gen) में फ़ंक्शन लिखने का तरीका बताया गया है, जो चेतावनी वाले इवेंट को हैंडल करते हैं.

यह कैसे काम करता है?

इन सोर्स से जनरेट होने वाली सूचना इवेंट के जवाब में, फ़ंक्शन ट्रिगर किए जा सकते हैं:

• App Distribution से जुड़ी चेतावनी वाले इवेंट मैनेज करना
• Crshlytics से जुड़ी चेतावनी वाले इवेंट को मैनेज करें
• परफ़ॉर्मेंस के बारे में बताने वाले अलर्ट से जुड़े इवेंट को मैनेज करना

किसी सामान्य लाइफ़साइकल में, किसी सूचना इवेंट से ट्रिगर होने वाला फ़ंक्शन ये काम करता है:

1. Firebase से मिलने वाली किसी खास तरह की चेतावनी को सुनता है/इंतज़ार करता है.
2. यह तब ट्रिगर होता है, जब सूचना भेजी जाती है और उसे इवेंट पेलोड मिलता है. इसमें इवेंट के बारे में खास जानकारी होती है.
3. इवेंट पेलोड को हैंडल करने के लिए, आपके फ़ंक्शन के कोड को शुरू करता है.

सूचना से जुड़े इवेंट पर फ़ंक्शन ट्रिगर करें

firebase-functions/v2/alerts सबपैकेज का इस्तेमाल करके ऐसा फ़ंक्शन लिखें जो सूचना इवेंट को हैंडल करता हो. प्रॉडक्ट से जुड़े इन उदाहरणों में वर्कफ़्लो दिखाया गया है. इसमें Firebase से मिलने वाली सूचना को Discord चैनल पर पोस्ट करने के लिए, वेबहुक का इस्तेमाल किया गया है.

अहम जानकारी: इनमें से हर उदाहरण यह मानता है कि आपने पहले ही Firebase के लिए Cloud Functions सेट अप कर लिया है.

Crashlytics की चेतावनी वाले इवेंट को मैनेज करना

Crashlytics के नीचे दिए गए उदाहरण के लिए, किसी नई गंभीर समस्या की चेतावनी वाले इवेंट को मैनेज करने के लिए, 'Firebase के लिए Cloud Functions' का इस्तेमाल किया जाता है. यह फ़ंक्शन, 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 को बनाया गया मैसेज भेजता है:

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

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

परफ़ॉर्मेंस के बारे में बताने वाले अलर्ट से जुड़े इवेंट को मैनेज करना

इस उदाहरण में, ऐसे फ़ंक्शन को एक्सपोर्ट किया गया है जो परफ़ॉर्मेंस थ्रेशोल्ड के अलर्ट इवेंट के बारे में पता करता है:

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 को बनाया गया मैसेज भेजता है:

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

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

कैप्चर किए जा सकने वाले सभी परफ़ॉर्मेंस अलर्ट इवेंट के बारे में जानने के लिए, परफ़ॉर्मेंस मॉनिटर करने से जुड़ी चेतावनियों के रेफ़रंस दस्तावेज़ देखें.

App Distribution से जुड़ी चेतावनी वाले इवेंट को मैनेज करना

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

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

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 को बनाया गया मैसेज भेजता है:

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

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

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