Modify ARMS agents for Java parameters and data reporting regions through a configuration file - Application Real-Time Monitoring Service

Les agents Java d'Application Real-Time Monitoring Service (ARMS) utilisent des fichiers de configuration statiques pour contrôler le comportement de l'agent, notamment l'identité de l'application, les tags d'instance et les régions de transmission des données.

Les fichiers de configuration statiques ont la priorité la plus basse. Les sources de priorité supérieure, telles que les configurations dynamiques, les propriétés système Java et les variables d'environnement, remplacent les valeurs définies dans les fichiers de configuration :

Dynamic configurations (highest)
        ↓
Java system properties (-D flags)
        ↓
Environment variables
        ↓
Static configuration files (lowest)

Lorsqu'un indicateur de commande de démarrage (-D) et une variable d'environnement spécifient le même paramètre, l'indicateur de commande de démarrage est prioritaire.

Agents V4.x et versions ultérieures

Dans les agents V4.x, tous les fichiers de configuration par défaut sont intégrés au package JAR. Pour personnaliser les paramètres, créez un fichier de configuration externe qui remplace les valeurs par défaut intégrées.

Configurer les paramètres de l'agent

Créez un fichier .properties, tel que my-app.properties. Placez-le dans le même répertoire que le JAR de l'agent pour faciliter la gestion.

Ajoutez les paramètres selon vos besoins. Tous les paramètres sont vides par défaut. Les trois derniers paramètres définissent les tags d'instance dans ARMS. Exemple de configuration minimale Remplacez les espaces réservés suivants par des valeurs réelles :

Paramètre	Description
`arms.licenseKey`	LicenseKey pour l'installation de l'agent. Obtenez-la depuis la carte Java Application Monitor sur la page du Integration Center, ou en appelant l'API DescribeTraceLicenseKey.
`arms.appName`	Nom de l'application affiché dans ARMS.
`profiler.tags.env`	Tag d'environnement pour l'instance surveillée.
`profiler.tags.version`	Tag de version pour l'instance surveillée.
`profiler.tags.customtags`	Tag d'instance personnalisé.

Espace réservé	Description	Exemple
`<your-license-key>`	LicenseKey ARMS	LTAI5tXxx
`<your-app-name>`	Nom de l'application	my-order-service

   arms.licenseKey=<your-license-key>
   arms.appName=<your-app-name>

Pointez l'agent vers votre fichier de configuration au démarrage. Utilisez l'une des méthodes suivantes : Indicateur de commande de démarrage Variable d'environnement Remplacez /path/to/my-app.properties par le chemin absolu vers votre fichier de configuration.
```
   -Dotel.javaagent.configuration-file=/path/to/my-app.properties
```
```
   OTEL_JAVAAGENT_CONFIGURATION_FILE=/path/to/my-app.properties
```
Appliquez le fichier de configuration modifié à l'installation de n'importe quel agent ARMS pour Java V4.x selon vos besoins.

Modifier la région de transmission

La région de transmission par défaut dépend de votre méthode d'intégration :

Méthode d'intégration	Région par défaut
Container Service for Kubernetes (ACK)	Région de votre cluster ACK
Installation manuelle	Région du bucket Object Storage Service (OSS) utilisé pour le téléchargement de l'agent

Utilisez l'une des méthodes suivantes pour modifier la région de transmission.

Méthode 1 : Variable d'environnement ACK

Pour les applications déployées dans un cluster ACK :

Mettez à jour le composant ack-onepilot vers la version V4.0.0 ou ultérieure.
Ajoutez la variable d'environnement ARMS_REPORT_REGION à l'application ack-onepilot-ack-onepilot dans le namespace ack-onepilot. Définissez la valeur sur l'ID d'une région ARMS prise en charge, telle que cn-hangzhou ou cn-beijing.
Redémarrez les applications existantes ou déployez de nouvelles applications pour appliquer la modification.

Remarque

Après avoir ajouté cette variable d'environnement, toutes les applications du cluster transmettent leurs données à la région spécifiée.

Méthode 2 : Indicateur de commande de démarrage ou variable d'environnement

Indicateur de commande de démarrage

-Daliyun.javaagent.profileId=<region-id>

Variable d'environnement

ALIYUN_JAVAAGENT_PROFILEID=<region-id>

Remplacez <region-id> par l'ID d'une région ARMS prise en charge, telle que cn-hangzhou.

Agents V3.x

Configurer les paramètres de l'agent

Dans le répertoire de l'agent décompressé, ouvrez le fichier arms-agent.config.

Modifiez les paramètres dans arms-agent.config et enregistrez le fichier. Vous pouvez également remplacer le fichier par une version préconfigurée.

Afficher le fichier arms-agent.config complet (exemple)

########################################################################
#  Specify arms.licenseKey (obtained from the console) and arms.appName
#  (the name of the integrated application).
#
#  Example:
#  arms.licenseKey=XXXXXXXXXXXXXXX
#  arms.appName=Demo-Service
#
########################################################################

arms.licenseKey=

arms.appName=

########################################################################
#  The ARMS agent operates with default system configurations.
#  Maintain these settings to ensure system stability.
########################################################################

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

