Rapport métriques via l'API métrique

Utilisez l' API métrique pour envoyer des métriques personnalisées à la plateforme New Relic. Ce document comprend un démarrage rapide pour envoyer vos premières métriques personnalisées, ainsi que des informations détaillées sur la façon de formater et d'envoyer vos données métriques.

Démarrage rapide : Envoyer des données métriques

Nous rapportons les types métriques count, gauge et summary. Pour plus d'informations sur les métriques, consultez notre documentation.

Soumettez les données métriques à New Relic via une requête HTTP POST. Composez chaque requête avec un ou plusieurs points de données métriques, constitués d'un name, d'un timestamp et d'un value pour la métrique.

Suivez cet exemple pour envoyer vos premiers points de données métriques à New Relic :

1. Obtenez le clé de licencepour le compte auquel vous souhaitez signaler des données.

2. Insérez la clé de licence dans le JSON suivant, puis envoyez le JSON à notre point de terminaison.

3. Pour timestamp remplacez INSERT_CURRENT_TIMESTAMP par un horodatage d'époque valide. Cet exemple crée un seul point de données métrique pour une métrique nommée memory.heap, mais vous pouvez créer des points de données ou d'attribut supplémentaires en spécifiant des types de métrique ou en ajoutant des blocs common facultatifs.

   bash

   Copier

   $
   curl -vvv -k -H "Content-Type: application/json" \
   >
   -H "Api-Key: NEW_RELIC_LICENSE_KEY" \
   >
   -X POST https://metric-api.newrelic.com/metric/v1 \
   >
   --data '[{ 
   $
           "metrics":[{ 
   $
               "name":"memory.heap", 
   $
               "type":"gauge", 
   $
               "value":2.3, 
   $
               "timestamp":INSERT_CURRENT_TIMESTAMP, 
   $
               "attributes":{"host.name":"dev.server.com"} 
   $
           }] 
   $
       }]'

La métrique devrait être disponible dans New Relic dans quelques secondes. Vous pouvez interroger les données de n’importe quelle interface NRQL à l’aide de cette requête :

FROM Metric SELECT max(memory.heap) TIMESERIES

Pour en savoir plus sur l'emplacement où les données s'affichent, consultez Rechercher les données de l'API métrique.

URL du point de terminaison

Utilisez un HTTP POST lors de l'envoi de données métriques aux points de terminaison d'API métrique :

https://metric-api.newrelic.com/metric/v1

https://metric-api.eu.newrelic.com/metric/v1

En-têtes de requête HTTP

Incluez les en-têtes de requête HTTP suivants avec la requête POST. Vous pouvez envoyer certains paramètres sous forme de paramètres de requête au lieu d'en-têtes de requête.

Corps de la requête HTTP

Le corps de la requête HTTP POST doit être au format JSON. Ce qui suit décrit les exigences et les recommandations pour la charge utile JSON.

La charge utile doit être codée comme UTF-8.

Structure

La charge utile JSON utilise cette structure :

• La charge JSON est un ensemble de cartes.
• Chaque carte doit contenir une clé metrics dont la valeur est un éventail contenant un ou plusieurs points de données métriques.
• Un point de données métrique est identifié par un name, value et timestamp ainsi qu'un ensemble facultatif d'attributs.

[
  {
    "metrics": [
      {
        "name": "service.errors.all",
        "type": "count",
        "value": 15,
        "timestamp": INSERT_CURRENT_TIMESTAMP,
        "interval.ms": 10000,
        "attributes": {
          "service.response.statuscode": "400",
          "host.name": "dev.server.com",
          "service.name": "foo"
        }
      },
      {
        "name": "service.memory",
        "type": "gauge",
        "value": 2.7,
        "timestamp": INSERT_CURRENT_TIMESTAMP,
        "attributes": {
          "host.name": "dev.server.com",
          "app.name": "foo"
        }
      }
    ]
  }
]

Paires de clés de valeur requises

Chaque carte de points de données métriques de l'éventail metrics utilise la structure de valeur clé suivante :

[
  {
    "metrics": [
      {
        "name": "cache.misses",
        "type": "count",
        "value": 15,
        "timestamp": INSERT_CURRENT_TIMESTAMP,
        "interval.ms": 10000,
        "attributes": {
          "cache.name": "myCache",
          "host.name": "dev.server.com"
        }
      },
      {
        "name": "temperature",
        "type": "gauge",
        "value": 15,
        "timestamp": INSERT_CURRENT_TIMESTAMP,
        "attributes": {
          "city": "Portland",
          "state": "Oregon"
        }
      },
      {
        "name": "service.response.duration",
        "type": "summary",
        "value": {
          "count": 5,
          "sum": 0.004382655,
          "min": 0.0005093,
          "max": 0.001708826
        },
        "interval.ms": 10000,
        "timestamp": INSERT_CURRENT_TIMESTAMP,
        "attributes": {
          "host.name": "dev.server.com",
          "app.name": "foo"
        }
      }
    ]
  }
]

Partager l'attribut sur plusieurs métriques avec common

Si vous souhaitez inclure un ensemble d'attributs sur plusieurs métriques (et ne pas ajouter le même attribut pour chaque métrique), vous pouvez utiliser le bloc common . Il s'agit d'une carte facultative qui spécifie les informations qui s'appliquent à tous les points de données métriques associés. Les valeurs de la section commune seront remplacées si la même clé existe sur un point de données métrique.

Le bloc peut inclure :

[
  {
    "common": {
      "timestamp": 1531414060739,
      "interval.ms": 10000,
      "attributes": {
        "app.name": "foo",
        "host.name": "dev.server.com"
      }
    },
    "metrics": [
      {
        "name": "service.errors.all",
        "type": "count",
        "value": 9,
        "attributes": {
          "service.response.statuscode": "400"
        }
      },
      {
        "name": "service.errors.all",
        "type": "count",
        "value": 4,
        "attributes": {
          "service.response.statuscode": "500"
        }
      },
      {
        "name": "service.response.duration",
        "type": "summary",
        "value": {
          "count": 5,
          "sum": 0.004382655,
          "min": 0.0005093,
          "max": 0.001708826
        },
        "attributes": {
          "service.response.statuscode": "200"
        }
      }
    ]
  }
]

Validation des réponses et codes d'état

L'API métrique renvoie un code de réponse 202 pour requests réussies. Lorsque vos données sont acceptées, un code de réponse HTTP 202 est renvoyé avec une structure de réponse comme celle-ci :

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=UTF-8
Content-Length: 52
Access-Control-Allow-Methods: GET, POST, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Access-Control-Allow-Origin: *
Connection: keep-alive

{"requestId":"f0e7bfff-001a-b000-0000-01682bcf4565"}

Données manquantes avec 202

Un code 202 indique que l'API a bien reçu vos données et que celles-ci ont passé les contrôles de validation de base. Normalement, vos données seront disponibles pour interrogation en quelques secondes. Cependant, New Relic exécute une validation supplémentaire de manière asynchrone après réception de vos données. Si vous recevez une réponse 202 mais que vous ne trouvez pas votre métrique, cela indique que New Relic a trouvé une erreur lors de cette validation asynchrone.

Vous pouvez trouver ces erreurs en interrogeant l'événementNrIntegrationError dans le compte associé à l'API d'insertion de clé que vous avez utilisée. Le requestId de chaque requête sera étiqueté sur l'événement NrIntegrationError . Pour plus d'informations, voir Résoudre les problèmes d'un événement NRIntegrationError .

Codes d'état

L'API métrique peut renvoyer les codes d'état HTTP suivants :