토폴로지 맵 위젯
토폴로지 맵 위젯 (Topology Map Widget)
출처: 문서
본문
토폴로지 맵 위젯은 데이터 소스와 그 관계를 시각화해서 데이터가 아키텍처를 통해 어떻게 흐르는지 이해할 수 있게 도와줘요.
설정 (Setup)
구성 (Configuration)
- 그래프로 그릴 데이터 소스를 선택해요.
| 데이터 소스 | 노드가 나타내는 것 | 선이 나타내는 것 |
|---|---|---|
| 서비스 맵 (Service Map) | 매핑된 서비스(위젯 구성에서 선택된 서비스) | 업스트림-다운스트림 관계(어느 방향이든) |
| 데이터 스트림 (Data Streams) | 서비스나 큐 같은 데이터 파이프라인의 구성 요소 | 파이프라인에서 생산자와 소비자 사이의 데이터 흐름 |
| 네트워크 경로 (Network Path) | 네트워크 경로를 따라 있는 홉(hop) | 소스에서 목적지까지 두 홉 사이의 지연(레이턴시) 주석이 달린 링크 |
서비스 맵의 경우, 다른 서비스가 매핑된 서비스를 호출하면 해당 서비스에서 매핑된 서비스로 선이 표시돼요. 매핑된 서비스가 다른 서비스를 호출하면 매핑된 서비스에서 각 서비스로 선이 표시돼요.
- 그래프 제목을 입력해요.
API
이 위젯은 **대시보드 API**와 함께 사용할 수 있어요. 위젯 JSON 스키마 정의에 대해서는 다음 표를 참고하세요.
| 필드 | 타입 | 설명 |
|---|---|---|
| custom_links | object[] | 사용자 지정 링크 목록. |
| is_hidden | boolean | 컨텍스트 메뉴 링크 표시 여부를 전환하는 플래그. |
| label | string | 사용자 지정 링크 URL의 라벨. 라벨을 짧고 명확하게 유지하세요. 메트릭과 태그를 변수로 사용하세요. |
| link | string | 사용자 지정 링크의 URL. URL은 http 또는 https를 포함해야 해요. 상대 URL은 /로 시작해야 해요. |
| override_label | string | 컨텍스트 메뉴 링크를 나타내는 라벨 ID. logs, hosts, traces, profiles, processes, containers, rum 중 하나가 될 수 있어요. |
| description | string | 위젯의 설명. |
| requests [필수] | object[] | 하나의 토폴로지 요청. |
| query | object | 서비스 맵 토폴로지 데이터 소스에 대한 쿼리. |
| data_source [필수] | enum | 데이터 소스 이름. 허용 enum 값: service_map |
| filters [필수] | string[] | 환경 및 기본 태그(또는 계정에서 활성화된 경우 *). |
| query_string | string | 서비스를 필터링하기 위한 검색 문자열. 설정하면 service 필드를 대체해요. |
| service [필수] | string | (더 이상 사용되지 않음) 서비스 이름. 비워 두고 query_string을 사용하세요. |
| request_type | enum | 위젯 요청 유형. 허용 enum 값: topology |
| time | object | 위젯의 시간 설정. |
| title | string | 위젯 제목. |
| title_align | enum | 위젯 텍스트 정렬 방식. 허용 enum 값: center,left,right |
| title_size | string | 제목 크기. |
| type [필수] | enum | 토폴로지 맵 위젯 유형. 허용 enum 값: topology_map 기본값: topology_map |
time 객체는 라이브 스팬(live span) 래퍼이며 live_span(허용 enum: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert)과 hide_incomplete_cost_data 필드를 가져요.
예시:
{
"custom_links": [
{
"is_hidden": false,
"label": "Search logs for {{host}}",
"link": "https://app.datadoghq.com/logs?query={{host}}",
"override_label": "logs"
}
],
"description": "string",
"requests": [
{
"query": {
"data_source": "service_map",
"filters": [
"env:prod",
"az:us-east"
],
"query_string": "service:myservice",
"service": "myservice"
},
"request_type": "string"
}
],
"time": {
"hide_incomplete_cost_data": false,
"live_span": "5m"
},
"title": "string",
"title_align": "string",
"title_size": "string",
"type": "topology_map"
}