Modificar parâmetros de agentes ARMS para Java e regiões de relatório de dados por arquivo de configuração - Application Real-Time Monitoring Service: Central de Documentação do Alibaba Cloud

Os arquivos de configuração estáticos têm a menor prioridade. Fontes com maior prioridade, como configurações dinâmicas, propriedades de sistema Java e variáveis de ambiente, substituem os valores definidos nos arquivos de configuração:

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

Quando tanto um sinalizador de comando de inicialização (-D) quanto uma variável de ambiente especificarem a mesma definição, o sinalizador de comando de inicialização terá precedência.

Agentes V4.x e posteriores

Nos agentes V4.x, todos os arquivos de configuração padrão estão empacotados no JAR. Para personalizar as definições, crie um arquivo de configuração externo que substitua os padrões integrados.

Configurar parâmetros do agente

Crie um arquivo .properties, como my-app.properties. Coloque-o no mesmo diretório do JAR do agente para facilitar o gerenciamento.

Adicione os parâmetros conforme necessário. Todos os parâmetros têm valor vazio por padrão. Os três últimos parâmetros definem as tags de instância no ARMS. Exemplo de configuração mínima: substitua os placeholders abaixo pelos valores reais:

Parâmetro	Descrição
`arms.licenseKey`	LicenseKey para instalação do agente. Obtenha-o no cartão Java Application Monitor na página Integration Center ou chamando a API DescribeTraceLicenseKey.
`arms.appName`	Nome da aplicação exibido no ARMS.
`profiler.tags.env`	Tag de ambiente da instância monitorada.
`profiler.tags.version`	Tag de versão da instância monitorada.
`profiler.tags.customtags`	Tag de instância personalizada.

Placeholder	Descrição	Exemplo
`<your-license-key>`	LicenseKey do ARMS	LTAI5tXxx
`<your-app-name>`	Nome da aplicação	my-order-service

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

Aponte o agente para o arquivo de configuração na inicialização. Use um dos métodos a seguir: Sinalizador de comando de inicialização ou Variável de ambiente. Substitua /path/to/my-app.properties pelo caminho absoluto do seu arquivo de configuração.
```
   -Dotel.javaagent.configuration-file=/path/to/my-app.properties
```
```
   OTEL_JAVAAGENT_CONFIGURATION_FILE=/path/to/my-app.properties
```
Aplique o arquivo de configuração modificado à instalação de qualquer agente ARMS para Java V4.x conforme necessário.

Alterar a região de relatório

A região de relatório padrão depende do método de integração:

Método de integração	Região padrão
Container Service for Kubernetes (ACK)	Região do cluster ACK
Instalação manual	Região do bucket do Object Storage Service (OSS) usado para baixar o agente

Use um dos métodos a seguir para alterar a região de relatório.

Método 1: Variável de ambiente ACK

Para aplicações implantadas em um cluster ACK:

Atualize o componente ack-onepilot para a versão V4.0.0 ou posterior.
Adicione a variável de ambiente ARMS_REPORT_REGION à aplicação ack-onepilot-ack-onepilot no namespace ack-onepilot. Defina o valor como um ID de região suportada pelo ARMS, como cn-hangzhou ou cn-beijing.
Reinicie as aplicações existentes ou implante novas aplicações para aplicar a alteração.

Nota

Após adicionar essa variável de ambiente, todas as aplicações no cluster reportarão dados para a região especificada.

Método 2: Sinalizador de comando de inicialização ou variável de ambiente

Sinalizador de comando de inicialização

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

Variável de ambiente

ALIYUN_JAVAAGENT_PROFILEID=<region-id>

Substitua <region-id> por um ID de região suportada pelo ARMS, como cn-hangzhou.

Agentes V3.x

Configurar parâmetros do agente

No diretório descompactado do agente, abra o arquivo arms-agent.config.

Edite os parâmetros em arms-agent.config e salve o arquivo. Você também pode substituir o arquivo por uma versão pré-configurada.

Visualizar o arquivo arms-agent.config completo (exemplo)

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

Não modifique parâmetros além daqueles listados na tabela a seguir. A alteração de outros parâmetros pode causar comportamentos de amostragem inesperados. Para ajustar configurações do agente além desses parâmetros, consulte Personalizar configurações para uma aplicação Java.

A tabela a seguir lista os parâmetros que podem ser modificados com segurança.

Nota

Os parâmetros profiler.tags.env, profiler.tags.version e profiler.tags.customtags especificam as tags de instância monitoradas no ARMS.
Os seis últimos parâmetros usam a região China (Hangzhou) apenas como exemplo.

Parâmetro	Descrição	Valor padrão
`arms.licenseKey`	LicenseKey para instalação do agente. Obtenha-o no cartão Java Application Monitor na página Integration Center ou chamando a API DescribeTraceLicenseKey.	-
`arms.appName`	Nome da aplicação exibido no ARMS.	-
`profiler.tags.env`	Tag de ambiente da instância monitorada.	-
`profiler.tags.version`	Tag de versão da instância monitorada.	-
`profiler.tags.customtags`	Tag de instância personalizada.	-
`profiler.collector.trace.endpoint`	Endpoint para relatório de dados de rastreamento.	arms-dc-hz.aliyuncs.com
`profiler.collector.metric.endpoint`	Endpoint para relatório de dados de métricas.	cn-hangzhou.arms.aliyuncs.com
`profiler.collector.meta.endpoint`	Endpoint para relatório de metadados.	arms-dc-hz.aliyuncs.com
`profiler.collector.endpoint`	Endpoint para relatório de outros dados.	arms-dc-hz.aliyuncs.com
`profiler.acm.endpoint`	Endpoint para configurações dinâmicas do Application Configuration Management (ACM).	addr-hz-internal.edas.aliyun.com
`profiler.acm.region.id`	ID da região para configurações dinâmicas do ACM.	cn-hangzhou

Aplique o arquivo de configuração modificado à instalação de qualquer agente ARMS para Java V3.x conforme necessário.

Alterar a região de relatório

A região de relatório padrão depende do método de integração:

Método de integração	Região padrão
Container Service for Kubernetes (ACK)	Região do cluster ACK
Instalação manual	Região do bucket OSS usado para baixar o agente

Use um dos métodos a seguir para alterar a região de relatório.

Método 1: Variável de ambiente ACK (recomendado)

Para aplicações implantadas em um cluster ACK:

Atualize o componente ack-onepilot para a versão V4.0.0 ou posterior.
Adicione a variável de ambiente ARMS_REPORT_REGION à aplicação ack-onepilot-ack-onepilot no namespace ack-onepilot. Defina o valor como um ID de região suportada pelo ARMS, como cn-hangzhou ou cn-beijing.
Reinicie as aplicações existentes ou implante novas aplicações para aplicar a alteração.

Nota

Após adicionar essa variável de ambiente, todas as aplicações no cluster reportarão dados para a região especificada.

Método 2: Reinstalar o agente (recomendado)

Para um agente instalado manualmente, baixe um novo pacote de instalação da região de destino e reinstale o agente.

Método 3: Editar parâmetros de endpoint (não recomendado)

Modifique os seguintes parâmetros em arms-agent.config para apontar para a região de destino: profiler.collector.trace.endpoint, profiler.collector.metric.endpoint, profiler.collector.meta.endpoint, profiler.collector.endpoint, profiler.acm.endpoint e profiler.acm.region.id. Para valores de endpoint, consulte Endpoints do ARMS.

Importante

O agente ARMS realiza verificações de conectividade de Virtual Private Cloud (VPC). Se a conectividade VPC falhar, o agente retornará automaticamente para a rede pública. Sempre que possível, use endpoints VPC.

Agentes V2.x (descontinuados)

O Monitoramento de Aplicações do ARMS não suporta mais agentes Java V2.x. Atualize seu agente para a versão V3.x ou posterior o mais rápido possível.