Class Logger

چوبگیر

اگر اسکریپت با پروژه استاندارد Cloud مرتبط است، این کلاس به توسعه‌دهنده اجازه می‌دهد تا در گزارش اجرا و 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)

داده ها را در گزارش می نویسد. داده ها می توانند یک رشته، یک شی جاوا اسکریپت یا یک شی با ویژگی 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 یک رشته قالبی که به تعداد آرگومان های values حاوی نمونه های %s است
values Object... تعداد متغیری از مقادیر برای درج در رشته قالب

بازگشت

Logger - چوب‌بر، برای زنجیر کردن