Class Logger

Регистратор

Этот класс позволяет разработчику вести запись в журнал выполнения и в Google Cloud Logging, если сценарий связан со стандартным облачным проектом . Этот класс предпочтителен для структурированного ведения журналов и поддержки json Payload в Cloud Logging. Для регистрации по времени используйте console .

Методы

Метод Тип возврата Краткое описание
clear() void Очищает журнал.
get Log() String Возвращает полный список сообщений в текущем журнале.
log(data) Logger Записывает данные в журнал.
log(format, values) Logger Записывает форматированную строку в консоль журналирования, используя предоставленный формат и значения.

Подробная документация

clear()

Очищает журнал.

get Log()

Возвращает полный список сообщений в текущем журнале. Этот метод можно использовать для сохранения или отправки по электронной почте всего вывода журнала, созданного во время выполнения сценария.

// 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 , это свойство используется в качестве сообщения журнала. В противном случае вызывается метод to String() для преобразования объекта в строку. Все остальные свойства, которые можно сериализовать в формате JSON, включаются как часть json Payload в Log Entry , как показано в примере ниже:

{
  "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 — Регистратор для цепочки.

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

Параметры

Имя Тип Описание
format String строка формата, содержащая столько экземпляров %s сколько аргументов values
values Object... переменное количество значений для вставки в строку формата

Возвращаться

Logger — Регистратор для цепочки