인프라 경고에 대한 REST API 호출

인프라 REST API를 사용하여 경고 조건을 추가, 업데이트, 삭제 및 나열합니다. 인프라 모니터링 UI 를 사용하여 개별 알림 조건을 관리할 수도 있습니다.

인프라 경고에 대한 REST API 호출은 API 탐색기 에서 사용할 수 없습니다.

API를 사용하는 이유	예
일관성	인프라 UI에서 매번 동일한 조건을 설정할 필요 없이 모든 클러스터에 대해 동일한 조건 집합을 정의합니다. UI를 사용하여 하나씩 업데이트하지 않고도 여러 조건을 빠르게 관리할 수 있습니다.
유연성	임의의 호스트 그룹에 대한 조건을 만듭니다. 언제든지 오프라인 상태가 된 호스트에 대한 조건을 비활성화하거나 삭제할 수 있습니다. 제외 필터링을 사용하여 조건을 만듭니다(예: `environment NOT LIKE x` ). 이에 대한 자세한 내용 은 제외 필터링에 대한 이 게시물을 참조하십시오. AWS 클라우드 통합의 경우 아직 AWS에서 전송하지 않은 속성을 선택합니다. 2차 또는 3차 측정항목에 대한 제한을 지정할 수 있는 `where_clause` 을 사용하여 복합 경고 조건을 생성합니다. NRQL 경고 조건에 대한 500개 패싯 제한을 초과합니다.
신뢰할 수 있음	조건이 마지막으로 업데이트된 시간을 감사합니다.

요구 사항

Infrastructure REST API를 사용하려면 다음이 필요합니다.

New Relic 계정. 하나가 없습니까? 무료 가입! . 신용 카드가 필요하지 않습니다.
API 키 ($API_KEY)
GET 조건 목록 또는 경고 REST API 를 통해 사용할 수 있는 New Relic의 경고 조건 관련 policy_id
GET 조건 목록 또는 인프라 UI의 조건 URL을 통해 사용 가능한 조건 id

팁

조직이 미국 이외의 데이터센터 리전에서 데이터를 호스팅하는 경우 올바른 리전 엔드포인트를 사용하고 있는지 확인하십시오. 데이터센터 리전 및 엔드포인트에 대해 자세히 알아보십시오.

인프라 API 호출 사용

다음은 인프라 경고 조건에 대한 몇 가지 기본 cURL 명령 및 해당 응답입니다. 조건 유형에 따라 호출에서 제공하는 DATA 정보는 POST(추가) 및 PUT(업데이트) 호출에 따라 달라집니다.

data 블록에 사용된 각 속성의 정의는 정의 섹션에서 찾을 수 있습니다.

GET 인프라 조건

인프라 조건 목록을 GET하거나 특정 인프라 조건 을 GET할 수 있습니다. 다음은 인프라 조건을 나열하기 위한 몇 가지 팁입니다.

페이지 매김의 경우 limit (페이지당 레코드 수) 및 offset (건너뛸 레코드 수) 매개변수를 사용합니다. 기본값은 페이지당 50개 레코드이고 offset 는 0에서 시작합니다(레코드 건너뛰기).
결과 범위를 특정 정책으로 지정하려면 policy_id 을 사용합니다.

팁

GET 응답을 PUT 또는 POST 입력의 템플릿으로 사용하려면 created_at_epoch_millis , updated_at_epoch_millis 및 id 정보를 제거해야 합니다.

인프라 조건 목록을 GET

bash

$curl -v -X GET --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions?policy_id=111111"

예시 정책에 대한 3가지 조건 중 2가지를 보여주는 응답(가독성을 위해 형식이 지정되고 잘림):

HTTP/1.1 200 OK
Content-Length: 622
Content-Type: application/json

{
   "data":[
      {
         "type":"infra_process_running",
         "name":"Java is running",
         "enabled":true,
         "where_clause":"(`hostname` LIKE '%cassandra%')",
         "id":13890,
         "created_at_epoch_millis":1490996713872,
         "updated_at_epoch_millis":1490996713872,
         "policy_id":111111,
         "comparison":"equal",
         "critical_threshold":{
            "value":0,
            "duration_minutes":6
         },
         "process_where_clause":"(`commandName` = 'java')"
      },
      {
         "created_at_epoch_millis": 1501704525462,
         "critical_threshold": {
             "duration_minutes": 5
         },
         "enabled": true,
         "filter": {
            "and": [
                {
                     "like": {
                         "fullHostname": "Production_1"
                     }
                 }
             ]
         },
         "id": 448036,
         "name": "PROD - Host Machine's Agent Not Responding ....",
         "policy_id": 98485,
         "type": "infra_host_not_reporting",
         "updated_at_epoch_millis": 1504879191220
      }
     . . . 
   ],
   "meta":{
      "limit":50,
      "offset":0,
      "total":3
   },
   "links":{}
}

