Reportar métricas via API métrica

Utilize a API métrica para enviar métrica personalizada para a plataforma New Relic. Este documento inclui um início rápido para enviar sua primeira métrica personalizada, além de informações detalhadas sobre como formatar e enviar seus dados de métrica.

Início rápido: Enviar dados métricos

Reportamos os tipos de métricas count, gauge e summary. Para mais informações sobre métrica consulte nossa documentação.

Envie dados métricos para New Relic por meio de uma solicitação HTTP POST. Componha cada solicitação com um ou mais pontos de dados métricos, que consistem em um name, um timestamp e um value para a métrica.

Siga este exemplo para enviar seus primeiros pontos de dados métricos para o New Relic:

1. Obtenha o chave de licençada conta para a qual você deseja relatar dados.

2. Insira a chave de licença no JSON a seguir e envie o JSON para nosso endpoint.

3. Para timestamp substitua INSERT_CURRENT_TIMESTAMP por um timestampde época válido. Este exemplo cria um único ponto de dados métricos para uma métrica chamada memory.heap, mas você pode criar atributos ou pontos de dados adicionais especificando tipos métricos ou adicionando blocos common opcionais.

   bash

   Copiar

   $
   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"} 
   $
           }] 
   $
       }]'

A métrica deverá estar disponível no New Relic em alguns segundos. Você pode consultar os dados de qualquer interface NRQL usando esta consulta:

FROM Metric SELECT max(memory.heap) TIMESERIES

Para saber mais sobre onde os dados aparecem, consulte Encontrar dados da API métrica.

URL endpoint

Use um HTTP POST ao enviar dados de métrica para os endpoints de métrica da API:

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

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

Cabeçalhos de solicitação HTTP

Inclua os seguintes cabeçalhos de solicitação HTTP na solicitação POST. Você pode enviar alguns parâmetros como parâmetro de consulta em vez de cabeçalhos de solicitação.

Corpo da solicitação HTTP

O corpo da solicitação HTTP POST deve estar no formato JSON. A seguir descrevemos os requisitos e recomendações para a carga JSON.

A carga deve ser codificada como UTF-8.

Estrutura

A carga JSON usa esta estrutura:

• A carga JSON é uma matriz de mapas.
• Cada mapa deve conter uma chave metrics cujo valor é uma matriz contendo um ou mais pontos de dados métricos.
• Um ponto de dados métrico é identificado por name, value e timestamp junto com um conjunto opcional de atributo.

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

Pares de valores principais obrigatórios

Cada mapa de pontos de dados métricos na matriz metrics usa a seguinte estrutura de valor principal:

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

Compartilhe atributo entre métricas com common

Se quiser incluir um conjunto de atributos em múltiplas métricas (e não adicionar o mesmo atributo para cada métrica), você pode usar o bloco common . Este é um mapa opcional que especifica informações que se aplicam a todos os pontos de dados métricos associados. Os valores na seção comum serão substituídos se a mesma chave existir em um ponto de dados métricos.

O bloco pode 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"
        }
      }
    ]
  }
]

Validação de resposta e códigos de status

A API métrica retorna um código de resposta 202 para solicitações bem-sucedidas. Quando seus dados são aceitos, um código de resposta HTTP 202 é retornado com uma estrutura de resposta 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"}

Dados ausentes com 202

Um código 202 indica que a API recebeu seus dados e que os dados passaram nas verificações básicas de validação. Normalmente, seus dados estarão disponíveis para consulta em alguns segundos. No entanto, o New Relic executa validação adicional de forma assíncrona após receber seus dados. Se você receber uma resposta 202 , mas não conseguir encontrar sua métrica, isso indica que a New Relic encontrou um erro durante esta validação assíncrona.

Você pode encontrar esses erros consultando o eventoNrIntegrationError na conta associada à chave de API Insert que você usou. O requestId de cada solicitação será marcado no evento NrIntegrationError . Para obter mais informações, consulte Solucionar problemas de um evento NRIntegrationError .

Códigos de status

A API métrica pode retornar os seguintes códigos de status HTTP: