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

Los agentes Java de Application Real-Time Monitoring Service (ARMS) utilizan archivos de configuración estáticos para controlar el comportamiento del agente, lo cual incluye la identidad de la aplicación, las etiquetas de instancia y las regiones de reporte de datos.

Los archivos de configuración estáticos tienen la prioridad más baja. Las fuentes con mayor prioridad, como dynamic configurations, las propiedades del sistema Java y las variables de entorno, anulan los valores establecidos en los archivos de configuración:

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

Cuando tanto un indicador de comando de inicio (-D) como una variable de entorno especifican la misma configuración, el indicador de comando de inicio tiene precedencia.

Agentes V4.x y posteriores

En los agentes V4.x, todos los archivos de configuración predeterminados se incluyen dentro del paquete JAR. Para personalizar la configuración, cree un archivo de configuración externo que anule los valores predeterminados integrados.

Configuración de parámetros del agente

Cree un archivo .properties, por ejemplo my-app.properties. Colóquelo en el mismo directorio que el JAR del agente para facilitar su gestión.

Agregue los parámetros según sea necesario. Todos los parámetros están vacíos de forma predeterminada. Los últimos tres parámetros establecen instance tags en ARMS. Ejemplo de configuración mínima Reemplace los siguientes marcadores de posición con los valores reales:

Parámetro	Descripción
`arms.licenseKey`	LicenseKey para la instalación del agente. Obténgalo desde la tarjeta Java Application Monitor en la página Integration Center, o mediante la API DescribeTraceLicenseKey.
`arms.appName`	Nombre de la aplicación que se muestra en ARMS.
`profiler.tags.env`	Etiqueta de entorno para la instancia monitoreada.
`profiler.tags.version`	Etiqueta de versión para la instancia monitoreada.
`profiler.tags.customtags`	Etiqueta de instancia personalizada.

Marcador de posición	Descripción	Ejemplo
`<your-license-key>`	LicenseKey de ARMS	LTAI5tXxx
`<your-app-name>`	Nombre de la aplicación	my-order-service

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

Dirija el agente a su archivo de configuración durante el inicio. Utilice uno de los siguientes métodos: Indicador de comando de inicio Variable de entorno Reemplace /path/to/my-app.properties con la ruta absoluta a su archivo de configuración.
```
   -Dotel.javaagent.configuration-file=/path/to/my-app.properties
```
```
   OTEL_JAVAAGENT_CONFIGURATION_FILE=/path/to/my-app.properties
```
Aplique el archivo de configuración modificado a la instalación de cualquier agente ARMS para Java V4.x según sea necesario.

Cambio de la región de reporte

La región de reporte predeterminada depende de su método de integración:

Método de integración	Región predeterminada
Container Service for Kubernetes (ACK)	Región de su clúster de ACK
Instalación manual	Región del bucket de Object Storage Service (OSS) utilizado para descargar el agente

Utilice uno de los siguientes métodos para cambiar la región de reporte.

Método 1: Variable de entorno de ACK

Para aplicaciones desplegadas en un clúster de ACK:

Actualice el componente ack-onepilot a la versión V4.0.0 o posterior.
Agregue la variable de entorno ARMS_REPORT_REGION a la aplicación ack-onepilot-ack-onepilot en el namespace ack-onepilot. Establezca el valor con un ID de supported ARMS region, como cn-hangzhou o cn-beijing.
Reinicie las aplicaciones existentes o despliegue nuevas aplicaciones para aplicar el cambio.

Nota

Después de agregar esta variable de entorno, todas las aplicaciones del clúster reportarán datos a la región especificada.

Método 2: Indicador de comando de inicio o variable de entorno

Indicador de comando de inicio

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

Variable de entorno

ALIYUN_JAVAAGENT_PROFILEID=<region-id>

Reemplace <region-id> con un ID de supported ARMS region, como cn-hangzhou.

Agentes V3.x

Configuración de parámetros del agente

En el directorio del agente descomprimido, abra el archivo arms-agent.config.

Edite los parámetros en arms-agent.config y guarde el archivo. También puede reemplazar el archivo con una versión preconfigurada.

