대시보드-구축은(는) 무엇을 하나요?
Axiom 대시보드를 API를 통해 설계 및 구축합니다. 차트 유형, APL 및 메트릭/MPL 쿼리 패턴, SmartFilter, 레이아웃 및 구성 옵션을 다룹니다. 대시보드 생성, Splunk에서 마이그레이션, 또는 차트 옵션 구성 시 사용하세요.
소개
이 스킬은 Axiom API를 사용하여 대시보드를 생성하고 관리하는 방법을 안내합니다. 대시보드는 여러 차트와 필터로 구성되어 있으며, 각 차트는 특정 APL 또는 MPL 쿼리를 기반으로 데이터를 시각화합니다.
지원하는 차트 유형
- 라인 차트 (Line chart): 시간에 따른 추세를 표시합니다.
- 막대 차트 (Bar chart): 범주별 데이터를 비교합니다.
- 파이 차트 (Pie chart): 전체에서 각 부분의 비율을 보여줍니다.
- 테이블 (Table): 원시 데이터를 테이블 형태로 표시합니다.
- 단일 값 (Single value): 하나의 주요 지표를 강조합니다.
쿼리 패턴
APL (Axiom Processing Language)
APL은 로그 및 이벤트 데이터를 분석하기 위한 강력한 쿼리 언어입니다.
['my-dataset']
| where severity == 'error'
| summarize count() by service
| sort by count() desc
MPL (Metrics Processing Language)
MPL은 메트릭 데이터를 분석하기 위한 전용 쿼리 언어입니다.
['cpu-usage']
| where host == 'web-server-1'
| rate()
| avg() by [1m]
SmartFilter
SmartFilter는 대시보드 전체에 적용되는 동적 필터로, 사용자가 특정 조건을 선택하면 모든 차트가 실시간으로 업데이트됩니다.
{
"name": "서비스 필터",
"field": "service",
"type": "list"
}
레이아웃
대시보드 레이아웃은 그리드 시스템을 기반으로 하며, 각 차트의 위치와 크기를 x, y, w, h 속성으로 지정합니다.
| 속성 | 설명 |
|---|---|
x | 그리드의 X 좌표 (열) |
y | 그리드의 Y 좌표 (행) |
w | 차트의 너비 (그리드 단위) |
h | 차트의 높이 (그리드 단위) |
API 사용 예시
대시보드 생성
curl -X POST https://api.axiom.co/v1/dashboards \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "내 서비스 모니터링",
"description": "주요 서비스 상태를 모니터링하는 대시보드",
"charts": [
{
"title": "서비스별 오류 수",
"type": "bar",
"query": {
"apl": "['logs'] | where severity == 'error' | summarize count() by service"
},
"position": {
"x": 0,
"y": 0,
"w": 6,
"h": 4
}
}
],
"smartFilters": [
{
"name": "환경 필터",
"field": "environment",
"type": "list"
}
]
}'
Splunk에서 마이그레이션
Splunk에서 Axiom으로 대시보드를 마이그레이션할 때는 다음 단계를 따르세요:
- Splunk 쿼리를 APL 또는 MPL로 변환합니다.
- 차트 유형을 Axiom 지원 유형에 매핑합니다.
- 기존 Splunk 대시보드의 레이아웃 정보를 추출합니다.
- Axiom API를 사용하여 동등한 대시보드를 생성합니다.
참고 사항
- 모든 API 호출에는 유효한 API 토큰이 필요합니다.
- 대시보드 이름은 고유해야 합니다.
- 차트 쿼리는 유효한 APL 또는 MPL 구문을 따라야 합니다.
- 레이아웃 속성의 좌표는 0부터 시작합니다.