# The region where the ARMS agent reports the Microservices Engine (MSE) monitoring data.
profiler.mse.region=cn-hangzhou

# The agent log level: ERROR < WARN <  INFO <  DEBUG < TRACE
# Settings with a higher priority will output logs with a lower level.
profiler.agent.logger.level=WARN

# Global configuration: specifies whether to enable instrumentation. Retain the value true for the agent to work properly.
profiler.enable=true

# Global configuration: specifies whether to enable sampling function is enabled. Retain the value true to sample data properly.
profiler.sampling.enable=true

# Global configuration: the sampling rate, unit: %.
profiler.sampling.rate=10

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

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

###########################################################
# Alibaba Cloud High-speed Service Framework (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

# Configurations for an invalid URL.

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=

Important

Ne modifiez pas les paramètres autres que ceux répertoriés dans le tableau suivant. La modification d'autres paramètres peut entraîner un comportement d'échantillonnage inattendu. Pour ajuster les paramètres de l'agent au-delà de ces paramètres, consultez la rubrique Personnaliser les paramètres d'une application Java.

Le tableau suivant répertorie les paramètres que vous pouvez modifier en toute sécurité.

Remarque

Les paramètres profiler.tags.env, profiler.tags.version et profiler.tags.customtags spécifient les tags d'instance surveillés dans ARMS.
Les six derniers paramètres utilisent la région Chine (Hangzhou) à titre d'exemple uniquement.

Paramètre	Description	Valeur par défaut
`arms.licenseKey`	LicenseKey pour l'installation de l'agent. Obtenez-la depuis la carte Java Application Monitor sur la page du Integration Center, ou en appelant l'API DescribeTraceLicenseKey.	-
`arms.appName`	Nom de l'application affiché dans ARMS.	-
`profiler.tags.env`	Tag d'environnement pour l'instance surveillée.	-
`profiler.tags.version`	Tag de version pour l'instance surveillée.	-
`profiler.tags.customtags`	Tag d'instance personnalisé.	-
`profiler.collector.trace.endpoint`	Endpoint pour la transmission des données de trace.	arms-dc-hz.aliyuncs.com
`profiler.collector.metric.endpoint`	Endpoint pour la transmission des données de métrique.	cn-hangzhou.arms.aliyuncs.com
`profiler.collector.meta.endpoint`	Endpoint pour la transmission des métadonnées.	arms-dc-hz.aliyuncs.com
`profiler.collector.endpoint`	Endpoint pour la transmission d'autres données.	arms-dc-hz.aliyuncs.com
`profiler.acm.endpoint`	Endpoint pour les configurations dynamiques d'Application Configuration Management (ACM).	addr-hz-internal.edas.aliyun.com
`profiler.acm.region.id`	ID de région pour les configurations dynamiques ACM.	cn-hangzhou

Appliquez le fichier de configuration modifié à l'installation de n'importe quel agent ARMS pour Java V3.x selon vos besoins.

Modifier la région de transmission

La région de transmission par défaut dépend de votre méthode d'intégration :

Méthode d'intégration	Région par défaut
Container Service for Kubernetes (ACK)	Région de votre cluster ACK
Installation manuelle	Région du bucket OSS utilisé pour le téléchargement de l'agent

Utilisez l'une des méthodes suivantes pour modifier la région de transmission.

Méthode 1 : Variable d'environnement ACK (recommandée)

Pour les applications déployées dans un cluster ACK :

Mettez à jour le composant ack-onepilot vers la version V4.0.0 ou ultérieure.
Ajoutez la variable d'environnement ARMS_REPORT_REGION à l'application ack-onepilot-ack-onepilot dans le namespace ack-onepilot. Définissez la valeur sur l'ID d'une région ARMS prise en charge, telle que cn-hangzhou ou cn-beijing.
Redémarrez les applications existantes ou déployez de nouvelles applications pour appliquer la modification.

Remarque

Après avoir ajouté cette variable d'environnement, toutes les applications du cluster transmettent leurs données à la région spécifiée.

Méthode 2 : Réinstaller l'agent (recommandée)

Pour un agent installé manuellement, téléchargez un nouveau package d'installation depuis la région cible et réinstallez l'agent.

Méthode 3 : Modifier les paramètres d'endpoint (non recommandée)

Modifiez les paramètres suivants dans arms-agent.config pour pointer vers la région cible : profiler.collector.trace.endpoint, profiler.collector.metric.endpoint, profiler.collector.meta.endpoint, profiler.collector.endpoint, profiler.acm.endpoint et profiler.acm.region.id. Pour les valeurs d'endpoint, consultez la rubrique Endpoints ARMS.

Important

L'agent ARMS effectue des vérifications de connectivité Virtual Private Cloud (VPC). Si la connectivité VPC échoue, l'agent revient automatiquement au réseau public. Utilisez les endpoints VPC chaque fois que possible.

Agents V2.x (obsolètes)

ARMS Application Monitoring ne prend plus en charge les agents Java V2.x. Mettez à niveau votre agent vers la version V3.x ou ultérieure dès que possible.