Metric API를 통해 메트릭 보고

Metric API 를 사용하여 New Relic 플랫폼에 사용자 지정 메트릭을 보냅니다. 이 문서에는 첫 번째 사용자 지정 메트릭을 보내기 위한 빠른 시작과 메트릭 데이터의 형식을 지정하고 보내는 방법에 대한 자세한 정보가 포함되어 있습니다.

빠른 시작: 측정항목 데이터 보내기

count , gauge 및 summary 측정항목 유형을 보고합니다. 측정항목에 대한 자세한 내용은 설명서 를 참조하십시오.

메트릭 데이터는 HTTP POST 요청을 통해 New Relic에 제출됩니다. 각 요청은 메트릭 이름, 타임스탬프 및 값으로 구성된 하나 이상의 메트릭 데이터 요소로 구성됩니다.

다음 예에 따라 첫 번째 메트릭 데이터 포인트를 New Relic으로 보냅니다.

가져오기 데이터를 보고하려는 계정에 대해.
라이선스 키를 다음 JSON에 삽입한 다음 JSON을 엔드포인트 로 보냅니다.
유효한 에포크 타임스탬프로 timestamp 을 업데이트합니다. 이 예에서는 memory.heap 이라는 측정항목에 대한 단일 측정항목 데이터 요소를 생성하지만 측정항목 유형 을 지정하거나 선택적 common 블록 을 추가하여 추가 속성 또는 데이터 요소를 생성할 수 있습니다.
bash
```
$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"} 
$        }] 
$    }]'
```

몇 초 안에 New Relic에서 메트릭을 사용할 수 있습니다. 다음 쿼리를 사용하여 모든 NRQL 인터페이스 에서 데이터를 쿼리할 수 있습니다.

FROM Metric SELECT max(memory.heap) TIMESERIES

데이터가 표시되는 위치에 대한 자세한 내용은 Metric API 데이터 찾기 를 참조하세요.

엔드포인트 URL

메트릭 API 엔드포인트에 메트릭 데이터를 보낼 때 HTTP POST를 사용합니다.

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

팁

조직이 EU 데이터 센터에서 데이터를 호스팅하는 경우 EU 지역 엔드포인트를 사용하고 있는지 확인하세요. 이 API의 경우 EU 엔드포인트는 다음과 같습니다.

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

HTTP 요청 헤더

POST 요청에 다음 HTTP 요청 헤더를 포함합니다. 일부 매개변수를 요청 헤더 대신 쿼리 매개변수로 보낼 수 있습니다.

머리글	쿼리 매개변수로 보내시겠습니까?	세부
`Content-Type`	아니요	필수 . `application/json` 이어야 합니다.
`Content-Length`	아니요	필수(일반적으로 HTTP 클라이언트에 의해 자동으로 설정됨) . 청크 인코딩으로 보내지 않는 한 요청 본문의 길이(8비트 바이트)입니다. 이 헤더는 일반적으로 데이터를 보내는 기본 HTTP 클라이언트에 의해 기본적으로 설정되며 대부분의 경우 최종 사용자의 추가 노력이 필요하지 않습니다.
`Api-Key`	네	필수의. ㅏ 데이터를 보고하려는 계정에 대해. 헤더와 쿼리 매개변수로 모두 제공되는 경우 값이 일치해야 합니다.
`Content-Encoding`	아니요	GZIP인 경우 필수입니다. 값은 `GZIP` 또는 `Identity.` 이어야 합니다. 값이 없으면 `Identity` 로 간주됩니다.
`x-request-id`	아니요	선택 사항 - 향후 사용을 위해 예약되어 있습니다. 값은 유효한 `UUID4` 이어야 합니다. 값은 각 요청에 대해 고유해야 합니다.

HTTP 요청 본문

HTTP POST 요청의 본문은 JSON 형식이어야 합니다. 다음은 JSON 페이로드에 대한 요구 사항 및 권장 사항을 설명합니다.

페이로드는 UTF-8 로 인코딩되어야 합니다.

구조

