Membuat profil aplikasi Java

Halaman ini menjelaskan cara mengubah aplikasi Java 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 Java:

Waktu CPU
Heap (memerlukan lingkungan standar Java 11 atau App Engine, dinonaktifkan secara default)
Waktu proses (tidak tersedia untuk lingkungan standar App Engine Java 8)

Versi bahasa Java yang didukung:

JVM berbasis HotSpot (termasuk Oracle JDK dan beberapa build OpenJDK) untuk Java 8, 11, atau yang lebih baru.

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 Java 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 (memerlukan App Engine SDK versi 1.9.64 atau yang lebih baru)
Dataproc (Untuk informasinya, lihat Mengonfigurasi Cloud Profiler untuk tugas Dataproc Spark dan Hadoop.)
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

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

Jalankan perintah berikut:

gcloud services enable cloudprofiler.googleapis.com

Untuk informasi selengkapnya, lihat gcloud services.

Konsol Google Cloud

Di panel navigasi Konsol Google Cloud, pilih APIs & Services, klik Enable APIs and Services, lalu aktifkan Cloud Profiler API:
Buka setelan Profiler API
Jika API enabled ditampilkan, berarti API sudah diaktifkan. Jika belum, klik tombol Enable.

Menginstal agen Profiler

Compute Engine

Buat direktori penginstalan, misalnya, /opt/cprof, untuk agen Profiler:
```
 sudo mkdir -p /opt/cprof
```

Download arsip agen dari repositori storage.googleapis.com dan ekstrak ke direktori penginstalan:

wget -q -O- https://storage.googleapis.com/cloud-profiler/java/latest/profiler_java_agent.tar.gz \
| sudo tar xzv -C /opt/cprof

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.

Ubah Dockerfile untuk membuat direktori penginstalan bagi agen Profiler, download arsip agen, lalu ekstrak arsip ke direktori penginstalan.

Linux (library C berbasis glibc):

Gunakan perintah penginstalan berikut:

RUN mkdir -p /opt/cprof && \
  wget -q -O- https://storage.googleapis.com/cloud-profiler/java/latest/profiler_java_agent.tar.gz \
  | tar xzv -C /opt/cprof

Linux Alpine (library C berbasis musl):

Gunakan perintah penginstalan berikut:

wget -q -O- https://storage.googleapis.com/cloud-profiler/java/latest/profiler_java_agent_alpine.tar.gz \
| tar xzv -C /opt/cprof

Lingkungan Fleksibel

Saat Anda menggunakan image dasar Java 8 runtime atau image dasar Java 9 / Jetty 9 runtime, agen Profiler sudah diinstal sebelumnya sehingga tidak ada langkah tambahan yang perlu Anda lakukan untuk menginstal agen.

Untuk semua image dasar lainnya, Anda perlu menginstal agen. Misalnya, Dockerfile berikut berisi petunjuk cara menggunakan image openjdk:11-slim, untuk menginstal agen Profiler, dan menentukan parameter default yang akan digunakan saat memulai aplikasi:

FROM openjdk:11-slim

