Class Logger

Logger

Class ini memungkinkan developer menulis ke log Eksekusi dan ke Google Cloud Logging jika skrip dikaitkan dengan Project Cloud standar. Class ini lebih disukai untuk logging terstruktur dan dukungan jsonPayload di Cloud Logging. Untuk logging berbasis waktu, gunakan console.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
clear()voidMenghapus log.
getLog()StringMenampilkan daftar lengkap pesan dalam log saat ini.
log(data)LoggerMenulis data ke log.
log(format, values)LoggerMenulis string berformat ke konsol logging, menggunakan format dan nilai yang disediakan.

Dokumentasi mendetail

clear()

Menghapus log.


getLog()

Menampilkan daftar lengkap pesan dalam log saat ini. Metode ini dapat digunakan untuk menyimpan atau mengirim email seluruh output log yang dihasilkan selama eksekusi skrip.

// 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);

Pulang pergi

String — log dari konsol logging


log(data)

Menulis data ke log. Data dapat berupa string, objek JavaScript, atau objek dengan properti 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

Saat meneruskan objek, jika objek berisi properti message, properti tersebut akan digunakan sebagai pesan log. Jika tidak, metode toString() akan dipanggil untuk mengonversi objek menjadi string. Semua properti lain yang dapat diserialisasi JSON disertakan sebagai bagian dari jsonPayload di LogEntry, mirip dengan contoh di bawah:

{
  "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"
}

Parameter

NamaJenisDeskripsi
dataObjectobjek yang akan dicatat ke dalam log

Pulang pergi

Logger — Logger, untuk pembuatan rantai.


log(format, values)

Menulis string berformat ke konsol logging, menggunakan format dan nilai yang disediakan. String dapat menyertakan beberapa placeholder %s, yang diganti dengan nilai yang sesuai dari daftar argumen, yang dikonversi menjadi string.

// 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);

Parameter

NamaJenisDeskripsi
formatStringstring format yang berisi instance %s sebanyak jumlah argumen values
valuesObject...jumlah nilai variabel yang akan disisipkan ke dalam string format

Pulang pergi

Logger — Logger, untuk pembuatan rantai