Class Logger

יומן

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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
clear()	void	ניקוי היומן.
getLog()	String	הפונקציה מחזירה רשימה מלאה של ההודעות ביומן הנוכחי.
log(data)	Logger	כתיבת הנתונים ביומן.
log(format, values)	Logger	כתיבת מחרוזת בפורמט למסוף הרישום ביומן, באמצעות הפורמט והערכים שצוינו.

מסמכים מפורטים

clear()

ניקוי היומן.

---

getLog()

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

// Generate a log, then email it to the person who ran the script.
const files = DriveApp.getFiles();
while (files.hasNext()) {
  Logger.log(files.next().getName());
}
const recipient = Session.getActiveUser().getEmail();
const subject = 'A list of files in your Google Drive';
const body = Logger.getLog();
MailApp.sendEmail(recipient, subject, body);

חזרה

String – היומן ממסוף הרישום

---

log(data)

כתיבת הנתונים ביומן. הנתונים יכולים להיות מחרוזת, אובייקט JavaScript או אובייקט עם מאפיין message.

Logger.log("my log message");
// Info   my logmessage
Logger.log({ key: "value" });
// Info   {key=value}
Logger.log({ message: "my log message", data: { key: "value" } })
// Info   my logmessage

כשמעבירים אובייקט, אם האובייקט מכיל את המאפיין message, המאפיין הזה משמש כהודעה ביומן. אחרת, מתבצעת קריאה ל-method‏ toString() כדי להמיר את האובייקט למחרוזת. כל שאר המאפיינים שניתנים לסריאליזציה ב-JSON נכללים כחלק מ-jsonPayload ב-LogEntry, בדומה לדוגמה הבאה:

{
  "insertId": "w5eib...",
  "jsonPayload": {
    "message": "my log message",
    "serviceContext": {
      "service": "AKfyc..."
    },
    "data": {
      "key": "value"
    }
  },
  "resource": {
    "type": "app_script_function",
    "labels": {
      "invocation_type": "editor",
      "function_name": "unknown",
      "project_id": "1234567890"
    }
  },
  "timestamp": "2024-11-15T23:28:19.448591Z",
  "severity": "INFO",
  "labels": {
    "script.googleapis.com/user_key": "AOX2d...",
    "script.googleapis.com/process_id": "EAEA1...",
    "script.googleapis.com/project_key": "MQXvl...",
    "script.googleapis.com/deployment_id": "AKfyc..."
  },
  "logName": "projects/[PROJECT_ID]/logs/script.googleapis.com%2Fconsole_logs",
  "receiveTimestamp": "2024-11-15T23:28:20.363790313Z"
}

פרמטרים

שם	סוג	תיאור
data	Object	האובייקט לתיעוד ביומן

חזרה

Logger – ה-Logger, לצורך שרשור.

---

log(format, values)

הכתיבה של מחרוזת בפורמט למסוף הרישום ביומן, באמצעות הפורמט והערכים שצוינו. המחרוזת יכולה לכלול כמה placeholder‏ %s, שיוחלפו בערכים התואמים מרשימת הארגומנטים, לאחר שהם יומרו למחרוזות.

// Log the number of Google Groups you belong to.
const groups = GroupsApp.getGroups();
Logger.log('You are a member of %s Google Groups.', groups.length);

פרמטרים

שם	סוג	תיאור
format	String	מחרוזת עיצוב שמכילה כמה מכונות של %s כמו מספר הארגומנטים של values
values	Object...	מספר משתנה של ערכים להוספה למחרוזת הפורמט

חזרה

Logger – ה-Logger, לשרשור