Modifikasi agensi ARMS untuk parameter Java dan wilayah pelaporan data melalui file konfigurasi - Application Real-Time Monitoring Service

Anda dapat mengontrol konfigurasi default dari agen Application Real-Time Monitoring Service (ARMS) untuk Java melalui file konfigurasi statis.

File konfigurasi statis hanya memodifikasi beberapa konfigurasi statis dan konfigurasi default. Prioritas konfigurasi ini lebih rendah daripada konfigurasi dinamis, properti sistem Java, dan variabel lingkungan.

Agen V4.x dan yang lebih baru

Untuk agen ini, semua file konfigurasi sudah terintegrasi ke dalam paket JAR. Anda dapat membuat file konfigurasi eksternal untuk menulis parameter eksternal. File konfigurasi eksternal akan menggantikan file konfigurasi bawaan di dalam paket JAR, tetapi tetap berada di bawah konfigurasi dinamis, properti sistem Java, dan variabel lingkungan.

Modifikasi konfigurasi agen

Buat file konfigurasi agen dengan ekstensi .properties, seperti my-app.properties, sebaiknya di direktori tempat agen berada.

Tulis parameter berikut sesuai kebutuhan. Nilai default semuanya kosong.

Parameter	Deskripsi
arms.licenseKey	LicenseKey yang diperlukan untuk menginstal agen. Anda bisa mendapatkannya dengan mengklik kartu Java Application Monitor pada halaman Pusat Integrasi di konsol ARMS, atau dengan memanggil DescribeTraceLicenseKey di platform OpenAPI.
arms.appName	Nama aplikasi.
profiler.tags.env	Tag lingkungan aplikasi.
profiler.tags.version	Tag versi aplikasi.
profiler.tags.customtags	Tag instansi kustom aplikasi.

Tiga item konfigurasi terakhir menentukan tag instansi yang dipantau di ARMS.

Saat agen dimulai, tambahkan -Dotel.javaagent.configuration-file=/path/to/my-app.properties ke perintah startup atau atur variabel lingkungan OTEL_JAVAAGENT_CONFIGURATION_FILE=/path/to/my-app.properties.
Catatan
- Ganti /path/to/my-app.properties dengan jalur absolut dari file konfigurasi.
- Jika kedua perintah startup dan variabel lingkungan dikonfigurasi, perintah startup akan memiliki prioritas.
Terapkan file konfigurasi yang telah dimodifikasi ke instalasi agen ARMS untuk Java V4.x sesuai kebutuhan.

Modifikasi wilayah pelaporan

Wilayah pelaporan data default tergantung pada cara integrasinya:

Integrasi melalui Alibaba Cloud Container Service for Kubernetes (ACK): Wilayah cluster ACK Anda.
Integrasi manual: Wilayah bucket Object Storage Service (OSS) yang digunakan untuk unduhan agen.

Untuk memodifikasi wilayah tempat agen melaporkan data pemantauan:

Metode 1

Untuk aplikasi yang diterapkan di cluster ACK:

Perbarui komponen ack-onepilot ke V4.0.0 atau yang lebih baru.
Tambahkan variabel lingkungan ARMS_REPORT_REGION ke aplikasi ack-onepilot-ack-onepilot di namespace ack-onepilot. Nilainya harus merupakan ID wilayah tempat ARMS tersedia. Contoh: cn-hangzhou atau cn-beijing.
Mulai ulang aplikasi yang ada atau terapkan aplikasi baru untuk melaporkan data lintas wilayah.
Catatan
Setelah variabel lingkungan ditambahkan, semua aplikasi yang diterapkan di cluster melaporkan data ke wilayah yang ditentukan pada langkah sebelumnya.

Metode 2

Tambahkan -Daliyun.javaagent.profileId=cn-hangzhou ke perintah startup, atau tambahkan variabel lingkungan ALIYUN_JAVAAGENT_PROFILEID=cn-hangzhou.

Catatan

Ganti cn-hangzhou dengan semua wilayah pelaporan yang didukung oleh ARMS.
Jika kedua perintah startup dan variabel lingkungan dikonfigurasi, perintah startup akan memiliki prioritas.

Agen V3.x

Modifikasi konfigurasi agen

Pergi ke direktori agen yang telah diekstrak dan temukan file arms-agent.config.

Ubah konfigurasi dalam file arms-agent.config dan simpan perubahan, atau ganti dengan file arms-agent.config yang telah Anda siapkan.

Perluas untuk Melihat File arms-agent.config (Contoh)

