IM 시스템과 경고 알림 통합하기

Qi Guo

Qi Guo

April 24, 2024

Products

소개

오늘날 디지털화된 비즈니스 환경에서 모니터링과 알림은 중요한 역할을 하고 있습니다. 이는 기업이 시스템 이상을 적시에 감지할 수 있도록 도울 뿐만 아니라, 장애로 인한 비즈니스 손실을 효과적으로 줄이는 데도 기여합니다. API7 Enterprise는 다양한 알림 규칙을 제공하여 사용자가 유연한 알림 전략을 설정할 수 있도록 합니다. Webhook 템플릿을 통한 알림 방법을 통해, 알림 정보를 우리가 자주 사용하는 인스턴트 메시징(IM) 시스템으로 전송할 수 있습니다. 이를 통해 시스템의 운영 상태를 신속하고 효과적으로 모니터링하고, 적시에 대응하여 비즈니스의 연속성과 안정성을 보장할 수 있습니다.

이제 API7 Enterprise를 사용하여 알림 규칙을 구성하고, Webhook를 통해 기존 IM 시스템으로 알림 정보를 전송하는 방법을 자세히 살펴보겠습니다. 이를 통해 이 시나리오의 구성 과정을 쉽게 익힐 수 있을 것입니다.

알림 규칙 및 알림

1. 알림 전략

API7 Enterprise는 현재 여러 알림 전략을 지원하며, 사용자는 비즈니스 요구에 따라 유연하게 구성할 수 있습니다. 일반적인 알림 전략에는 다음이 포함됩니다:

  • 인증서가 만료되기 직전에 알림을 트리거합니다.
  • 게이트웨이 인스턴스가 오프라인 상태일 때 알림을 트리거합니다.
  • 상태 코드 4xx 및 5xx의 수량을 기반으로 알림을 트리거합니다.
  • 상태 코드 4xx 및 5xx의 비율을 기반으로 알림을 트리거합니다.

실제 응용에서는 여러 전략을 결합하여 다양한 알림 요구를 충족시킬 수 있으며, 이를 통해 자동으로 알림이 트리거되고 관련 인원에게 통보되어 장애 해결의 응답 속도와 효율성을 높일 수 있습니다.

2. 알림 수준의 정의 및 관리

알림 수준은 다양한 알림 상황을 분류하고 식별하여 사용자가 알림의 중요성을 명확히 인식할 수 있도록 합니다. 일반적인 알림 수준에는 높음, 중간, 낮음이 포함됩니다. 관리자는 다른 알림 수준을 설정하여 중요한 알림이 적시에 주목받고 처리되도록 합니다. API7 Enterprise는 사용자가 다양한 시나리오에서의 모니터링 요구를 충족시키기 위해 알림 수준을 쉽게 구성하고 관리할 수 있도록 지원합니다.

3. 알림 알림의 메커니즘

API7 Enterprise에서 Webhook 템플릿을 생성할 수 있습니다. 시스템이 이상을 감지하고 알림을 트리거할 때, API7 Enterprise는 미리 구성된 Webhook 주소를 자동으로 호출합니다. 이는 HTTP POST 요청의 형태로 알림 정보를 지정된 목적지 주소로 전송합니다. Webhook는 애플리케이션 간 통신에 일반적으로 사용되는 기술로, 사용자가 특정 이벤트가 발생할 때 지정된 URL로 데이터를 자동으로 전송할 수 있도록 합니다.

Slack, Microsoft Teams, Lark, DingTalk, WeCom과 같은 인기 있는 IM 시스템은 메시지를 보내고 받기 위한 Webhook 봇을 제공합니다. 아래에서는 Lark를 예로 들어 API7 Enterprise와 알림 알림을 통합하는 방법을 자세히 설명합니다.

IM 시스템 Webhook 봇과의 통합

IM 시스템의 Webhook 봇은 메시지를 자동으로 보내거나 이벤트를 알리거나 특정 작업을 수행하는 데 사용되는 특수 계정입니다. API7 Enterprise의 Webhook 템플릿 알림을 구성하여 IM 시스템의 Webhook 봇 주소와 통합함으로써, 알림 정보의 자동 푸시를 달성할 수 있으며, 이는 알림 알림의 실시간성과 정확성을 크게 향상시킵니다.

Lark의 Webhook 봇 구성

  1. 먼저, Lark에서 Webhook 봇을 생성하고 구성해야 합니다. 해당 그룹에서 그룹 봇 추가 옵션을 찾습니다. 그런 다음 Custom Bot 옵션을 볼 수 있습니다.

Lark에서 커스텀 봇 추가

  1. 봇에 아바타와 관련 설명을 추가한 후, 다음을 클릭하면 Webhook 주소를 볼 수 있습니다. 이 주소는 알림 정보를 받는 데 사용됩니다.

Webhook 주소 복사

  1. 필요에 따라 키워드, IP 화이트리스트 등과 같은 보안 정책 규칙을 봇에 설정할 수 있습니다.

API7 Enterprise에서 알림 규칙 구성

  1. API7 Enterprise에서 알림 전략을 추가하고 트리거 조건을 지정합니다.

커스텀 트리거 조건 추가

  1. Webhook 알림 템플릿을 구성합니다:
{ "msg_type": "text", "content": { "text": "API7 EE Alarm: 4xx error" } }

Webhook 템플릿 업데이트

  1. 향후 테스트를 쉽게 하기 위해, 알림 확인 간격을 1분으로 변경합니다.

확인 간격 조정

  1. 알림 전략 및 해당 Webhook 알림을 활성화합니다.

알림 정책 및 알림 활성화

  1. 401 상태 코드로 요청을 보내 알림을 트리거합니다:
curl -i http://127.0.0.1:9080/get

HTTP/1.1 401 Unauthorized
...
{"message":"Missing API key found in request"}
  1. 다음으로, Lark 그룹에서 Webhook 봇이 보낸 해당 알림 메시지를 볼 수 있어야 합니다.

고급 사용법

API7 Enterprise는 Webhook를 통해 알림 컨텍스트 변수를 전달하는 것을 지원합니다. 일반적인 변수에는 다음이 포함됩니다:

  • 제목: {{ .Title }} 알림 제목
  • 심각도: {{ .Severity }} 알림 심각도
  • 상세 정보: {{ .Detail }} 알림 설명
  • AlertEvents: {{ .AlertEvents.XXX }} 다른 정책 설정에 따른 해당 알림 이벤트.

결론

API7 Enterprise는 많은 강력한 기능을 제공하여 기업의 모니터링 및 API 관리에 편의와 지원을 제공합니다. IM 시스템과 통합된 Webhook 알림 메커니즘을 사용하여, 알림 정보를 신속하고 정확하게 관련 인원에게 전달할 수 있으며, 이는 장애 대응의 속도와 품질을 향상시킵니다. 이는 기업에 더 효율적이고 신뢰할 수 있는 모니터링 및 관리 경험을 제공합니다.

Tags:
Monitoring
API Security