Collecter l'attribut personnalisé

Lorsqu'il s'agit de signaler des données personnalisées non signalées par défaut par les solutions New Relic, deux des solutions les plus populaires sont attribut personnalisé et événement personnalisé. Ce document expliquera plus en détail pourquoi vous utiliseriez un attribut personnalisé.

Pour certaines solutions New Relic, une façon de signaler des données personnalisées à New Relic consiste à utiliser un attribut personnalisé. En ajoutant des attributs personnalisés à vos données, vous pouvez effectuer une analyse plus approfondie et personnalisée de votre entreprise. Par exemple, pour monitoring des navigateurs New Relic, vous pouvez créer un attribut personnalisé pour suivre le nom de l'utilisateur associé à une demande lente ou défaillante.

Important

les attributs personnalisés comptent pour les Go ingérés et sont des données facturables.

Exigences

Des attributs personnalisés sont disponibles pour ces solutions New Relic :

APM
Monitoring de navigateurs
Monitoring de l’activité mobile
Monitoring de l'infrastructure
Moniteur synthétique

Nous entrerons plus en détail sur ces options ci-dessous.

Recommandations pour la création et l'utilisation d'attributs personnalisés

Chez New Relic, les attributs sont des paires valeur clé qui fournissent des métadonnées sur l' événement auquel elles sont attachées.

Un modèle courant lors de la création d'attributs personnalisés consiste à capturer les informations de l'utilisateur, telles que le nom, l'identifiant, l'e-mail, etc. Cela vous permet de créer une association entre vos données opérationnelles et vos données commerciales. Par exemple, si vous disposez des informations utilisateur, vous associez les données de votre service d'assistance et de votre CRM aux données opérationnelles de New Relic.

D’autres types de contexte commercial peuvent inclure :

clients jeton
Segment de marché des clients
classification de la valeur des clients
les valeurs de contrôle du workflow ne sont pas évidentes dans l'URISTem
Contexte de privilège utilisateur/produit/compte

Le contexte opérationnel peut inclure :

Quels indicateurs de fonctionnalité ont été utilisés
À quelle datastore a été accédé
À quel cache a été accédé
Quelles erreurs ont été détectées et ignorées (partitionnement des erreurs)

Une fois que vous avez ajouté un attribut personnalisé, vous pouvez l'interroger dans New Relic et créer des graphiques personnalisés à partir de ces données. Par exemple, si vous avez utilisé l' API d'agentJava pour ajouter un attribut userId à votre événement Transaction et TransactionError, vous pouvez alors créer une requête NRQL en utilisant cet attribut, comme :

SELECT count(*) FROM TransactionError
WHERE userId = '1401961100' FACET dateOf(timestamp), `error.message`
SINCE 1 week ago

APM : Enregistrer l'attribut personnalisé

Important

Consultez la liste des termes réservés utilisés par NRQL. L'utilisation de termes réservés peut entraîner des problèmes.

Pour activer et utiliser l'attribut personnalisé pour APM, suivez la procédure pour votre agent :

L'attribut personnalisé collection est activé par défaut dans Java. Vous pouvez collecter des attributs personnalisés à l'aide de XML et de l'API Java de l'agent. Ces deux méthodes peuvent être utilisées conjointement. Notez que la collecte d'attributs personnalisés nécessite que le fichier jar de l'API Java New Relic soit dans le classpath de l'application.