########################################################################
#  Tentukan arms.licenseKey (diperoleh dari konsol) dan arms.appName (nama aplikasi yang diintegrasikan).
#
#  Contoh:
#  arms.licenseKey=XXXXXXXXXXXXXXX
#  arms.appName=Demo-Service
#
########################################################################

arms.licenseKey=

arms.appName=

########################################################################
#  Agen ARMS beroperasi dengan konfigurasi sistem default. Pertahankan pengaturan ini untuk memastikan stabilitas sistem.
########################################################################

profiler.collector.trace.endpoint=arms-dc-hz.aliyuncs.com
profiler.collector.metric.endpoint=cn-hangzhou.arms.aliyuncs.com
profiler.collector.meta.endpoint=arms-dc-hz.aliyuncs.com
profiler.collector.endpoint=arms-dc-hz.aliyuncs.com


profiler.log.report.support=true

profiler.acm.endpoint=addr-hz-internal.edas.aliyun.com
profiler.acm.tenant=c845a7b4-23a1-4f28-a380-5ab30d8a280f
profiler.acm.region.id=cn-hangzhou

# Wilayah tempat agen ARMS melaporkan data pemantauan Microservices Engine (MSE).
profiler.mse.region=cn-hangzhou


# Tingkat log agen: ERROR < WARN <  INFO <  DEBUG < TRACE
# Pengaturan dengan prioritas lebih tinggi akan mengeluarkan log dengan level lebih rendah.
profiler.agent.logger.level=WARN

# Konfigurasi global: menentukan apakah instrumen diaktifkan. Pertahankan nilai true agar agen bekerja dengan benar.
profiler.enable=true

# Konfigurasi global: menentukan apakah fungsi sampling diaktifkan. Pertahankan nilai true untuk sampling data dengan benar.
profiler.sampling.enable=true

# Konfigurasi global: laju sampling, unit: %.
profiler.sampling.rate=10

###########################################################
# Dubbo                                                   #
###########################################################
profiler.dubbo.enable=true

###########################################################
# Google HTTP Client                                      #
###########################################################
profiler.googlehttpclient.enable=true

###########################################################
# Kerangka Layanan Cepat Alibaba Cloud (HSF)              #
###########################################################
profiler.hsf.enable=true

###########################################################
# HTTPClient3                                             #
###########################################################
profiler.httpclient3.enable=true

###########################################################
# HTTPClient4                                             #
###########################################################
profiler.httpclient4.enable=true

###########################################################
# JDK HTTP                                                #
###########################################################
profiler.jdkhttp.enable=true

###########################################################
# Jetty                                                   #
###########################################################
profiler.jetty.enable=true

###########################################################
# MyBatis                                                 #
###########################################################
profiler.mybatis.enable=true

###########################################################
# MySQL JDBC                                              #
###########################################################
profiler.mysql.enable=true

###########################################################
# OkHttp                                                  #
###########################################################
profiler.okhttp.enable=true

###########################################################
# Oracle JDBC                                             #
###########################################################
profiler.oracle.enable=true

###########################################################
# PostgreSQL JDBC                                         #
###########################################################
profiler.postgresql.enable=true

###########################################################
# Redis                                                   #
###########################################################
profiler.redis.enable=true

###########################################################
# Spring                                                  #
###########################################################
profiler.spring.enable=true

###########################################################
# Spring-boot                                             #
###########################################################
profiler.springboot.enable=true

###########################################################
# Tomcat                                                  #
###########################################################
profiler.tomcat.enable=true

###########################################################
# MongoDB                                                 #
###########################################################
profiler.mongodb.enable=true

###########################################################
# Lettuce                                                 #
###########################################################
profiler.lettuce.enable=true

###########################################################
# GRPC                                                    #
###########################################################
profiler.grpc.enable=true

###########################################################
# Thrift                                                  #
###########################################################
profiler.thrift.enable=true

###########################################################
# Memcached                                               #
###########################################################
profiler.memcached.enable=true

# Konfigurasi untuk URL yang tidak valid.


profiler.thresholds.limit=100

profiler.defined.method=

profiler.callstack.maxLength=128

profiler.callsql.maxLength=1024

profiler.tprof.enableThreadProfiler=true

profiler.alibabacloud.metaserver.address=100.100.100.200
###########################################################
# SOFARPC                                                #
###########################################################
profiler.sofa.rpc.enable=true

profiler.exception.stacktrace=2

###########################################################
# Tags                                                    #
###########################################################
#profiler.tags.env=prod
profiler.tags.env=

