Zipkin 템플릿 변수
Zipkin 템플릿 변수 (Zipkin template variables)
템플릿 변수로 동적이고 재사용 가능한 대시보드를 만들 수 있어요. 트레이스 ID를 하드코딩하는 대신 변수를 사용하면 뷰어가 보는 시점에 트레이스 ID를 선택하거나 입력할 수 있어, 팀 간 대시보드 공유가 쉬워집니다. Zipkin 데이터 소스는 쿼리 기반 변수는 지원하지 않지만, 커스텀/텍스트 박스/데이터 소스 변수를 활용할 수 있어요.
출처: 문서
본문
지원되는 변수 유형
| 변수 유형 | 설명 | 지원 |
|---|---|---|
| Custom | 트레이스 ID 등 고정 목록 정의 | 예 |
| Text box | 대시보드 보기 시점에 사용자가 트레이스 ID 입력 | 예 |
| Data source | 사용자가 Zipkin 인스턴스 전환 | 예 |
| Query | 데이터 소스 쿼리로 옵션 채우기 | 아니요 |
Zipkin 데이터 소스는 쿼리 기반 변수를 지원하지 않지만, 커스텀/텍스트 박스 변수로 트레이스 ID 쿼리를 파라미터화할 수 있어요.
텍스트 박스 변수 만들기
텍스트 박스 변수는 대시보드 뷰어가 트레이스 ID를 직접 입력하게 해 주며, Zipkin에서 가장 흔한 변수 유형입니다.
- 대시보드에서 Edit 클릭 → Add new element(파란 더하기) → Variable 클릭
- 변수 유형으로 Textbox 선택
- Name을
traceId로 설정 - Display 드롭다운에서 표시 위치 선택
- (선택) 알려진 트레이스 ID를 기본 Value로 설정
- Save → (선택) 설명 → Save → Exit edit
대시보드에 트레이스 ID를 붙여넣을 수 있는 텍스트 입력이 표시됩니다.
커스텀 변수 만들기
커스텀 변수는 미리 정의된 값 목록을 제공해요. 뷰어에게 선택할 수 있는 알려진 트레이스 ID 집합을 주고 싶을 때 유용해요.
- Edit → Add new element → Variable 클릭
- 변수 유형으로 Custom 선택
- Name을
traceId로 설정 - Open variable editor 클릭해 Custom options 대화상자 열기
- Values separated by comma 필드에 트레이스 ID 입력:
efe9cb8857f68c8f,463ac35c9f6413ad48485a3953bb6124
- Apply → Save → Exit edit
대시보드에 미리 정의된 트레이스 ID 중 선택하는 드롭다운이 표시됩니다.
데이터 소스 변수 만들기
데이터 소스 변수는 뷰어가 여러 Zipkin 인스턴스 사이를 전환하게 해줘요. 환경별로 별도의 Zipkin 배포가 있을 때 유용하죠.
- Edit → Add new element → Variable 클릭
- 변수 유형으로 Data source 선택
- Name을
zipkinDs로 설정 - Type으로 Zipkin 선택
- Save → Exit edit
그 다음 패널 쿼리 편집기에서 특정 Zipkin 인스턴스 대신 ${zipkinDs}를 데이터 소스로 선택하세요.
쿼리에서 변수 사용하기
쿼리 편집기의 Trace ID 필드에서 템플릿 변수를 사용할 수 있어요. 실행 시 Grafana가 변수를 현재 값으로 치환합니다. 예를 들어 traceId 텍스트 박스 변수를 만들었다면 트레이스 ID 필드에 ${traceId}를 입력하세요. 뷰어가 새 트레이스 ID를 입력하면 쿼리가 자동으로 새 값으로 실행돼요. 변수 문법에 대한 자세한 내용은 Variable syntax를 참고하세요.
문제 해결
템플릿 변수가 예상대로 동작하지 않으면 Zipkin 데이터 소스 문제 해결을 참고하세요.