Class Logger

โปรแกรมบันทึก

คลาสนี้ช่วยให้นักพัฒนาแอปเขียนลงในบันทึกการดำเนินการและการบันทึกของ Google Cloud ได้หากสคริปต์เชื่อมโยงกับโปรเจ็กต์ Cloud มาตรฐาน เราขอแนะนำให้ใช้คลาสนี้สำหรับการบันทึกที่มีโครงสร้างและjsonPayloadการสนับสนุนใน Cloud Logging สําหรับการบันทึกตามเวลา ให้ใช้ console

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
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 — เครื่องมือบันทึกสำหรับใช้ต่อเชื่อม


log(format, values)

เขียนสตริงที่จัดรูปแบบไปยังคอนโซลการบันทึกโดยใช้รูปแบบและค่าที่ระบุ สตริงอาจมีตัวยึดตําแหน่ง %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 — เครื่องมือบันทึกสำหรับใช้ต่อเชื่อม