Google Cloud Monitoring 어노테이션

Google Cloud Monitoring 어노테이션

어노테이션은 그래프 위에 풍부한 이벤트 정보를 겹쳐 보여주는 기능이에요. 어노테이션을 활용하면 대시보드에 중요한 이벤트, 배포, 장애를 표시할 수 있어요. Google Cloud Monitoring 데이터 소스로 특정 지표 이벤트가 발생한 시점을 그래프에 표시해 보세요.

출처: Google Cloud Monitoring annotations

본문

시작하기 전에

어노테이션을 구성하기 전에 다음이 준비되어 있어야 해요.

  • 구성된 Google Cloud Monitoring 데이터 소스
  • 어노테이션을 추가할 대시보드

어노테이션 제한 사항

어노테이션을 사용할 때는 다음 제한 사항을 염두에 두세요.

  • 성능: 어노테이션 렌더링은 비용이 큰 작업이에요. 대시보드 성능을 유지하려면 반환되는 행 수를 제한하세요.
  • 네이티브 이벤트: Google Cloud Monitoring의 네이티브 어노테이션과 이벤트는 표시를 지원하지 않아요. 다만 Google Cloud Monitoring의 커스텀 메트릭과는 잘 동작해요.

어노테이션 쿼리 추가하기

대시보드에 어노테이션 쿼리를 추가하려면:

  1. 업데이트할 대시보드로 이동해 Edit을 클릭해요.
  2. Add new element 아이콘(파란색 더하기)을 클릭해요.
  3. Annotation query를 클릭해요.
  4. 어노테이션 쿼리의 이름을 입력해요.
  5. 어노테이션 쿼리를 당장 쓰지 않을 거라면 Enabled 체크박스를 해제해요.
  6. 어노테이션 이벤트 마커의 색상을 선택해요.
  7. Show annotation controls in 드롭다운에서 어노테이션을 표시할 대시보드 위치를 선택해요.
  8. Show in 드롭다운에서 어노테이션을 표시할 패널을 선택해요.
  9. Open query editor를 클릭해 Annotation Query 대화 상자를 열어요.
  10. Data source 드롭다운에서 Google Cloud Monitoring 데이터 소스를 선택해요.
  11. 어노테이션 쿼리와 필드 매핑을 구성해요.
  12. (선택) Test annotation query를 클릭해 쿼리가 제대로 동작하는지 확인해요.
  13. 쿼리 설정을 마쳤으면 Close를 클릭해요.
  14. Save를 클릭해요.
  15. (선택) 변경 내용에 대한 설명을 입력해요.
  16. Save를 클릭해요.
  17. Exit edit을 클릭해요.

어노테이션 쿼리 구성하기

어노테이션용 쿼리 편집기에서 지표와 필터를 선택해 어떤 데이터 포인트가 어노테이션을 만드는지 정의할 수 있어요.

Title과 Text 필드는 템플릿을 지원하며 쿼리에서 반환된 데이터를 사용할 수 있어요.

예를 들어, Title 필드에 다음과 같이 넣을 수 있어요.

{{metric.type}} has value: {{metric.value}}

예시 결과: monitoring.googleapis.com/uptime_check/http_status has this value: 502

어노테이션 패턴

Title과 Text 필드에 다음 패턴을 사용해 어노테이션에 지표 데이터를 표시해요.

패턴 형식 설명 예시 결과
{{metric.value}} 지표/포인트의 값 {{metric.value}} 555
{{metric.type}} 전체 Metric Type 반환 {{metric.type}} compute.googleapis.com/instance/cpu/utilization
{{metric.name}} 지표 이름 부분 반환 {{metric.name}} instance/cpu/utilization
{{metric.service}} 서비스 부분 반환 {{metric.service}} compute
{{metric.label.xxx}} 지표 라벨 값 반환 {{metric.label.instance_name}} grafana-1-prod
{{resource.label.xxx}} 리소스 라벨 값 반환 {{resource.label.zone}} us-east1-b

예시: 업타임 체크 실패 어노테이션

업타임 체크 실패에 대한 어노테이션을 만들려면:

  1. Google Cloud Monitoring 데이터 소스를 사용해 어노테이션 쿼리를 추가해요.
  2. monitoring.googleapis.com/uptime_check/check_passed 지표를 선택해요.
  3. check_passed = false 필터를 추가해요.
  4. Title을 Uptime check failed: {{metric.label.check_id}}로 설정해요.
  5. Text를 Region: {{resource.label.zone}}으로 설정해요.

이렇게 하면 업타임 체크가 실패할 때마다 그래프에 어노테이션 마커가 만들어져요.

더 알아보기 (Learn more)