Saat mengembangkan jenis aplikasi apa pun, Anda sering kali ingin mencatat informasi ke dalam log untuk membantu mendiagnosis kesalahan selama pengembangan, mengidentifikasi dan mendiagnosis masalah pelanggan, dan untuk tujuan lainnya.
Apps Script menyediakan tiga mekanisme berbeda untuk logging:
Log eksekusi Apps Script bawaan. Log ini ringan dan melakukan streaming secara real time, tetapi hanya bertahan dalam waktu singkat.
Antarmuka Cloud Logging di Konsol Developer menyediakan log yang tersimpan selama berhari-hari setelah dibuat.
Antarmuka Error Reporting di Konsol Play, yang mengumpulkan dan mencatat error yang terjadi saat skrip berjalan.
Hal ini dijelaskan di bagian berikut. Selain mekanisme ini, Anda juga dapat membuat kode pencatat log sendiri yang, misalnya, menulis informasi ke Spreadsheet logging atau database JDBC.
Menggunakan log eksekusi Apps Script
Pendekatan dasar untuk login ke Apps Script adalah menggunakan log eksekusi bawaan. Untuk melihat log ini, di bagian atas editor, klik Execution log. Saat Anda menjalankan fungsi atau menggunakan debugger, log akan di-streaming secara real time.
Anda dapat menggunakan layanan logging Logger
atau
console
di
log eksekusi bawaan.
Log ini dimaksudkan untuk pemeriksaan sederhana selama pengembangan dan proses debug, serta tidak bertahan lama.
Misalnya, pertimbangkan fungsi ini:
Jika skrip ini dijalankan dengan input "2" dan "john@example.com", log berikut akan ditulis:
[16-09-12 13:50:42:193 PDT] Mengirim data baris 2 melalui email ke john@example.com
[16-09-12 13:50:42:271 PDT] Data baris 2: Biaya 103,24
Cloud Logging
Apps Script juga menyediakan akses sebagian ke layanan Cloud Logging Google Cloud Platform (GCP). Jika Anda memerlukan logging yang bertahan selama beberapa hari, atau memerlukan solusi logging yang lebih kompleks untuk lingkungan produksi multi-pengguna, Cloud Logging adalah pilihan yang lebih disukai. Lihat kuota dan batas Cloud Logging untuk mengetahui retensi data dan detail kuota lainnya.
Jika memerlukan lebih banyak kuota logging, Anda dapat mengirimkan permintaan kuota Google Cloud Platform. Tindakan ini mengharuskan Anda memiliki akses ke project Cloud Platform yang digunakan skrip Anda.
Menggunakan Cloud Logging
Log cloud dilampirkan ke project Google Cloud yang terkait dengan Apps Script Anda. Anda dapat melihat versi sederhana log ini di dasbor Apps Script.
Untuk memaksimalkan penggunaan Cloud Logging dan kemampuannya, gunakan project Google Cloud standar dengan project skrip Anda. Dengan begitu, Anda dapat mengakses log Cloud langsung di GCP Console dan memberi Anda lebih banyak opsi tampilan dan pemfilteran.
Saat melakukan logging, sebaiknya Anda tidak mencatat informasi pribadi apa pun tentang pengguna, seperti alamat email. Log cloud otomatis diberi label dengan kunci pengguna aktif yang dapat Anda gunakan untuk menemukan pesan log pengguna tertentu jika diperlukan.
Anda dapat mencatat string, string berformat, dan bahkan objek JSON ke dalam log menggunakan fungsi yang disediakan oleh layanan console
Apps Script.
Contoh berikut menunjukkan cara menggunakan layanan console
untuk mencatat informasi di Cloud Operations.
Kunci pengguna aktif
Kunci pengguna aktif sementara menyediakan cara yang mudah untuk menemukan pengguna unik dalam entri Cloud Log tanpa mengungkapkan identitas pengguna tersebut. Kunci ditetapkan per skrip dan berubah sekitar sebulan sekali untuk memberikan keamanan tambahan jika pengguna mengungkapkan identitasnya kepada developer, misalnya saat melaporkan masalah.
Kunci pengguna aktif sementara lebih unggul daripada ID logging seperti alamat email karena:
- Anda tidak perlu menambahkan apa pun ke {i>logging<i} Anda; semuanya sudah ada di sana!
- Otorisasi tidak memerlukan otorisasi pengguna.
- Mereka melindungi privasi pengguna.
Untuk menemukan kunci pengguna yang aktif sementara dalam entri Cloud Log Anda, lihat log Cloud Anda di Konsol Google Cloud. Anda dapat melakukannya hanya jika project skrip Anda menggunakan project Google Cloud standar yang dapat Anda akses. Setelah membuka project Google Cloud di konsol, pilih entri log yang diinginkan dan luaskan untuk melihat metadata > labels > script.googleapis.com/user_key.
Anda juga bisa mendapatkan kunci pengguna aktif sementara dengan memanggil
Session.getTemporaryActiveUserKey()
dalam skrip. Salah satu cara menggunakan metode ini adalah dengan menampilkan kunci kepada pengguna saat mereka menjalankan skrip Anda. Kemudian, pengguna dapat memilih untuk menyertakan kunci mereka
saat melaporkan masalah untuk membantu Anda mengidentifikasi log yang relevan.
Logging pengecualian
Logging pengecualian mengirimkan pengecualian yang tidak tertangani dalam kode project skrip Anda ke Cloud Logging, beserta stack trace.
Untuk melihat log pengecualian, ikuti langkah-langkah di bawah:
- Buka project Apps Script.
- Di sebelah kiri, klik Executions .
- Di bagian atas, klik Tambahkan filter > Status.
- Centang kotak Failed dan Timed out.
Anda juga dapat melihat pengecualian yang dicatat ke dalam log di konsol GCP jika project skrip Anda menggunakan project Google Cloud standar yang dapat Anda akses.
Mengaktifkan logging pengecualian
Logging pengecualian diaktifkan secara default untuk project baru. Guna mengaktifkan logging pengecualian untuk project lama, ikuti langkah-langkah di bawah ini:
- Buka project skrip.
- Di sebelah kiri, klik Project Settings .
- Centang kotak Masukkan pengecualian yang tidak tertangkap ke Cloud Operations.
Error Reporting
Logging pengecualian secara otomatis terintegrasi dengan Cloud Error Reporting, sebuah layanan yang menggabungkan dan menampilkan error yang dihasilkan dalam skrip Anda. Anda dapat melihat laporan error Cloud di Konsol Google Cloud. Jika Anda diminta untuk "Menyiapkan Error Reporting", ini karena skrip Anda belum mencatat pengecualian apa pun ke dalam log. Selain mengaktifkan logging pengecualian, tidak diperlukan penyiapan apa pun.
Persyaratan logging
Tidak ada persyaratan untuk menggunakan log eksekusi bawaan.
Anda dapat melihat versi log Cloud yang disederhanakan di dasbor Apps Script. Namun, untuk memaksimalkan Cloud Logging dan pelaporan error, Anda harus memiliki akses ke project GCP skrip. Hal ini hanya dapat dilakukan jika project skrip Anda menggunakan project Google Cloud standar.