Atributo do agente Java

Atributo New Relic são pares de valores principais contendo informações que determinam as propriedades de um evento ou transação. Esses pares de valores principais podem ajudá-lo a obter maiores insights sobre seu aplicativo e a anotar os dados ao consultá-los. Você também pode encaminhar automaticamente as informações do usuário para o New Relic.

Tanto o atributo padrão quanto o personalizado são visíveis em trace da transação, trace distribuído e análise de erros; Evento APM e evento do browser no painel. Você pode personalizar exatamente qual atributo será enviado para cada um desses destinos.

Este documento descreve o atributo do agente Java, detalha como ativar ou desativar o atributo e descreve as regras que o agente segue para determinar qual atributo incluir ou excluir para um destino.

Dica

Essas configurações de atributo se aplicam à versão 3.7.0 ou superior do agente Java. Se você usa uma versão mais antiga do agente, consulte Atualizar configuração do legado atributo.

Atributo específico de Java

Além do atributo padrão do APM, o agente Java coleta atributo destas fontes:

Atributo adicionado por uma chamada à API do agente Java NewRelic.addCustomParameter(...) . O nome da chave para esse atributo depende do que você especifica ao chamar o método.

A configuração padrão para cada destino é:

Rastreamento da transação: Habilitado
Análise de erros: habilitada
Evento APM: Desativado
Evento do browser: Desativado
Importante
Antes de criar um atributo personalizado, revise a lista de termos reservados da New Relic usados pelo NRQL. Caso contrário, você poderá obter alguns resultados inesperados.

Atributo adicionado por uma chamada à API do agente Java NewRelic.getAgent().getTracedMethod().addCustomAttribute(...) . O nome da chave para esse atributo depende do que você especifica ao chamar o método.

Esses atributos são adicionados ao span evento, que pode ser encontrado na interfacedistributed tracing ou consultado diretamente no criador de consulta.

Importante

Antes de criar um atributo personalizado, revise a lista de termos reservados da New Relic usados pelo NRQL. Caso contrário, você poderá obter resultados inesperados.

O agente Java pode capturar os seguintes cabeçalhos de resposta e solicitação como atributo:

Cabeçalhos de solicitação HTTP capturados:

request.headers.referer
request.headers.accept
request.headers.contentLength
request.headers.host
request.headers.userAgent
Cabeçalho de resposta capturado: response.headers.contentType
O agente não captura outros cabeçalhos de solicitação.
O sistema de atributo não se aplica a nenhum valor de cabeçalho diferente dos listados acima. Se desejar capturar cabeçalhos de solicitação adicionais não listados aqui, você deverá usar a opção de configuração custom_request_headers para especificar cabeçalhos a serem capturados pelo agente. Como alternativa, você mesmo pode registrar diretamente os cabeçalhos usando o método addCustomParameter() da API do agente Java.
A configuração padrão para cada destino é:
Rastreamento da transação: Habilitado
Análise de erros: habilitada
Evento APM: Habilitado
Evento do browser: Desativado

O agente Java captura os métodos de solicitação GET, POST e PUT por padrão como parte do atributo request.method .

Os parâmetros de solicitação da transação não são capturados por padrão. Use a API do agente Java addCustomParameter() para capturar o parâmetro da solicitação.

A chave para esses atributos é request.parameters.*. Se a captura de informações confidenciais for uma preocupação, você pode usar estas opções:

Evite usar curingas em attributes.include. Em vez disso, especifique explicitamente cada campo a ser capturado.
Se você quiser usar um curinga em attributes.include, exclua explicitamente os campos confidenciais usando attributes.exclude.

Coletar atributos do usuário

Com o agente Java do APM, você pode coletar automaticamente informações do usuário editando seu arquivo de configuração. Você pode então executar a consulta NRQL com base nas informações do usuário sem precisar criar um atributo personalizado manualmente. Este recurso está disponível com o agente Java 3.10.0 da New Relic ou mais alto.

Importante

Atributos de usuários Java são incompatíveis com o modo de alta segurança.

Para coletar o atributo de usuário enduser.id por meio da API pública com o agente Java 8.1.0 ou superior, ligue:

