Modifica as configurações do Monitoramento de Aplicativos, como amostragem de rastros e configurações de ativação do agente.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| Pid |
string |
Sim |
O ID do processo (PID) do aplicativo. Faça login no console do ARMS. No painel de navegação à esquerda, escolha Monitoramento de Aplicativos > Lista de Aplicativos. Na página Lista de Aplicativos, clique no nome de um aplicativo. A URL na barra de endereços contém o PID do aplicativo. O PID é indicado no formato pid=xxx. O PID geralmente é codificado em porcentagem como xxx%40xxx. Você deve modificar este valor para remover a codificação de porcentagem. Por exemplo, se o PID na URL for xxx%4074xxx, você deve substituir %40 por um sinal de arroba (@) para obter xxx@74xxx. |
a2n80plglh@745eddxxx |
| Settings |
array<object> |
Não |
As configurações do Monitoramento de Aplicativos. |
|
|
object |
Não |
|||
| Key |
string |
Não |
A chave das configurações que você deseja modificar. Para obter mais informações sobre as configurações suportadas, consulte as seções a seguir.
|
sampling.enable |
| Value |
string |
Não |
O valor das configurações que você deseja modificar. Para obter mais informações sobre as configurações suportadas, consulte as seções a seguir.
|
true |
Configurações de amostragem de rastros
| Chave | Descrição | Valor |
| sampling.enable | Especifica se deve ativar o switch de amostragem. | Valores válidos:- true: ativa o switch de amostragem- false: desativa o switch de amostragem |
| sampling.rate | A taxa de amostragem. | Valores válidos: 0 a 100. Valor padrão: 10. |
Configurações de ativação do agente
| Chave | Descrição | Valor |
| enable | Especifica se deve ativar o switch do agente. | Valores válidos:- true: ativa o switch do agente- false: desativa o switch do agente |
Configurações de limite
| Chave | Descrição | Valor |
| thresholds.limit | O limite de limitação. | Valor padrão: 100. |
| thresholds.interface | O limite de tempo de resposta para chamadas de API. | Valor padrão: 500. Unidade: ms. |
| thresholds.sql | O limite de tempo consumido por consultas SQL lentas. | Valor padrão: 500. Unidade: ms. |
Configurações avançadas
| Chave | Descrição | Valor |
| defined.excludeurl | As chamadas de API inválidas que você deseja excluir. | Separe várias chamadas de API com vírgulas (,).Valor padrão: /**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg.Exemplo: /service/taobao,/service/status. |
| callstack.maxLength | O comprimento máximo das pilhas de métodos. | Valor padrão: 128. Valor máximo: 400. |
| exception.stacktrace | A profundidade da pilha com base na qual o sistema identifica o mesmo tipo de exceções. | Valor padrão: 2. O sistema identifica o mesmo tipo de exceções com base na profundidade da pilha especificada. Se você alterar o valor, poderão ocorrer estatísticas inesperadas. Prossiga com cautela. |
| callsql.maxLength | O comprimento máximo das instruções SQL coletadas. | Uma instrução SQL coletada deve ter de 256 a 4096 caracteres. Valor padrão: 1024. |
| jdbc.tracesqlbindvalue | Especifica se deve capturar variáveis vinculadas ao parâmetro PrepareStatement. | Valores válidos:-true: ativa o switch de captura de variáveis vinculadas ao parâmetro PrepareStatement- false: desativa o switch de captura de variáveis vinculadas ao parâmetro PrepareStatement |
| jdbc.tracesqlraw | Especifica se deve capturar instruções SQL brutas. | Valores válidos:- true: ativa o switch de captura de instruções SQL brutas- false: desativa o switch de captura de instruções SQL brutas |
| exception.whitelist | As exceções que você deseja excluir. | O valor deve ser uma expressão regular que especifica o nome de uma categoria de exceção. Separe várias categorias de exceções com vírgulas (,). Exemplo: java.lang.InterrupetedException,java.lang.IndexOutOfBoundsException. As exceções das categorias que você especificar não serão exibidas nos gráficos nas páginas Detalhes do Aplicativo e Diagnóstico de Exceções. |
| error.skip | Os erros que você deseja excluir. | Por padrão, todos os códigos de status HTTP maiores que 400 são contados como erros. Para ignorar códigos de status HTTP específicos maiores que 400, você pode especificá-los como o valor desta chave. Dessa forma, eles não são contados como erros. Separe vários códigos de status HTTP com vírgulas (,). Exemplos: 429 e 429,512. Esta chave é suportada pela versão do agente 2.5.7.2 ou posterior. |
| compress.enable | Especifica se deve ativar o switch de compactação de rastros. | Valores válidos:- true: ativa o switch de compactação de rastros- false: desativa o switch de compactação de rastros |
| param.maxLength | O comprimento máximo dos parâmetros de solicitação. | Valor padrão: 512. Se o valor for maior que o valor padrão, recursos adicionais do sistema serão consumidos. Tenha cautela ao configurar esta chave. |
| quantile.enable | Especifica se deve ativar o switch de estatísticas de quantis. | Valores válidos:- true: ativa o switch de estatísticas de quantis- false: desativa o switch de estatísticas de quantis |
| threadpoolmonitor.enable | Especifica se deve ativar o monitoramento de pool de threads e pool de conexões. | A configuração desta chave entra em vigor após a reinicialização do aplicativo.Valores válidos:- true: ativa o monitoramento de pool de threads e pool de conexões- false: desativa o monitoramento de pool de threads e pool de conexões |
| async.autoTransmit | Especifica se deve ativar o switch de propagação assíncrona automática. | Esta chave é válida apenas quando a versão do agente é 2.8.3 ou posterior.A configuração desta chave entra em vigor após a reinicialização do aplicativo. Este recurso encapsula as tarefas Runnable e Callable que são enviadas ao pool de threads para propagar o contexto. Riscos potenciais podem surgir. Tenha cautela ao configurar esta chave.Valores válidos:-true: ativa o switch de propagação assíncrona automática- false: desativa o switch de propagação assíncrona automática |
| thread.match.package | O nome do pacote para propagação assíncrona. | Esta chave é válida apenas quando a versão do agente é 2.7.1.3 ou posterior.A configuração desta chave entra em vigor após a reinicialização do aplicativo. Quando um Runnable, Callable, Supplier sob o pacote especificado é criado, o contexto de rastro é automaticamente capturado e propagado para a nova thread. Separe vários nomes de pacotes com vírgulas (,). |
| responseInject.enable | Especifica se deve ativar o switch de retorno do ID de rastro na solicitação. | Valores válidos:- true: ativa o switch- false: desativa o switch |
Configurações de thread
| Chave | Descrição | Valor |
| tprof.enableThreadProfiler | Especifica se deve ativar o switch principal de perfilamento de threads. | Valores válidos:- true: ativa o switch- false: desativa o switchSe você ativar este switch, as pilhas de métodos nativos de chamadas de API lentas são salvas automaticamente. |
| tprof.threadProfilerSlowInteractionRt | O limite de tempo consumido por chamadas de API lentas. | Valor padrão: 2000. Se o tempo consumido por chamadas de API lentas exceder o limite, o perfilamento de threads será ativado. Recomendamos que você defina o valor como o 99º percentil do tempo consumido. Se você definir um valor menor que 2000, o consumo de CPU aumentará. Recomendamos que você defina um valor maior ou igual a 500. |
| tprof.enableThreadStackRecorder | Especifica se deve ativar o perfilamento de threads para pilhas de métodos. | Valores válidos:- true: ativa o perfilamento de threads para pilhas de métodos- false: desativa o perfilamento de threads para pilhas de métodosSe você ativar o perfilamento de threads, as pilhas de métodos serão coletadas a cada 5 minutos. |
Configurações de associação de logs de negócios
| Chave | Descrição | Valor |
| logging.enable | Especifica se deve ativar o switch para associar IDs de rastro a logs de negócios. | Valores válidos:- true: ativa o switch- false: desativa o switchSe você ativar este switch, IDs de rastro serão gerados automaticamente nos logs de negócios de um aplicativo. Esta configuração entra em vigor após a reinicialização do aplicativo. Utilitários de log como Log4j, Log4j2 e Logback são suportados. Você deve adicionar %X{EagleEye-TraceID} ao layout do log para gerar IDs de rastro. |
| SLS.project | O projeto do Simple Log Service que armazena os logs de negócios gerados na região atual. | Você pode especificar o nome de um projeto do Simple Log Service que armazena os logs de negócios gerados na região atual. |
| SLS.logStore | O Logstore do Simple Log Service que armazena os logs de negócios gerados na região atual. | Você pode especificar o nome de um Logstore do Simple Log Service que armazena os logs de negócios gerados na região atual. |
| SLS.index | O tipo de índices de logs de negócios gerados na região atual. | Valores válidos:- Se você quiser usar índices de texto completo, não defina esta chave.- Se você quiser usar um índice específico de campo, defina o valor como o nome do campo. Exemplo: SLS.index: tag.Para obter mais informações sobre as diferenças entre índices específicos de campo e índices de texto completo, consulte Configurar índices. |
Configurações de convergência de URL
| Chave | Descrição | Valor |
| convergence.enable | Especifica se deve ativar o recurso de convergência de URL. | Valores válidos:- true: ativa o recurso de convergência de URL- false: desativa o recurso de convergência de URL |
| convergence.minServerSize | O limite de convergência. | Se o limite for excedido, a convergência será realizada. |
| convergence.pattern | A expressão regular das regras de convergência. | Você pode usar expressões regulares para configurar regras de convergência. Separe várias expressões regulares com vírgulas (,). Insira uma URL no texto original para indicar que a URL não é convergida. Exemplo: /service/(.*?)/demo. |
Configurações de diagnóstico do Arthas
Nota: As configurações de diagnóstico do Arthas entram em vigor apenas quando a versão do agente é 2.7.1.3 ou posterior. Para obter mais informações sobre outros pré-requisitos, consulte Diagnóstico do Arthas.
| Chave | Descrição | Valor |
| arthas.enable | Especifica se deve ativar o switch do Arthas. | Valores válidos:- true: ativa o switch do Arthas- false: desativa o switch do Arthas |
| arthas.enableIps | Os endereços IP para os quais o recurso de diagnóstico do Arthas está ativado. | Se você configurar esta chave, o recurso de diagnóstico do Arthas entrará em vigor apenas nos endereços IP especificados. Se você não configurar esta chave, o recurso de diagnóstico do Arthas entrará em vigor em todos os endereços IP por padrão. Separe vários endereços IP com vírgulas (,). |
Configurações de perfilamento contínuo
Nota: As configurações de perfilamento contínuo entram em vigor apenas quando a versão do agente é 2.7.3.5 ou posterior. Para obter mais informações sobre outros pré-requisitos, consulte Perfilamento contínuo.
| Chave | Descrição | Valor |
| cp.enable | Especifica se deve ativar o switch de perfilamento contínuo. | Valores válidos:- true: ativa o switch de perfilamento contínuo- false: desativa o switch de perfilamento contínuo* Se você ativar este switch, deverá configurar os endereços IP nos quais o switch entra em vigor. Caso contrário, o switch não entrará em vigor. Você pode configurar os endereços IP nos dois modos a seguir. |
| Modo | Chave | Descrição | Valor |
| Lista de permissões de endereços IP | cp.allowIPs | Lista de permissões de endereços IP | Os endereços IP das instâncias para as quais o perfilamento contínuo está ativado. Separe vários endereços IP com vírgulas (,).Exemplo: 192.168.0.1,192.168.0.2 |
| cp.allowNetwork | Bloco CIDR | Especifique uma string vazia. Caso contrário, o perfilamento contínuo não funcionará corretamente. | |
| Bloco CIDR | cp.allowIPs | Lista de permissões de endereços IP | Especifique uma string vazia. Caso contrário, o perfilamento contínuo não funcionará corretamente. |
| cp.allowNetwork | Bloco CIDR | O bloco CIDR das instâncias para as quais o perfilamento contínuo está ativado.Exemplo: 192.168.2.0/24/24 |
Configurações de mascaramento de dados Nota: As configurações de mascaramento de dados entram em vigor apenas quando a versão do agente é 2.9.0 ou posterior.
| Chave | Descrição | Valor |
| sanitizer.enable | Especifica se deve ativar o switch de mascaramento de dados. | Valores válidos:- true: ativa o switch de mascaramento de dados- false: desativa o switch de mascaramento de dados |
| sanitizer.keys | As regras de mascaramento de dados. | Você pode especificar regras para mascaramento de dados, conforme mostrado no exemplo. As regras especificadas são usadas como chaves para correspondência exata. Por exemplo, se você especificar password, a regra é equivalente à expressão regular .*password.*. As chaves não diferenciam maiúsculas de minúsculas. Separe várias regras com vírgulas (,).Exemplo: password,secret,key,token e credentials |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| Data |
string |
Indica se a chamada foi bem-sucedida. |
success |
| RequestId |
string |
O ID da solicitação. |
78901766-3806-4E96-8E47-CFEF59E4**** |
| Message |
string |
A mensagem retornada. |
message |
| Code |
integer |
O código de status HTTP. 2XX indica que a solicitação foi bem-sucedida. 3XX indica que a solicitação foi redirecionada. 4XX indica que ocorreu um erro de solicitação. 5XX indica que ocorreu um erro de servidor. |
200 |
| Success |
boolean |
Indica se a solicitação foi bem-sucedida. Valores válidos:
|
true |
Exemplos
Resposta de sucesso
JSON formato
{
"Data": "success",
"RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
"Message": "message",
"Code": 200,
"Success": true
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | ParameterMissing | You must specify the parameter. | You must specify the parameter. |
| 400 | ParameterTraceAppSettingKeyIllegal | The application configuration key is invalid. | The application configuration key is invalid. |
| 400 | ParameterTraceAppSettingValueIllegal | The application configuration value is invalid. | The application configuration value is invalid. |
| 400 | InternalError | InterPlease try again. Contact the DingTalk service account if the issue persists after multiple retries. | |
| 404 | AppNotExist | The application does not exist. | The application does not exist. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.