agent Java attribut

New Relic Les attributs sont des paires valeur/clé contenant des informations qui déterminent les propriétés d'un événement ou d'une transaction. Ces paires valeur-clé peuvent vous aider à obtenir des informations plus détaillées sur votre application et à annoter les données lorsque vous les interrogez. Vous pouvez également transmettre automatiquement les informations utilisateur à New Relic.

Les attributs par défaut et personnalisés sont visibles dans trace de transaction, traces distribuées et analyse des erreurs ; APM événement et navigateur événement dans le dashboard. Vous pouvez personnaliser exactement quel attribut sera envoyé à chacune de ces destinations.

Ce document décrit les attributs d'agent Java, détaille comment activer ou désactiver l'attribut et décrit les règles que l'suit agent pour déterminer quel attribut inclure ou exclure pour une destination.

Conseil

Ces paramètres d'attribut s'appliquent à la version 3.7.0 ou supérieure de l'agent Java. Si vous utilisez une ancienne version de l'agent, consultez legacy Mettre à jour des configuration attributs .

Attribut spécifique à Java

En plus de l'attribut APM par défaut, l'agent Java collecte les attributs à partir de ces sources :

Attributs ajoutés par un appel de NewRelic.addCustomParameter(...) à l'API de l'agent Java. Le nom de clé de cet attribut dépend de ce que vous spécifiez lorsque vous appelez la méthode.

Le paramètre par défaut pour chaque destination est :

trace de transaction : Activé
Analyse des erreurs : activée
Événement APM : Désactivé
navigateur événement: Disabled
Important
Avant de créer des attributs personnalisés, consultez la liste des termes réservés utilisés par NRQL de New Relic.Sinon, vous pourriez obtenir des résultats inattendus.

attribut ajouté par un appel à l'de l'NewRelic.getAgent().getTracedMethod().addCustomAttribute(...) agent Java API. Le nom de clé de cet attribut dépend de ce que vous spécifiez lorsque vous appelez la méthode.

Ces attributs sont ajoutés à span événement, que l'on retrouve dans l' UI de tracing distribué ou directement requête dans le générateur de requêtes.

Important

Avant de créer des attributs personnalisés, consultez la liste des termes réservés utilisés par NRQL de New Relic.Sinon, vous pourriez obtenir des résultats inattendus.

L'agent Java peut capturer les en-têtes de réponse et de demande suivants en tant qu'attribut :

En-têtes de requête HTTP capturés :

request.headers.referer
request.headers.accept
request.headers.contentLength
request.headers.host
request.headers.userAgent
En-tête de réponse capturé : response.headers.contentType
L'agent ne capture pas les autres en-têtes de requête.
L'attribut système ne s'applique pas aux valeurs d'en-tête autres que celles répertoriées ci-dessus. Si vous souhaitez capturer des en-têtes de demande supplémentaires non répertoriés ici, vous devez utiliser l'option de configuration custom_request_headers pour spécifier les en-têtes que l'agent doit capturer. Alternativement, vous pouvez enregistrer directement les en-têtes vous-même à l'aide de la méthode addCustomParameter() de l'API de l'agent Java.
Le paramètre par défaut pour chaque destination est :
trace de transaction : Activé
Analyse des erreurs : activée
Événement APM : Activé
navigateur événement: Disabled

L'agent Java capture les méthodes de requête GET, POST et PUT par défaut dans le cadre de l'attribut request.method .

Les paramètres de demande de la transaction ne sont pas capturés par défaut. Utilisez addCustomParameter()l'API de l'agent Java pour capturer les paramètres de requête.

La clé de ces attributs est request.parameters.*. Si la capture d’informations sensibles est une préoccupation, vous pouvez utiliser ces options :

Évitez d’utiliser des caractères génériques dans attributes.include. Au lieu de cela, spécifiez explicitement chaque champ à capturer.
Si vous souhaitez utiliser un caractère générique dans attributes.include, excluez explicitement les champs sensibles à l'aide de attributes.exclude.

Collecter l'attribut utilisateur

Avec l'agent Java d'APM, vous pouvez collecter automatiquement les informations utilisateur en modifiant votre fichier de configuration. Vous pouvez ensuite exécuter une requête NRQL sur les informations de l'utilisateur sans avoir à créer manuellement un attribut personnalisé. Cette fonctionnalité est disponible avec l'agent Java 3.10.0 de New Relic ou supérieur.