NewRelic.setUserId(String userId);

Aqui está um trecho de código de exemplo definindo o ID do usuário:

@Trace(dispatcher = true)
public void run() {
    NewRelic.setUserId("example-user-id");
}

Para coletar atributos do usuário por meio de nossa instrumentação de servlet com agente Java 3.10.0 ou mais alto:

Abra newrelic.yml, geralmente localizado no mesmo diretório que newrelic.jar.

Na seção class_transformer , edite com.newrelic.instrumentation.servlet-user para definir enabled como true:

class_transformer:
  # This instrumentation reports the name of the user principal returned from 
  # HttpServletRequest.getUserPrincipal() when servlets and filters are invoked.
  com.newrelic.instrumentation.servlet-user:
    enabled: true

Reinicie seu servidor web.

Se você estiver usando o 8.1.0 versão do agente Java ou superior, você pode consultar o atributo enduser.id ativando com.newrelic.instrumentation.servlet-user ou usando a API pública e aguardando alguns minutos. Por exemplo, você poderia usar a seguinte consulta NRQL para obter uma contagem exclusiva de todos os usuários:

SELECT uniqueCount(enduser.id) FROM Transaction SINCE 1 day ago

Ou se você estiver usando o 3.10.0 versão do agente Java ou superior, e habilitado com.newrelic.instrumentation.servlet-user, você pode consultar o atributo user em poucos minutos:

SELECT uniqueCount(user) FROM Transaction SINCE 1 day ago

Em ambos os casos, caso sejam reportados erros, você pode utilizar o(s) atributo(s) do usuário para ver quantos usuários são impactados em um determinado grupo de erros.

Configurar atributo: ativar, incluir e excluir

Você pode configurar quais tipos de atributo, ou qual atributo específico, o agente Java reporta à New Relic. Isso geralmente é feito por motivos de segurança, quando há certos atributos confidenciais que você não deseja que sejam relatados à New Relic. Para saber quais configurações substituem outras configurações, consulte as regras de configuração do atributo.

Opções de configuração do atributo:

Destino	Opção de configuração	Padrão
Todos	`attributes.enabled`	Verdadeiro
Rastreamento da transação	`transaction_tracer.attributes.enabled`	Verdadeiro
Segmentos de transação	`transaction_segments.attributes.enabled`	Verdadeiro
Análise de erros	`error_collector.attributes.enabled`	Verdadeiro
Evento APM	`transaction_events.attributes.enabled`	Verdadeiro
Evento do browser	`browser_monitoring.attributes.enabled`	Falso
Evento de extensão	`span_events.attributes.enabled`	Verdadeiro

Outros recursos:

Consulte o modelo de arquivo de configuração do agente Java.
Consulte as regras que regem a configuração do atributo, incluindo quais configurações substituem outras configurações.

Destino	Opção de configuração	Padrão
Todos	`attributes.include`	(nenhum)
Rastreamento da transação	`transaction_tracer.attributes.include`	(nenhum)
Segmentos de transação	`transaction_segments.attributes.include`	(nenhum)
Análise de erros	`error_collector.attributes.include`	(nenhum)
Evento APM	`transaction_events.attributes.include`	(nenhum)
Evento do browser	`browser_monitoring.attributes.include`	(nenhum)
Evento de extensão	`span_events.attributes.include`	(nenhum)

Outros recursos:

Consulte o modelo de arquivo de configuração do agente Java.
Consulte as regras que regem a configuração do atributo, incluindo quais configurações substituem outras configurações.

Destino	Opção de configuração	Padrão
Todos	`attributes.exclude`	(nenhum)
Rastreamento da transação	`transaction_tracer.attributes.exclude`	(nenhum)
Segmentos de transação	`transaction_segments.attributes.exclude`	(nenhum)
Análise de erros	`error_collector.attributes.exclude`	(nenhum)
Evento APM	`transaction_events.attributes.exclude`	(nenhum)
Evento do browser	`browser_monitoring.attributes.exclude`	(nenhum)
Evento de extensão	`span_events.attributes.exclude`	(nenhum)

