लॉग लिखें और देखें


कोड को डीबग करने और मॉनिटर करने के लिए, लॉगिंग एक ज़रूरी टूल है. Cloud Functions की मदद से, Node.js या Python के लिए लॉगर SDK टूल का इस्तेमाल किया जा सकता है. इसके अलावा, वेब के लिए डेवलप करने के लिए, console ऑब्जेक्ट स्टैंडर्ड का इस्तेमाल भी किया जा सकता है.

Cloud Logging की सेवा के लिए शुल्क लिया जाता है. बिना किसी शुल्क के इस्तेमाल किए जा सकने वाले कोटे से ज़्यादा डेटा का इस्तेमाल करने पर, आपसे शुल्क लिया जा सकता है. ज़्यादा जानकारी के लिए, Cloud Logging की कीमतें देखें.

लॉग लिखना

Cloud Functions लॉगर SDK टूल का इस्तेमाल करना

Cloud Functions लॉगर SDK टूल, फ़ंक्शन से Cloud Logging में स्थिति की रिपोर्ट करने के लिए एक स्टैंडर्ड इंटरफ़ेस उपलब्ध कराता है. इस SDK टूल का इस्तेमाल करके, स्ट्रक्चर्ड डेटा के साथ इवेंट लॉग किए जा सकते हैं. इससे, इवेंट का आसानी से विश्लेषण और निगरानी की जा सकती है.

logger सब-पैकेज से इंपोर्ट करने के लिए:

Node.js

// All available logging functions
const {
  log,
  info,
  debug,
  warn,
  error,
  write,
} = require("firebase-functions/logger");

Python

from firebase_functions import logger
  • logger.log() कमांड का लॉग लेवल INFO होता है.

  • logger.info() कमांड का लॉग लेवल INFO होता है.

  • logger.warn() निर्देशों में चेतावनी का लॉग लेवल होता है.

  • logger.error() कमांड का लॉग लेवल ERROR होता है.

  • logger.debug() निर्देशों का लॉग लेवल डीबग होता है.

  • संगठन में एक से दूसरे उपयोगकर्ता को भेजे गए मैसेज का लॉग लेवल डीबग होता है.

यह उदाहरण, बेसिक लॉग लिखने वाले फ़ंक्शन के बारे में बताता है:

Node.js

exports.helloWorld = onRequest((request, response) => {
  // sends a log to Cloud Logging
  log("Hello logs!");

  response.send("Hello from Firebase!");
});

Python

@https_fn.on_request()
def hello_world(req: https_fn.Request) -> https_fn.Response:
    # sends a log to Cloud Logging
    logger.log("Hello logs!")

    return https_fn.Response("Hello from Firebase!")

अपने फ़ंक्शन कोड में, अलग-अलग तरह के लॉग के लिए अलग-अलग लॉग लेवल का इस्तेमाल करें. स्ट्रक्चर्ड डेटा को आखिरी तर्क के तौर पर लॉग में अटैच किया जा सकता है. यहां एक उदाहरण दिया गया है, जिसमें बताया गया है कि कोई फ़ंक्शन, हर तरह के लॉग का इस्तेमाल कैसे कर सकता है:

Node.js

exports.getInspirationalQuote = onRequest(async (request, response) => {
  const db = getFirestore();
  const today = new Date();
  const quoteOfTheMonthRef = db
      .collection("quotes")
      .doc(`${today.getFullYear()}`)
      .collection("months")
      .doc(`${today.getMonth()}`);

  const DEFAULT_QUOTE =
      "You miss 100% of the shots you don't take. -Wayne Gretzky";
  let quote;
  try {
    const quoteOfTheMonthDocSnap = await quoteOfTheMonthRef.get();

    // Attach relevant debugging information with debug()
    debug("Monthly quote fetch result", {
      docRef: quoteOfTheMonthRef.path,
      exists: quoteOfTheMonthDocSnap.exists,
      createTime: quoteOfTheMonthDocSnap.createTime,
    });

    if (quoteOfTheMonthDocSnap.exists) {
      quote = quoteOfTheMonthDocSnap.data().text;
    } else {
      // Use warn() for lower-severity issues than error()
      warn("Quote not found for month, sending default instead", {
        docRef: quoteOfTheMonthRef.path,
        dateRequested: today.toLocaleDateString("en-US"),
      });

      quote = DEFAULT_QUOTE;
    }
  } catch (err) {
    // Attach an error object as the second argument
    error("Unable to read quote from Firestore, sending default instead",
        err);

    quote = DEFAULT_QUOTE;
  }

  // Attach relevant structured data to any log
  info("Sending a quote!", {quote: quote});
  response.json({inspirationalQuote: quote});
});

Python

