Melengkapi aplikasi Node.js untuk Error Reporting

Anda dapat mengirim laporan error ke Error Reporting dari aplikasi Node.js dengan menggunakan library Error Reporting untuk Node.js. Gunakan library Error Reporting untuk Node.js guna membuat grup error untuk kasus berikut:

• Bucket log Anda memiliki kunci enkripsi yang dikelola pelanggan (CMEK).
• Bucket log Anda tidak berada di region global.
• Anda ingin melaporkan peristiwa error kustom.

Error Reporting terintegrasi dengan beberapa layanan Google Cloud, seperti Cloud Functions dan App Engine, Compute Engine, serta Google Kubernetes Engine. Error Reporting menampilkan error yang dicatat ke Cloud Logging oleh aplikasi yang berjalan di layanan tersebut. Untuk mengetahui informasi selengkapnya, buka Menjalankan di Google Cloud di halaman ini.

Anda juga dapat mengirim data error ke Error Reporting menggunakan Logging. Untuk mengetahui informasi tentang persyaratan pemformatan data, baca Memformat pesan error di Logging.

Sebelum memulai

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

3. Make sure that billing is enabled for your Google Cloud project.

4. Aktifkan Error Reporting API .

   Mengaktifkan API

5. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

6. Make sure that billing is enabled for your Google Cloud project.

7. Aktifkan Error Reporting API .

   Mengaktifkan API

8. Menyiapkan lingkungan Anda untuk pengembangan Node.js.

   Buka panduan penyiapan Node.js

Menginstal library klien

Library Error Reporting untuk Node.js memungkinkan Anda memantau dan melihat error yang dilaporkan oleh aplikasi Node.js yang berjalan hampir di mana saja.

1. Gunakan npm untuk menginstal paket:

   npm install --save @google-cloud/error-reporting

2. Impor library dan buat instance klien untuk mulai melaporkan error:

   // Imports the Google Cloud client library
   const {ErrorReporting} = require('@google-cloud/error-reporting');
   
   // Instantiates a client
   const errors = new ErrorReporting();
   
   // Reports a simple error
   errors.report('Something broke!');

Untuk informasi lebih lanjut tentang penginstalan, baca dokumentasi untuk library Error Reporting untuk Node.js. Anda juga dapat melaporkan masalah menggunakan issue tracker.

Mengonfigurasi library klien

Anda dapat menyesuaikan perilaku library Error Reporting untuk Node.js. Lihat konfigurasi library untuk mengetahui daftar opsi konfigurasi yang memungkinkan. Opsi ini dapat diteruskan dalam objek options yang diteruskan ke konstruktor library.

Integrasi lainnya

Untuk informasi selengkapnya tentang integrasi antara library Error Reporting untuk Node.js dan framework web Node.js lainnya, lihat repositori library di GitHub.

Menjalankan aplikasi di Google Cloud

Untuk membuat grup error menggunakan projects.events.report, akun layanan Anda memerlukan peran Penulis Error Reporting (roles/errorreporting.writer).

Beberapa layanan Google Cloud secara otomatis memberikan peran Error Reporting Writer (roles/errorreporting.writer) ke akun layanan yang sesuai. Namun, Anda harus memberikan peran ini ke akun layanan yang sesuai untuk beberapa layanan.

Lingkungan fleksibel App Engine

App Engine memberikan peran Penulis Pelaporan Error (roles/errorreporting.writer) ke akun layanan default Anda secara otomatis.

Library Error Reporting untuk Node.js dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Error Reporting diaktifkan secara otomatis untuk aplikasi lingkungan fleksibel App Engine. Tidak diperlukan penyiapan tambahan.

Catatan: Log error yang ditulis ke stderr diproses secara otomatis oleh Error Reporting, tanpa perlu menggunakan library Error Reporting untuk Node.js secara langsung.

Google Kubernetes Engine

Untuk menggunakan Error Reporting dengan Google Kubernetes Engine, lakukan hal berikut:

1. Pastikan akun layanan yang akan digunakan oleh penampung Anda telah diberi peran Penulis Pelaporan Error (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Buat cluster Anda dan beri cluster cakupan akses cloud-platform.

   Misalnya, perintah create berikut menentukan cakupan akses cloud-platform dan akun layanan:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Catatan: Setelah membuat cluster, Anda tidak dapat mengubah akun layanannya.

Compute Engine

Untuk menggunakan Error Reporting dengan instance VM Compute Engine, lakukan hal berikut:

1. Pastikan akun layanan yang akan digunakan oleh instance VM Anda telah diberi peran Penulis Error Reporting (roles/errorreporting.writer).

   Anda dapat menggunakan akun layanan default Compute Engine atau akun layanan kustom.

   Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

2. Di panel navigasi Konsol Google Cloud, pilih Compute Engine, lalu pilih VM instances:

   Buka instance VM

3. Pilih instance VM yang Anda inginkan untuk menerima cakupan akses cloud-platform.

4. Klik Hentikan, lalu klik Edit.

5. Di bagian Identity and API access, pilih akun layanan yang memiliki peran Error Reporting Writer (roles/errorreporting.writer).

6. Di bagian Access scope, pilih Allow full access to all Cloud APIs, lalu simpan perubahan.

7. Klik Mulai/Lanjutkan.

Cloud Functions

Cloud Functions memberikan peran Penulis Pelaporan Error (roles/errorreporting.writer) ke akun layanan default Anda secara otomatis.

Library Error Reporting untuk Node.js dapat digunakan tanpa perlu memberikan kredensial secara eksplisit.

Cloud Functions dikonfigurasi untuk menggunakan Error Reporting secara otomatis. Pengecualian JavaScript yang tidak tertangani akan muncul di Logging dan diproses oleh Error Reporting tanpa perlu menggunakan library Error Reporting untuk Node.js.

Catatan: Entri log diproses secara otomatis jika berisi stack trace dan tidak menentukan tingkat keparahan log atau tingkat keparahan log minimal ERROR, tanpa perlu menggunakan library Error Reporting untuk Node.js.

Contoh:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

// Reports a simple error
errors.report('Something broke!');

Contoh

Anda dapat melaporkan error secara manual dengan memanggil metode report, seperti yang terlihat pada contoh berikut:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

// Use the error message builder to customize all fields ...
const errorEvent = errors.event();

// Add error information
errorEvent.setMessage('My error message');
errorEvent.setUser('root@nexus');

// Report the error event
errors.report(errorEvent, () => {
  console.log('Done reporting error event!');
});

// Report an Error object
errors.report(new Error('My error message'), () => {
  console.log('Done reporting Error object!');
});

// Report an error by provided just a string
errors.report('My error message', () => {
  console.log('Done reporting error string!');
});

Melaporkan error dengan Express.js

Library Error Reporting untuk Node.js dapat mengintegrasikan Error Reporting ke dalam framework web Node.js populer seperti Express.js:

const express = require('express');

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

const app = express();

app.get('/error', (req, res, next) => {
  res.send('Something broke!');
  next(new Error('Custom error message'));
});

app.get('/exception', () => {
  JSON.parse('{"malformedJson": true');
});

// Note that express error handling middleware should be attached after all
// the other routes and use() calls. See the Express.js docs.
app.use(errors.express);

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

Menjalankan aplikasi di lingkungan pengembangan lokal

Agar dapat menggunakan library Error Reporting untuk Node.js di lingkungan pengembangan lokal, seperti menjalankan library di workstation sendiri, Anda harus menyediakan library Error Reporting untuk Node.js dengan kredensial default aplikasi lokal. Untuk mengetahui informasi selengkapnya, lihat Mengautentikasi ke Error Reporting.

Untuk menggunakan contoh Node.js di halaman ini dalam lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

1. Install the Google Cloud CLI.

2. To initialize the gcloud CLI, run the following command:

   gcloud init

3. Buat kredensial autentikasi lokal untuk Akun Google Anda:

   gcloud auth application-default login

   Catatan: Jika gcloud CLI menampilkan peringatan bahwa akun Anda tidak memiliki izin serviceusage.services.use, beberapa perintah gcloud CLI dan library klien mungkin tidak berfungsi. Minta administrator untuk memberi Anda peran IAM Consumer Service Usage (roles/serviceusage.serviceUsageConsumer), lalu jalankan perintah berikut:

   gcloud auth application-default set-quota-project PROJECT_ID

Untuk informasi selengkapnya, lihat Set up authentication for a local development environment.

Metode projects.events.report juga mendukung kunci API. Jika ingin menggunakan kunci API untuk autentikasi, Anda tidak perlu menyiapkan file Kredensial Default Aplikasi lokal. Untuk informasi selengkapnya, lihat Membuat kunci API dalam dokumentasi autentikasi Google Cloud.

Contoh:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

// Reports a simple error
errors.report('Something broke!');

Melihat laporan error

Di panel navigasi konsol Google Cloud, pilih Error Reporting, lalu pilih project Google Cloud Anda:

Buka Error Reporting

Untuk informasi selengkapnya, lihat Melihat Error.