50개 제한을 초과하는 10개 인프라 조건 목록을 가져오려면 다음을 수행합니다.

bash

$curl -v -X GET --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions?policy_id=111111&offset=50&limit=10"

특정 인프라 조건을 GET

단일 인프라 조건에 대한 정보를 얻으려면 다음을 수행하십시오.

bash

$curl -v -X GET --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions/condition-id"

응답(가독성을 위해 형식 지정):

HTTP/1.1 200 OK
Content-Length: 246
Content-Type: application/json

{
   "data":{
      "type":"infra_host_not_reporting",
      "name":"demo condition",
      "enabled":false,
      "id":13887,
      "created_at_epoch_millis":1490981583580,
      "updated_at_epoch_millis":1490981583580,
      "policy_id":23635,
      "critical_threshold":{
         "duration_minutes":100
      }
   }
}

인프라 조건 생성(POST)

중요

새 조건(POST)을 추가할 때 "id": 을 포함하지 마십시오. 조건이 생성될 때 생성됩니다.

인프라 조건을 추가하려면 다음 기본 cURL 명령을 사용하십시오.

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json'  \
>     -d '{"data":{DATA object details}}'

추가할 인프라 조건 유형에 대한 세부정보를 DATA 객체( -d 섹션)에 포함합니다.

실행 조건 API 데이터 처리
측정항목 조건 API 데이터
호스트가 조건 API 데이터를 보고하지 않음

업데이트(PUT) 인프라 조건

인프라 조건을 업데이트할 때 변경해야 하는 필드만 포함하면 됩니다. API는 누락된 필드에 대한 기존 값을 유지합니다.

중요

type 조건을 변경하려면 PUT을 사용하지 마세요. 대신 기존 조건을 삭제한 다음 새 조건 type 및 all 필드를 사용하여 새 조건을 추가(POST)하세요.

인프라 조건을 업데이트하려면 이 기본 cURL 명령을 사용하십시오. 업데이트할 조건을 나타내려면 "id": 을 포함해야 합니다.

bash

$curl -X PUT 'https://infra-api.newrelic.com/v2/alerts/conditions/condition-id' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' \
>     -d '{"data":{DATA object details}}'

업데이트할 인프라 조건 유형에 대한 세부정보를 DATA 객체( -d 섹션)에 포함합니다.

실행 조건 API 데이터 처리
측정항목 조건 API 데이터
호스트가 조건 API 데이터를 보고하지 않음

인프라 조건 제거(DELETE)

인프라 조건을 삭제하려면 다음 기본 cURL 명령을 사용하십시오.

bash

$curl -v -X DELETE --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions/condition_id"

조건의 유형

프로세스 실행 조건은 프로세스 수가 정의한 레버 값보다 높거나 낮거나 같을 때 알려줍니다. 프로세스 실행 조건을 추가(POST) 또는 업데이트(PUT) 하려면 API 키를 사용하고 정의를 참조하여 API 호출에서 값을 맞춤설정하세요.

예를 들어:

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' -d \
>'{
$   "data":{
$      "type":"infra_process_running",
$      "name":"Java is running",
$      "enabled":true,
$      "where_clause":"(hostname LIKE '\''%cassandra%'\'')",
$      "policy_id":policy_id,
$      "comparison":"equal",
$      "critical_threshold":{
$         "value":0,
$         "duration_minutes":6
$      },
$      "process_where_clause":"(commandName = '\''java'\'')"
$   }
$}'

중요

where_clause 및 process_where_clause

메트릭 조건은 선택한 메트릭이 정의한 임계값보다 높거나 낮거나 같을 때 경고합니다. 여기에는 다음이 포함됩니다.

시스템 메트릭
프로세스 메트릭
네트워크 측정항목
스토리지 측정항목
클라우드 통합 측정항목
측정항목 조건을 추가(POST) 하거나 업데이트(PUT) 하려면 API 키 를 사용하고 정의 를 참조하여 API 호출에서 값을 사용자 지정합니다.
클라우드 통합 경고 조건을 추가하거나 업데이트하는 경우:
event_type 필드에 선택한 클라우드 통합 서비스에서 생성한 이벤트 유형을 입력합니다(예: AWS EC2 통합의 경우 ComputeSample ).
공급자 값이 필요한 클라우드 통합 서비스에 대한 경고 조건을 설정하는 경우(예: AWS RDS는 DatastoreSample 을 provider 값이 RdsDbInstance 또는 RdsDbCluster 인 경우) 다음을 추가해야 합니다. "integration_provider" 필드에 입력하고 경고 조건이 대상으로 하는 서비스에 적절한 값을 사용합니다(예: "integration_provider":"RdsDbInstance" ).

