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 nhật ký 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 các vấn đề của khách hàng, cũng như cho các mục đích khác.

Apps Script cung cấp ba cơ chế khác nhau để ghi nhật ký:

• Nhật ký thực thi Apps Script tích hợp sẵn. Nhật ký này có dung lượng nhẹ và phát 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ý đám mây trong Bảng điều khiển dành cho nhà phát triển. Bảng điều khiển này cung cấp các 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 Developer Console, giao diện này thu thập và ghi lại các lỗi xảy ra khi tập lệnh của bạn đang chạy.

Thông tin 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, ví dụ: 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. Để xem các nhật ký này, hãy nhấp vào Nhật ký thực thi ở đầu trình chỉnh sửa. Khi bạn chạy một hàm hoặc sử dụng trình gỡ lỗi, luồng nhật ký sẽ xuất hiệ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 nhằm mục đích 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 quá lâu.

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

utils/log.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 chạy với dữ liệu đầu vào "2" và "[e-mail]", các nhật ký sau đây sẽ được viết:

[16-09-12 13:50:42:193 PDT] Gửi dữ liệu qua email hàng 2 đế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 quyền truy cập một phần vào dịch vụ Cloud Logging của Google Cloud Platform (GCP). Khi bạn yêu cầu ghi nhật ký tồn tại nhiều 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 sản xuất cho 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. Xem hạn mức và giới hạn của Cloud Logging để 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 hạn mức Google Cloud Platform. Điều này đòi hỏi 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 ý: Cloud Logging 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ác cảnh báo và chỉ số. Hiện tại, các dịch vụ này chưa có sẵn trên Apps Script.

Sử dụng tính năng ghi nhật ký trên đám mây

Nhật ký trên đám mây được đính kèm vào dự án GCP liên kết với Apps Script. 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 của Apps Script.

Để tận dụng tối đa tính năng Ghi nhật ký đá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 GCP chuẩn cùng với dự án tập lệnh. Điều này cho phép bạn truy cập trực tiếp vào nhật ký trên đám mây trong Bảng điều khiển GCP và cung cấp cho bạn nhiều tuỳ chọn xem và lọc hơn.

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ụ Tập lệnh ứng dụng Logger. 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ý đá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ể 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 nhật ký các chuỗi, chuỗi được định dạng và thậm chí là các đối tượng JSON bằng cách sử dụng các hàm do dịch vụ Apps console cung cấp.

Ví dụ sau cho biết cách sử dụng dịch vụ console để ghi nhật ký thông tin trong Cloud Operations.

utils/log.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 cung cấp 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 trong Nhật ký đám mây mà không tiết lộ danh tính của những người dùng đó. Khoá dành 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, ví dụ như khi báo cáo một vấn đề.

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

• Bạn không cần phải thêm bất kỳ nội dung nào vào nhật ký; nhật ký duyệt web của bạn đã có ở đó!
• Chúng không yêu cầu người dùng uỷ quyền.
• Chúng bảo vệ quyền riêng tư của người dùng.

Để tìm khoá người dùng đang hoạt động tạm thời trong các mục nhập trong Nhật ký trên đám mây, hãy xem nhật ký của Cloud trong bảng điều khiển của GCP. 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 dự án GCP chuẩn mà bạn có quyền truy cập. Sau khi bạn đã mở dự án GCP trong bảng điều khiển, hãy chọn một mục nhật ký mà bạn quan tâm và mở rộng mục đó để xem siêu dữ liệu > nhãn > Script.googleapis.com/user_key.

Bạn cũng có thể nhận 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 của mình. Có 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 của bạn. Sau đó, người dùng có thể chọn bao gồm các khoá của họ khi báo cáo vấn đề để giúp bạn xác định nhật ký phù hợp.

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 để ghi nhật ký trên đám mây, cùng với một 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 Thực thi .
3. Ở trên cùng, hãy nhấp vào Thêm bộ lọc > Trạng thái.
4. Đánh dấu vào các hộp Không đạt và Hết thời gian chờ.

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

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

Tính năng ghi nhật ký ngoại lệ được bật theo mặc định đối với 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. Đánh dấu vào hộp Ghi lại các trường hợp ngoại lệ chưa nắm bắt được đối với Cloud Operations.

Error Reporting

Tính năng ghi nhật ký ngoại lệ tự động tích hợp với 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 được tạo ra trong tập lệnh của bạn. Bạn có thể xem báo cáo lỗi trên đám mây trong bảng điều khiển của GCP. Nếu bạn được nhắc "Thiết lập báo cáo lỗi", điều này 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 phải 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 gì về việc sử dụng nhật ký thực thi tích hợp sẵn.

Bạn có thể xem một phiên bản đơn giản của nhật ký trên đám mây trong trang tổng quan của 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. Điều này chỉ có thể xảy ra nếu dự án tập lệnh của bạn đang sử dụng dự án GCP chuẩn.