인시던트 이벤트 REST API

이벤트 API 사용하여 사용자 정의 공지 인시던트 트리거 이벤트를 뉴렐릭에 보고할 수 있습니다. 이 이벤트는 인시던트를 직접 생성하지는 않지만 인시던트 생성을 트리거합니다.

API는 비동기 엔드포인트입니다. 즉, 낮은 응답 지연 시간으로 많은 양의 POSTS를 안정적으로 보낼 수 있습니다.

API 사용: 개요

인시던트 이벤트 API를 통해 New Relic에 커스텀 인시던트 이벤트를 보내는 일반적인 프로세스는 다음과 같습니다.

데이터를 보고하려는 계정에 대해 생성합니다.
사용자 정의 속성 생성을 시작하기 전에 Event API의 제한 및 제한된 문자 를 검토하십시오.
JSON 형식 지침 을 따르는 사건 이벤트에 대한 JSON을 생성합니다.
POST 요청에서 curl을 사용하여 압축된 JSON 페이로드(예: gzip 또는 deflate)를 HTTPS 끝점에 제출합니다.

사건 이벤트 데이터를 New Relic에 보내기 시작했으면 구문 분석 오류에 대한 알림을 받도록 NRQL 경고 조건 을 설정하는 것이 좋습니다.

예제 JSON

JSON 페이로드는 이 예와 비슷할 수 있습니다.

[
  {
    "eventType": "NrAiIncidentExternal",
    "title": "Test",
    "description": "The latency is above threshold of 500000 MS",
    "state": "trigger",
    "source": "luna",
    "entityName": "testEntity",
    "entity.guid": "testEntity123",
    "aggregationTag.serviceId": 5,
    "aggregationTag.environment": "testing",
    "aggregationTag.errorId": 10543,
    "tag.stackTrace": "some stack trace...",
    "version": 1
  }
]

eventType 필드는 NrAiIncidentExternal 을 사용해야 합니다.

명령줄에서 인시던트 이벤트 보내기

다음은 curl을 사용하여 JSON 페이로드를 보내는 방법의 예입니다.

bash

$gzip -c example_incidents.json | curl --data-binary @-  \
>-X POST -H "Content-Type: application/json"  \
>-H "Api-Key: YOUR_LICENSE_KEY" -H "Content-Encoding: gzip" \
>https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT/events

