Class Logger

چوب‌بر

این کلاس به توسعه‌دهنده اجازه می‌دهد تا در صورت مرتبط بودن اسکریپت با یک پروژه ابری استاندارد ، در گزارش اجرایی و در Google Cloud Logging بنویسد. این کلاس برای گزارش‌گیری ساختاریافته و پشتیبانی jsonPayload در Cloud Logging ترجیح داده می‌شود. برای گزارش‌گیری مبتنی بر زمان، console استفاده کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
clear() void لاگ را پاک می‌کند.
get Log() 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)

داده‌ها را در لاگ می‌نویسد. این داده‌ها می‌توانند یک رشته، یک شیء جاوا اسکریپت یا یک شیء با ویژگی 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 property) باشد، آن ویژگی به عنوان پیام لاگ (log 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"
}

پارامترها

نام نوع توضیحات
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 — چوب‌نگار، برای زنجیرسازی