Outros recursos:

Consulte o modelo de arquivo de configuração do agente Java.
Consulte as regras que regem a configuração do atributo, incluindo quais configurações substituem outras configurações.

Regras de atributo

O agente Java segue estas regras ao determinar qual atributo incluir ou excluir para um destino:

Se você definir a propriedade attributes.enabled principal como false, o agente não reportará nenhum atributo.

Quando você define ativado como false para um destino, o agente ignora suas configurações de inclusão/exclusão e não relata nenhum atributo para esse destino.

Se vários atributos de inclusão ou exclusão afetarem a mesma chave, a configuração mais específica terá prioridade.

Configuração do agente:

attributes.enabled: true
attributes.include: foo, myCustomAtt
attributes.exclude: password, myCustomAtt
browser_monitoring.attributes.enabled: true
Chaves de entrada:
food
food.bread
food.fruit.banana
food.fruit.apple
Saída do agente:
Rastreamento da transação: food.fruit.apple
Análise de erros: food.fruit.banana, food.fruit.apple
Evento APM: food.fruit.banana, food.fruit.apple
Evento do browser: food.fruit.banana, food.fruit.apple

As chaves especificadas nas propriedades .include e .exclude diferenciam maiúsculas de minúsculas.

Você pode usar um asterisco * no final de uma chave como curinga. Isso corresponderá a um conjunto de atributo com o mesmo prefixo.

Configuração do agente:

attributes.enabled: true
attributes.include: custom*
attributes.exclude: request.parameters.*
Chaves de entrada:
custom
custom.key1
custom.key2
request.parameters.
request.parameters.foo
request.parameters.bar
Saída do agente:
Rastreamento da transação: custom, custom.key1, custom.key2
Análise de erros: custom, custom.key1, custom.key2
Evento APM: custom, custom.key1, custom.key2
Evento do browser: custom, custom.key1, custom.key2

Esta tradução de máquina é fornecida para sua comodidade.

Dica

Atributo específico de Java

Códigos de resposta HTTP

Mensagens de resposta HTTP

Encadeamentos JVM

Threads JVM bloqueados

Atributo de transação personalizado

Importante

Atributo de evento de período personalizado

Importante

NoticeError() chamada de API

Cabeçalhos de solicitação e resposta

Parâmetro de solicitação

Coletar atributos do usuário

Importante

Habilitar coleta de atributos do usuário

Ver atributo do usuário no painel

Configurar atributo: ativar, incluir e excluir

destination.attributes.enabled

destination.attributes.include

destination.attributes.exclude

Regras de atributo

Definir attributes.enabled como false substitui todas as outras configurações.

Desativando todos os atributos

Definir um destino para substituições falsas inclui/exclui.

Desabilitar um destino

Excluir substituições incluem.

Conflito entre configurações de inclusão e exclusão

Regras mais específicas têm prioridade.

Configurações específicas conflitantes

As chaves diferenciam maiúsculas de minúsculas.

Chaves que não correspondem ao caso especificado

Use um asterisco para curingas.

Combine várias chaves de entrada

Esta tradução de máquina é fornecida para sua comodidade.

Atributo do agente Java

Dica

Atributo específico de Java .css-21sua1{background:none;border:none;width:0;padding:0;}

Mensagens de resposta HTTP

Encadeamentos JVM

Threads JVM bloqueados

Atributo de transação personalizado

Atributo de evento de período personalizado

NoticeError() chamada de API

Cabeçalhos de solicitação e resposta

Parâmetro de solicitação

Coletar atributos do usuário

Importante

Habilitar coleta de atributos do usuário

Ver atributo do usuário no painel

Configurar atributo: ativar, incluir e excluir

destination.attributes.enabled

destination.attributes.include

destination.attributes.exclude

Regras de atributo

Definir attributes.enabled como false substitui todas as outras configurações.

Definir um destino para substituições falsas inclui/exclui.

Excluir substituições incluem.

Regras mais específicas têm prioridade.

As chaves diferenciam maiúsculas de minúsculas.

Use um asterisco para curingas.

Atributo específico de Java