Membuat profil aplikasi Node.js

Halaman ini menjelaskan cara mengubah aplikasi Node.js untuk mengambil data pembuatan profil dan mengirimkan data tersebut ke project Google Cloud Anda. Untuk mengetahui informasi umum tentang pembuatan profil, lihat Konsep pembuatan profil.

Jenis profil untuk Node.js:

• Heap
• Waktu proses

Versi bahasa Node.js yang didukung:

• Node.js 14 atau yang lebih baru
• Untuk kebijakan rilis Node.js, lihat Jadwal rilis.

Versi agen pembuatan profil yang didukung:

• Rilis agen terbaru didukung. Secara umum, rilis yang lebih lama dari satu tahun tidak didukung. Sebaiknya gunakan versi agen yang terakhir dirilis.

Sistem operasi yang didukung:

• Linux. Pembuatan profil aplikasi Node.js didukung untuk kernel Linux yang library C standarnya diimplementasikan dengan glibc atau dengan musl. Untuk informasi konfigurasi khusus kernel Linux Alpine, lihat Berjalan di Linux Alpine.

Lingkungan yang didukung:

• Compute Engine
• Google Kubernetes Engine (GKE)
• Lingkungan fleksibel App Engine
• Lingkungan standar App Engine
• Di luar Google Cloud (Untuk mengetahui informasi tentang persyaratan konfigurasi tambahan, lihat Membuat profil aplikasi yang berjalan di luar Google Cloud.)

Mengaktifkan Profiler API

Sebelum Anda menggunakan agen pembuatan profil, pastikan bahwa Profiler API yang mendasarinya telah diaktifkan. Anda dapat memeriksa status API dan mengaktifkannya jika perlu menggunakan Google Cloud CLI atau Konsol Google Cloud:

gcloud CLI

1. Jika belum menginstal Google Cloud CLI di workstation, lihat dokumentasi Google Cloud CLI.

2. Jalankan perintah berikut:

   gcloud services enable cloudprofiler.googleapis.com
   

Untuk informasi selengkapnya, lihat gcloud services.

Konsol Google Cloud

1. Di panel navigasi Konsol Google Cloud, pilih APIs & Services, klik Enable APIs and Services, lalu aktifkan Cloud Profiler API:

   Buka setelan Profiler API

2. Jika API enabled ditampilkan, berarti API sudah diaktifkan. Jika belum, klik tombol Enable.

Menggunakan Cloud Profiler

Di semua lingkungan yang didukung, Anda menggunakan Profiler dengan menginstal paket @google-cloud/profiler, menambahkan pernyataan require ke aplikasi, lalu men-deploy aplikasi dengan cara yang biasa.

Sebelum menginstal @google-cloud/profiler

Paket @google-cloud/profiler bergantung pada modul native. Biner bawaan untuk modul native ini tersedia untuk Linux dan Alpine Linux untuk Node 14 dan 16. Tidak ada dependensi tambahan yang diperlukan. @google-cloud/profiler menggunakan node-pre-gyp untuk menentukan biner bawaan yang akan diinstal.

Catatan: Jika sistem build Anda tidak sesuai dengan versi Node, versi libc, arsitektur, atau platform untuk sistem tempat Anda berencana men-deploy aplikasi, Anda harus menentukan nilai yang benar dalam perintah npm install. Untuk mengetahui detailnya, lihat node-pre-gyp.

Saat menggunakan @google-cloud/profiler di lingkungan lain yang tidak memiliki biner bawaan, modul node-gyp digunakan untuk membuat biner. Untuk mengetahui informasi tentang dependensi yang diperlukan untuk mem-build biner dengan node-gyp, lihat dokumentasi penginstalan node-gyp.

Penginstalan

Untuk menginstal Cloud Profiler versi terbaru, lakukan hal berikut:

    npm install --save @google-cloud/profiler

Jika Anda juga menggunakan agen Trace, saat memodifikasi aplikasi, impor paket Profiler setelah paket agen Trace (@google-cloud/trace-agent).

Compute Engine

Untuk Compute Engine, lakukan hal berikut:

1. Instal Cloud Profiler versi terbaru:

   npm install --save @google-cloud/profiler
   

2. Ubah kode require aplikasi Anda untuk membuat objek serviceContext yang menetapkan service nama layanan yang sedang dibuat profilnya. Atau, Anda dapat menetapkan versi layanan yang sedang dibuat profilnya, ke version. Lihat Argumen nama dan versi layanan untuk mengetahui informasi selengkapnya tentang opsi konfigurasi ini:

   require('@google-cloud/profiler').start({
     serviceContext: {
       service: 'your-service',
       version: '1.0.0',
     },
   });

GKE

Catatan: Jika mengaktifkan Workload Identity di cluster, pastikan Anda menambahkan peran Cloud Profiler Agent (roles/cloudprofiler.agent) ke akun layanan Kubernetes. Untuk mengetahui informasi selengkapnya, lihat Menggunakan Workload Identity.

Untuk GKE, lakukan hal berikut:

1. Ubah Dockerfile Anda untuk menginstal paket Profiler:

   FROM node:10
   ...
   RUN npm install @google-cloud/profiler
   

2. Ubah kode require aplikasi Anda untuk membuat objek serviceContext yang menetapkan service nama layanan yang sedang dibuat profilnya. Atau, Anda dapat menetapkan versi layanan yang sedang dibuat profilnya, ke version. Lihat Argumen nama dan versi layanan untuk mengetahui informasi selengkapnya tentang opsi konfigurasi ini:

   require('@google-cloud/profiler').start({
     serviceContext: {
       service: 'your-service',
       version: '1.0.0',
     },
   });

