Ghi nhật ký

Khi phát triển bất kỳ loại ứng dụng nào, bạn thường muốn ghi lại thông tin để giúp chẩn đoán lỗi trong quá trình phát triển, xác định và chẩn đoán vấn đề của khách hàng cũng như cho các mục đích khác.

Apps Script cung cấp 3 cơ chế ghi nhật ký:

• Nhật ký thực thi Apps Script tích hợp sẵn. Nhật ký này có kích thước nhỏ và truyền trực tuyến theo thời gian thực, nhưng chỉ tồn tại trong một thời gian ngắn.

• Giao diện Ghi nhật ký trên đám mây trong Developer Console cung cấp nhật ký tồn tại trong nhiều ngày sau khi tạo.

• Giao diện Báo cáo lỗi trong Bảng điều khiển dành cho nhà phát triển thu thập và ghi lại các lỗi xảy ra trong khi tập lệnh của bạn đang chạy.

Các loại này được mô tả trong các phần sau. Ngoài các cơ chế này, bạn cũng có thể tạo mã trình ghi nhật ký của riêng mình, chẳng hạn như ghi thông tin vào Bảng tính ghi nhật ký hoặc cơ sở dữ liệu JDBC.

Sử dụng nhật ký thực thi Apps Script

Một phương pháp cơ bản để ghi nhật ký trong Apps Script là sử dụng nhật ký thực thi tích hợp sẵn. Để xem các nhật ký này, ở đầu trình chỉnh sửa, hãy nhấp vào Nhật ký thực thi. Khi bạn chạy một hàm hoặc sử dụng trình gỡ lỗi, nhật ký sẽ truyền theo thời gian thực.

Bạn có thể sử dụng dịch vụ ghi nhật ký Logger hoặc console trong nhật ký thực thi tích hợp.

Các nhật ký này dùng để kiểm tra đơn giản trong quá trình phát triển và gỡ lỗi, đồng thời không tồn tại lâu.

Ví dụ: hãy xem xét hàm này:

utils/logging.gs

Xem trên GitHub

/**
 * Logs Google Sheet information.
 * @param {number} rowNumber The spreadsheet row number.
 * @param {string} email The email to send with the row data.
 */
function emailDataRow(rowNumber, email) {
  console.log('Emailing data row ' + rowNumber + ' to ' + email);
  try {
    const sheet = SpreadsheetApp.getActiveSheet();
    const data = sheet.getDataRange().getValues();
    const rowData = data[rowNumber - 1].join(' ');
    console.log('Row ' + rowNumber + ' data: ' + rowData);
    MailApp.sendEmail(email, 'Data in row ' + rowNumber, rowData);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed with error %s', err.message);
  }
}

Khi tập lệnh này được chạy với dữ liệu đầu vào "2" và "[e-mail]", các nhật ký sau sẽ được ghi:

[16-09-12 13:50:42:193 PDT] Gửi hàng dữ liệu của hàng 2 qua email đến [e-mail]
[16-09-12 13:50:42:271 PDT] Dữ liệu của hàng 2: Chi phí 103,24

Cloud Logging

Apps Script cũng cung cấp một phần quyền truy cập vào dịch vụ Ghi nhật ký trên đám mây của Google Cloud Platform (GCP). Khi bạn cần ghi nhật ký liên tục trong vài ngày hoặc cần một giải pháp ghi nhật ký phức tạp hơn cho môi trường phát hành công khai nhiều người dùng, thì tính năng Ghi nhật ký trên đám mây là lựa chọn ưu tiên. Hãy xem bài viết Hạn mức và hạn mức của tính năng Ghi nhật ký trên đám mây để biết thông tin chi tiết về việc giữ lại dữ liệu và các hạn mức khác.

Nếu cần thêm hạn mức ghi nhật ký, bạn có thể gửi yêu cầu về hạn mức trên Google Cloud Platform. Để làm việc này, bạn phải có quyền truy cập vào dự án Cloud Platform mà tập lệnh của bạn sử dụng.

Lưu ý: Dịch vụ ghi nhật ký trên đám mây cung cấp một số dịch vụ ngoài việc lưu trữ nhật ký, chẳng hạn như cảnh báo và chỉ số. Hiện tại, bạn không thể sử dụng các dịch vụ này trong Apps Script.

Sử dụng Cloud Logging

Nhật ký trên đám mây được đính kèm vào dự án Google Cloud liên kết với Apps Script của bạn. Bạn có thể xem phiên bản đơn giản của các nhật ký này trong trang tổng quan về Apps Script.

Để khai thác tối đa tính năng Ghi nhật ký trên đám mây và các chức năng của tính năng này, hãy sử dụng dự án Google Cloud tiêu chuẩn với dự án tập lệnh. Nhờ đó, bạn có thể truy cập trực tiếp vào nhật ký trên Google Cloud trong Bảng điều khiển GCP và có thêm nhiều lựa chọn xem và lọc.

Lưu ý: Nếu bạn sử dụng môi trường thời gian chạy Rhino, thì tính năng Ghi nhật ký trên đám mây sẽ không hỗ trợ dịch vụ Logger của Tập lệnh ứng dụng. Thay vào đó, hãy sử dụng dịch vụ console.

Khi ghi nhật ký, bạn nên tránh ghi lại bất kỳ thông tin cá nhân nào về người dùng, chẳng hạn như địa chỉ email. Nhật ký trên đám mây được tự động gắn nhãn bằng khoá người dùng đang hoạt động mà bạn có thể sử dụng để tìm thông điệp nhật ký của một người dùng cụ thể khi cần.

Bạn có thể ghi lại chuỗi, chuỗi được định dạng và thậm chí là đối tượng JSON bằng cách sử dụng các hàm do dịch vụ console của Apps Script cung cấp.

