Para garantir que a New Relic identifique corretamente os editores de integração de API, cada integração precisa de uma string de agente de usuário personalizada exclusiva.
Se você estiver usando sua integração apenas internamente e não planeja compartilhá-la com ninguém fora da sua organização, não será necessário definir uma sequência de agente personalizada exclusiva.
Pré-requisitos
Este documento pressupõe que você planeja distribuir publicamente uma integração que faz uso de qualquer API RESTful pública da New Relic. Exemplos de distribuição pública incluem:
- Divulgando seu código de integração no Github.
- Empacotar sua integração em um plug-in, extensão ou outro pacote e distribuí-lo por meio de um diretório como o plug-in do WordPress.
- Oferecendo uma integração "como serviço" entre seu produto e o New Relic, sem realmente distribuir seu código de integração, como a integração do Runscope.
Agente do usuário
Ao escrever aplicativos para funcionar com API RESTful da New Relic (referida como integration neste documento), você está criando um agente HTTP para gerenciar a troca de informações entre seu aplicativo e a New Relic. Uma integração se identifica enviando uma sequência de identificação padrão. No HTTP esta string está incluída no campo de cabeçalho User-Agent.
Ao usar APIs RESTful da New Relic, defina um cabeçalho User-Agent que identifique sua integração na chamada de API. Essa string User-Agent personalizada permite que a New Relic identifique a integração que está fazendo solicitações à API da New Relic.
Ao definir um agente de usuário personalizado, a New Relic pode rastrear:
- Estatísticas de uso para sua integração.
- Uso de API potencialmente problemático ou abusivo.
Definir um agente de usuário
Para definir um agente de usuário personalizado, inclua uma sequência de agente no cabeçalho HTTP User-Agent.
Exemplos:
Language | Example |
|---|---|
cURL | |
Java | |
PHP | |
A string mínima do agente do usuário é o nome e a versão da integração: name/version. Você pode encadear vários valores em uma lista separada por espaços. A sintaxe completa é:
name/version [(comments)] [name/version [(comments)]] [...]Para o nome da integração, use uma string que identifique sua integração de forma clara e significativa.
Nome ambíguo: New Relic integração
Nome claro e significativo: SaaS XYZTools integração com New Relic
Para a versão de integração, use um ID de construção, commit aplicar hash ou outro identificador que seja atualizado quando você lançar novas versões de integração.
Coloque os comentários entre parênteses () como uma lista separada por ponto e vírgula;
Comentários úteis a serem incluídos:
- A URL acessível publicamente da sua integração. Por exemplo, um URL do Github ou uma página em seu site de documentos que descreva a integração.
- Informações de contato para que a New Relic possa entrar em contato facilmente com o editor da integração.
Dica
As informações da string do agente do usuário nunca serão compartilhadas nem usadas pela New Relic para qualquer finalidade que não seja discutir a integração com seu editor.
Strings de agente de usuário e New Relic
New Relic captura strings de agente de usuário da chamada de API para identificar sua origem.
O uso de strings de agente de usuário personalizadas para integração publicamente disponível é uma prática recomendada. Dependendo do seu relacionamento comercial com a New Relic, isso pode ser necessário. Rotular sua integração com uma string de agente de usuário personalizada não afeta sua interação com API da New Relic.