최근 GCP에서 Metric export pipline을 구현하기 위해 오픈소스를 분석할 일이 있었다.
문제는 짧은 시간 내에 전체 소스를 파악해야 한다는 점. 다들 아시겠지만, 낯선 오픈소스 레포를 빠르게 이해하는 건 정말 쉽지 않다. 특히 문서화가 잘 안 되어 있는 경우엔 더더욱.
이때 문득,
"AI로 코드 구조를 시각화해주는 서비스 없을까?"
하는 생각이 들었고, 우연히 발견한 게 바로gitdiagram
이다.
Gitdiagram이 뭐냐면?
간단히 말하면, GitHub 레포를 시각화해서 구조를 한눈에 보여주는 AI 기반 도구다.
링크 하나만 입력하면, 해당 레포를 분석해서 다음과 같은 정보를 자동으로 정리해준다:
- 전체 파일 및 디렉토리 구조
- 주요 모듈의 설명
- 흐름도 스타일의 시각적 구조
- 사용된 기술 스택
- 코드의 역할별 분류
사용해보니 어땠냐면…
내가 분석하려던 오픈소스는 GCP와 연동되는 모니터링 도구였다. 코드가 깔끔했지만 낯선 컴포넌트 (pub/sub, app engine)들을 활용하는 레포였기 때문에 마냥 쉽지는 않았다.
그런데 Gitdiagram에 URL을 넣자마자 한눈에 구조를 파악할 수 있었다.
파이프라인 개발이었기 때문에 라인바이라인 분석보다는 전체적 흐름 파악이 우선이었는데 이 과정이 정말 명확했다.
솔직히 GitHub만 봤으면 반나절은 걸렸을 분석을, 30분 만에 끝냈다.
내가 분석한 Repo : https://github.com/googlecloudplatform/stackdriver-metrics-export
GitHub - GoogleCloudPlatform/stackdriver-metrics-export
Contribute to GoogleCloudPlatform/stackdriver-metrics-export development by creating an account on GitHub.
github.com
결과 : https://gitdiagram.com/GoogleCloudPlatform/stackdriver-metrics-export
GitDiagram - Repository to Diagram in Seconds
Turn any GitHub repository into an interactive diagram for visualization.
gitdiagram.com
팁
- instruction을 조정할 수 있다.
- 처음 결과에서는 함수레벨까지는 분석해주지 않아서 아쉬웠는데 instruction을 추가하고 나니 함수 레벨까지 분석해줬다.
- 사용한 instruction
Please analyze the repository in detail and generate diagrams **down to the function-level granularity**. I want to see:
- Functions defined in each module
- Relationships between functions (calls, dependencies)
- The role of each function within the overall flow
- Grouping by file/module with inline function annotations
The diagram should clearly show the flow of logic and major functional components.
이런 분들께 추천
- 오픈소스 레포를 빠르게 파악해야 하는 개발자
- 신규 프로젝트에 합류하면서 기존 코드베이스를 이해해야 하는 상황
- 교육용으로 코드 구조를 시각화해서 설명하고 싶은 분들
마무리
최근 AI 기반 도구들이 점점 더 개발자의 시간을 절약해주는 방향으로 발전하고 있다.
Gitdiagram도 그중 하나로, “코드 분석”이라는 가장 수고로운 일 중 하나를 도와주는 유용한 툴이었다.
혹시 나처럼 새로운 레포를 파악해야 하는 분이 있다면, 한 번 써보시길 추천드린다.
👉 https://gitdiagram.com/
'Study' 카테고리의 다른 글
Cloud monitoring overview (0) | 2025.05.27 |
---|