select_value 필드의 경우 다음 구문을 사용하여 측정항목 이름을 빌드합니다. 여기서 provider 은 표준 접두사 문자열입니다.

provider.metric.aggregation_type

metric: 통합을 위한 New Relic 문서에 설명된 대로 메트릭 이름을 사용하십시오.
aggregation_type: Sum , Average , Minimum 또는 Maximum 을 사용합니다. 각 메트릭에 사용할 수 있는 통계 집계를 확인하려면 통합 클라우드 공급자의 원본 문서를 참조하십시오.

예를 들어:

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' -d \
>'{
$   "data":{
$      "type":"infra_metric",
$      "name":"Disk Space Condition",
$      "enabled":true,
$      "where_clause":"(hostname LIKE '\''%cassandra%'\'')",
$      "policy_id":policy_id,
$      "event_type":"StorageSample",
$      "select_value":"diskFreePercent",
$      "comparison":"below",
$      "critical_threshold":{
$         "value":10,
$         "duration_minutes":1,
$         "time_function":"any"
$      },
$      "warning_threshold":{
$         "value":30,
$         "duration_minutes":2,
$         "time_function":"any"
$      }
$   }
$}'

중요

작은 따옴표를 이스케이프 처리하는 추가 작은 따옴표에 유의하십시오. where_clause

보고하지 않는 호스트 상태 는 호스트가 보고를 중지할 때 경고합니다. 보고하지 않는 호스트를 추가(POST) 또는 업데이트(PUT) 하려면 API 키 를 사용하고 정의 를 참조하여 API 호출에서 값을 사용자 정의하십시오.

no_trigger_on 필드는 선택사항입니다. ["shutdown"] 로 설정하면 Don't trigger alerts for hosts that perform a clean shutdown 인프라 조건 옵션이 활성화됩니다.

예를 들어:

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' -d \
>'{
$   "data":{
$      "type":"infra_host_not_reporting",
$      "name":"Cassandra Host Reporting Condition",
$      "enabled":true,
$      "where_clause":"(hostname LIKE '\''%cassandra%'\'')",
$      "policy_id":policy_id,
$      "critical_threshold":{
$         "duration_minutes":12,
$         "no_trigger_on": ["shutdown"]
$      }
$   }
$}'

중요

작은 따옴표를 이스케이프 처리하는 추가 작은 따옴표에 유의하십시오. where_clause

정의

cURL 명령을 형식화할 때 필요에 따라 이 값을 사용하십시오. API 호출에 나타나는 순서가 아니라 알파벳 순서로 나열됩니다.