App Engine

Untuk lingkungan fleksibel App Engine dan lingkungan standar App Engine, kode require mirip dengan berikut ini:

require('@google-cloud/profiler').start();

Di App Engine, parameter service dan version berasal dari lingkungan, sehingga Anda tidak perlu menentukannya. Oleh karena itu, Anda tidak perlu membuat objek serviceContext.

Menganalisis data

Setelah Profiler mengumpulkan data, Anda dapat melihat dan menganalisis data ini menggunakan antarmuka Profiler.

Pada panel navigasi konsol Google Cloud, pilih Profiler:

Buka Profiler

Argumen nama dan versi layanan

Saat memuat agen Profiler, Anda menentukan argumen nama layanan dan argumen versi layanan opsional untuk mengonfigurasinya.

Catatan: Di lingkungan fleksibel App Engine, Anda tidak perlu menentukan argumen ini karena argumen tersebut berasal dari lingkungan.

Nama layanan memungkinkan Profiler mengumpulkan data pembuatan profil untuk semua replika layanan tersebut. Layanan profiler memastikan kecepatan pengumpulan rata-rata satu profil per menit untuk setiap nama layanan di setiap kombinasi zona dan versi layanan.

Misalnya, jika Anda memiliki layanan dengan dua versi yang berjalan di replika dalam tiga zona, profiler akan membuat rata-rata 6 profil per menit untuk layanan tersebut.

Jika Anda menggunakan nama layanan yang berbeda untuk replika, layanan Anda akan diprofilkan lebih sering daripada yang diperlukan, dengan overhead yang sebetulnya lebih tinggi.

Saat memilih nama layanan:

• Pilih nama yang secara jelas menggambarkan layanan dalam arsitektur aplikasi Anda. Pilihan nama layanan tidak begitu penting jika Anda hanya menjalankan satu layanan atau aplikasi. Akan lebih penting lagi jika aplikasi Anda berjalan sebagai sekumpulan layanan mikro.

• Pastikan untuk tidak menggunakan nilai khusus proses apa pun, seperti ID proses, dalam string nama layanan.

• String nama layanan harus cocok dengan ekspresi reguler ini:

  ^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$

Panduan yang baik adalah menggunakan string statis seperti imageproc-service sebagai nama layanan.

Versi layanan bersifat opsional. Jika Anda menentukan versi layanan, Profiler dapat menggabungkan informasi pembuatan profil dari beberapa instance dan menampilkannya dengan benar. Layanan ini dapat digunakan untuk menandai versi layanan Anda yang berbeda saat di-deploy. UI Profiler memungkinkan Anda memfilter data berdasarkan versi layanan; dengan cara ini, Anda dapat membandingkan performa kode versi lama dan baru.

Nilai argumen versi layanan adalah string bentuk bebas, tetapi nilai untuk argumen ini biasanya terlihat seperti nomor versi, misalnya 1.0.0 atau 2.1.2.

Logging agen

Agen pembuatan profil dapat melaporkan informasi logging. Untuk mengaktifkan logging, tetapkan opsi logLevel saat memulai agen. Nilai logLevel yang didukung adalah:

• 0: menonaktifkan semua logging agen.
• 1: mengaktifkan logging error.
• 2: mengaktifkan logging peringatan (default).
• 3: memungkinkan logging info.
• 4: mengaktifkan logging debug.

Tetapkan nilai logLevel dalam objek yang sama yang menyediakan konteks layanan:

require('@google-cloud/profiler').start({
    serviceContext: { ... }
    logLevel:       3
});

Berjalan dengan Linux Alpine

Agen pembuatan profil Node.js untuk Linux Alpine hanya didukung untuk konfigurasi Google Kubernetes Engine.

Error build

Jika Anda menjalankan npm install dan build gagal dengan error berikut, berarti Dockerfile Anda tidak memiliki beberapa dependensi build:

ERR! stack Error: not found: make

Untuk mengatasi masalah ini, tambahkan pernyataan berikut ke tahap build Dockerfile Anda:

RUN apk add python3 g++ make

Error autentikasi

Jika Anda menggunakan image Docker yang berjalan dengan Linux Alpine (seperti golang:alpine atau hanya alpine), Anda mungkin melihat error autentikasi berikut:

connection error: desc = "transport: authentication handshake failed: x509: failed to load system roots and no roots provided"

Perhatikan bahwa untuk melihat error, Anda harus mengaktifkan logging agen.

Error ini menunjukkan bahwa image Docker dengan Linux Alpine tidak memiliki sertifikat SSL root yang diinstal secara default. Sertifikat tersebut diperlukan agar agen pembuatan profil dapat berkomunikasi dengan API profiler. Untuk mengatasi error ini, tambahkan perintah apk berikut ke Dockerfile Anda:

FROM alpine
...
RUN apk add --no-cache ca-certificates

Kemudian, Anda harus membangun ulang dan men-deploy ulang aplikasi Anda.

Masalah umum

Agen pembuatan profil untuk Node.js mengganggu keluar normal dari program. Perlu waktu hingga satu jam untuk keluar dari program setelah semua tugas dalam program selesai. Jika Anda mengeluarkan SIGINT, misalnya menggunakan Ctrl-C, hal ini akan menyebabkan proses dihentikan dengan baik.

Langkah selanjutnya

• Memilih profil yang akan dianalisis
• Berinteraksi dengan grafik flame
• Memfilter grafik flame
• Memfokuskan grafik api
• Membandingkan profil