Important

Les attributs utilisateur Java sont incompatibles avec le mode haute sécurité.

Pour collecter l'attribut utilisateur enduser.id via l'API publique avec l'agent Java 8.1.0 ou supérieur, appelez le :

NewRelic.setUserId(String userId);

Voici un exemple snippet de code définissant l'ID utilisateur :

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

Pour collecter les attributs utilisateur via notre instrumentation de servlet avec agent Java 3.10.0 ou supérieur :

Ouvrez newrelic.yml, généralement situé dans le même répertoire que newrelic.jar.

Dans la section class_transformer, modifiez com.newrelic.instrumentation.servlet-user pour définir enabled sur 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

Redémarrez votre serveur Web.

Si vous utilisez la version 8.1.0 sortie de l'agent Java, ou supérieur, vous pouvez interroger l'attribut enduser.id soit en activant com.newrelic.instrumentation.servlet-user, soit en utilisant l'API publique et en attendant quelques minutes. Par exemple, vous pouvez utiliser la requête NRQL suivante pour obtenir un décompte unique de tous les utilisateurs :

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

Ou si vous utilisez la version 3.10.0 sortie de l'agent Java ou supérieur, et com.newrelic.instrumentation.servlet-user activé, vous pouvez interroger l'attribut user en quelques minutes :

SELECT uniqueCount(user) FROM Transaction SINCE 1 day ago

Dans les deux cas, si des erreurs sont signalées, vous pouvez utiliser les attributs utilisateur pour voir combien d'utilisateurs sont impactés dans un groupe d'erreurs donné.

Configurer l'attribut : activer, inclure et exclure

Vous pouvez configurer les types d'attributs, ou les attributs spécifiques, que l'agent Java signale à New Relic. Cela est souvent fait pour des raisons de sécurité, lorsqu'il y a certains attributs sensibles que vous ne souhaitez pas signaler à New Relic. Pour savoir quels paramètres remplacent d’autres paramètres, consultez les règles configuration des attributs.

options configuration des attributs :

Destination	Option de configuration	Défaut
Tous	`attributes.enabled`	Vrai
trace de transaction	`transaction_tracer.attributes.enabled`	Vrai
Segments de transaction	`transaction_segments.attributes.enabled`	Vrai
Analyse des erreurs	`error_collector.attributes.enabled`	Vrai
Événement APM	`transaction_events.attributes.enabled`	Vrai
Browser events	`browser_monitoring.attributes.enabled`	FAUX
Événement de span	`span_events.attributes.enabled`	Vrai

Autres ressources :

Voir le modèle de fichier de configuration de l'agent Java.
Consultez les règles régissant configuration des attributs, y compris les paramètres qui remplacent d'autres paramètres.

Destination	Option de configuration	Défaut
Tous	`attributes.include`	(aucun)
trace de transaction	`transaction_tracer.attributes.include`	(aucun)
Segments de transaction	`transaction_segments.attributes.include`	(aucun)
Analyse des erreurs	`error_collector.attributes.include`	(aucun)
Événement APM	`transaction_events.attributes.include`	(aucun)
Browser events	`browser_monitoring.attributes.include`	(aucun)
Événement de span	`span_events.attributes.include`	(aucun)

Autres ressources :

Voir le modèle de fichier de configuration de l'agent Java.
Consultez les règles régissant configuration des attributs, y compris les paramètres qui remplacent d'autres paramètres.

Destination	Option de configuration	Défaut
Tous	`attributes.exclude`	(aucun)
trace de transaction	`transaction_tracer.attributes.exclude`	(aucun)
Segments de transaction	`transaction_segments.attributes.exclude`	(aucun)
Analyse des erreurs	`error_collector.attributes.exclude`	(aucun)
Événement APM	`transaction_events.attributes.exclude`	(aucun)
Browser events	`browser_monitoring.attributes.exclude`	(aucun)
Événement de span	`span_events.attributes.exclude`	(aucun)

Autres ressources :

Voir le modèle de fichier de configuration de l'agent Java.
Consultez les règles régissant configuration des attributs, y compris les paramètres qui remplacent d'autres paramètres.

Règles d'attribut

L'agent Java suit ces règles pour déterminer quel attribut inclure ou exclure pour une destination :

Si vous définissez la propriété principale attributes.enabled sur false, l'agent ne signale aucun attribut.

Lorsque vous définissez l'option activée sur false pour une destination, l'agent ignore vos paramètres d'inclusion/exclusion et ne signale aucun attribut pour cette destination.

Les propriétés .exclude remplacent les propriétés .include .

Si plusieurs attributs d'inclusion ou d'exclusion affectent la même clé, le paramètre le plus spécifique aura la priorité.

configuration de l'agent :

attributes.enabled: true
attributes.include: foo, myCustomAtt
attributes.exclude: password, myCustomAtt
browser_monitoring.attributes.enabled: true
Touches de saisie :
food
food.bread
food.fruit.banana
food.fruit.apple
Sortie de l'agent :
trace de transaction: food.fruit.apple
Analyse des erreurs : food.fruit.banana, food.fruit.apple
Événement APM : food.fruit.banana, food.fruit.apple
événement du navigateur : food.fruit.banana, food.fruit.apple

Les clés spécifiées dans les propriétés .include et .exclude sont sensibles à la casse.

Vous pouvez utiliser un astérisque * à la fin d'une clé comme caractère générique. Cela correspondra à un ensemble d’attributs avec le même préfixe.

configuration de l'agent :

attributes.enabled: true
attributes.include: custom*
attributes.exclude: request.parameters.*
Touches de saisie :
custom
custom.key1
custom.key2
request.parameters.
request.parameters.foo
request.parameters.bar
Sortie de l'agent :
trace de transaction : custom, custom.key1, custom.key2
Analyse des erreurs : custom, custom.key1, custom.key2
Événement APM : custom, custom.key1, custom.key2
navigateur événement: custom, custom.key1, custom.key2

Cette traduction automatique est fournie pour votre commodité.

Conseil

Attribut spécifique à Java

Codes de réponse HTTP

Messages de réponse HTTP

Fils JVM

Threads JVM verrouillés

Attribut de transaction personnalisé

Important

Attribut d'événement span personnalisé

Important

NoticeError() appel d'API

En-têtes de requête et de réponse

Paramètres de la demande

Collecter l'attribut utilisateur

Important

Activer la collecte des attributs utilisateur

Afficher l'attribut utilisateur dans le dashboard

Configurer l'attribut : activer, inclure et exclure

destination.attributes.enabled

destination.attributes.include

destination.attributes.exclude

Règles d'attribut

La définition de attributes.enabled sur false remplace tous les autres paramètres.

Désactiver tous les attributs

La définition d'une destination sur false remplace l'inclusion/l'exclusion.

Désactiver une destination

Les remplacements d'exclusion incluent.

Conflit entre les paramètres d'inclusion et d'exclusion

Les règles plus spécifiques ont la priorité.

Paramètres spécifiques conflictuels

Les clés sont sensibles à la casse.

Clés qui ne correspondent pas à la casse spécifiée

Utilisez un astérisque pour les caractères génériques.

Associer plusieurs clés d'entrée

Cette traduction automatique est fournie pour votre commodité.

agent Java attribut

Conseil

Attribut spécifique à Java .css-21sua1{background:none;border:none;width:0;padding:0;}

Messages de réponse HTTP

Fils JVM

Threads JVM verrouillés

Attribut de transaction personnalisé

Attribut d'événement span personnalisé

NoticeError() appel d'API

En-têtes de requête et de réponse

Paramètres de la demande

Collecter l'attribut utilisateur

Important

Activer la collecte des attributs utilisateur

Afficher l'attribut utilisateur dans le dashboard

Configurer l'attribut : activer, inclure et exclure

destination.attributes.enabled

destination.attributes.include

destination.attributes.exclude

Règles d'attribut

La définition de attributes.enabled sur false remplace tous les autres paramètres.

La définition d'une destination sur false remplace l'inclusion/l'exclusion.

Les remplacements d'exclusion incluent.

Les règles plus spécifiques ont la priorité.

Les clés sont sensibles à la casse.

Utilisez un astérisque pour les caractères génériques.

Attribut spécifique à Java