লগ লেখা ও দেখা

কোড ডিবাগ ও মনিটর করার জন্য লগিং একটি গুরুত্বপূর্ণ টুল। Cloud Functions আপনাকে Node.js বা Python-এর জন্য অথবা ওয়েবের জন্য ডেভেলপ করার জন্য console অবজেক্ট স্ট্যান্ডার্ডের জন্য লগার SDK ব্যবহার করার বিকল্প দেয়।

Cloud Logging হল একটি চার্জযোগ্য পরিষেবা; আপনি যদি ফ্রি কোটা অতিক্রম করেন, তাহলে আপনাকে বিল করা হতে পারে। আরও তথ্যের জন্য, Cloud Logging-এর দাম দেখুন।

লগ লেখা

Cloud Functions logger 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() কমান্ডের তথ্য লগ লেভেল আছে।

  • logger.info() কমান্ডের তথ্য লগ লেভেল আছে।

  • logger.warn() কমান্ডের লগ লেভেল সতর্কতা।

  • logger.error() কমান্ডের লগ লেভেল ERROR।

  • logger.debug() কমান্ডের লগ লেভেল DEBUG।

  • ইন্টার্নাল সিস্টেম মেসেজের লগ লেভেল 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 ব্যবহার করতে পারবেন, কিন্তু সঠিকভাবে কাজ করার জন্য স্ট্যান্ডার্ড পদ্ধতি প্যাচ করতে আপনাকে প্রথমে একটি বিশেষ মডিউল প্রয়োজন:

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() কমান্ডের তথ্য লগ লেভেল আছে।
  • console.info() কমান্ডের তথ্য লগ লেভেল আছে।
  • console.warn() কমান্ডের লগ লেভেল ERROR।
  • console.error() কমান্ডের লগ লেভেল ERROR।
  • ইন্টার্নাল সিস্টেম মেসেজের লগ লেভেল DEBUG হয়।

লগ দেখা

Cloud Functions-এর লগ Google Cloud কনসোল, Cloud Logging UI অথবা 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 UI ব্যবহার করা

আপনি Cloud Logging UI-তে Cloud Functions-এর জন্য লগ দেখতে পাবেন।

লগ বিশ্লেষণ করা

Cloud Logging লগ বিশ্লেষণ টুলের একটি শক্তিশালী স্যুট অফার করে যা আপনি Cloud Functions মনিটর করতে ব্যবহার করতে পারেন।

চার্ট ও সতর্কতা

আপনার ফাংশন মনিটর করার জন্য লগ-ভিত্তিক মেট্রিক তৈরি করা হয়ে গেলে, আপনি এইসব মেট্রিকের উপর ভিত্তি করে চার্ট ও অ্যালার্ট তৈরি করতে পারবেন। যেমন, আপনি সময়ের সাথে সাথে লেটেন্সি ভিজ্যুয়ালাইজ করতে একটি চার্ট তৈরি করতে পারেন অথবা কোনও নির্দিষ্ট সমস্যা খুব ঘন ঘন হলে তা আপনাকে জানানোর জন্য একটি অ্যালার্ট তৈরি করতে পারেন।

চার্ট ও অ্যালার্ম নীতিতে কীভাবে লগ-ভিত্তিক মেট্রিক ব্যবহার করতে হয় সেই সম্পর্কে বিস্তারিত তথ্য পেতে চার্ট ও অ্যালার্ট তৈরি করা দেখুন।

এক্সিকিউশন আইডি বোঝা ও ব্যবহার করা

ডিফল্ট হিসেবে, Cloud Run ফাংশন (২য় জেনারেশন) একটি ফাংশন ইনস্ট্যান্সের মধ্যে একাধিক অনুরোধের কনকারেন্ট এক্সিকিউশন সমর্থন করে। এর অর্থ হল, আলাদা আলাদা অনুরোধের লগ ইন্টারলিভ করা যেতে পারে, যার ফলে কোনও একটি এক্সিকিউশনের ফ্লো ফলো করা কঠিন হয়ে যায়।

এই বিষয়ে সাহায্য করতে, Firebase CLI ভার্সন 13.33.0 ও এর পরবর্তী যেকোনও ভার্সন ব্যবহার করে ডেপ্লয় করা ফাংশন অটোমেটিক ডেপ্লয় করা হয়। এর সাথে, সেই এক্সিকিউশন হ্যান্ডেল করার সময় নির্গত প্রতিটি লগ এন্ট্রির সাথে একটি এক্সিকিউশন আইডি অ্যাসোসিয়েট করার বিকল্পও থাকে।

আপনার ফাংশন দ্বারা হ্যান্ডেল করা একটি অনুরোধের সাথে যুক্ত সমস্ত লগকে এক্সিকিউশন আইডি অনন্যভাবে শনাক্ত করে। কোনও কোড পরিবর্তন করার প্রয়োজন নেই; এক্সিকিউশন আইডি আপনার লগ ফাইলে অটোমেটিক যোগ হয়ে যাবে।

আপনার লগ এন্ট্রিতে এক্সিকিউশন আইডি লগ করা বন্ধ করতে, আপনার dotenv ফাইলে এনভায়রনমেন্ট ভেরিয়েবল LOG_EXECUTION_ID false হিসেবে সেট করুন।

এক্সিকিউশন আইডি দিয়ে লগ খুঁজে বের করা ও কোরিলেট করা

আপনি Cloud Logs Explorer-এ এক্সিকিউশন আইডি দিয়ে লগ পরিদর্শন ও কোরিলেট করতে পারবেন।

  1. আপনার ফাংশন থেকে লগ এন্ট্রি বড় করে দেখুন। স্ট্রাকচার্ড লগ ডেটার মধ্যে এক্সিকিউশন আইডি থাকে। এটি labels.execution_id লেবেলের মধ্যে নেস্ট করা থাকে।

  2. execution_id-এর ভ্যালুতে ক্লিক করুন এবং সেই একই ফাংশন এক্সিকিউশনের সাথে যুক্ত অন্যান্য সব লগ দেখতে ড্রপ-ডাউন মেনু থেকে "মিলছে এমন এন্ট্রি দেখুন" বিকল্প বেছে নিন।

এক্সিকিউশন আইডি ব্যবহার করে, আপনি একটি অনুরোধের সাথে সম্পর্কিত সব লগ মেসেজ একসাথে গ্রুপ করতে পারবেন, এমনকি আপনার ফাংশন যদি একই সাথে একাধিক অনুরোধ হ্যান্ডেল করে থাকে।

কাস্টম সারসংক্ষেপ ফিল্ডের মাধ্যমে লগ দৃশ্যমানতা উন্নত করা

Logs Explorer-এ এক্সিকিউশন আইডি আরও সহজে দৃশ্যমান করতে, আপনি এটিকে [কাস্টম সারসংক্ষেপ ফিল্ড][cloud-logging-preference] হিসেবে যোগ করতে পারেন। আপনি execution ID-কে সারসংক্ষেপ ফিল্ড হিসেবে যোগ করার পরে, প্রতিটি লগ এন্ট্রিতে লগ লাইনের শুরুতে চিপ হিসেবে execution ID দেখানো হবে। এটি ঠিক সেই ভাবেই করা হবে যেভাবে 1st Gen ফাংশন সব লগ এন্ট্রির জন্য execution ID দেখায়।

সারসংক্ষেপ ফিল্ডে এক্সিকিউশন আইডি যোগ করতে:

  1. labels.execution_id-এর অধীনে স্ট্রাকচার্ড লগ এন্ট্রিতে এক্সিকিউশন আইডির ভ্যালুতে ক্লিক করুন।

  2. ড্রপডাউন মেনু থেকে "সারসংক্ষেপ লাইনে ফিল্ড যোগ করুন" বিকল্প বেছে নিন।

প্রতিটি লগ এন্ট্রি এখন সারসংক্ষেপ ফিল্ডে executionId স্পষ্টভাবে দেখায়, এর ফলে নির্দিষ্ট এক্সিকিউশন আইডি সম্পর্কিত লগ শনাক্ত ও গ্রুপ করা সহজ হয়।