<ph type="x-smartling-placeholder"></ph>
현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보
트래픽 알림을 사용하여 환경, 프록시 또는 리전의 트래픽이 지정된 비율만큼 변경되면 알림 전송 확인할 수 있습니다
기간을 다음과 같이 설정합니다.
- 1시간
- 1일
- 7일
- 15일 (API 전용)
- 30일 (API 전용)
알림은 현재 기간의 트래픽과 이전 기간의 트래픽을 비교하는 방식으로 작동합니다. 예를 들어 시간 범위를 1시간으로 지정합니다. 그런 다음 알림이 가장 최근 1시간 동안의 트래픽을 비교합니다. 이전 1시간의 트래픽과 비교하여 트래픽의 변동률을 계산합니다.
percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100
양수 값은 트래픽이 증가했음을 의미하고 음수 값은 트래픽이 감소했음을 의미합니다.
그런 다음 트래픽 알림을 트리거하는 임계값을 API 트래픽의 증가 또는 감소 비율로 설정합니다. 지정된 기간 동안 표시됩니다.
해당 비율을 설정하기 전에 표준 값과 일치하는지 확인하세요. 살펴봤습니다 예를 들어 API 트래픽이 보통 하루 동안 변동하며 시간별 트래픽이 최대 100%까지 증가하는 경우 특정 사용량이 많은 시기에는 이러한 급증이 정상이므로 알림을 트리거하지 않습니다. 그러나 그런 다음 시간당 트래픽이 50% 증가하면 알림이 전송되도록 구성하세요. 정상적인 트래픽에 대한 불필요한 알림이 전송됩니다.
알림에 대한 자세한 내용은 알림 및 알림 설정을 참조하세요.
교통정보 경고 및 알림 추가
교통정보 알림을 추가하는 방법은 다음과 같습니다. <ph type="x-smartling-placeholder">- </ph>
- Edge UI에서 분석 > 경고 규칙을 클릭합니다.
- +경고를 클릭합니다.
- 경고에 대해 다음 일반 정보를 입력합니다.
필드 설명 경고 이름 경고의 이름입니다. 트리거를 올바르게 설명하고 유용한 이름을 사용합니다. 이름은 128자(영문 기준)를 초과할 수 없습니다. 설명 경고에 대한 설명입니다. 경고 유형 총 트래픽을 선택합니다. 자세한 내용은 자세한 내용은 알림 유형 정보를 참고하세요. 환경 드롭다운 목록에서 환경을 선택합니다. 상태 경고 사용 설정 또는 사용 중지를 전환합니다. - 알림을 트리거할 조건의 기준 및 측정기준을 정의합니다.
조건 필드 설명 기준 트래픽이 증가하거나 알림이 오면 알림을 보내도록 지정합니다. 이전 시간 간격과 비교할 때 특정 백분율로 감소합니다.
증가 비율을 0% 이상의 값으로 설정합니다. 감소 비율을 0% 이상의 값으로 설정합니다. 100% 이하여야 합니다
다음과 같은 시간 간격을 선택할 수 있습니다.
- 1시간
- 1일
- 1주
측정기준 + 측정기준 추가를 클릭하고 다음과 같은 결과를 반환할 측정기준 세부정보를 지정합니다. 지정할 수 있습니다
특정 측정기준을 다음과 같이 설정합니다.
- 프록시 - 특정 프록시 또는 모든 프록시로 설정합니다. 프록시는 "Any" 값을 지원하지 않습니다. 대신 관심 있는 프록시마다 별도의 알림을 추가할 수 있습니다.
- 리전 - 특정 리전 또는 모든 리전으로 설정합니다. 리전은 "Any" 값을 지원하지 않습니다. 대신 관심 있는 지역마다 별도의 알림을 추가할 수 있습니다.
- 경고 알림을 추가하려면 +알림을 클릭합니다.
알림 세부정보 설명 채널 사용하려는 알림 채널을 선택하고 이메일, Slack, PagerDuty, 웹훅과 같은 대상을 지정합니다. 대상 선택한 채널 유형에 따라 대상 유형을 지정합니다. <ph type="x-smartling-placeholder"> - </ph>
- 이메일 - 이메일 주소(예:
joe@company.com) - Slack - Slack 채널 URL(예:
https://hooks.slack.com/services/T00000000/B00000000/XXXXX) - PagerDuty - PagerDuty 코드(예:
abcd1234efgh56789) - 웹훅 - 웹훅 URL(예:
https://apigee.com/test-webhook)참고: 알림당 대상을 하나만 지정할 수 있습니다. 동일한 채널 유형에 여러 대상을 지정하려면 알림을 더 추가하세요.
- 이메일 - 이메일 주소(예:
- 알림을 추가하려면 이전 단계를 반복합니다.
- 알림을 추가한 경우 다음 필드를 설정합니다.
필드 설명 플레이북 (선택사항) 권장 조치에 대한 간단한 설명을 제공하는 자유 형식 텍스트 입력란 해결할 수 있습니다. 또한 내부 위키 또는 권장사항을 참조할 수 있는 커뮤니티 페이지입니다. 이 필드의 정보는 포함되어 있습니다 이 필드의 내용은 1,500자를 초과할 수 없습니다. 제한 알림을 전송할 빈도입니다. 드롭다운 목록에서 값을 선택합니다. - 저장을 클릭합니다.
이벤트 대시보드에서 알림 보기
Edge는 알림 조건을 감지하면 해당 조건을 이벤트 대시보드 이벤트 대시보드에 표시되는 이벤트 목록 모든 알림(수정된 알림 및 인증서)이 포함됩니다.
알림을 보려면 다음 단계를 따르세요.
분석 > 이벤트를 참조하세요. 새 이벤트 대시보드가 표시됩니다.
이벤트 대시보드 필터링 기준:
- 환경
- 지역
- 기간
- 이벤트 대시보드에서 행을 선택하여 만료 인증서가 포함된 키 저장소를 표시합니다. 경보를 더 자세히 조사합니다 키 저장소 페이지에서 새 인증서를 업로드하고 인증서가 만료됩니다.
교통정보 알림과 함께 알림 API 사용
교통정보 알림을 만들고 관리하는 데 사용하는 대부분의 API가 사용하는 API와 동일함 사용할 수 있습니다.
- 알림 가져오기: 수정되었거나 이상치 알림을 정의합니다.
- 알림 기록 가져오기: 알림 기록 측정항목을 가져옵니다.
- 알림 삭제 - 수정되었거나 이상치 알림 정의를 삭제합니다.
- 알림 인스턴스 가져오기: 트리거된 알림에 관한 정보를 가져옵니다.
- 알림 수 가져오기: 총 알림 수를 가져옵니다.
하지만 일부 API에는 이상 알림을 지원하는 데 사용되는 다음과 같은 추가 속성이 있습니다.
- 알림 받기 - 수정된 알림과 이상치 알림을 포함한 모든 알림을 표시합니다.
- 알림 만들기 - 수정되었거나 이상치 알림을 만듭니다.
- 알림 업데이트: 수정되었거나 이상치 알림 정의를 업데이트합니다.
교통정보 알림 만들기 또는 업데이트
동일한 API를 사용하여 만들기 또는 업데이트 트래픽 알림을 사용할 수 있습니다. 트래픽 알림을 만들거나 업데이트하는 API 호출의 본문은 다음과 같은 변경사항이 적용됩니다.
다음 새 속성을 추가하여 알림이 교통정보 알림임을 지정합니다.
"alertType": "runtime" "alertSubType": "trafficfixed"
이러한 속성의 기본값은 다음과 같습니다.
"alertType": "runtime" "alertSubType": "fixed"
conditions배열의dimensions요소에서 다음을 실행합니다. <ph type="x-smartling-placeholder">- </ph>
org,env,proxy, 및region속성. 이러한 속성만 지원됩니다.proxy및region를ALL로 설정할 수 있습니다.traffic속성의 값을total로 설정해야 합니다.
conditions배열에서 다음 사항을 유의하세요.metrics속성은 값이trafficChange이어야 합니다.comparator속성은increasedBy또는decreasedBy로 설정해야 합니다.threshold속성에 트래픽 증가 또는 감소 비율을 지정하는 양수 값이 있습니다. 여기서1.0값은 100%에 해당합니다.increasedBy의 경우 0.0 (0%) 이상이어야 합니다.decreasedBy의 값은 0.0 이상 (0%) 이상 1.0 (100%) 이하여야 합니다.durationSeconds속성은 다음 값 중 하나로 설정해야 합니다.3600(1시간),86400(1일),604800(7일),1296000(15일),2592000(30일)
reportEnabled속성은 교통정보 알림에 지원되지 않습니다.
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
-X POST \
-H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
"organization":"myorg",
"name":"My Traffic Alert",
"description":"My traffic alert",
"environment":"prod",
"enabled":true,
"alertType":"runtime",
"alertSubType":"trafficfixed",
"conditions":[
{
"description":"",
"dimensions": {
"org":"nyorg",
"env":"prod",
"proxy":"ALL",
"region":"ALL",
"traffic":"total"
},
"metric": "trafficChange",
"threshold": 0.5,
"durationSeconds": 3600,
"comparator": "increasedBy"
}
],
"notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
"playbook":"http://acme.com/myplaybook.html",
"throttleIntervalSeconds":3600,
"reportEnabled":true
}'
OAuth 2.0 액세스 토큰 가져오기에 설명된 대로 $ACCESS_TOKEN을 OAuth 2.0 액세스 토큰으로 설정합니다.
이 예에서 사용된 cURL 옵션에 관한 자세한 내용은 cURL 사용을 참고하세요.
이 API 사용에 관한 자세한 내용은 이벤트 보기를 참고하세요.
교통정보 알림 받기
기본적으로 Get Alerts API는 정의된 모든 알림에 대한 정보를 반환합니다. 이제 이 API에서 쿼리 매개변수를 사용하여 결과를 필터링할 수 있습니다.
enabled-true가 사용 설정된 알림만 반환하도록 지정하는 경우입니다. 기본값은false입니다.alertType- 반환할 알림 유형을 지정합니다. 허용되는 값은runtime(기본값),cert입니다.alertSubType- 반환할 알림 하위유형을 지정합니다. 기본값은 설정되지 않습니다. 즉, 모든 알림 하위유형이 반환됩니다.
예를 들어 myorg라는 조직에 알림 사용 설정만 반환하려면 다음 API 호출을 사용합니다.
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'
다음 호출은 사용 설정 및 사용 중지 모두의 교통정보 알림만 반환합니다.
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'
OAuth 2.0 액세스 토큰 가져오기에 설명된 대로 $ACCESS_TOKEN을 OAuth 2.0 액세스 토큰으로 설정합니다. 이 예에서 사용된 cURL 옵션에 관한 자세한 내용은 cURL 사용을 참고하세요.