COPY . .
RUN  apt-get update \
     && apt-get install wget \
     && rm -rf /var/lib/apt/lists/*

RUN mkdir -p /opt/cprof && \
    wget -q -O- https://storage.googleapis.com/cloud-profiler/java/latest/profiler_java_agent.tar.gz \
    | tar xzv -C /opt/cprof

CMD ["java", "-agentpath:/opt/cprof/profiler_java_agent.so=OPTION1,OPTION2", "-jar", "PATH_TO_YOUR_JAR_FILE"]

Untuk menggunakan Dockerfile ini dengan lingkungan fleksibel App Engine, Anda perlu melakukan hal berikut:

Ganti OPTION1 dan OPTION2 dengan nilai konfigurasi agen yang diperlukan untuk aplikasi Anda, dan ganti PATH_TO_YOUR_JAR_FILE dengan jalur ke file jar Anda.
Tempatkan Dockerfile di direktori yang sama dengan file app.yaml Anda.
Ubah file app.yaml Anda untuk menentukan runtime kustom. Untuk informasi selengkapnya, lihat Membangun Runtime Kustom.

Lingkungan Standar

Saat Anda menggunakan lingkungan runtime Java, agen Profiler sudah diinstal sebelumnya, sehingga tidak ada langkah tambahan yang perlu Anda lakukan untuk menginstal agen. Untuk Java versi 11 dan yang lebih baru, aplikasi ini sudah diinstal sebelumnya di /opt/cprof.

Di luar Google Cloud

Buat direktori penginstalan, misalnya, /opt/cprof, untuk agen Profiler:
```
 sudo mkdir -p /opt/cprof
```

Download arsip agen dari repositori storage.googleapis.com dan ekstrak ke direktori penginstalan:

wget -q -O- https://storage.googleapis.com/cloud-profiler/java/latest/profiler_java_agent.tar.gz \
| sudo tar xzv -C /opt/cprof

Untuk menampilkan semua versi agen yang tersedia untuk didownload, jalankan perintah berikut:

gsutil ls gs://cloud-profiler/java/cloud-profiler-*

Respons perintahnya mirip dengan berikut ini:

gs://cloud-profiler/java/cloud-profiler-java-agent_20191014_RC00.tar.gz
gs://cloud-profiler/java/cloud-profiler-java-agent_20191021_RC00.tar.gz
gs://cloud-profiler/java/cloud-profiler-java-agent_20191028_RC00.tar.gz

Untuk mendownload versi agen tertentu, teruskan URL-nya ke perintah download. Misalnya, untuk mendownload agen yang dibuat pada 28 Oktober 2019, gunakan pernyataan berikut:

wget -q -O- https://storage.googleapis.com/cloud-profiler/java/cloud-profiler-java-agent_20191028_RC00.tar.gz \
  | sudo tar xzv -C /opt/cprof

Versi agen dicatat selama inisialisasi.

Memuat agen Profiler

Untuk membuat profil aplikasi, mulai Java seperti biasa untuk menjalankan program, tetapi tentukan opsi konfigurasi agen. Anda menentukan jalur ke library agen, dan Anda dapat meneruskan opsi ke library.

Untuk lingkungan standar App Engine, agen dimuat dan dikonfigurasi secara otomatis. Lanjutkan ke Memulai program untuk mengetahui detail tentang cara mengonfigurasi dan memulai program.

Konfigurasi agen

Untuk mengonfigurasi agen pembuatan profil, sertakan flag -agentpath saat memulai aplikasi Anda:

 -agentpath:INSTALL_DIR/profiler_java_agent.so=OPTION1,OPTION2,OPTION3

Dalam ekspresi ini, INSTALL_DIR adalah jalur ke agen pembuatan profil, sedangkan OPTION1, OPTION2, dan OPTION3 adalah opsi konfigurasi agen. Misalnya, jika Anda mengganti OPTION1 dengan -cprof_service=myapp dalam ekspresi sebelumnya, tetapkan nama layanan ke myapp. Tidak ada batasan jumlah opsi atau pemesanannya. Opsi konfigurasi yang didukung tercantum dalam tabel berikut:

Opsi agen	Deskripsi
`-cprof_service`	Jika aplikasi Anda tidak berjalan di App Engine, Anda harus menggunakan opsi konfigurasi ini untuk menetapkan nama layanan. Untuk batasan nama layanan, lihat Argumen nama dan versi layanan.
`-cprof_service_version`	Jika Anda menginginkan kemampuan menganalisis data pembuatan profil menggunakan UI Profiler berdasarkan versi layanan, gunakan opsi ini untuk menetapkan versinya. Untuk batasan versi, lihat Argumen nama dan versi layanan.
`-cprof_project_id`	Jika Anda menjalankannya di luar Google Cloud, gunakan opsi ini untuk menentukan ID project Google Cloud Anda. Untuk mengetahui informasi selengkapnya, lihat Membuat profil aplikasi yang berjalan di luar Google Cloud.
`-cprof_zone_name`	Saat aplikasi Anda berjalan di Google Cloud, agen pembuatan profil menentukan zona dengan berkomunikasi dengan layanan metadata Compute Engine. Jika agen pembuatan profil tidak dapat berkomunikasi dengan layanan metadata, Anda harus menggunakan opsi ini.
`-cprof_gce_metadata_server_retry_count` `-cprof_gce_metadata_server_retry_sleep_sec`	Bersama-sama, kedua opsi ini menentukan kebijakan percobaan ulang yang digunakan agen profiler saat berkomunikasi dengan layanan metadata Compute Engine. untuk mengumpulkan informasi zona dan ID project Google Cloud Anda. Kebijakan defaultnya adalah mencoba ulang hingga 3 kali menunggu 1 detik antar-percobaan. Kebijakan ini cukup untuk sebagian besar konfigurasi.
`-cprof_cpu_use_per_thread_timers`	Untuk profil waktu CPU yang paling akurat, setel opsi ini ke benar (true). Penggunaan opsi ini mengakibatkan peningkatan overhead per thread. Nilai defaultnya adalah false.
`-cprof_force_debug_non_safepoints`	Secara default, agen pembuatan profil memaksa JVM membuat informasi proses debug untuk kode yang dihasilkan tepat waktu (JIT), selain menghasilkan informasi debug untuk semua safepoint. Hal ini akan menghasilkan informasi fungsi dan lokasi tingkat baris yang paling akurat untuk waktu CPU dan profil heap dengan mengorbankan overhead agen tambahan. Anda dapat menonaktifkan pembuatan informasi proses debug untuk kode JIT dengan menetapkan opsi ini ke false. Nilai defaultnya adalah true (benar).
`-cprof_wall_num_threads_cutoff`	Secara default, profil dinding tidak dikumpulkan jika jumlah total thread dalam aplikasi melebihi 4.096. Batas ini memastikan bahwa selama pengumpulan profil, biaya menjelajahi stack thread bersifat minimal. Jika layanan Anda biasanya memiliki lebih dari 4096 thread dan jika Anda ingin mengumpulkan data pembuatan profil dengan mengorbankan overhead tambahan, gunakan tanda ini untuk meningkatkan batas. Batas default adalah 4096 thread.
`-cprof_enable_heap_sampling`	Guna mengaktifkan pembuatan profil heap untuk Java 11 dan yang lebih baru, setel `-cprof_enable_heap_sampling=true`. Pembuatan profil heap tidak didukung untuk Java 10 dan yang lebih rendah. Pembuatan profil heap dinonaktifkan secara default. Jika Anda mengaktifkan pembuatan profil heap, interval pengambilan sampel ditetapkan ke 512 KiB secara default. Interval ini cukup untuk sebagian besar aplikasi dan menimbulkan overhead kurang dari 0,5% untuk aplikasi. Interval pengambilan sampel dari 256 KiB (262144) hingga 1024 KiB (1048576) didukung. Misalnya, untuk menetapkan interval pengambilan sampel ke 256 KiB, yang menggandakan frekuensi sampling, tambahkan opsi agen: `-cprof_heap_sampling_interval=262144` Demikian pula, untuk menetapkan interval pengambilan sampel ke 1024 KiB, yang mengurangi separuh frekuensi sampling, tambahkan opsi agen: `-cprof_heap_sampling_interval=1048576` Jika Anda mengaktifkan jenis profil ini, tentukan versi layanan baru saat men-deploy aplikasi. Untuk informasi selengkapnya, lihat Mengapa saya tidak memiliki data untuk jenis profil tertentu? Catatan: Penggunaan beberapa profiler heap secara bersamaan akan menonaktifkan semua dukungan pembuatan profil heap untuk Java. Ini adalah batasan JVM.

Argumen nama dan versi layanan

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

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.

Memulai program Anda

Compute Engine

Mulai Java seperti biasa untuk menjalankan program Anda, dan tambahkan opsi konfigurasi agen:

java \
    -agentpath:/opt/cprof/profiler_java_agent.so=-cprof_service=myapp,-cprof_service_version=1.0.0 \
    JAVA_OPTIONS -jar PATH_TO_YOUR_JAR_FILE PROGRAM_OPTIONS

GKE

Ubah Dockerfile container layanan untuk memulai Java seperti yang biasa Anda lakukan untuk menjalankan program, dan tambahkan opsi konfigurasi agen:

CMD ["java", \
    "-agentpath:/opt/cprof/profiler_java_agent.so=-cprof_service=myapp,-cprof_service_version=1.0.0", \
     "-jar", "PATH_TO_YOUR_JAR_FILE" ]

Lingkungan Fleksibel

Ubah file konfigurasi app.yaml untuk menetapkan variabel lingkungan PROFILER_ENABLE. Kemudian mulai program Anda seperti biasa:

env_variables:
   PROFILER_ENABLE: true

Baca Menentukan variabel lingkungan untuk mengetahui informasi selengkapnya.

Lingkungan Standar

Lingkungan runtime Java 21

Jika Anda tidak menggunakan layanan paket lama, aktifkan pengumpulan profiler dengan memodifikasi file app.yaml untuk menentukan flag agentpath menggunakan salah satu metode berikut:

Tetapkan variabel lingkungan JAVA_TOOL_OPTIONS:

runtime: java21
env_variables:
  JAVA_TOOL_OPTIONS: "-agentpath:/opt/cprof/profiler_java_agent.so=-logtostderr,-cprof_enable_heap_sampling=true"

Tentukan agentpath menggunakan elemen entrypoint:

runtime: java21
entrypoint: java \
  -agentpath:/opt/cprof/profiler_java_agent.so=-logtostderr,-cprof_enable_heap_sampling=true \
  Main.java

Jika Anda menggunakan layanan paket versi lama, aktifkan pengumpulan profiler dengan memodifikasi file appengine-web.xml untuk menentukan flag agentpath menggunakan salah satu metode berikut:

Tetapkan variabel lingkungan JAVA_USER_OPTS:

<?xml version="1.0" encoding="utf-8"?>
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
<env-variables>
<env-var name="JAVA_USER_OPTS" value="-agentpath:/opt/cprof/profiler_java_agent.so=-logtostderr,-cprof_enable_heap_sampling=true" />
</env-variables>
</appengine-web-app>

Tetapkan variabel lingkungan CPROF_ENABLE:

<?xml version="1.0" encoding="utf-8"?>
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
<env-variables>
<env-var name="CPROF_ENABLE" value="-agentpath:/opt/cprof/profiler_java_agent.so=-logtostderr,-cprof_enable_heap_sampling=true" />
</env-variables>
</appengine-web-app>

Tentukan agentpath menggunakan elemen entrypoint:

<?xml version="1.0" encoding="utf-8"?>
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
  <entrypoint>
   java
   -agentpath:/opt/cprof/profiler_java_agent.so=-logtostderr,-cprof_enable_heap_sampling=true
  </entrypoint>
</appengine-web-app>

Jika jenis profil baru dikonfigurasi untuk pengumpulan, pastikan Anda menentukan versi layanan baru saat men-deploy aplikasi. Untuk informasi selengkapnya, lihat Mengapa saya tidak memiliki data untuk jenis profil tertentu?

Logging agen

Agen pembuatan profil dapat melaporkan informasi logging untuk lingkungan fleksibel App Engine, Compute Engine, dan GKE. Agen pembuatan profil mendukung level logging berikut:

0: Mencatat semua pesan ke dalam log. Level logging default.
1: Membuat log pesan peringatan, error, dan fatal.
2: Mencatat pesan error dan fatal ke dalam log.
3: Hanya mencatat pesan fatal dan menghentikan aplikasi.

Untuk mengaktifkan penulisan log ke error standar dengan level logging default, tambahkan -logtostderr ke konfigurasi -agentpath.

Untuk menetapkan level logging agar hanya mencatat pesan error dan fatal ke dalam log, tambahkan -minloglevel=2 ke konfigurasi -agentpath.

Misalnya, untuk mengaktifkan logging pesan error dan fatal ke error standar, tambahkan -logtostderr dan ‑minloglevel=2 ke konfigurasi -agentpath:

 java -agentpath:/opt/cprof/profiler_java_agent.so=-cprof_service=myapp,-logtostderr,-minloglevel=2 \
   -jar myApp.jar

Pemecahan masalah

Bagian ini mencantumkan masalah yang spesifik terkait pembuatan profil aplikasi Java. Lihat Pemecahan masalah untuk mendapatkan bantuan terkait masalah umum.

Perilaku	Penyebab	Solusi
Anda telah mengaktifkan beberapa profiler heap dan tidak memiliki data profil.	Penggunaan beberapa profiler heap secara bersamaan akan menonaktifkan semua dukungan pembuatan profil heap untuk Java. Ini adalah batasan JVM.	Mengaktifkan 1 profiler.

Berjalan dengan Linux Alpine

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

Untuk menginstal agen pembuatan profil Java terbaru untuk Linux Alpine, lihat Menginstal agen Profiler.

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.

Membuat profil aplikasi Java

Mengaktifkan Profiler API

gcloud CLI

Konsol Google Cloud

Menginstal agen Profiler

Compute Engine

GKE

Lingkungan Fleksibel

Lingkungan Standar

Di luar Google Cloud

Memuat agen Profiler

Konfigurasi agen

Argumen nama dan versi layanan

Memulai program Anda

Compute Engine

GKE

Lingkungan Fleksibel

Lingkungan Standar

Logging agen

Pemecahan masalah

Berjalan dengan Linux Alpine

Error autentikasi

Langkah selanjutnya