Field	Definition
`comparison` ( 열거 )	Condition type: `infra_metric`, `infra_process_running` 임계값을 정의하는 데 사용되는 값입니다. 예: `"["above", "below", "equal"]` .
`critical_threshold` 그리고 `warning_threshold`	Condition type: 모든 이 개체는 인시던트를 열기 전에 임계값을 식별합니다. `critical_threshold` 은(는) 필수 항목입니다. `warning_threshold` 은 선택사항이며 `infra_metric` 조건에서만 사용할 수 있습니다. 이 개체의 키는 조건 유형에 따라 다릅니다. Condition type: `infra_metric` 체재: `"critical_threshold":{ "value":<number>, "duration_minutes":<integer>, "time_function":"any" or "all" },` Condition type: `infra_process_running` 체재: `"critical_threshold":{ "value":<integer>, "duration_minutes":<integer>, },` Condition type: `infra_host_not_reporting` 체재: `"critical_threshold":{ "duration_minutes":<integer>, },`
`enabled` ( 부울 )	Condition type: 모든 조건이 켜져 있는지 여부 `true` 또는 `false` .
`event_type` ( 문자열 )	Condition type: `infra_metric` 메트릭 이벤트 예를 들어 시스템 메트릭, 프로세스 메트릭, 스토리지 메트릭 또는 네트워크 메트릭이 있습니다. 이는 인프라 통합을 위해 자동으로 채워집니다. 예: `StorageSample` 또는 `SystemSample` .
`filter` ( 문자열 )	Condition type: 모든 UI에서 조건이 만들어진 경우 `where_clause` 대신 `filter` 이 나타납니다. 예를 들어: `{and: [{is: {ec2InstanceType: "m3.medium"}}]}` 권장사항: 새 조건을 생성할 때 `where_clause` 사용하세요.
`id` ( 정수 )	Condition type: 모든 URL에 있는 조건 ID입니다. GET: 이 값은 GET 응답에 나타납니다. PUT: 이 값을 `DATA` 섹션에 포함합니다. POST: `DATA` 섹션에 이것을 포함하지 마십시오. 삭제: `-X DELETE` 호출에 이 값을 포함합니다.
`integration_provider` ( 문자열 )	Condition type: `infra_metric` 통합에 대한 알림의 경우 `event_type` 대신 `integration_provider` 사용하세요. 유효한 값을 보려면 클라우드 서비스에 대한 뉴베리 문서에서 Find and use data 섹션을 확인하세요. 예: AWS RDS 모니터링 통합 문서에서 `DatastoreSample` 이벤트 유형이 DB 인스턴스의 경우 `RdsDbInstance` 또는 Aurora DB 클러스터의 경우 `RdsDbCluster` 의 `integration_provider` 값과 함께 사용될 수 있음을 확인할 수 있습니다.
`name` ( 문자열 )	Condition type: 모든 인프라 경고 조건의 이름입니다. 예를 들어: `"[test] process running"`
`policy_id` ( 정수 )	Condition type: 모든 조건과 연결된 경고 정책의 계정 ID에 대한 고유 ID입니다. 예: `1234567890` . 이것은 정책의 전역 ID가 아닙니다.
`process_where_clause` ( 문자열 )	Condition type: `infra_process_running` 특히 프로세스 실행 경고 조건에서 프로세스에 적용된 모든 필터. 이 매개변수는 이러한 유형의 경보 조건에 필수입니다. 예를 들어: `"commandName = '\''java'\''"`
`runbook_url` ( 문자열 )	Condition type: `all` 알림에 표시할 Runbook URL입니다.
`select_value` ( 문자열 )	Condition type: `infra_metric` 대상이 되는 지표를 식별하는 속성 이름입니다. 예: `"cpuPercent"`, `"diskFreePercent"`, `"memoryResidentSizeBytes", or "memoryFreeBytes/memoryTotalBytes*100"`. 이는 인프라 통합을 위해 자동으로 채워집니다. 예: `diskFreePercent`.
`type` ( 열거 )	Condition type: 모든 인프라 경고 조건 유형: `"infra_process_running"` , `"infra_metric"` 또는 `"infra_host_not_reporting"` .
`violation_close_timer` ( 정수 )	Condition type: 모든 공지 이벤트 시간 제한 설정으로, 시간으로 표시됩니다. 가능한 값은 `0`, `1`, `2`, `4`, `8`,`12`, `24`, `48`, `72` 입니다. 이는 인시던트가 자동으로 닫히기까지 얼마나 시간이 경과할지를 결정합니다. 새 조건의 경우 값이 제공되지 않으면 다음 기본값이 사용됩니다. 모든 조건: `24 hours` 기존 조건을 업데이트할 때 값이 제공되면 기존 값을 재정의하지만 이미 열린 인시던트에는 영향을 미치지 않습니다.
`where_clause` ( 문자열 )	Condition type: 모든 해당하는 경우 사용된 모든 인프라 호스트 필터 를 식별합니다. 예를 들어: "(`hostname` LIKE '\''%cassandra%'\'')",

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

인프라 경고에 대한 REST API 호출

요구 사항

팁

인프라 API 호출 사용

GET 인프라 조건

팁

인프라 조건 목록을 GET

예 GET 조건 목록

특정 인프라 조건을 GET

예 GET 특정 조건

인프라 조건 생성(POST)

중요

업데이트(PUT) 인프라 조건

중요

예제 업데이트(PUT) 조건

인프라 조건 제거(DELETE)

조건의 유형

실행 조건 API 데이터 처리

조건 유형의 예

중요

측정항목 조건 API 데이터

예시

중요

호스트가 상태를 보고하지 않음

예시

중요

정의

`값`

`지속 시간_분`

`시간 함수`

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

인프라 경고에 대한 REST API 호출

요구 사항.css-21sua1{background:none;border:none;width:0;padding:0;}

팁

인프라 API 호출 사용

GET 인프라 조건

팁

인프라 조건 목록을 GET

예 GET 조건 목록

특정 인프라 조건을 GET

예 GET 특정 조건

인프라 조건 생성(POST)

중요

업데이트(PUT) 인프라 조건

중요

예제 업데이트(PUT) 조건

인프라 조건 제거(DELETE)

조건의 유형

측정항목 조건 API 데이터

호스트가 상태를 보고하지 않음

정의

값

지속 시간_분

시간 함수

요구 사항

`값`

`지속 시간_분`

`시간 함수`