체크 상태 위젯
체크 상태 위젯 (Check Status Widget)
서비스 체크(Service check)는 특정 서비스의 업/다운 상태를 모니터링해요. 모니터링 Agent가 지정된 연속 체크 횟수 동안 서비스에 연결하지 못하면 알림이 트리거돼요. 체크 상태(Check Status) 위젯은 대시보드에서 서비스 성능 저하, 서비스 실패, 클러스터 전체 문제, 처리량 감소, 지연 시간 증가를 시각적으로 표시할 수 있어요.
자세한 내용은 Service check 문서를 참조해요.
출처: 문서
본문
개요
체크 상태 위젯은 수행된 모든 체크의 현재 상태 또는 결과 수를 보여 줘요. 서비스 성능 저하, 서비스 실패, 클러스터 전체 문제, 처리량 감소, 지연 시간 증가를 시각적으로 표시할 수 있어요.
설정
구성
- 이전에 만든 서비스 체크를 선택해요.
- 보고 시간 범위를 선택해요. 이 시간 범위는 항상 현재까지를 포함하므로
The past 10 minutes(지난 10분) 또는The past 1 day(지난 1일) 같은 옵션을 선택할 수 있고, 현재 순간까지의 시간 범위를 포함한 상태를 보고해요.Global Time을 선택하면 대시보드를 사용하는 사람이 오른쪽 위의 시간 범위 선택기로 범위를 선택할 수 있지만, 현재 순간을 포함하는 범위(즉past X시간 범위)를 선택해야 해요. 그렇지 않으면 위젯이 비어 있어요. - 범위(scope)를 선택해요:
- 단일 체크: 체크 상태 위젯이 특정 요소 전용인 경우 이 옵션을 선택해요. 예: 하나의
host:<HOSTNAME>, 하나의service:<SERVICE_NAME>. - 체크 클러스터: 체크 상태 위젯이 모든
host나 모든service처럼 요소의 범위를 위한 경우 이 옵션을 선택해요.
- 단일 체크: 체크 상태 위젯이 특정 요소 전용인 경우 이 옵션을 선택해요. 예: 하나의
- 범위를 선택한 후 Reported by 필드로 체크 상태 위젯의 컨텍스트를 정의해요.
- 범위가 '체크 클러스터'인 경우 Group by 필드로 부분집합을 선택할 수 있어요. 참고: 체크 상태는 그룹당 체크 수를 표시하지 않고, 체크를 실행 중인 그룹 수를 표시해요. 예를 들어 Agent Up을
env로 그룹화해 모니터링하는 경우, 체크 상태는 환경에서 Agent를 실행 중인env의 수를 보여 주며 환경의 Agent 수는 아니에요.
API
이 위젯은 **Dashboards API**와 함께 사용할 수 있어요. widget JSON 스키마 정의는 다음 표를 참조해요:
| 필드 | 타입 | 설명 |
|---|---|---|
check [필수] |
string | 위젯에서 사용할 체크의 이름. |
description |
string | 위젯의 설명. |
group |
string | 단일 체크를 보고하는 그룹. |
group_by |
string[] | 클러스터 체크의 경우 그룹화할 태그 접두사 목록. |
grouping [필수] |
enum | 사용할 그룹화의 종류. 허용되는 enum 값: check,cluster |
tags |
string[] | 클러스터 체크를 보고하는 그룹을 필터링하는 데 사용되는 태그 목록. |
time |
oneOf | 위젯의 시간 설정. |
title |
string | 위젯의 제목. |
title_align |
enum | 위젯에서 텍스트를 정렬하는 방법. 허용되는 enum 값: center,left,right |
title_size |
string | 제목의 크기. |
type [필수] |
enum | 체크 상태 위젯의 유형. 허용되는 enum 값: check_status, 기본값: check_status |
JSON 예시:
{
"check": "",
"description": "string",
"group": "string",
"group_by": [],
"grouping": "check",
"tags": [],
"time": {
"hide_incomplete_cost_data": false,
"live_span": "5m"
},
"title": "string",
"title_align": "string",
"title_size": "string",
"type": "check_status"
}