JSON 페이로드는 다음 구조를 사용합니다.

JSON 페이로드는 맵의 배열입니다.
각 지도에는 값이 하나 이상의 측정항목 데이터 포인트를 포함하는 배열인 metrics 키가 있어야 합니다.
측정항목 데이터 포인트는 선택적 속성 세트와 함께 name , value 및 timestamp 로 식별됩니다.

이 예제 페이로드는 두 개의 메트릭을 생성합니다. service.errors.all 은 3개의 속성이 있는 개수 측정항목이고 service.memory 은 2개의 속성이 있는 게이지 측정항목입니다.

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

필수 키-값 쌍

metrics 배열의 각 측정항목 데이터 포인트 맵은 다음 키-값 구조를 사용합니다.

열쇠	설명
`name` 끈	필수 . 측정항목의 이름입니다. 값은 255자 미만이어야 합니다.
`value` 번호 또는 지도	필수 . 값은 측정항목 유형 에 따라 다릅니다. `gauge` 및 `count` 의 경우 값은 단일 숫자여야 합니다. `summary` 의 경우 값은 개수, 합계, 최소값 및 최대값을 지정하는 키-값 쌍이 있는 맵이어야 합니다.
`timestamp` 긴	필수 . 측정항목의 시작 시간( Unix 시간 )입니다. 기본값은 UTC 시간대를 사용합니다. 이 필드는 초, 마이크로초 및 나노초도 지원합니다. 그러나 데이터는 저장 및 쿼리를 위해 밀리초로 변환됩니다. 48시간 이전 또는 보고된 시간으로부터 24시간 이후의 타임스탬프로 보고된 메트릭은 삭제됩니다.
`interval.ms` 긍정적인 긴	`count` 및 `summary` 측정항목 유형 에 필요 합니다. 기간의 길이입니다.
`type`	추천 . 이것은 지원되는 측정항목 유형 중 하나여야 합니다. 유형을 지정하지 않으면 기본값은 `gauge` 입니다.
`attributes` 문자열 , JSON 숫자 또는 부울	추천 . 이 특정 측정항목과 연결된 키 값 쌍의 맵입니다. 값은 문자열, JSON 숫자 또는 부울일 수 있습니다. 키는 대소문자를 구분하며 255자 미만이어야 합니다.

다음은 각 메트릭 유형에 대해 하나의 메트릭 데이터 포인트를 포함하는 페이로드의 예입니다.

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

메트릭 간에 속성 공유 `common`

여러 측정항목에 속성 집합을 포함하려는 경우(각 측정항목에 동일한 속성을 추가하지 않음) common 블록을 사용할 수 있습니다. 연결된 모든 메트릭 데이터 요소에 적용되는 정보를 지정하는 선택적 맵입니다. 메트릭 데이터 포인트에 동일한 키가 있는 경우 공통 섹션의 값이 재정의됩니다.

블록에는 다음이 포함될 수 있습니다.

기인하다	설명
`timestamp` 긴	측정항목의 시작 시간( Unix 시간 )입니다. UTC 표준 시간대의 현재 시간이 기본값입니다. 이 필드는 초, 마이크로초 및 나노초도 지원합니다. 그러나 데이터는 저장 및 나중에 쿼리하기 위해 밀리초로 변환됩니다.
`interval.ms` 긍정적인 긴	`count` 및 `summary` 에 필요합니다. 기간의 길이입니다.
`attributes` 문자열, JSON 숫자 또는 부울	이 특정 측정항목과 연결된 키-값 쌍의 맵입니다. 값은 문자열, JSON 숫자 또는 부울일 수 있습니다.

기인하다

설명

timestamp

긴

측정항목의 시작 시간( Unix 시간 )입니다. UTC 표준 시간대의 현재 시간이 기본값입니다. 이 필드는 초, 마이크로초 및 나노초도 지원합니다. 그러나 데이터는 저장 및 나중에 쿼리하기 위해 밀리초로 변환됩니다.

interval.ms

긍정적인 긴

