Lampirkan agen Application Real-Time Monitoring Service (ARMS) Java ke aplikasi Anda untuk mengumpulkan jejak (traces), topologi aplikasi, data transaksi abnormal dan lambat, serta analisis SQL.
Untuk aplikasi yang dideploy di kluster Container Service for Kubernetes (ACK), instal komponen ack-onepilot sebagai gantinya. Lihat Instalasi otomatis agen ARMS di ACK atau Instalasi otomatis agen ARMS di kluster Kubernetes open-source.
Prasyarat
Sebelum memulai, pastikan bahwa:
Jaringan Anda memenuhi persyaratan konektivitas agen ARMS.
Versi JDK Anda didukung oleh Pemantauan Aplikasi.
Memori heap maksimum JVM (
-Xmx) minimal 256 MB.
Instalasi agen ARMS
Langkah 1: Unduh agen
Masuk ke Konsol ARMS.
Pada panel navigasi sebelah kiri, klik Integration Center.
Klik kartu Java Application Monitor, lalu pilih Manual Installation.
Unduh paket agen menggunakan salah satu metode berikut:
Dari konsol — Pada panel Java Application Monitor, ikuti petunjuk unduhan.
Dari command line — Jalankan perintah
wgetsesuai wilayah Anda. Pilih wilayah Anda dari tabel di bawah ini.
Langkah 2: Ekstrak paket agen
Ekstrak file ZIP yang telah diunduh ke direktori kerja:
unzip AliyunJavaAgent.zip -d <working-directory>Ganti <working-directory> dengan direktori tempat Anda ingin menginstal agen, misalnya, /opt/arms.
Langkah 3: Konfigurasikan license key dan nama aplikasi
Agen ARMS memerlukan dua parameter untuk melaporkan data:
| Parameter | Description | Where to find it |
|---|---|---|
LicenseKey | Mengotentikasi agen dengan akun ARMS Anda | Salin dari panel Java Application Monitor, atau panggil API DescribeTraceLicenseKey |
AppName | Mengidentifikasi aplikasi Anda di Konsol ARMS. Dalam arsitektur terdistribusi, beberapa instans peer menggunakan nama yang sama. | Pilih nama, misalnya, order-service |
Teruskan parameter tersebut dengan salah satu cara berikut:
Opsi A: Teruskan sebagai argumen JVM (disarankan)
Tambahkan -Darms.licenseKey dan -Darms.appName langsung dalam perintah startup. Lihat Langkah 4 untuk perintah lengkapnya.
Opsi B: Gunakan file konfigurasi
Pendekatan ini berguna ketika beberapa aplikasi berbagi skrip startup yang sama.
Pertama, periksa versi agen di file version di dalam direktori hasil ekstraksi.
Agen ARMS V4.0.0 atau lebih baru:
Buat file bernama arms-agent.properties di direktori agen:
arms.licenseKey=<your-license-key>
arms.appName=<your-app-name>Kemudian tambahkan salah satu dari berikut ke perintah startup Anda:
Argumen JVM:
-Dotel.javaagent.configuration-file=/path/to/arms-agent.propertiesVariabel lingkungan:
OTEL_JAVAAGENT_CONFIGURATION_FILE=/path/to/arms-agent.properties
Agen ARMS versi sebelum V4.0.0:
Edit file arms-agent.config di direktori agen:
arms.licenseKey=<your-license-key>
arms.appName=<your-app-name>Untuk detail parameter agen lainnya, lihat Ubah parameter agen ARMS dan wilayah pelaporan data.
Langkah 4: Tambahkan agen ke perintah startup Anda
Tambahkan opsi -javaagent ke perintah startup Anda. Sintaksnya bervariasi tergantung lingkungan runtime.
Ganti placeholder berikut dengan nilai aktual Anda:
| Placeholder | Description | Example |
|---|---|---|
<working-directory> | Direktori tempat Anda mengekstrak agen | /opt/arms |
<your-license-key> | License key ARMS Anda | a]xxxxxx@xxxxxxxx |
<your-app-name> | Nama aplikasi untuk ARMS | order-service |
Spring Boot atau java -jar
Letakkan -javaagent sebelum argumen -jar:
java -javaagent:/<working-directory>/AliyunJavaAgent/aliyun-java-agent.jar \
-Darms.licenseKey=<your-license-key> \
-Darms.appName=<your-app-name> \
-jar demoApp.jarTomcat
Tambahkan baris berikut ke {TOMCAT_HOME}/bin/setenv.sh:
JAVA_OPTS="$JAVA_OPTS -javaagent:/<working-directory>/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey=<your-license-key> -Darms.appName=<your-app-name>"Jika file setenv.sh tidak ada, tambahkan konfigurasi yang sama ke parameter JAVA_OPTS di {TOMCAT_HOME}/bin/catalina.sh. Lihat baris 256 catalina.sh sebagai referensi.
Jetty
Tambahkan baris berikut ke {JETTY_HOME}/start.ini:
--exec
-javaagent:/<working-directory>/AliyunJavaAgent/aliyun-java-agent.jar
-Darms.licenseKey=<your-license-key>
-Darms.appName=<your-app-name>Beberapa instans pada server yang sama
Untuk menjalankan beberapa instans aplikasi yang sama pada satu server, tambahkan -Darms.agentId dengan nilai unik untuk membedakan proses JVM:
java -javaagent:/<working-directory>/AliyunJavaAgent/aliyun-java-agent.jar \
-Darms.licenseKey=<your-license-key> \
-Darms.appName=<your-app-name> \
-Darms.agentId=001 \
-jar demoApp.jarUntuk versi agen sebelum V2.7.3.5, ganti
AliyunJavaAgent/aliyun-java-agent.jardenganArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar. Segera tingkatkan ke versi terbaru jika memungkinkan.Pada Windows, ganti
/dengan\pada path dan gunakan file.batsebagai pengganti file.sh.Untuk mengaktifkan Application Security (tersedia mulai V2.7.1.4), tambahkan
-Darms.appsec.enable=true. Lihat penagihan Application Security untuk informasi harga.
Langkah 5: Restart aplikasi
Restart aplikasi Java Anda agar agen dapat berjalan.
(Opsional) Instalasi dengan Docker
Gunakan Dockerfile berikut sebagai templat untuk menginstal agen ARMS dalam image Docker:
# Ganti <your-base-image:tag> dengan image Anda
FROM <your-base-image:tag>
WORKDIR /root/
# Unduh agen (gunakan URL sesuai wilayah Anda; lihat Langkah 1)
RUN wget "http://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/AliyunJavaAgent.zip" -O AliyunJavaAgent.zip
RUN unzip AliyunJavaAgent.zip -d /root/
# Atur kredensial sebagai variabel lingkungan
ENV arms_licenseKey=<your-license-key>
ENV arms_appName=<your-app-name>
# Suntikkan agen melalui JAVA_TOOL_OPTIONS
ENV JAVA_TOOL_OPTIONS ${JAVA_TOOL_OPTIONS} '-javaagent:/root/AliyunJavaAgent/aliyun-java-agent.jar -Darms.licenseKey='${arms_licenseKey}' -Darms.appName='${arms_appName}
# Verifikasi variabel lingkungan
RUN env | grep JAVA_TOOL_OPTIONS
# Tambahkan instruksi spesifik aplikasi Anda di bawah ini
# ...Verifikasi instalasi
Setelah Anda merestart aplikasi, agen akan mulai melaporkan data dalam waktu sekitar satu menit.
Di Konsol ARMS, pilih Application Monitoring > Application List.
Pastikan aplikasi Anda muncul dalam daftar dan catatan data sedang dikirim.
Jika aplikasi Anda tidak muncul setelah beberapa menit, periksa hal berikut:
| Issue | Action |
|---|---|
| Kredensial salah | Pastikan nilai LicenseKey dan AppName sesuai dengan nilai di Konsol ARMS. |
| Path agen salah | Pastikan path -javaagent mengarah ke file aliyun-java-agent.jar yang benar. |
| Aplikasi belum direstart | Restart aplikasi setelah menambahkan konfigurasi agen. |
| Konektivitas jaringan | Pastikan server dapat mencapai titik akhir ARMS melalui jaringan. Lihat Konfigurasi jaringan. |
| Kegagalan startup agen | Periksa log startup aplikasi untuk pesan inisialisasi agen ARMS. Cari baris yang berisi ArmsAgent atau arms-agent. Jika tidak ada entri log agen, argumen -javaagent mungkin tidak dimuat. |
Untuk panduan troubleshooting lebih lanjut, lihat FAQ Pemantauan Aplikasi.