Para garantizar que New Relic identifique correctamente a los editores de integración de API, cada integración necesita una cadena de agente de usuario personalizada única.
Si solo utiliza su integración internamente y no planea compartirla con nadie fuera de su organización, no necesita establecer una cadena de agente personalizada única.
Requisitos previos
Este documento supone que planea distribuir públicamente una integración que utiliza cualquiera de las API RESTful públicas de New Relic. Ejemplos de distribución pública incluyen:
- Publicar su código de integración en Github.
- Empaquetar su integración en un complemento, extensión u otro paquete y distribuirla a través de un directorio como el complemento de WordPress.
- Ofrecer una integración "como servicio" entre su producto y New Relic, sin distribuir realmente su código de integración, como la integración de Runscope.
Agente de usuario
Al escribir aplicaciones para que funcionen con las API RESTful de New Relic (denominadas integration en este documento), está creando un agente HTTP para administrar el intercambio de información entre su aplicación y New Relic. Una integración se identifica a sí misma enviando una cadena de identificación estándar. En HTTP, esta cadena se incluye en el campo de encabezado User-Agent.
Cuando utilice las API RESTful de New Relic, establezca un encabezado User-Agent que identifique su integración en la API de llamada. Esta cadena User-Agent personalizada permite a New Relic identificar la integración que realiza solicitudes a las API de New Relic.
Al configurar un agente de usuario personalizado, New Relic puede rastrear:
- Estadísticas de uso para tu integración.
- Uso de API potencialmente defectuoso o abusivo.
Establecer un agente de usuario
Para configurar un agente de usuario personalizado, incluya una cadena de agente en el encabezado HTTP User-Agent.
Ejemplos:
Language | Example |
|---|---|
cURL | |
Java | |
PHP | |
La cadena mínima del agente de usuario es el nombre y la versión de la integración: name/version. Puede encadenar varios valores en una lista separada por espacios. La sintaxis completa es:
name/version [(comments)] [name/version [(comments)]] [...]Para el nombre de la integración, utilice una cadena que identifique de forma clara y significativa su integración.
Nombre ambiguo: integración New Relic
Nombre claro y significativo: integración de SaaS XYZTools con New Relic
Para la versión de integración, utilice un ID de compilación, un hash de confirmación u otro identificador que se actualice cuando publique nuevas versiones de integración.
Envuelva los comentarios entre paréntesis () como una lista separada por punto y coma;
Comentarios útiles para incluir:
- La URL de acceso público de su integración. Por ejemplo, una URL de Github o una página en su sitio de documentos que describa la integración.
- Información de contacto para que New Relic pueda comunicarse fácilmente con el editor de integración.
Sugerencia
New Relic nunca compartirá ni utilizará la información de la cadena del agente de usuario para ningún otro propósito que no sea discutir la integración con su editor.
Cadenas de agentes de usuario y New Relic
New Relic captura cadenas de agentes de usuario de la API de llamadas para identificar su fuente.
Una de las mejores prácticas recomendadas es el uso de cadenas de agentes de usuario personalizadas para la integración disponible públicamente. Dependiendo de su relación comercial con New Relic, es posible que sea necesario. Etiquetar su integración con una cadena de agente de usuario personalizada no afecta su interacción con las API de New Relic.