Méthode	How to do it
Spécifier l'attribut en XML	XML vous permet de spécifier des attributs personnalisés sans modifier aucune de vos sources de code. Vous pouvez avoir plusieurs fichiers XML pour les attributs personnalisés qui sont regroupés par une facette logique. Pour définir des attributs personnalisés pour votre application Java via XML : Consultez la documentation de l'agent Java New Relic sur le format de fichier XML, les méthodes et les classes, ainsi que les exemples. Depuis votre répertoire `Extensions` dans l'agent Java New Relic, créez un fichier XML unique. Définissez les méthodes que vous souhaitez que New Relic monitore en modifiant directement votre fichier XML . Définissez un fichier instrumentation XML à l'aide de l' UI de New Relic. Cela peut nécessiter une configuration supplémentaire dans le bloc `common:` de votre newrelic.yml. Voir Report custom attributes sous Options d'instrumentation pour plus de détails.
Appeler l'API de l'agent	Example 1: Adding custom attributes to transactions Pour collecter des attributs personnalisés à l'aide de l'appel d'API de l'agent, utilisez les méthodes appropriées : Pour chaque méthode pour laquelle vous souhaitez enregistrer un attribut, appelez `NewRelic.addCustomParameter(...)`. Facultatif : inclure ou exclure certains attributs avec `attributes.include` et `attributes.exclude`. Par exemple, pour enregistrer une variable nommée `userId`, incluez ce code dans la méthode parent : `NewRelic.addCustomParameter("userId", userId);` Example 2: Adding custom attributes to spans in distributed traces Pour collecter des attributs personnalisés à l'aide de l'appel d'API de l'agent, utilisez les méthodes appropriées : Pour chaque span (méthode en cours d'exécution) pour laquelle vous souhaitez enregistrer un attribut, appelez `NewRelic.getAgent().getTracedMethod().addCustomAttribute(...)`. Facultatif : inclure ou exclure certains attributs avec `span_events.attributes.include` et `span_events.attributes.exclude`. Par exemple, pour enregistrer une variable nommée `userId` sur la plage actuelle, incluez ce code dans la méthode associée : `NewRelic.getAgent().getTracedMethod().addCustomAttribute("userId", userId);`
Collecter l'attribut utilisateur	L'agent Java comprend également un mécanisme intégré pour activer l'attribut utilisateur et collecter les informations utilisateur de `HttpServletRequest.getUserPrincipal()` en tant qu'attribut personnalisé.

Méthode

How to do it

Spécifier l'attribut en XML

XML vous permet de spécifier des attributs personnalisés sans modifier aucune de vos sources de code. Vous pouvez avoir plusieurs fichiers XML pour les attributs personnalisés qui sont regroupés par une facette logique.

Pour définir des attributs personnalisés pour votre application Java via XML :

Consultez la documentation de l'agent Java New Relic sur le format de fichier XML, les méthodes et les classes, ainsi que les exemples.
Depuis votre répertoire Extensions dans l'agent Java New Relic, créez un fichier XML unique.
Définissez les méthodes que vous souhaitez que New Relic monitore en modifiant directement votre fichier XML .
Définissez un fichier instrumentation XML à l'aide de l' UI de New Relic. Cela peut nécessiter une configuration supplémentaire dans le bloc common: de votre newrelic.yml. Voir Report custom attributes sous Options d'instrumentation pour plus de détails.

Appeler l'API de l'agent

Example 1: Adding custom attributes to transactions

Pour collecter des attributs personnalisés à l'aide de l'appel d'API de l'agent, utilisez les méthodes appropriées :

Pour chaque méthode pour laquelle vous souhaitez enregistrer un attribut, appelez NewRelic.addCustomParameter(...).
Facultatif : inclure ou exclure certains attributs avec attributes.include et attributes.exclude.
Par exemple, pour enregistrer une variable nommée userId, incluez ce code dans la méthode parent :
```
NewRelic.addCustomParameter("userId", userId);
```
Example 2: Adding custom attributes to spans in distributed traces
Pour collecter des attributs personnalisés à l'aide de l'appel d'API de l'agent, utilisez les méthodes appropriées :
Pour chaque span (méthode en cours d'exécution) pour laquelle vous souhaitez enregistrer un attribut, appelez NewRelic.getAgent().getTracedMethod().addCustomAttribute(...).
Facultatif : inclure ou exclure certains attributs avec span_events.attributes.include et span_events.attributes.exclude.
Par exemple, pour enregistrer une variable nommée userId sur la plage actuelle, incluez ce code dans la méthode associée :
```
NewRelic.getAgent().getTracedMethod().addCustomAttribute("userId", userId);
```

Collecter l'attribut utilisateur

L'agent Java comprend également un mécanisme intégré pour activer l'attribut utilisateur et collecter les informations utilisateur de HttpServletRequest.getUserPrincipal() en tant qu'attribut personnalisé.

L'attribut personnalisé collection est activé par défaut dans .NET. Pour collecter des attributs personnalisés, appelez les méthodes API appropriées :

Pour chaque méthode pour laquelle vous souhaitez enregistrer un attribut, appelez AddCustomAttribute.
Facultatif : inclure ou exclure l'attribut avec les include exclude configuration options et .
Par exemple, pour enregistrer l'attribut d'un code de coupon (chaîne) et d'un code d'identification d'article (numéro), vous pouvez inclure ce code dans la méthode parente :
```
IAgent agent = NewRelic.Api.Agent.NewRelic.GetAgent();
ITransaction transaction = agent.CurrentTransaction;

transaction
    .AddCustomAttribute("Discount Code", "Summer Super Sale")
    .AddCustomAttribute("Item Code", 31456);
```

L'attribut personnalisé collection est activé par défaut dans Node.js. Pour collecter des attributs personnalisés, appelez la méthode API appropriée :

Pour chaque attribut que vous souhaitez enregistrer, appelez newrelic.addCustomAttribute.
Pour enregistrer plusieurs attributs à l’aide d’un seul appel, utilisez newrelic.addCustomAttributes.
Par exemple, pour enregistrer l'attribut d'un code de coupon et d'un code d'identification d'article, vous pouvez l'inclure dans la méthode parente :
```
newrelic.addCustomAttributes({
  "Discount Code": "Summer Super Sale",
  "Item Code": 31456
});
```

L'attribut personnalisé collection est activé par défaut en PHP. Pour collecter des attributs personnalisés, appelez la méthode API appropriée pour chaque méthode pour laquelle vous souhaitez enregistrer un attribut ;

newrelic_add_custom_parameter pour l'événement et la durée de la transaction
newrelic_add_custom_span_parameter uniquement pour les travées
Par exemple, pour enregistrer une variable nommée $userId, incluez ce code dans la méthode parent :
```
newrelic_add_custom_parameter ('userID', $userId)
```

L'attribut personnalisé collection est activé par défaut dans Python. Pour collecter des attributs personnalisés, appelez add_custom_attribute pour chaque méthode pour laquelle vous souhaitez enregistrer un attribut.

Par exemple, pour enregistrer une variable nommée user_id, incluez ce code dans la méthode parent :

newrelic.agent.add_custom_attribute('user_id', user_id)

L'attribut personnalisé collection est activé par défaut dans Ruby. Pour collecter des attributs personnalisés, appelez la méthode add_custom_attributes . Par exemple, pour enregistrer une variable nommée @user_id, incluez ce code dans la méthode parent :

::NewRelic::Agent.add_custom_attributes({ user_id: @user.id })

monitoring des navigateurs : Record attribut personnalisé

L'agent de navigateur fournit une API pour spécifier des détails supplémentaires associés à l'événement du navigateur lors du chargement d'une page, soit en transmettant l'attribut d'APM à monitoring des navigateurs, soit en spécifiant un attribut personnalisé via JavaScript. Les valeurs transmises par l'agent APM sont codées et injectées dans l'attribut du navigateur par notre agent de navigateur.

monitoring d'infrastructure: Record attribut personnalisé

Notre monitoring d'infrastructure vous permet de créer des attributs personnalisés qui servent à annoter les données de l'agent infrastructure . Vous pouvez utiliser cette métadonnée pour filtrer votre entité, regrouper vos résultats et annoter vos données.

monitoring des applications mobiles : Enregistrer l'attribut personnalisé

Les agents mobiles incluent l'appel d'API pour enregistrer l'attribut personnalisé :

Pour un aperçu des données personnalisées , voir Insérer un événement personnalisé et un attribut
Méthode Android : setAttribute
Méthode iOS : setAttribute

Moniteur synthétique : Enregistrer l'attribut personnalisé

Voir Synthétique moniteur attribut personnalisé.

Cette traduction automatique est fournie pour votre commodité.

Important

Exigences .css-21sua1{background:none;border:none;width:0;padding:0;}

Recommandations pour la création et l'utilisation d'attributs personnalisés

APM : Enregistrer l'attribut personnalisé

Important

Java

.NET

Node.js

PHP

Python

Ruby

monitoring des navigateurs : Record attribut personnalisé

monitoring d'infrastructure: Record attribut personnalisé

monitoring des applications mobiles : Enregistrer l'attribut personnalisé

Moniteur synthétique : Enregistrer l'attribut personnalisé

Exigences