Reporte métrica a través de la API métrica

Utilice la API de métrica para enviar métrica personalizada a la plataforma New Relic. Este documento incluye un inicio rápido para enviar su primera métrica personalizada, además de información detallada sobre cómo formatear y enviar sus datos de métrica.

Inicio rápido: Enviar datos métricos

Reportamos los tipos métricos count, gauge y summary. Para más información sobre métrica consulte nuestra documentación.

Los datos métricos se envían a New Relic a través de una solicitud HTTP POST. Cada solicitud se compone de uno o más puntos de datos de métrica, que constan de un nombre de métrica, una timestamp y un valor.

Siga este ejemplo para enviar sus primeros puntos de datos métricos a New Relic:

1. Obtenga el clave de licenciapara la cuenta a la que desea informar datos.

2. Inserte la clave de licencia en el siguiente JSON y luego envíe el JSON a nuestro extremo.

3. Actualice el timestamp con una timestamp epoch válida. Este ejemplo crea un único punto de datos métrico para una métrica llamada memory.heap, pero puede crear atributos o puntos de datos adicionales especificando tipos de métricas o agregando bloques common opcionales.

   bash

   Copia

   $
   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":CURRENT_TIME, 
   $
               "attributes":{"host.name":"dev.server.com"} 
   $
           }] 
   $
       }]'

La métrica debería estar disponible en New Relic en unos segundos. Puedes consultar los datos desde cualquier interfaz NRQL usando esta consulta:

FROM Metric SELECT max(memory.heap) TIMESERIES

Para obtener más información sobre dónde aparecen los datos, consulte Buscar datos de API métrica.

URL extrema

Utilice un HTTP POST al enviar datos métricos a los extremos métricos de API:

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

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

Encabezados de solicitud HTTP

Incluya los siguientes encabezados de solicitud HTTP con la solicitud POST. Puede enviar algún parámetro como parámetro de consulta en lugar de encabezados de solicitud.

Cuerpo de solicitud HTTP

El cuerpo de la solicitud HTTP POST debe estar en formato JSON. A continuación se describen los requisitos y recomendaciones para la carga útil JSON.

La carga útil debe estar codificada como UTF-8.

Estructura

La carga útil JSON utiliza esta estructura:

• La carga útil JSON es una matriz de mapas.
• Cada mapa debe contener una clave metrics cuyo valor es una matriz que contiene uno o más puntos de datos métricos.
• Un punto de datos métrico se identifica mediante name, value y timestamp junto con un conjunto opcional de atributos.

[
  {
    "metrics": [
      {
        "name": "service.errors.all",
        "type": "count",
        "value": 15,
        "timestamp": CURRENT_TIME,
        "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": CURRENT_TIME,
        "attributes": {
          "host.name": "dev.server.com",
          "app.name": "foo"
        }
      }
    ]
  }
]

Pares principales de valores requeridos

Cada mapa de puntos de datos métricos en la matriz metrics utiliza la siguiente estructura principal de valor:

[
  {
    "metrics": [
      {
        "name": "cache.misses",
        "type": "count",
        "value": 15,
        "timestamp": CURRENT_TIME,
        "interval.ms": 10000,
        "attributes": {
          "cache.name": "myCache",
          "host.name": "dev.server.com"
        }
      },
      {
        "name": "temperature",
        "type": "gauge",
        "value": 15,
        "timestamp": CURRENT_TIME,
        "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": CURRENT_TIME,
        "attributes": {
          "host.name": "dev.server.com",
          "app.name": "foo"
        }
      }
    ]
  }
]

Compartir atributo a través de métrica con common

Si desea incluir un conjunto de atributos en múltiples métricas (y no agregar el mismo atributo para cada métrica), puede usar el bloque common . Este es un mapa opcional que especifica información que se aplica a todos los puntos de datos métricos asociados. Los valores de la sección común se anularán si existe la misma clave en un punto de datos métrico.

El bloque puede incluir:

[
  {
    "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"
        }
      }
    ]
  }
]

Validación de respuesta y códigos de estado.

La API de métrica devuelve un código de respuesta 202 para solicitudes exitosas. Cuando se aceptan sus datos, se devuelve un código de respuesta HTTP 202 con una estructura de respuesta como esta:

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"}

Faltan datos con 202 respuesta

Un código 202 indica que la API recibió sus datos y que los datos pasaron las comprobaciones de validación básicas. Normalmente, sus datos estarán disponibles para su consulta en unos segundos. Sin embargo, New Relic ejecuta una validación adicional de forma asincrónica después de recibir sus datos. Si recibe una respuesta 202 pero no puede encontrar su métrica, esto indica que New Relic encontró un error durante esta validación asincrónica.

Puede encontrar estos errores consultando NrIntegrationError evento en la cuenta asociada con Insertar clave de API que utilizó. El requestId para cada solicitud será etiqueta en el evento NrIntegrationError . Para obtener más información, consulte Solucionar problemas de un evento NRIntegrationError .

Códigos de estado

La API métrica puede devolver los siguientes códigos de estado HTTP: