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

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

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

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

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

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

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

• App Distribution सूचना वाले इवेंट को मैनेज करना
• Crashlytics सूचना वाले इवेंट को हैंडल करना
• Performance Monitoring सूचना वाले इवेंट को हैंडल करना

आम तौर पर, अलर्ट इवेंट से ट्रिगर होने वाला फ़ंक्शन ये काम करता है:

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

सूचना वाले इवेंट पर फ़ंक्शन को ट्रिगर करना

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

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

Crashlytics सूचना वाले इवेंट को हैंडल करना

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

Performance Monitoring सूचना वाले इवेंट को हैंडल करना

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

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

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

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 सूचना से ट्रिगर किए गए फ़ंक्शन का इस्तेमाल करने का तरीका जानने के लिए, Jira में इन-ऐप्लिकेशन फ़ीडबैक भेजें लेख पढ़ें.