Ver el archivo arms-agent.config completo (ejemplo)

########################################################################
#  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=

Importante

No modifique parámetros distintos a los listados en la siguiente tabla. Cambiar otros parámetros puede provocar un comportamiento de muestreo inesperado. Para ajustar la configuración del agente más allá de estos parámetros, consulte Customize settings for a Java application.

La siguiente tabla enumera los parámetros que puede modificar de forma segura.

Nota

Los parámetros profiler.tags.env, profiler.tags.version y profiler.tags.customtags especifican las instance tags monitoreadas en ARMS.
Los últimos seis parámetros utilizan la región China (Hangzhou) solo como ejemplo.

Parámetro	Descripción	Valor predeterminado
`arms.licenseKey`	LicenseKey para la instalación del agente. Obténgalo desde la tarjeta Java Application Monitor en la página Integration Center, o mediante la API DescribeTraceLicenseKey.	-
`arms.appName`	Nombre de la aplicación que se muestra en ARMS.	-
`profiler.tags.env`	Etiqueta de entorno para la instancia monitoreada.	-
`profiler.tags.version`	Etiqueta de versión para la instancia monitoreada.	-
`profiler.tags.customtags`	Etiqueta de instancia personalizada.	-
`profiler.collector.trace.endpoint`	Endpoint para el reporte de datos de rastreo.	arms-dc-hz.aliyuncs.com
`profiler.collector.metric.endpoint`	Endpoint para el reporte de datos de métricas.	cn-hangzhou.arms.aliyuncs.com
`profiler.collector.meta.endpoint`	Endpoint para el reporte de metadatos.	arms-dc-hz.aliyuncs.com
`profiler.collector.endpoint`	Endpoint para el reporte de otros datos.	arms-dc-hz.aliyuncs.com
`profiler.acm.endpoint`	Endpoint para configuraciones dinámicas de Application Configuration Management (ACM).	addr-hz-internal.edas.aliyun.com
`profiler.acm.region.id`	ID de región para configuraciones dinámicas de ACM.	cn-hangzhou

Aplique el archivo de configuración modificado a la instalación de cualquier agente ARMS para Java V3.x según sea necesario.

Cambio de la región de reporte

La región de reporte predeterminada depende de su método de integración:

Método de integración	Región predeterminada
Container Service for Kubernetes (ACK)	Región de su clúster de ACK
Instalación manual	Región del bucket de OSS utilizado para descargar el agente

Utilice uno de los siguientes métodos para cambiar la región de reporte.

Método 1: Variable de entorno de ACK (recomendado)

Para aplicaciones desplegadas en un clúster de ACK:

Actualice el componente ack-onepilot a la versión V4.0.0 o posterior.
Agregue la variable de entorno ARMS_REPORT_REGION a la aplicación ack-onepilot-ack-onepilot en el namespace ack-onepilot. Establezca el valor con un ID de supported ARMS region, como cn-hangzhou o cn-beijing.
Reinicie las aplicaciones existentes o despliegue nuevas aplicaciones para aplicar el cambio.

Nota

Después de agregar esta variable de entorno, todas las aplicaciones del clúster reportarán datos a la región especificada.

Método 2: Reinstalación del agente (recomendado)

Para un agente instalado manualmente, download a new installation package from the target region y vuelva a instalar el agente.

Método 3: Edición de parámetros de endpoint (no recomendado)

Modifique los siguientes parámetros en arms-agent.config para apuntar a la región objetivo: profiler.collector.trace.endpoint, profiler.collector.metric.endpoint, profiler.collector.meta.endpoint, profiler.collector.endpoint, profiler.acm.endpoint y profiler.acm.region.id. Para consultar los valores de los endpoints, véase ARMS endpoints.

Importante

El agente ARMS realiza comprobaciones de conectividad de Virtual Private Cloud (VPC). Si falla la conectividad VPC, el agente cambia automáticamente a la red pública. Utilice endpoints VPC siempre que sea posible.

Agentes V2.x (obsoletos)

Application Monitoring de ARMS ya no admite agentes Java V2.x. Actualice a la versión V3.x o posterior lo antes posible mediante Upgrade your agent.