MongoDB Ops Manager를 구성하여 경고 알림을 웹후크 엔드포인트로 HTTP 게시 요청으로 보내 프로그래밍 방식으로 처리할 수 있습니다. Webhook을 사용하면 MongoDB Ops Manager 경고를 사용자 지정 모니터링 시스템, 인시던트 관리 플랫폼 또는 자동화 워크플로우와 연동할 수 있습니다.
필요한 액세스 권한
Ops Manager를 웹후크와 통합하려면 프로젝트에 대한 Project Monitoring Admin 액세스 권한이 있어야 합니다.
웹훅 요청 인증
다음 방법을 사용하여 웹훅 요청을 인증할 수 있습니다.
Webhook 시크릿: Ops Manager 이 시크릿을 사용하여
X-MMS-Signature헤더를 생성합니다. Ops Manager 시크릿 자체를 인증 헤더 또는 베어러 토큰으로 전송하지 않습니다. 서명을 확인하는 방법을 학습 웹훅 요청 확인을 참조하세요.OAuth 2.0 클라이언트 자격 증명: Ops Manager OAuth 2.0 토큰 엔드포인트에서 베어러 액세스 토큰을 가져와
Authorization헤더로 전송합니다. 이 메서드를 구성하려면 웹훅 통합 구성을 참조하세요.
한 가지 방법을 사용하거나 둘 다 사용하거나 전혀 사용하지 않을 수 있습니다. 둘 다 구성하는 경우, Ops Manager 동일한 요청 에 Authorization 및 X-MMS-Signature 헤더를 포함합니다.
Ops Manager OAuth 2.0 액세스 토큰을 캐시하고 토큰이 만료되면 새로 고칩니다. 웹훅 엔드포인트가 401 응답을 반환하면 Ops Manager 토큰을 새로 고치고 요청 한 번 재시도합니다.
사용자 지정 헤더 템플릿 동작
사용자 지정 헤더 템플릿을 구성하면 요청 의 기본값 헤더를 대체합니다. Ops Manager X-MMS-Signature 또는 Authorization 헤더를 추가하지 않습니다. 두 헤더 중 하나를 포함하려면 템플릿에 추가합니다.
"X-MMS-Signature": "${signature}""Authorization": "Bearer ${oauthToken}"
웹훅 템플릿에 대해 자세히 학습 웹훅 템플릿 구성을 참조하세요.
기타 인증 방법
웹훅 시크릿과 OAuth 2.0 클라이언트 자격 증명 요구 사항을 충족하지 않는 경우 다음 방법 중 하나로 인증 처리하다 할 수 있습니다.
쿼리 매개변수: Webhook URL 에 인증 자격 증명을 쿼리 매개변수로 포함합니다. 예:
https://example.com/webhook?token=your-auth-tokenIP 액세스 목록: 웹훅 엔드포인트가 MongoDB Ops Manager 인스턴스의 IP 주소에서 오는 요청만 수락하도록 구성합니다.
리버스 프록시 또는 API 게이트웨이: Webhook 엔드포인트로 요청을 전송하기 전에 인증을 처리하는 리버스 프록시 또는 API 게이트웨이를 사용합니다.
웹훅 요청 확인
webhook 요청이 MongoDB Ops Manager에서 시작되었는지 확인하려면 X-MMS-Signature 헤더의 유효성을 검사하세요.
웹훅 시크릿을 사용하여 요청 본문의 기본64 인코딩된 HMAC -SHA-1 서명을 계산합니다.
웹훅 통합 구성
인증 구성합니다.
다음 인증 옵션 중 하나 이상을 입력합니다.
Webhook Secret: 비밀 키를 입력합니다. Ops Manager 이 시크릿을 사용하여 요청 확인을 위한
X-MMS-Signature헤더를 생성합니다.OAuth2 Token URL, OAuth2 Client ID 및 OAuth2 Client Secret: 액세스 토큰을 얻기 위해 Ops Manager 호출하는 토큰 엔드포인트와 OAuth 2.0 제공자 에 등록한 애플리케이션 의 자격 증명 을 입력합니다. 세 값을 모두 함께 설정하거나 세 값을 모두 비워 두세요.
두 옵션을 함께 사용할 수 있습니다.자세한 학습 은 웹훅 요청 인증을 참조하세요.
웹훅으로 경고를 보내려면 경고 알림을 구성하세요. 자세한 내용은 MongoDB Ops Manager에서 경고 설정 구성을 참조하세요.
요청 헤더
MongoDB Ops Manager는 각 웹훅 요청에 다음 HTTP 헤더를 포함합니다:
Ops Manager는 다양한 경고 상태를 구분하기 위해 X-MMS-Event 이라는 요청 헤더를 추가합니다. 이 헤더에 사용할 수 있는 값은 다음과 같습니다.
| 경고가 방금 열렸습니다. |
| 경고가 해결되었습니다. |
| 이전에 열린 경고는 여전히 열려 있습니다. |
| 경고가 승인되었습니다. |
| 경고가 유효하지 않게 되어 취소되었습니다. |
| '프라이머리 선출'과 같은 특정 시점 이벤트인 정보 경고를 나타냅니다. |
Webhook Secret 필드에 키를 지정하면 MongoDB Ops Manager가 X-MMS-Signature 요청 헤더를 추가합니다. 이 헤더에는64 1 요청 본문의 Base 인코딩 HMAC -SHA- 서명이 포함되어 있습니다. MongoDB Ops Manager는 제공된 시크릿을 사용하여 서명을 생성합니다.
OAuth 2.0 클라이언트 자격 증명 구성하면 MongoDB Ops Manager Authorization 요청 헤더를 추가합니다. 이 헤더에는 MongoDB Ops Manager OAuth 2.0 토큰 엔드포인트에서 얻은 베어러 액세스 토큰이 포함되어 있습니다.
요청 본문
요청 본문에는 MongoDB Ops Manager API 경고 리소스 와 동일한 형식을 사용하는 JSON 문서가 포함되어 있습니다. 페이로드에는 다음과 같은 주요 필드를 포함합니다:
id: 경고의 고유 식별자입니다.eventTypeName경고를 트리거하는 이벤트 유형입니다.created경고가 생성된 시간입니다.status: 경고의 현재 상태(예시:OPEN,CLOSED).humanReadable: 경고에 대한 사람이 읽을 수 있는 설명입니다.
필드 전체 목록은 Get One 경고 엔드포인트 문서를 참조하세요.
예시 웹훅 페이로드
다음 예시는 지표 임계값 경고에 대한 샘플 웹후크 페이로드를 보여줍니다.
{ "id": "5d1b6f8e8c2e4e2d3c4a5b6c", "groupId": "5d1b6f8e8c2e4e2d3c4a5b6d", "eventTypeName": "OUTSIDE_METRIC_THRESHOLD", "status": "OPEN", "created": "2024-01-15T10:30:00Z", "updated": "2024-01-15T10:30:00Z", "lastNotified": "2024-01-15T10:30:00Z", "humanReadable": "Disk space used on data partition is 95.2%.", "metricName": "DISK_PARTITION_SPACE_USED_DATA", "currentValue": { "number": 95.2, "units": "RAW" }}웹훅 템플릿 사용자 지정
FreeMarker 템플릿을 사용하여 요청 헤더와 본문 콘텐츠를 사용자 지정할 수 있습니다. 사용 가능한 템플릿 변수, 정규식 헬퍼, 예시 등 웹훅 템플릿에 대한 자세한 내용은 웹훅 템플릿 구성을 참조하세요.
제한 사항
webhook 통합을 사용할 때 다음 제한 사항을 고려합니다.
경고 심각도 미포함
웹훅 페이로드에는 Ops Manager에서 구성한 경고 심각도 수준이 포함되어 있지 않습니다. 구성된 심각도를 조회하려면 웹후크 페이로드의 alertConfigId를 사용하여 경고 구성 하나 가져오기 엔드포인트에 추가 호출을 수행하세요.
수동 테스트 경고 없음
Ops Manager 테스트 경고를 수동으로 트리거하다 하는 방법을 제공하지 않습니다. 웹훅 엔드포인트를 테스트하려면 다음과 같이 트리거하다 할 수 있는 조건으로 경고 일시적으로 설정하다 수 있습니다.
테스트 배포서버의 낮은 디스크 공간 임계값입니다.
여러 연결을 열어 trigger할 수 있는 연결 카운트 임계값입니다.
테스트 복제본 세트의 복제 지연 임계값.
웹훅이 경고를 정상적으로 수신하는 것을 확인한 후 테스트 경고 구성을 삭제할 수 있습니다.
방화벽 구성
MongoDB Ops Manager가 자체 호스팅되므로, MongoDB Ops Manager 서버에서 웹후크 엔드포인트로 보내는 아웃바운드 HTTP 요청을 네트워크에서 허용하는지 확인하십시오. 웨흑 엔드포인트가 방화벽 뒤에 있는 경우, MongoDB Ops Manager 서버의 IP 주소를 엔드포인트의 IP 액세스 목록에 추가합니다.
웹훅 전달 문제 해결
웹훅이 경고를 수신하지 않은 경우: