Ops Manager 에서 Webhooks와 통합

필요한 액세스 권한

Ops Manager 웹훅과 통합하려면 프로젝트 에 대한 Project Monitoring Admin 액세스 있어야 합니다.

웹훅 통합 구성

웹훅에 경고를 보내려면 경고 알림 구성합니다.자세한 학습 은 Ops Manager 에서 경고 설정 구성하기를 참조하세요.

요청 헤더

Ops Manager 각 웹훅 요청 에 다음과 같은 HTTP headers 포함되어 있습니다.

Ops Manager는 다양한 경고 상태를 구분하기 위해 X-MMS-Event 이라는 요청 헤더를 추가합니다. 이 헤더에 사용할 수 있는 값은 다음과 같습니다.

Webhook Secret 필드 에 키를 지정하면 MongoDB Ops Manager X-MMS-Signature 요청 헤더를 추가합니다. 이 헤더에는 요청 본문의 기본64인코딩된 HMAC-SHA-1 서명이 포함되어 있습니다. MongoDB Ops Manager 제공된 시크릿을 사용하여 서명을 생성합니다.

요청 본문

요청 본문에는 Ops Manager API 경고 리소스 와 동일한 형식을 사용하는 JSON 문서 포함되어 있습니다. 페이로드에는 다음과 같은 키 필드가 포함됩니다.

• id: 경고의 고유 식별자입니다.

• eventTypeName경고를 트리거하는 이벤트 유형입니다.

• created경고가 생성된 시간입니다.

• status: Current status of the alert (for example, OPEN, CLOSED).

• humanReadable: 사람이 읽을 수 있는 경고 에 대한 설명입니다.

For a complete list of fields, refer to the Get One Alert endpoint documentation.

{
  "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 Secret 필드 Ops Manager 요청 확인을 위해 X-MMS-Signature 헤더를 생성하는 데만 사용하는 시크릿을 저장합니다. Ops Manager 시크릿을 인증 헤더 또는 베어러 토큰으로 직접 전송하지 않습니다.

웹훅 엔드포인트에 인증이 필요한 경우 다음 방법 중 하나를 사용하여 독립적으로 처리해야 합니다.

• 쿼리 매개변수: Webhook URL 에 인증 자격 증명을 쿼리 매개변수로 포함합니다. 예: https://example.com/webhook?token=your-auth-token

• IP 액세스 목록: Ops Manager 인스턴스의 IP 주소로부터의 요청만 수락하도록 웹훅 엔드포인트를 구성합니다.

• Reverse Proxy or API Gateway: Use a reverse proxy or API gateway that handles authentication before forwarding requests to your webhook endpoint.

제한 사항

webhook 통합을 사용할 때 다음 제한 사항을 고려합니다.

방화벽 구성

Ops Manager 자체 호스팅되므로 네트워크가 Ops Manager 서버 에서 웹훅 엔드포인트로의 아웃바운드 HTTP 요청을 허용하는지 확인하세요. 웹훅 엔드포인트가 방화벽 뒤에 있는 경우 Ops Manager 서버의 IP 주소 엔드포인트의 IP 액세스 목록 에 추가하세요.

웹훅 전달 문제 해결

웹훅이 경고를 수신하지 않은 경우: