모니터 API 옵션
모니터 API 옵션 (Monitor API Options)
이 가이드는 Monitors API를 통해 모니터를 구성할 때 사용할 수 있는 옵션들을 설명해요. 다음 옵션들을 다룹니다:
- 모든 모니터 유형에 공통인 옵션
- 편집 권한을 제어하는 옵션
- 메트릭, 이상, 로그, 서비스 체크, Synthetic 테스트 모니터 같은 특정 모니터 유형에만 적용되는 옵션
출처: 문서
본문
공통 옵션 (Common options)
{% dl %}
{% dt %}
silenced
{% /dt %}
{% dd %}
더 이상 사용되지 않음(Deprecated): v1 다운타임만 반영해요. 대신 Downtimes API를 사용해요. 기본값: null 스코프와 타임스탬프의 사전(dictionary)이거나, 영구 음소거를 위한 null이에요.
예시: {'*': null}은 모든 것을 음소거하고, {'role:db': 1412798116}은 해당 타임스탬프까지 role:db를 음소거해요.
{% /dd %}
{% dt %}
new_host_delay
{% /dt %}
{% dd %}
더 이상 사용되지 않음(Deprecated): 대신 new_group_delay를 사용해요. 기본값: 300 모니터 결과를 평가하기 전에 호스트가 부팅될 시간(초)이에요.
{% /dd %}
{% dt %}
new_group_delay
{% /dt %}
{% dd %}
기본값: 60 새 그룹에 경보를 발생시키기 전의 시간(초)으로, 새 애플리케이션이나 컨테이너가 시작될 시간을 줘요. 음이 아닌 정수예요. 시작 시 CPU가 급증하는 컨테이너처럼 새로 생성된 group-by 값에 대한 경보를 막아줘요.
{% /dd %}
{% dt %}
notify_no_data
{% /dt %}
{% dd %}
기본값: false 데이터가 보고를 중단할 때 모니터가 알림을 보낼지 여부를 나타내는 Boolean이에요.
{% /dd %}
{% dt %}
no_data_timeframe
{% /dt %}
{% dd %}
기본값: null 데이터가 보고를 중단한 후 모니터가 알림을 보내기까지의 분(minutes)이에요. 권장: 쿼리 알림은 모니터 시간 프레임의 2배, 서비스 체크는 2분이에요.
{% /dd %}
{% dt %}
timeout_h
{% /dt %}
{% dd %}
기본값: null 트리거된 상태에서 모니터가 자동으로 해소되기 전에 데이터가 없는 시간(시간 단위)이에요. 범위: 0-24.
{% /dd %}
{% dt %}
renotify_interval
{% /dt %}
{% dd %}
기본값: null 미해결 상태일 때 마지막 알림 후 모니터가 재알림(renotify)하기까지의 분(minutes)이에요.
{% /dd %}
{% dt %}
renotify_statuses
{% /dt %}
{% dd %}
기본값: null 재알림을 트리거하는 상태들이에요. renotify_interval이 설정되면 기본값은 alert와 no data예요.
{% /dd %}
{% dt %}
renotify_occurrences
{% /dt %}
{% dd %}
기본값: null renotify_interval로 보낼 재알림 횟수예요. renotify_interval이 필요해요.
{% /dd %}
{% dt %}
escalation_message
{% /dt %}
{% dd %}
기본값: null 재알림에 포함할 메시지예요. @username을 지원해요. renotify_interval이 필요해요.
{% /dd %}
{% dt %}
notify_audit
{% /dt %}
{% dd %}
기본값: false 태그된 사용자에게 모니터 변경 사항을 알릴지 여부를 나타내는 Boolean이에요.
{% /dd %}
{% dt %}
notify_by
{% /dt %}
{% dd %}
기본값: null 그룹화된 모니터의 경보 세분성(granularity)을 제어하는 태그들이에요. 쿼리의 group-by 태그의 부분집합이어야 해요. 단순 경보로 알리려면 ["*"]로 설정해요.
{% /dd %}
{% dt %}
notification_preset_name
{% /dt %}
{% dd %}
기본값: show_all 쿼리나 알림 대상(handle) 같은 추가 콘텐츠가 알림에 얼마나 표시되는지 제어해요. show_all, hide_query, hide_handles, hide_all, hide_query_and_handles, show_only_snapshot, hide_handles_and_footer 중 하나예요.
{% /dd %}
{% dt %}
include_tags
{% /dt %}
{% dd %}
기본값: true 알림 제목에 트리거링 태그를 포함할지 여부를 나타내는 Boolean이에요. 예시: true는 [Triggered on {host:h1}] Monitor Title을 만들고, false는 [Triggered] Monitor Title을 만들어요.
{% /dd %}
{% dt %}
evaluation_delay
{% /dt %}
{% dd %}
기본값: null 평가를 지연시킬 시간(초)이에요. AWS CloudWatch 같은 백필(backfilled) 데이터 소스에 유용해요. 대부분의 모니터 유형에서 사용 가능하며, SLO 모니터에서는 burn rate 알림 외에는 지원되지 않아요.
{% /dd %}
{% /dl %}
권한 옵션 (Permissions options)
{% dl %}
{% dt %}
restricted_roles
{% /dt %}
{% dd %} 모니터를 편집할 수 있는 역할의 UUID 배열이에요. 모니터 편집에는 모니터 구성 업데이트, 모니터 삭제, 아무 기간 동안의 모니터 음소거가 포함돼요. 역할 UUID는 Roles API에서 가져와요. {% /dd %}
{% /dl %}
참고: 역할 외에도 Teams와 사용자 기반으로 Restriction Policies를 사용해 모니터에 권한을 설정할 수도 있어요. 모니터 권한 제한에 대한 자세한 내용은 전용 가이드를 참고해요.
모니터 유형별 옵션 (Options by monitor type)
{% collapsible-section %}
이상 옵션 (Anomaly options)
이 옵션들은 이상 모니터에만 적용되며 다른 모니터 유형에서는 무시돼요.
{% dl %}
{% dt %}
threshold_windows
{% /dt %}
{% dd %}
recovery_window와 trigger_window를 포함하는 사전(dictionary)이에요.
recovery_window: 경보가 복구되기 전에 이상 메트릭이 정상이어야 하는 시간이에요.trigger_window: 경보가 트리거되기 전에 메트릭이 이상이어야 하는 시간이에요.
예시: {'threshold_windows': {'recovery_window': 'last_15m', 'trigger_window': 'last_15m'}}
{% /dd %}
{% /dl %}
{% /collapsible-section %}
{% collapsible-section %}
메트릭 경보 옵션 (Metric alert options)
이 옵션들은 메트릭 경보에만 적용돼요.
{% dl %}
{% dt %}
thresholds
{% /dt %}
{% dd %}
임계값 유형별 임계값의 사전(dictionary)이에요. 메트릭 경보에는 critical과 warning 두 가지 임계값 유형이 있어요. Critical은 쿼리에 정의되지만 이 옵션에서도 지정할 수 있어요. Warning 임계값은 thresholds 옵션으로만 지정할 수 있어요. 모니터에 복구 임계값(recovery thresholds)을 사용하려면 critical_recovery와 warning_recovery 속성을 사용해요.
예시: {'critical': 90, 'warning': 80, 'critical_recovery': 70, 'warning_recovery': 50}
{% /dd %}
{% dt %}
require_full_window
{% /dt %}
{% dd %}
기본값: false 이 모니터가 평가되기 전에 전체 창(full window)의 데이터가 필요한지 여부를 나타내는 Boolean이에요. 희소(sparse) 메트릭에서는 false로 설정할 것을 Datadog는 권장해요. 그렇지 않으면 일부 평가가 건너뛰어져요.
{% /dd %}
{% /dl %}
{% /collapsible-section %}
{% collapsible-section %}
서비스 체크 옵션 (Service check options)
이 옵션들은 서비스 체크에만 적용되며 다른 모니터 유형에서는 무시돼요.
{% dl %}
{% dt %}
thresholds
{% /dt %}
{% dd %}
상태별 임계값의 사전(dictionary)이에요. 서비스 체크는 여러 임계값을 가질 수 있으므로 쿼리에 직접 정의되지 않아요.
예시: {'ok': 1, 'critical': 1, 'warning': 1}
{% /dd %}
{% /dl %}
{% /collapsible-section %}
{% collapsible-section %}
로그 경보 옵션 (Logs alert options)
이 옵션들은 로그 경보에만 적용돼요.
{% dl %}
{% dt %}
thresholds
{% /dt %}
{% dd %}
상태별 임계값의 사전(dictionary)이에요.
예시: {'ok': 1, 'critical': 1, 'warning': 1}
{% /dd %}
{% dt %}
aggregation
{% /dt %}
{% dd %}
type, metric, groupBy의 사전(dictionary)이에요.
예시: {"metric": "count","type": "count","groupBy": "core_service"}
type:count,cardinality,avg세 가지 유형이 지원돼요.metric:cardinality의 경우 패싯(facet) 이름을 사용해요.avg의 경우 메트릭 이름을 사용해요.count의 경우 metric으로count를 넣어요.groupBy: 그룹화할 패싯의 이름이에요.
{% /dd %}
{% dt %}
enable_logs_sample
{% /dt %}
{% dd %}
기본값: false 알림 메시지에 샘플이나 값을 추가할지 여부를 나타내는 Boolean이에요.
{% /dd %}
{% /dl %}
{% /collapsible-section %}
{% collapsible-section %}
Synthetic 테스트 모니터 옵션 (Synthetic test monitor options)
이 옵션들은 Synthetic 테스트 모니터에만 적용돼요.
{% dl %}
{% dt %}
min_failure_duration
{% /dt %}
{% dd %}
기본값: 0 경보를 발생시키기 전에 테스트가 실패 상태여야 하는 시간(초)이에요. 최대: 7200.
{% /dd %}
{% dt %}
min_location_failed
{% /dt %}
{% dd %}
기본값: 1 경보를 발생시키기 전에 min_failure_duration 창 동안 동시에 실패 상태여야 하는 최소 테스트 위치 수예요. 고급 경보 규칙의 일부로 min_failure_duration과 함께 사용돼요.
{% /dd %}
{% /dl %}
{% /collapsible-section %}
{% collapsible-section %}
APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, RUM 모니터 옵션 (Options for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors)
이 옵션들은 이 섹션 제목에 나열된 모니터 유형에만 적용돼요.
{% dl %}
{% dt %}
group_retention_duration
{% /dt %}
{% dd %}
데이터가 누락된 그룹이 모니터 상태에서 삭제되는 시간 간격이에요. 최소: 1시간. 최대: 72시간.
예시 값: 60m, 1h, 2d.
{% /dd %}
{% dt %}
on_missing_data
{% /dt %}
{% dd %}
평가가 데이터 포인트를 반환하지 않을 때 그룹이나 모니터가 어떻게 동작할지 제어해요. 기본 동작은 쿼리 유형에 따라 달라져요: count 쿼리를 사용하는 모니터는 빈 평가를 0으로 취급해 임계값 조건과 비교하고, gauge, measure, rate 같은 다른 쿼리 유형을 사용하는 모니터는 마지막으로 알려진 상태를 표시해요. default, show_no_data, show_and_notify_no_data, resolve 중 하나예요.
{% /dd %}
{% dt %}
enable_samples
{% /dt %}
{% dd %} 모니터가 트리거될 때 샘플 목록을 보낼지 여부를 나타내는 Boolean이에요. CI Test 및 CI Pipeline 모니터에서만 사용 가능해요. {% /dd %}
{% /dl %}
{% /collapsible-section %}