인사이트 쿼리 API

New Relic Insights 쿼리 API는 NRQL 쿼리를 만들기 위한 REST API입니다.

요구 사항 및 권장 사항

이 API는 더 이상 New Relic 데이터를 쿼리하는 데 선호되는 방법이 아닙니다. 최상의 결과를 얻으려면 NerdGraph 를 사용하여 데이터를 쿼리해야 합니다.

이 API의 사용은 역할 관련 사용자 권한에 의해 제한될 수 있습니다.

New Relic에 사용자 정의 데이터를 추가하려면 사용자 정의 데이터 보고를참조하십시오.

조직이 EU 데이터 센터에서 데이터를 호스팅하는 경우 적절한 EU 지역 엔드포인트를사용하고 있는지 확인하십시오.

1. API 키 등록

Insights 쿼리 API를 사용하려면 쿼리 키가 필요합니다. 여러 쿼리 키를 가질 수 있으며 모든 쿼리 키를 사용하여 Insights API 쿼리를 시작할 수 있습니다. Insights 또는 다른 데이터 대상을 쿼리하는 여러 시스템이 있는 경우 New Relic은 데이터 보안을 강화하기 위해 여러 쿼리 키를 사용할 것을 권장합니다.

보안상의 이유로 쿼리 키는 API를 사용하여 변경하거나 읽을 수 없습니다. 쿼리 키를 변경하거나 읽으려면 New Relic UI를 사용하세요.

새 쿼리 키를 생성하려면:

1. one.newrelic.com/api-keys 로 이동하세요. EU 데이터 센터를 사용하는 경우 one.eu.newrelic.com/api-keys 로 이동하세요. 대신에.
2. API 키 페이지의 오른쪽 상단에 있는 Create a key button [키 만들기 버튼을] 클릭합니다.
3. 새 키를 구성합니다.

• 제공된 필드에 새 키의 이름을 입력합니다.
• 설명(예: "쿼리 키")을 추가합니다.

4. Save [저장을] 클릭하여 새 키를 생성합니다.

2. API 쿼리 요청 생성

쿼리 키를 만들거나 편집 할 때 템플릿으로 사용할 수 있는 예제 컬 쿼리가 표시됩니다. 다음 쿼리 규칙을 따르지 않으면 예제 쿼리가 작동하지 않습니다.

• NRQL 쿼리 문자열 은 URL로 인코딩 되어야 합니다.
• 쿼리 문자열은 4000바이트 미만이어야 합니다.
• URL은 유효한 계정 ID를 포함해야 합니다.
• X-Query-Key 은(는) 유효한 쿼리 키 를 포함해야 합니다.
• Content-Type 은 application/json }이어야 합니다.

Linux

다음은 컬의 예입니다.

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"

마이크로소프트 윈도우

Powershell 을 사용하여 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. 반환된 JSON 처리

쿼리 API는 결과를 JSON 형식으로 반환합니다. 요청당 결과는 5,000개로 제한됩니다.

JSON 데이터의 구조는 요청에 사용한 NRQL에 따라 다릅니다. SELECT 문, 절 및 함수의 다양한 조합은 각각 적절한 응답을 반환합니다. JSON을 처리하는 코드를 작성할 때 쿼리를 테스트 실행하고 결과 JSON을 검사해야 합니다.

예시

Insights 쿼리 API는 JSON 데이터를 반환합니다. 다음은 쿼리, 쿼리 요청 형식 및 반환된 데이터의 예입니다.

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

속도 제한 지침

쿼리 속도 제한이 있습니다 . 특히 다음 일반 지침을 따르는 경우 이러한 제한이 발생하지 않을 수 있습니다.

• 복잡한 쿼리(예: FACET 또는 TIMESERIES 절이 있는 쿼리 또는 백만 개 이상의 이벤트 쿼리)가 동시에 실행되는 요청의 양을 제한합니다.
• 특히 복잡한 쿼리가 포함된 경우 장기간에 걸쳐 동시에 실행되는 요청의 양을 최대 5개로 제한합니다.

New Relic이 분당 쿼리 수에 대해 계정에 속도 제한을 적용하는 경우 쿼리 API는 429 오류를 반환합니다. New Relic이 검사한 레코드에 대해 계정에 속도 제한을 적용하면 쿼리 API가 503 오류를 반환하고 차트에 시간 초과 오류 메시지가 표시될 수 있습니다.