@https_fn.on_request()
def get_inspirational_quote(req: https_fn.Request) -> https_fn.Response:
    firestore_client = firestore.client()
    today = datetime.date.today()
    quote_of_the_month_ref = (firestore_client.collection("quotes").doc(str(
        today.year)).collection("months").doc(str(today.month)))

    default_quote = "Python has been an important part of Google since the beginning, and remains so as the system grows and evolves."

    quote = None
    try:
        quote_of_the_month = quote_of_the_month_ref.get()

        # Attach relevant debugging information with debug()
        logger.debug(
            "Monthly quote fetch result",
            docRef=quote_of_the_month.path,
            exists=quote_of_the_month.exists,
            createTime=quote_of_the_month.createTime,
        )

        if quote_of_the_month.exists:
            quote = quote_of_the_month.to_dict()["text"]
        else:
            # Use warn() for lower-severity issues than error()
            logger.warn(
                "Quote not found for month, sending default instead",
                doc_reference=quote_of_the_month.path,
                date_requested=today.strftime("%Y-%m-%d"),
            )
            quote = default_quote
    except:
        e = sys.exc_info()[0]
        # Attach an error object as the second argument
        logger.error("Unable to read quote from Firestore, sending default instead", error=e)
        quote = default_quote

    # Attach relevant structured data to any log
    logger.info("Sending a quote!", quote=quote)
    return https_fn.Response("Hello from Firebase!")

logger.write() की मदद से, CRITICAL, ALERT, और EMERGENCY के लॉग गंभीरता लेवल के साथ लॉग एंट्री लिखी जा सकती हैं. LogSeverity देखें.

Node.js

exports.appHasARegression = onRegressionAlertPublished((event) => {
  write({
    // write() lets you set additional severity levels
    // beyond the built-in logger functions
    severity: "EMERGENCY",
    message: "Regression in production app",
    issue: event.data.payload.issue,
    lastOccurred: event.data.payload.resolveTime,
  });
});

Python

@crashlytics_fn.on_regression_alert_published()
def app_has_regression(alert: crashlytics_fn.CrashlyticsRegressionAlertEvent) -> None:
    logger.write(
        severity="EMERGENCY",
        message="Regression in production app",
        issue=alert.data.payload.issue,
        last_occurred=alert.data.payload.resolve_time,
    )
    print(alert)

console.log का इस्तेमाल करना

किसी फ़ंक्शन से लॉग करने के लिए, अपने प्लैटफ़ॉर्म के लिए लॉगर SDK टूल का इस्तेमाल करने का सुझाव दिया जाता है. Node.js के साथ, console.log और console.error जैसे स्टैंडर्ड JavaScript लॉगिंग कॉल का इस्तेमाल किया जा सकता है. हालांकि, स्टैंडर्ड तरीकों को सही तरीके से काम करने के लिए, आपको पहले एक खास मॉड्यूल की ज़रूरत होगी:

require("firebase-functions/logger/compat");

लॉगर के साथ काम करने वाले मॉड्यूल को ज़रूरी बनाने के बाद, अपने कोड में console.log() के तरीकों का सामान्य तौर पर इस्तेमाल किया जा सकता है:

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
  • console.log() कमांड का लॉग लेवल INFO होता है.
  • console.info() कमांड का लॉग लेवल INFO होता है.
  • console.warn() कमांड का लॉग लेवल ERROR होता है.
  • console.error() कमांड का लॉग लेवल ERROR होता है.
  • संगठन में एक से दूसरे उपयोगकर्ता को भेजे गए मैसेज का लॉग लेवल डीबग होता है.

लॉग देखना

Cloud Functions के लॉग, Google Cloud कंसोल, Cloud Logging यूज़र इंटरफ़ेस (यूआई) या firebase कमांड-लाइन टूल से देखे जा सकते हैं.

Firebase CLI का इस्तेमाल करना

firebase टूल की मदद से लॉग देखने के लिए, functions:log कमांड का इस्तेमाल करें:

firebase functions:log

किसी खास फ़ंक्शन के लॉग देखने के लिए, फ़ंक्शन का नाम आर्ग्युमेंट के तौर पर डालें:

firebase functions:log --only <FUNCTION_NAME>

लॉग देखने के सभी विकल्पों की पूरी रेंज के लिए, functions:log के लिए सहायता देखें:

firebase help functions:log

Google Cloud कंसोल का इस्तेमाल करना

Google Cloud कंसोल में, फ़ंक्शन के लॉग देखे जा सकते हैं.

Cloud Logging यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करना

Cloud Logging यूज़र इंटरफ़ेस (यूआई) में Cloud Functions के लिए लॉग देखे जा सकते हैं.

लॉग का विश्लेषण करना

Cloud Logging, लॉग के विश्लेषण के लिए कई बेहतरीन टूल उपलब्ध कराता है. इनका इस्तेमाल करके, Cloud Functions को मॉनिटर किया जा सकता है.

चार्ट और सूचनाएं

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

चार्ट और सूचना देने की नीतियों में, लॉग पर आधारित मेट्रिक का इस्तेमाल करने के तरीके के बारे में ज़्यादा जानने के लिए, चार्ट और सूचनाएं बनाना लेख पढ़ें.