লগ লেখা ও দেখা

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

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

লগ লেখা হচ্ছে

Cloud Functions লগার SDK ব্যবহার করা

Cloud Functions লগার SDK, ফাংশন থেকে Cloud Logging-এ স্ট্যাটাস রিপোর্ট করার জন্য একটি স্ট্যান্ডার্ড ইন্টারফেস প্রদান করে। আপনি এই SDK ব্যবহার করে স্ট্রাকচার্ড ডেটা সহ ইভেন্ট লগ করতে পারবেন, যা আরও সহজে বিশ্লেষণ ও মনিটর করার সুবিধা দেয়।

logger সাবপ্যাকেজ থেকে ইমপোর্ট করুন:

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

from firebase_functions import logger
main.py

• logger.log()টি কমান্ডে INFO লগ লেভেল আছে।

• logger.info()টি কমান্ডে INFO লগ লেভেল আছে।

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

• logger.error()টি কমান্ডে ERROR লগ লেভেল আছে।

• logger.debug()টি কমান্ডে DEBUG লগ লেভেল আছে।

• ইন্টার্নাল সিস্টেম মেসেজে DEBUG লগ লেভেল থাকে।

এই উদাহরণে দেখানো হয়েছে যে কীভাবে একটি ফাংশন বেসিক লগ লেখে:

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

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

@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!")
main.py

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

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});
});
index.js

@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!")
main.py

logger.write()-এর মাধ্যমে, আপনি CRITICAL, ALERT ও EMERGENCY-এর অতিরিক্ত লগ তীব্রতা লেভেল সহ লগ এন্ট্রি লিখতে পারবেন। LogSeverity দেখুন।

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,
  });
});
index.js

@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)
main.py

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...');
});
index.js

• console.log()টি কমান্ডে INFO লগ লেভেল আছে।
• console.info()টি কমান্ডে 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] হিসেবে যোগ করতে পারেন। আপনি সারসংক্ষেপ ফিল্ড হিসেবে এক্সিকিউশন আইডি যোগ করার পরে, প্রতিটি লগ এন্ট্রি লগ লাইনের শুরুতে চিপ হিসেবে এক্সিকিউশন আইডি দেখাবে। এটি ফার্স্ট জেনারেশন ফাংশন যেভাবে সব লগ এন্ট্রির জন্য এক্সিকিউশন আইডি দেখায় তার মতোই।

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

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

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

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