API de requête Insights

L'API de requête de New Relic Insights est une API REST permettant de créer NRQL des requêtes .

Exigences et recommandations

This API is no longer the preferred way to query New Relic data. Pour de meilleurs résultats, vous devez utiliser NerdGraph pour interroger les données.

L’utilisation de cette API peut être restreinte par des autorisations utilisateur liées au rôle.

Pour ajouter des données personnalisées à New Relic, consultez Rapport sur les données personnalisées.

Si votre organisation héberge des données dans un data center de l'UE, assurez-vous d'utiliser le point de terminaison de la région de l'UE approprié.

1. Enregistrer une clé API

Pour utiliser l’API de requête Insights, vous avez besoin d’une clé de requête. Vous pouvez avoir plusieurs clés de requête, et n’importe quelle clé de requête peut être utilisée pour lancer n’importe quelle Insights API requête . Si vous disposez de plusieurs systèmes interrogeant Insights ou différentes destinations de données, New Relic vous recommande d'utiliser plusieurs clés de requête pour améliorer la sécurité des données.

Pour des raisons de sécurité, la clé de requête ne peut pas être modifiée ou lue à l'aide de l'API. Pour modifier ou lire une clé de requête, utilisez l'UI de New Relic.

Pour créer une nouvelle clé de requête :

1. Accédez à one.newrelic.com/api-keys. Si vous utilisez le data center de l'UE, accédez à one.eu.newrelic.com/api-keys plutôt.

2. Cliquez sur Create a key button situé dans le coin supérieur droit de la page API clé.

3. Configurer la nouvelle clé :

• Saisissez un nom pour la nouvelle clé dans le champ prévu à cet effet.
• Ajoutez une description (telle que "clé de requête").

4. Cliquez sur Save pour générer la nouvelle clé.

2. Créez la demande de requête API

Lorsque vous créez ou modifiez une clé de requête, vous verrez un exemple de requête curl que vous pouvez utiliser comme modèle. L'exemple de requête ne fonctionnera pas si vous ne suivez pas ces règles de requête :

• La chaîne de requête NRQL doit être codée en URL.
• La chaîne de requête doit être inférieure à 4 000 octets.
• L'URL doit contenir un ID de compte valide.
• Le X-Query-Key doit contenir une clé de requête valide.
• Le Content-Type doit être application/json.

Linux

Voici un exemple curl :

$
curl -H "Accept: application/json" \
>
     -H "X-Query-Key: YOUR_QUERY_KEY" \
>
     "https://insights-api.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/query?nrql=YOUR_URL_ENCODED_QUERY"

Microsoft Windows

Vous pouvez utiliser Powershell pour requêter un événement via API:

Invoke-WebRequest -Uri https://insights-api.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/query?nrql=YOUR_URL_ENCODED_QUERY -Headers @{"X-Query-Key"="YOUR_QUERY_KEY"} -ContentType "application/json" -Method GET

3. Traitez le JSON renvoyé

L'API de requête renvoie des résultats au format JSON. Il y a une limite de 5 000 résultats par demande.

La structure des données JSON dépend du NRQL que vous avez utilisé dans la requête : différentes combinaisons d'instructions, de clauses et de fonctions SELECT renvoient chacune une réponse appropriée. Lorsque vous écrivez votre code pour traiter le JSON, vous devez effectuer un test de votre requête et examiner le JSON résultant.

Exemple

L'API de requête Insights renvoie des données JSON. Voici un exemple de requête, son format de demande de requête et ses données renvoyées :

SELECT count(appName) FROM PageView SINCE '2014-08-04 00:00:00+0500'

$
curl -H "Accept: application/json" \
>
     -H "X-Query-Key: YOUR_QUERY_KEY" \
>
     "https://insights-api.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/query?nrql=SELECT+count%28appName%29+FROM+PageView+SINCE+%272014-08-04+00%3A00%3A00%2B0500%27"

{
  "results": [
    {
      "count": 80275388
    }
  ],
  "metadata": {
    "eventTypes": ["PageView"],
    "eventType": "PageView",
    "openEnded": true,
    "beginTime": "2014-08-03T19:00:00Z",
    "endTime": "2017-01-18T23:18:41Z",
    "beginTimeMillis=": 1407092400000,
    "endTimeMillis": 1484781521198,
    "rawSince": "'2014-08-04 00:00:00+0500'",
    "rawUntil": "`now`",
    "rawCompareWith": "",
    "clippedTimeWindows": {
      "Browser": {
        "beginTimeMillis": 1483571921198,
        "endTimeMillis": 1484781521198,
        "retentionMillis": 1209600000
      }
    },
    "messages": [],
    "contents": [
      {
        "function": "count",
        "attribute": "appName",
        "simple": true
      }
    ]
  }
}

Lignes directrices sur la limitation du débit

Nous avons des limites de taux de requête. Vous ne rencontrerez probablement pas ces limites, surtout si vous suivez ces directives générales :

• Limitez le nombre de requests avec des requêtes complexes (par exemple, une requête avec des clauses FACET ou TIMESERIES, ou une requête de plus d'un million d'événements) exécutées en même temps.
• Limitez le nombre de requests exécutées simultanément sur des périodes prolongées à un maximum de 5, en particulier si elles incluent des requêtes complexes.

Si New Relic applique des limites de débit sur votre compte pour le nombre de requêtes par minute, l'API de requête renvoie une erreur 429. Si New Relic applique des limites de débit sur votre compte pour les enregistrements inspectés, l'API de requête renvoie une erreur 503 et vos graphiques peuvent afficher un message d'erreur de délai d'expiration.