نوشتن و مشاهده گزارش‌ها (نسل اول)

گزارش‌گیری ابزار مهمی برای اشکال‌زدایی و نظارت بر کد است. Cloud Functions به شما این امکان را می‌دهد که از کیت توسعه نرم‌افزار ثبت‌کننده آن، Google Cloud Logging سفارشی، یا استاندارد شیء console برای توسعه وب استفاده کنید.

درحال نوشتن گزارش‌ها

درحالی‌که کیت توسعه نرم‌افزار Cloud Functions ثبت‌کننده برای اکثر موقعیت‌ها توصیه می‌شود، ممکن است به‌دلایل زیر یکی از گزینه‌های دیگر را انتخاب کنید:

  • پایگاه کد موجود دارید و ترجیح می‌دهید از console.log بازسازی کد نکنید.
  • با Cloud Logging (StackDriver logging سابق) آشنا هستید و ترجیح می‌دهید از آن برای ثبت سفارشی استفاده کنید.

استفاده از کیت توسعه نرم‌افزار ثبت‌کننده Cloud Functions

کیت توسعه نرم‌افزار ثبت‌کننده Cloud Functions میانای استانداردی ارائه می‌دهد که میانای برنامه‌سازی کاربردی مشابهی با عبارت‌های console.log دارد و از سطوح گزارش دیگر پشتیبانی می‌کند. می‌توانید از این کیت توسعه نرم‌افزار برای ثبت رویدادها با داده‌های ساختاریافته استفاده کنید، که تجزیه‌وتحلیل و پایش را آسان‌تر می‌کند.

کیت توسعه نرم‌افزار ثبت‌کننده از ورودی‌های گزارش به‌عنوان بخشی از وارد کردن نویسه جانشین پشتیبانی می‌کند. برای مثال:

  const functions = require("firebase-functions/v1");

  functions.logger.log("Hello from info. Here's an object:", someObj);

همچنین می‌توانید از صادر کردن تکی استفاده کنید. این مثال نشان می‌دهد داده‌های ساختاریافته به‌عنوان آخرین آرگومان به گزارش پیوست شده است:

const { warn } = require("firebase-functions/logger");


// Attach structured data to the log as the last argument.
warn("This is a 'WARNING' severity message with some metadata.", {
  key1: 'val1',
  key2: 'val2'
});
  • logger.log() فرمان دارای سطح گزارش INFO است.
  • logger.info() فرمان دارای سطح گزارش INFO است.
  • logger.warn() فرمان دارای سطح گزارش هشدار است.
  • ‫logger.error() فرمان سطح گزارش ERROR دارند.
  • پیام‌های سیستم داخلی دارای سطح گزارش اشکال‌زدایی هستند.

با logger.write()، می‌توانید ورودی‌های گزارش را علاوه‌بر سطوح شدت گزارش CRITICAL، ALERT، و EMERGENCY بنویسید. LogSeverity را ببینید.

گزارش‌های سفارشی Cloud Logging

Cloud Functions گزارش‌های مربوط به کیت توسعه نرم‌افزار ثبت‌کننده توسط Cloud Logging پشتیبانی می‌شود. می‌توانید از کتابخانه Cloud Logging برای Node.js برای ثبت رویدادها با داده‌های ساختاریافته استفاده کنید، که تجزیه‌وتحلیل و نظارت را آسان‌تر می‌کند.

const { Logging } = require('@google-cloud/logging');

// ...

// Instantiate the logging SDK. The project ID will
// be automatically inferred from the Cloud Functions environment.
const logging = new Logging();
const log = logging.log('my-custom-log-name');

// This metadata is attached to each log entry. This specifies a fake
// Cloud Function called 'Custom Metrics' in order to make your custom
// log entries appear in the Cloud Functions logs viewer.
const METADATA = {
  resource: {
    type: 'cloud_function',
    labels: {
      function_name: 'CustomMetrics',
      region: 'us-central1'
    }
  }
};

// ...

// Data to write to the log. This can be a JSON object with any properties
// of the event you want to record.
const data = {
  event: 'my-event',
  value: 'foo-bar-baz',

  // Optional 'message' property will show up in the Firebase
  // console and other human-readable logging surfaces
  message: 'my-event: foo-bar-baz'
};

// Write to the log. The log.write() call returns a Promise if you want to
// make sure that the log was written successfully.
const entry = log.entry(METADATA, data);
log.write(entry);

استفاده از console.log

راه‌حل توصیه‌شده برای ثبت گزارش از تابع، استفاده از کیت توسعه نرم‌افزار ثبت‌کننده گزارش برای پلاتفرم شما است. با 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() فرمان دارای سطح گزارش INFO است.
  • console.info() فرمان دارای سطح گزارش INFO است.
  • ‫console.warn() فرمان سطح گزارش ERROR دارند.
  • ‫console.error() فرمان سطح گزارش ERROR دارند.
  • پیام‌های سیستم داخلی دارای سطح گزارش اشکال‌زدایی هستند.

مشاهده گزارش‌ها

گزارش‌های Cloud Functions در کنسول Google Cloud، میانای کاربر Cloud Logging، یا ازطریق ابزار خط فرمان firebase قابل‌مشاهده است.

استفاده از واسط خط فرمان Firebase

برای مشاهده گزارش‌ها با ابزار 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 Functions را در میانای کاربر Cloud Logging مشاهده کنید.

درحال تجزیه‌وتحلیل گزارش‌ها

Cloud Logging مجموعه قدرتمندی از ابزارهای تحلیل گزارش ارائه می‌دهد که می‌توانید از آن‌ها برای نظارت بر Cloud Functions خود استفاده کنید.

نمودارها و هشدارها

پس‌از ایجاد سنجه‌های مبتنی بر گزارش برای نظارت بر عملکردهایتان، می‌توانید براساس این سنجه‌ها نمودار و هشدار ایجاد کنید. برای مثال، می‌توانید نموداری برای دیداری‌سازی تأخیر درطول زمان ایجاد کنید، یا هشداری ایجاد کنید تا درصورت وقوع بیش‌ازحد خطایی خاص به شما اطلاع دهد.

برای اطلاعات دقیق درباره نحوه استفاده از سنجه‌های مبتنی بر گزارش در نمودارها و خط‌مشی‌های هشدار، به ایجاد نمودارها و هشدارها مراجعه کنید.