#profler.tags.version=v1.0
profiler.tags.version=

#profiler.tags.customtags=key1:value1&key2:value2
profiler.tags.customtags=

Penting

Jangan ubah parameter lain dalam file konfigurasi, karena ini dapat menyebabkan hasil sampling yang tidak terduga. Untuk memodifikasi konfigurasi agen, lihat Sesuaikan pengaturan untuk aplikasi Java.

Parameter	Deskripsi	Nilai default
arms.licenseKey	LicenseKey yang diperlukan untuk menginstal agen. Dapatkan dengan mengklik kartu Java Application Monitor pada halaman Pusat Integrasi di konsol ARMS, atau dengan memanggil DescribeTraceLicenseKey di platform OpenAPI.	-
arms.appName	Nama aplikasi.	-
profiler.tags.env	Tag lingkungan aplikasi.	-
profiler.tags.version	Tag versi aplikasi.	-
profiler.tags.customtags	Tag instansi kustom aplikasi.	-
profiler.collector.trace.endpoint	Titik akhir untuk melaporkan data jejak.	arms-dc-hz.aliyuncs.com
profiler.collector.metric.endpoint	Titik akhir untuk melaporkan data deret waktu.	cn-hangzhou.arms.aliyuncs.com
profiler.collector.meta.endpoint	Titik akhir untuk melaporkan metadata.	arms-dc-hz.aliyuncs.com
profiler.collector.endpoint	Titik akhir untuk melaporkan informasi lainnya.	arms-dc-hz.aliyuncs.com
profiler.acm.endpoint	Titik akhir untuk mendengarkan konfigurasi dinamis dari Application Configuration Management (ACM).	addr-hz-internal.edas.aliyun.com
profiler.acm.region.id	Wilayah tempat konfigurasi dinamis ACM berada.	cn-hangzhou

Catatan

Parameter profiler.tags.env, profiler.tags.version, dan profiler.tags.customtags menentukan tag instansi yang dipantau di ARMS.
Enam parameter terakhir menggunakan wilayah China (Hangzhou) sebagai contoh saja.

Terapkan file konfigurasi yang telah dimodifikasi ke instalasi agen ARMS untuk Java V3.x sesuai kebutuhan.

Modifikasi wilayah pelaporan

Wilayah pelaporan data default tergantung pada cara integrasinya:

Integrasi melalui Alibaba Cloud Container Service for Kubernetes (ACK): Wilayah cluster ACK Anda.
Integrasi manual: Wilayah bucket Object Storage Service (OSS) yang digunakan untuk unduhan agen.

Untuk memodifikasi wilayah tempat agen melaporkan data pemantauan:

Metode 1 (direkomendasikan)

Untuk aplikasi yang diterapkan di cluster ACK:

Perbarui komponen ack-onepilot ke V4.0.0 atau yang lebih baru.
Tambahkan variabel lingkungan ARMS_REPORT_REGION ke aplikasi ack-onepilot-ack-onepilot di namespace ack-onepilot. Nilainya harus merupakan ID wilayah tempat ARMS tersedia. Sebagai contoh, Anda dapat mengatur nilainya menjadi cn-hangzhou atau cn-beijing.
Mulai ulang aplikasi yang ada atau terapkan aplikasi baru untuk melaporkan data lintas wilayah.
Catatan
Setelah variabel lingkungan ditambahkan, semua aplikasi yang diterapkan di cluster melaporkan data ke wilayah yang ditentukan pada langkah sebelumnya.

Metode 2 (direkomendasikan)

Untuk agen yang diinstal secara manual, peroleh paket instalasi baru di wilayah target, dan instal ulang agen.

Metode 3 (tidak direkomendasikan)

Ubah parameter profiler.collector.trace.endpoint, profiler.collector.metric.endpoint, profiler.collector.meta.endpoint, profiler.collector.endpoint, profiler.acm.endpoint, dan profiler.acm.region.id dalam file konfigurasi. Untuk informasi tentang titik akhir, lihat Titik Akhir.

Penting

Agen ARMS mencakup pemeriksaan konektivitas jaringan virtual publik (VPC). Jika pemeriksaan konektivitas VPC gagal, ia secara otomatis beralih ke jaringan publik. Oleh karena itu, kami sarankan Anda menggunakan titik akhir VPC.

Agen 2.x

ARMS Pemantauan Aplikasi tidak lagi mendukung agen untuk Java V2.x. Tingkatkan agen Anda ke versi setelah V2.x sesegera mungkin.