Response
{"success":true, "uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}%

인시던트 이벤트 데이터가 성공적으로 전송되면 알림 UI 에서 확인하거나 해당 데이터를 쿼리하여 확인할 수 있습니다.

인시던트 이벤트 API 사양

인시던트 이벤트 API는 이벤트 API의 값 유형을 사용합니다. 이러한 값 유형 및 사용 지침에 대한 설명은 이벤트 API JSON 지침 을 참조하십시오.

주의

정확히 동일한 aggregationTag 로 두 개의 트리거 이벤트를 생성하는 경우, 이는 동일한 인시던트로 집계됩니다. 즉, 여러 개의 트리거에서 단 하나의 인시던트만 생성됩니다.

들	설명
`aggregationTag.` 문자열* , 숫자 또는 타임스탬프	REQUIRED `aggregationTag` 접두사가 붙은 모든 속성은 트리거 이벤트를 함께 집계하는 데 사용됩니다. 즉, 동일한 집계 태그를 가진 두 개의 트리거 이벤트는 동일한 인시던트로 집계됩니다. (트리거 이벤트 중 어느 것도 해결 이벤트가 아니라고 가정). 인시던트를 해결할 때, 해결 이벤트에 동일한 집계 태그가 포함되는 것이 중요합니다. 예약된 키워드가 있는 집계 태그는 필터링됩니다. 예를 들어 `aggregationTag.priority: 2` 이 있는 JSON 페이로드에서 이 키-값 쌍은 다음 예약된 키워드를 사용하는 사건 이벤트에서 생략됩니다. `reserved_key: {"priority", "accountId", "originalAccountId", "policyId", "conditionId", "aggregationKey", "entityType", "entityName", "entityId", "violationUuid", "violationId", "nrIncidentId" }`
`state` 열거형: (`trigger`, `resolve`)	REQUIRED 이벤트가 새 인시던트를 트리거해야 하는지 아니면 기존 인시던트를 해결해야 하는지 여부입니다. 인시던트에 대한 업데이트는 트리거를 사용하여 보낼 수도 있습니다.
`priority` 열거형: (`low`, `medium`, `high`, `critical`)	인시던트의 우선 순위입니다. 기본값: `high`. 다른 우선순위가 전송될 때 가장 높은 우선순위가 사용됩니다.
`title` 끈	REQUIRED, when `state` is `trigger` 트리거 이벤트의 제목입니다.
`source` 끈	REQUIRED, when `state` is `trigger` 인시던트의 출처 또는 인시던트를 촉발한 모니터링 시스템(장애가 발생한 엔티티 아님).
`description` 끈	트리거 이벤트의 설명입니다.
`deepLinkUrl` 끈	사건과 관련된 페이지에 대한 딥 링크입니다.
`runbookUrl` 끈	Runbook URL입니다.
`externalId` 끈	이벤트에 연결할 수 있는 외부 ID입니다. 예를 들어 이 이벤트 수집과 관련된 오류를 쿼리하는 데 사용할 수 있습니다.
`entityName` 끈	인시던트를 생성한 엔터티의 이름입니다.
`entity.guid` 끈	인시던트를 생성한 엔터티의 ID입니다.
`version` 뜨다	현재 형식의 버전입니다.

들

설명

aggregationTag.*

문자열 , 숫자 또는 타임스탬프

REQUIRED

aggregationTag 접두사가 붙은 모든 속성은 트리거 이벤트를 함께 집계하는 데 사용됩니다.

즉, 동일한 집계 태그를 가진 두 개의 트리거 이벤트는 동일한 인시던트로 집계됩니다. (트리거 이벤트 중 어느 것도 해결 이벤트가 아니라고 가정).

인시던트를 해결할 때, 해결 이벤트에 동일한 집계 태그가 포함되는 것이 중요합니다.

예약된 키워드가 있는 집계 태그는 필터링됩니다. 예를 들어 aggregationTag.priority: 2 이 있는 JSON 페이로드에서 이 키-값 쌍은 다음 예약된 키워드를 사용하는 사건 이벤트에서 생략됩니다.

reserved_key: {"priority",  "accountId", "originalAccountId", "policyId", "conditionId", "aggregationKey", "entityType", "entityName", "entityId", "violationUuid", "violationId", "nrIncidentId" }

state

열거형: (trigger, resolve)

REQUIRED

이벤트가 새 인시던트를 트리거해야 하는지 아니면 기존 인시던트를 해결해야 하는지 여부입니다. 인시던트에 대한 업데이트는 트리거를 사용하여 보낼 수도 있습니다.

priority

열거형: (low, medium, high, critical)

인시던트의 우선 순위입니다. 기본값: high.

다른 우선순위가 전송될 때 가장 높은 우선순위가 사용됩니다.

title

끈

REQUIRED, when state is trigger

트리거 이벤트의 제목입니다.

source

끈

REQUIRED, when state is trigger

인시던트의 출처 또는 인시던트를 촉발한 모니터링 시스템(장애가 발생한 엔티티 아님).

description

끈

트리거 이벤트의 설명입니다.

deepLinkUrl

끈

사건과 관련된 페이지에 대한 딥 링크입니다.

runbookUrl

끈

Runbook URL입니다.

externalId

끈

이벤트에 연결할 수 있는 외부 ID입니다.

예를 들어 이 이벤트 수집과 관련된 오류를 쿼리하는 데 사용할 수 있습니다.

entityName

끈

인시던트를 생성한 엔터티의 이름입니다.

entity.guid

끈

인시던트를 생성한 엔터티의 ID입니다.

version

뜨다

현재 형식의 버전입니다.

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

API 사용: 개요 .css-21sua1{background:none;border:none;width:0;padding:0;}

예제 JSON

명령줄에서 인시던트 이벤트 보내기

인시던트 이벤트 API 사양

주의

API 사용: 개요