Ví dụ sau đây cho biết cách sử dụng dịch vụ console để ghi lại thông tin trong Cloud Operations.

utils/logging.gs

Xem trên GitHub

/**
 * Logs the time taken to execute 'myFunction'.
 */
function measuringExecutionTime() {
  // A simple INFO log message, using sprintf() formatting.
  console.info('Timing the %s function (%d arguments)', 'myFunction', 1);

  // Log a JSON object at a DEBUG level. The log is labeled
  // with the message string in the log viewer, and the JSON content
  // is displayed in the expanded log structure under "jsonPayload".
  const parameters = {
    isValid: true,
    content: 'some string',
    timestamp: new Date()
  };
  console.log({message: 'Function Input', initialData: parameters});
  const label = 'myFunction() time'; // Labels the timing log entry.
  console.time(label); // Starts the timer.
  try {
    myFunction(parameters); // Function to time.
  } catch (e) {
    // Logs an ERROR message.
    console.error('myFunction() yielded an error: ' + e);
  }
  console.timeEnd(label); // Stops the timer, logs execution duration.
}

Khoá người dùng đang hoạt động

Khoá người dùng đang hoạt động tạm thời là một cách thuận tiện để phát hiện người dùng riêng biệt trong các mục nhập Nhật ký trên đám mây mà không tiết lộ danh tính của những người dùng đó. Khoá là cho mỗi tập lệnh và thay đổi khoảng một lần mỗi tháng để tăng cường bảo mật nếu người dùng tiết lộ danh tính của họ cho nhà phát triển, chẳng hạn như khi báo cáo sự cố.

Khoá người dùng đang hoạt động tạm thời vượt trội so với giá trị nhận dạng nhật ký như địa chỉ email vì:

• Bạn không cần thêm gì vào nhật ký; các thông tin đó đã có sẵn!
• Các quyền này không yêu cầu người dùng uỷ quyền.
• Các chính sách này bảo vệ quyền riêng tư của người dùng.

Để tìm khoá người dùng tạm thời đang hoạt động trong các mục Nhật ký trên đám mây, hãy xem Nhật ký trên đám mây trong Google Cloud Console. Bạn chỉ có thể thực hiện việc này nếu dự án tập lệnh của bạn đang sử dụng một dự án Google Cloud chuẩn mà bạn có quyền truy cập. Sau khi bạn mở dự án Google Cloud trong bảng điều khiển, hãy chọn một mục nhập nhật ký mà bạn quan tâm rồi mở rộng mục nhập đó để xem metadata > labels > script.googleapis.com/user_key.

Bạn cũng có thể lấy khoá người dùng đang hoạt động tạm thời bằng cách gọi Session.getTemporaryActiveUserKey() trong tập lệnh. Một cách để sử dụng phương thức này là hiển thị khoá cho người dùng trong khi họ đang chạy tập lệnh. Sau đó, người dùng có thể chọn đưa khoá của họ vào khi báo cáo vấn đề để giúp bạn xác định nhật ký có liên quan.

Ghi nhật ký ngoại lệ

Tính năng ghi nhật ký ngoại lệ sẽ gửi các ngoại lệ chưa được xử lý trong mã dự án tập lệnh của bạn đến tính năng Ghi nhật ký trên đám mây, cùng với dấu vết ngăn xếp.

Để xem nhật ký ngoại lệ, hãy làm theo các bước dưới đây:

1. Mở dự án Apps Script.
2. Ở bên trái, hãy nhấp vào biểu tượng Lượt thực thi .
3. Ở trên cùng, hãy nhấp vào Thêm bộ lọc > Trạng thái.
4. Chọn hộp đánh dấu Không thành công và Hết thời gian chờ.

Bạn cũng có thể xem các trường hợp ngoại lệ đã ghi nhật ký trong bảng điều khiển GCP nếu dự án tập lệnh của bạn đang sử dụng một dự án Google Cloud tiêu chuẩn mà bạn có quyền truy cập.

Bật tính năng ghi nhật ký ngoại lệ

Theo mặc định, tính năng ghi nhật ký ngoại lệ được bật cho các dự án mới. Để bật tính năng ghi nhật ký ngoại lệ cho các dự án cũ, hãy làm theo các bước dưới đây:

1. Mở dự án tập lệnh.
2. Ở bên trái, hãy nhấp vào biểu tượng Cài đặt dự án .
3. Chọn hộp đánh dấu Ghi các trường hợp ngoại lệ chưa nắm bắt được vào Hoạt động trên đám mây.

Error Reporting

Tính năng ghi nhật ký ngoại lệ tự động tích hợp với Cloud Error Reporting (Báo cáo lỗi trên đám mây), một dịch vụ tổng hợp và hiển thị các lỗi xảy ra trong tập lệnh của bạn. Bạn có thể xem báo cáo lỗi trên Cloud trong bảng điều khiển Google Cloud. Nếu bạn được nhắc "Thiết lập tính năng Báo cáo lỗi", thì đó là do tập lệnh của bạn chưa ghi lại bất kỳ ngoại lệ nào. Bạn không cần thiết lập gì ngoài việc bật tính năng ghi nhật ký ngoại lệ.

Yêu cầu về việc ghi nhật ký

Không có yêu cầu nào đối với việc sử dụng nhật ký thực thi tích hợp.

Bạn có thể xem phiên bản đơn giản của nhật ký trên Cloud trong trang tổng quan về Apps Script. Tuy nhiên, để khai thác tối đa tính năng Ghi nhật ký trên đám mây và báo cáo lỗi, bạn phải có quyền truy cập vào dự án GCP của tập lệnh. Bạn chỉ có thể thực hiện việc này nếu dự án tập lệnh của bạn đang sử dụng một dự án Google Cloud tiêu chuẩn.