Class Logger

Logger

تتيح هذه الفئة للمطوّر إمكانية الكتابة في سجلّ التنفيذ وفي Google Cloud Logging إذا كان النص البرمجي مرتبطًا بمشروع 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: المسجّل، للربط