count 및 summary 에 필요합니다. 기간의 길이입니다.

attributes

문자열, JSON 숫자 또는 부울

이 특정 측정항목과 연결된 키-값 쌍의 맵입니다. 값은 문자열, JSON 숫자 또는 부울일 수 있습니다.

다음 예제 페이로드에서는 3개의 메트릭이 전송됩니다. 세 가지 측정항목 모두 common 블록에 지정된 app.name 및 host.name 속성을 공유합니다. 각 측정항목에는 다른 속성 server.response.statuscode 에 대한 고유 값도 있습니다.

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

응답 검증 및 상태 코드

Metric API는 성공적인 요청에 대해 202 응답 코드를 반환합니다. 데이터가 수락되면 다음과 같은 응답 구조와 함께 HTTP 202 응답 코드가 반환됩니다.

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

`202` 응답이 있는 누락된 데이터

202 코드는 API가 데이터를 수신했으며 데이터가 기본 유효성 검사를 통과했음을 나타냅니다. 일반적으로 몇 초 안에 데이터를 쿼리할 수 있습니다. 그러나 New Relic은 데이터를 수신한 후 비동기적으로 추가 유효성 검사를 실행합니다. 202 응답을 받았지만 측정항목을 찾을 수 없는 경우 이는 New Relic이 이 비동기식 검증 중에 오류를 발견했음을 나타냅니다.

사용한 삽입 API 키와 연결된 계정에서 NrIntegrationError 이벤트 를 쿼리하여 이러한 오류를 찾을 수 있습니다. 각 요청에 대한 requestId 은 NrIntegrationError 이벤트에 태그가 지정됩니다. 자세한 내용 은 NRIntegrationError 이벤트 문제 해결 을 참조하십시오.

상태 코드

Metric API는 다음 HTTP 상태 코드를 반환할 수 있습니다.

상태 코드	정의
`202`	데이터가 승인되었습니다.
`400`	요청 구조가 잘못되었습니다.
`403`	인증 실패.
`404`	요청 경로가 잘못되었습니다.
`405`	POST 이외의 요청 방법을 사용했습니다.
`408`	요청이 끝점에 도달하는 데 너무 오래 걸렸습니다.
`411`	`Content-Length` 헤더가 포함되지 않았습니다.
`413`	페이로드가 너무 컸습니다. 페이로드는 1MB(10^6바이트) 미만이어야 합니다.
`414`	요청 URI가 너무 깁니다.
`415`	`Content-Type` 또는 `Content-Encoding` 이(가) 잘못되었습니다.
`429`	요청 비율 할당량이 초과되었습니다.
`431`	요청 헤더가 너무 깁니다.
`5xx`	서버 오류가 발생했습니다(다시 시도하십시오).

사용자의 편의를 위해 제공되는 기계 번역입니다.

빠른 시작: 측정항목 데이터 보내기

엔드포인트 URL

팁

HTTP 요청 헤더

HTTP 요청 본문

구조

2개의 메트릭을 생성하는 JSON 페이로드

필수 키-값 쌍

세 가지 측정항목 유형이 있는 JSON 페이로드

메트릭 간에 속성 공유 `common`

`common` 속성의 예

응답 검증 및 상태 코드

`202` 응답이 있는 누락된 데이터

상태 코드

사용자의 편의를 위해 제공되는 기계 번역입니다.

Metric API를 통해 메트릭 보고

빠른 시작: 측정항목 데이터 보내기 .css-21sua1{background:none;border:none;width:0;padding:0;}

엔드포인트 URL

팁

HTTP 요청 헤더

HTTP 요청 본문

구조

필수 키-값 쌍

세 가지 측정항목 유형이 있는 JSON 페이로드

메트릭 간에 속성 공유 common

common 속성의 예

응답 검증 및 상태 코드

202 응답이 있는 누락된 데이터

상태 코드

빠른 시작: 측정항목 데이터 보내기

메트릭 간에 속성 공유 `common`

`common` 속성의 예

`202` 응답이 있는 누락된 데이터