Pour garantir que New Relic identifie correctement les éditeurs d’intégration d’API, chaque intégration nécessite une chaîne d’agent utilisateur personnalisée unique.
Si vous utilisez votre intégration uniquement en interne et que vous ne prévoyez pas de la partager avec quelqu'un en dehors de votre organisation, vous n'avez pas besoin de définir une chaîne d'agent personnalisée unique.
Prérequis
Ce document suppose que vous prévoyez de distribuer publiquement une intégration qui utilise l'une des API RESTful publiques de New Relic. Voici quelques exemples de distribution publique :
- Publier votre code d'intégration sur Github.
- Empaquetez votre intégration dans un plugin, une extension ou un autre package et distribuez-la via un répertoire comme WordPress Plugins.
- Offrir une intégration « en tant que service » entre votre produit et New Relic, sans réellement distribuer votre code d'intégration, comme l'intégration de Runscope.
agent utilisateur
Lorsque vous écrivez une application destinée à fonctionner avec RESTful API de New Relic (appelée integration dans ce document), vous créez un HTTP agent pour gérer l'échange d'informations entre votre application et New Relic. Une intégration s'identifie en soumettant une chaîne d'identification standard. Dans HTTP, cette chaîne est incluse dans le champ d'en-tête User-Agent.
Lorsque vous utilisez la RESTful API de New Relic, définissez un User-Agent en-tête qui identifie votre intégration dans l'appel d'API. Cette chaîne personnalisée User-Agent permet New Relic à d'identifier l'intégration qui effectue requests à New Relic de API.
En définissant un agent utilisateur personnalisé, New Relic peut suivre :
- Statistiques d'utilisation de votre intégration.
- Utilisation potentiellement bugguée ou abusive de l'API.
Définir un agent utilisateur
Pour définir un agent utilisateur personnalisé, incluez une chaîne d’agent dans l’en-tête HTTP User-Agent.
Exemples :
Language | Example |
|---|---|
boucle | bash |
Java (en utilisant GET) | |
PHP | |
La chaîne d'agent utilisateur minimale est le nom et la version de l'intégration : name/version. Vous pouvez enchaîner plusieurs valeurs dans une liste séparée par des espaces. La syntaxe complète est :
name/version [(comments)] [name/version [(comments)]] [...]Pour le nom de l’intégration, utilisez une chaîne qui identifie clairement et de manière significative votre intégration.
- Nom ambigu : intégration New Relic
- Nom clair et significatif : intégration SaaS XYZTools avec New Relic
Pour la version d'intégration, utilisez un identifiant de build, un certificat de validation ou un autre identifiant qui est mis à jour lorsque vous sortez de nouvelles versions d'intégration.
Enveloppez les commentaires entre parenthèses () sous forme de liste séparée par des points-virgules ;
Commentaires utiles à inclure :
- L'URL accessible au public de votre intégration. Par instance, une URL Github ou une page de votre site de documentation qui décrit l’intégration.
- Coordonnées afin que New Relic puisse facilement joindre l'éditeur d'intégration.
Conseil
Les informations de la chaîne de l'agent utilisateur ne seront jamais partagées, ni utilisées par New Relic à d'autres fins que la discussion de l'intégration avec son éditeur.
Chaînes d'agent utilisateur et New Relic
New Relic capture les chaînes agent utilisateur à partir de l'appel d'API pour identifier leur source.
L’utilisation de chaînes agent utilisateur personnalisées pour une intégration accessible au public est une bonne pratique recommandée. En fonction de votre relation commerciale avec New Relic, cela peut être nécessaire. L'étiquetage de votre intégration avec une chaîne d'agent utilisateur personnalisée n'affecte pas son interaction avec les API de New Relic.