Git Sync에서 프로비저닝된 대시보드 다루기
Git Sync에서 프로비저닝된 대시보드 다루기
참고
Git Sync 기능은 계속 진화하고 있어요. 이 기능을 개선하는 데 도움이 되도록 Grafana에 지원을 요청하거나 문제를 신고해 주세요.
프로비저닝을 사용하면 대시보드 JSON 파일을 Git Sync를 사용한 Git 저장소 또는 로컬 경로에 저장하고, Grafana 인터페이스를 통해 관리할 수 있어요. Git Sync 또는 로컬 경로로 동기화된 대시보드와 폴더를 프로비저닝된 리소스(provisioned resources)라고 해요. Git Sync는 대시보드를 프로비저닝하는 데 권장되는 방법이에요.
출처: 문서
본문
Git Sync로 프로비저닝된 대시보드 관리
Git Sync를 사용하면 UI에서 대시보드를 관리하고 구성된 Git 저장소와 동기화할 수 있어요. 저장소에서 변경 사항을 푸시하면 해당 변경 사항이 Grafana 인스턴스에 반영돼요.
- Git Sync로 구성된 저장소 또는 로컬 폴더에 저장된 대시보드는 Grafana의 프로비저닝된 폴더에 나타나요.
- Git Sync로 저장된 대시보드 폴더는 UI에 Provisioned 라벨이 표시돼요.
- 프로비저닝된 리소스에 변경 사항을 저장하려면 pull request를 열거나
main같은 기존 브랜치에 직접 커밋하세요. - 대시보드 변경 사항을 검토하려면 pull request를 사용하세요.
- 병합 전에 변경 사항을 미리 보세요.
자세한 내용은 핵심 개념을 참고하세요.
새 대시보드 만들기
참고
변경 사항이 화면에 반영되는 데 몇 분이 걸릴 수 있어요. 반영되지 않으면 UI를 수동으로 새로 고치세요.
Git Sync 연결에서 새 대시보드를 추가하는 옵션은 다음과 같아요:
- Grafana UI의 Git Sync 관리 폴더 안에서 직접 생성
- Git 저장소에 JSON 파일을 커밋해 추가
기존 대시보드를 프로비저닝된 리소스에 추가하려면 Grafana에서 비프로비저닝 리소스 내보내기를 참고하세요.
Grafana UI에서 새 대시보드 추가
Grafana UI에서 새 대시보드를 추가하려면:
- Dashboards 탭에서 오른쪽 상단의 New를 클릭하고 다음 옵션 중 하나를 선택하세요:
대시보드를 만든 후 다음 단계를 따르세요:
- Save dashboard를 클릭하세요.
- Provisioned dashboard 패널에서 원하는 옵션을 선택하세요:
- Title: 대시보드의 제목.
- Description: 대시보드의 설명.
- Target folder: 새 대시보드를 저장할 폴더.
- Branch: Git 프로바이더의 브랜치 이름을 지정해요(예: main).
- Repository folder: 저장소 내부의 폴더. 저장소 루트를 사용하려면 비워두세요.
- Filename: 대시보드 파일의 이름.
- Comment: 커밋을 위해 변경 사항을 설명하는 주석을 추가해요.
- 선택 사항: Changes 탭을 선택해 만든 업데이트와 원본 리소스 간의 차이를 확인하세요.
- Save를 선택하면 업데이트된 대시보드가 로드돼요.
- 프롬프트에서 Open a pull request in GitHub를 선택해 저장소에 새 PR을 엽니다.
- 평소 Git 워크플로를 따라 PR을 저장소에 저장하고 병합하세요.
대시보드 편집
프로비저닝된 리소스를 편집하면 해당 변경 사항을 저장하거나 버릴지 묻는 프롬프트가 나타나요. 변경 사항을 저장하려면 Git 저장소에서 pull request를 열어야 해요.
대시보드 변경 사항을 저장하려면:
- Edit을 선택해 프로비저닝된 대시보드를 업데이트하세요.
- 원하는 변경 사항을 만들고 Save dashboard를 클릭하세요.
- Provisioned dashboard 패널에서 원하는 옵션을 선택하세요:
- Branch: Git 프로바이더의 브랜치 이름을 지정해요(예: main).
- Repository folder: 저장소 내부의 폴더. 저장소 루트를 사용하려면 비워두세요.
- Filename: 대시보드 파일의 이름.
- Comment: 커밋을 위해 변경 사항을 설명하는 주석을 추가해요.
- 선택 사항: Changes 탭을 선택해 만든 업데이트와 원본 리소스 간의 차이를 확인하세요.
- Save를 선택하면 업데이트된 대시보드가 로드돼요.
- 프롬프트에서 Open a pull request in GitHub를 선택해 저장소에 새 PR을 엽니다.
- 평소 Git 워크플로를 따라 PR을 저장소에 저장하고 병합하세요.
대시보드 제거
저장소에서 대시보드를 삭제하면 프로비저닝된 대시보드를 제거할 수 있어요. Git 저장소의 변경 사항이 동기화되면 Grafana UI가 업데이트돼요.
삭제된 대시보드를 복원하려면 Git 저장소에서 직접 PR을 올리세요. 현재는 UI에서 리소스를 복원할 수 없어요.
README로 폴더 문서화
프로비저닝된 폴더의 내용이나 기타 관련 정보를 저장소의 리소스 옆에 저장된 README.md 파일에 문서화할 수 있어요. Grafana는 폴더 페이지에서 대시보드 목록 아래에 README를 인라인으로 렌더링하므로, 팀원들이 Grafana를 벗어나지 않고 폴더에 무엇이 있는지, 어떻게 구성되어 있는지, 올바른 대시보드를 어디서 찾을 수 있는지 알 수 있어요.
- 폴더에
README.md파일이 있으면 Grafana는 그 Markdown 콘텐츠를 렌더링해요. README의 상대 링크와 이미지는 호스트 저장소에 대해 해석돼요. - 폴더에
README.md가 없거나 폴더가 비어 있으면 Add README 버튼이 있는 작업 프롬프트가 표시돼요. - README는 언제든지 편집할 수 있어요. README 헤더의 편집 연필을 선택해 Git 프로바이더의 편집기에서 파일을 열고 평소 워크플로를 통해 변경 사항을 커밋하세요.
참고
변경 사항이 화면에 반영되는 데 몇 분이 걸릴 수 있어요. 반영되지 않으면 UI를 수동으로 새로 고치세요.
모범 사례
프로비저닝된 대시보드를 다룰 때 다음 권장 사항을 따르세요:
- 변경 사항에 GitHub pull request 사용: 대시보드 수정에 대한 검토 프로세스를 유지하세요.
- 명확한 커밋 메시지 제공: 추적과 협업에 도움이 되도록 변경 사항을 설명하세요.
- 저장소를 정기적으로 동기화: Grafana를 최신 변경 사항으로 최신 상태로 유지하세요.
- Events 탭 검토: 변경 사항이 올바르게 적용되었는지 동기화 상태를 모니터링하세요.
- 폴더 README 추가: 팀원들이 올바른 대시보드를 빨리 찾을 수 있도록 각 폴더의 내용을
README.md로 문서화하세요.
Git Sync 사용에 대한 일반적인 지침은 프로비저닝된 저장소 다루기를 참고하세요.