כתיבה של יומנים וצפייה בהם (דור ראשון)

רישום ביומן הוא כלי חשוב לניפוי באגים ולמעקב אחרי קוד. ב-Cloud Functions אפשר להשתמש ב-SDK של רישום ביומן, ב-Cloud Logging בהתאמה אישית של Google או באובייקט הסטנדרטי console לפיתוח לאינטרנט.

כתיבת יומנים

למרות שמומלץ להשתמש ב-SDK של Cloud Functions logger ברוב המצבים, יכול להיות שתבחרו באחת מהאפשרויות האחרות מהסיבות הבאות:

  • יש לכם בסיס קוד קיים ואתם מעדיפים לא לשנות את המבנה של console.log.
  • אתם מכירים את Cloud Logging (לשעבר StackDriver logging) ומעדיפים להשתמש בו לרישום ביומן בהתאמה אישית.

שימוש ב-SDK של Cloud Functions לרישום ביומן

ערכת ה-SDK של Cloud Functions logger מספקת ממשק סטנדרטי עם API שדומה להצהרות console.log, ותומכת ברמות אחרות של רישום ביומן. אתם יכולים להשתמש ב-SDK הזה כדי לתעד אירועים ביומן באמצעות נתונים מובְנים, וכך לנתח ולנטר אותם בקלות רבה יותר.

ה-SDK של הרישום ביומן תומך ברשומות ביומן כחלק מייבוא של תו כללי לחיפוש. לדוגמה:

  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() יש את רמת היומן WARNING.
  • לפקודות logger.error() יש רמת יומן ERROR.
  • להודעות מערכת פנימיות יש רמת יומן של ניפוי באגים.

באמצעות logger.write(), אתם יכולים לכתוב רשומות ביומן עם רמות חומרה נוספות של CRITICAL,‏ ALERT ו-EMERGENCY. למידע נוסף, ראו LogSeverity.

יומני Cloud Logging בהתאמה אישית

יומני Cloud Functions עם ה-SDK של הרישום ביומן מגובים על ידי 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

הפתרון המומלץ לרישום ביומן מפונקציה הוא להשתמש ב-SDK של רישום ביומן לפלטפורמה שלכם. ב-Node.js, אתם יכולים להשתמש בקריאות רגילות לרישום ביומן של JavaScript, כמו console.log ו-console.error, אבל קודם צריך לדרוש מודול מיוחד כדי לתקן את השיטות הרגילות כך שיפעלו בצורה נכונה:

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

אחרי שדורשים את מודול התאימות של ה-logger, אפשר להשתמש בשיטות של 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 Functions בממשק המשתמש של Cloud Logging.

ניתוח יומנים

ב-Cloud Logging יש חבילה של כלים יעילים לניתוח יומנים, שבעזרתם אפשר לעקוב אחרי Cloud Functions.

תרשימים והתראות

אחרי שיוצרים מדדים מבוססי-יומנים כדי לעקוב אחרי הפונקציות, אפשר ליצור תרשימים והתראות על סמך המדדים האלה. לדוגמה, אפשר ליצור תרשים כדי להציג באופן חזותי את זמן האחזור לאורך זמן, או ליצור התראה כדי להודיע אם שגיאה מסוימת מתרחשת לעיתים קרובות מדי.

במאמר יצירת תרשימים והתראות מוסבר איך להשתמש במדדים מבוססי-יומנים בתרשימים ובכללי מדיניות התראה.