Class Logger

Logger

המחלקות האלה מאפשרות למפתח לכתוב ביומן הביצוע ול-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, המאפיין הזה משמש כהודעת היומן. אחרת, השיטה 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"
}

פרמטרים

שםסוגתיאור
dataObjectהאובייקט שרוצים לרשום ביומן

חזרה

Logger – Logger, לשרשור.


log(format, values)

כותבת מחרוזת בפורמט מסוים במסוף הרישום ביומן, באמצעות הפורמט והערכים שסופקו. המחרוזת יכולה לכלול כמה placeholders מסוג %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);

פרמטרים

שםסוגתיאור
formatStringמחרוזת פורמט שמכילה מספר מופעים של %s כמספר הארגומנטים של values
valuesObject...מספר משתנה של ערכים להוספה למחרוזת הפורמט

חזרה

Logger — Logger, לשרשור