GitHub

개요

GitHub 통합을 설정해 GitHub Apps와 GitHub Actions를 구성하고 내 리포지토리 액세스를 안정화한 후 고급 텔레메트리(예: 감사 로그, 취약성 보고서, 비밀 스캔, 리포지토리 통계)를 수집하세요.

Datadog 소스 코드 통합을 사용해 내 스택 트레이스의 코드 조각을 확인하고, Lambda 함수에 사용하기 위해 스택 트레이스를 GitHub 소스 코드에 연결하며, CI Visibility의 풀 요청 댓글에서 테스트 결과를 표시할 수 있습니다. 또 서비스 카탈로그에서 GitHub의 여러 서비스 정의에 액세스할 수 있습니다.

설정

다음 지침에 따라 GitHub Apps를 설치하고 Datadog에 권한을 부여하세요. 부여한 권한에 따라 소스 코드 통합을 설정하고, 스택 트레이스에서 코드 조각을 확인하며, 감사 로그와 같은 텔레메트리를 수집할 수 있습니다. 이에 더해 CI Visibility에서 GitHub Actions에 액세스하는 등 다양한 작업을 할 수 있습니다.

내 조직이나 개인 계정에 리포지토리 연결

GitHub 조직 관리자 역할을 맡고 있는 경우 GitHub App을 구성할 수 있습니다.

GitHub 통합 타이틀에서 Repo Configuration 탭으로 이동하세요.
Link GitHub Account를 클릭해 새 GitHub App을 생성하세요.
Configure에서 Organization를 클릭해 내 조직 이름을 입력하거나 Personal Account를 선택하세요.
(선택 사항) GitHub Enterprise Server 인스턴스(버전 2.22 이상)의 URL을 지정하고 Datadog 서버가 내 Enterprise 인스턴스에 연결할 수 있는지 확인하세요. IP 범위의 Webhook 섹션에서 서버 IP를 확인할 수 있습니다.
Edit Permissions에서 이슈, 풀 요청, 컨텐츠에 대한 Datadog의 읽기 권한을 활성화하세요. 최소 권한 하나를 선택해야 합니다.
Create App in GitHub을 클릭하면 GitHub 내의 GitHub App 이름을 입력하는 화면이 나타납니다.
GitHub App 이름 필드에 이름을 입력하고 Create GitHub App을 클릭하세요.
Configuration 탭에서 Install GitHub App을 클릭하고 Install & Authorize을 선택하세요.

GitHub App에서 통합 타이틀을 표시합니다. 스택 트레이스에서 인라인 코드 조각을 활성화하려면 소스 코드 통합 설정을 참고하세요.

노트북

이슈와 풀 요청에 대한 GitHub App 읽기 권한을 부여한 경우 GitHub 이슈와 풀 요청에서 마우스 오버하면 나타나는 미리 보기 상자를 자동으로 생성하여 커밋 내역, 작성자, 노트북 내 날짜를 표시합니다.

Notebooks > New Notebook으로 이동하세요.
Text 셀을 추가하고 Edit 필드에 GitHub의 이슈나 풀 요청을 언급하세요(예: https://github.com/project/repository/pull/#).
Done을 클릭하면 내가 연결한 이슈나 풀 요청 옆에 GitHub 아이콘이 나타납니다.
Connect to Preview와 Authorize를 클릭하세요.
연결한 이슈나 풀 요청에 마우스 커서를 올리면 설명 미리 보기가 나타납니다.

감사 로그

감사 로그에는 GitHub 조직 전반의 활동과 이벤트 전체가 포함됩니다. 애플리케이션을 설치한 후 Organization Administration 권한을 허용해 읽기 액세스가 가능하도록 하세요. 그러면 애플리케이션에서 GitHub을 대신해 GitHub의 감사 스트림을 로그로 스트림하기 시작합니다.

참고: 감사 로그를 수집하려면 GitHub Enterprise 계정이 필요합니다.

GitHub 설명서의 Datadog로 스트리밍 설정에 안내된 지침에 따라 감사 로그를 Datadog로 전송하세요. 감사 로그에 관한 자세한 정보를 보려면 GitHub 설명서에서 감사 로그 작업을 참고하세요.

수집한 데이터

메트릭

GitHub 통합에서는 코드 스캔 알림과 비밀 스캔 알림 메트릭을 수집합니다. 이 메트릭을 상태, 레포, 비밀 유형별로 카테고리화하여 조직의 알림 상태를 전반적으로 파악할 수 있습니다. 또 알람 추세와 일반적인 진행 상황에 관한 장기적인 인사이트를 얻을 수 있습니다.

github.code_scan_alert (gauge)	Github Code Scan Alerts Shown as alert
github.secret_scan_alert (gauge)	Github Secret Scan Alerts Shown as alert

이와 같은 메트릭을 수집하려면 애플리케이션을 설치하고 읽기 액세스를 허용하는 권한을 선택하세요. 코드 스캔이나 비밀 스캔 메트릭을 받고 싶지 않으면 통합 타이틀의 Telemetery 탭에서 해당 조직을 찾은 후 해당 섹션에 있는 토글 버튼을 클릭한 후 Update Account를 클릭하세요.

이벤트

GitHub과 Datadog에서 웹훅을 구성하려면 다음 지침을 따라 Events Explorer에서 이벤트가 나타나도록 허용하세요.

GitHub에서 웹훅 추가

GitHub 프로젝트에서 Settings > Webhooks으로 이동하세요.
Add webhook을 클릭하세요.
Payload URL 필드에 URL https:///intake/webhook/github?api_key=<DATADOG_API_KEY>를 추가하세요. 이때 <DATADOG_API_KEY>를 내 Datadog API 키로 바꿔야 합니다.
Content type 드롭다운 메뉴에서 application/json를 선택하세요.
(선택 사항) Secret 필드에 비밀을 추가합니다.

Which events would you like to trigger this webhook? 섹션에서 **Let me select individual events.**를 클릭하고 지원되는 다음 옵션 중 하나를 선택해 이벤트를 Datadog로 전송하세요.

이벤트 이름	이벤트 작업
브랜치 또는 태그 생성
커밋 댓글
이슈 댓글	다음 작업이 지원됩니다. - `created` - `deleted` - `edited`
이슈	다음 작업이 지원됩니다. - `assigned` - `closed` - `deleted` - `demilestoned` - `edited` - `labeled` - `locked` - `milestoned` - `opened` - `pinned` - `reopened` - `transferred` - `unassigned` - `unlabeled` - `unlocked` - `unpinned`
풀 요청 검토 댓글	다음 작업이 지원됩니다. - `created` - `deleted` - `edited`
풀 요청	다음 작업이 지원됩니다. - `assigned` - `unassigned` - `labeled` - `unlabeled` - `opened` - `edited` - `closed` - `reopened` - `synchronize` - `converted_to_draft` - `locked` - `unlocked` - `enqueued` - `dequeued` - `milestoned` - `demilestoned` - `ready_for_review` - `review_requested` - `review_request_removed` - `auto_merge_enabled` - `auto_merge_disabled`
푸시
리포지토리	다음 작업이 지원됩니다, - `archived` - `created` - `deleted` - `edited` - `privatized` - `publicized` - `renamed` - `transferred` - `unarchived`
보안 및 분석
팀 추가

Active를 선택해 후크가 트리거될 때 이벤트 상세 내용을 받으세요.
Add webhook을 클릭해 웹훅을 저장하세요.

Datadog에 웹훅 추가

GitHub 통합 타이틀에서 Webhooks 탭으로 이동하세요.
각 리포지토리에 모니터링하고 싶은 리포지토리와 브랜치를 지정하세요. 사용자나 조직에 있는 모든 리포지토리를 추가하려면 와일드카드(*)를 사용하세요. 브랜치 이름에 와일드카드를 사용하면 됩니다. 예를 들어 dev-*를 사용하면 dev-로 시작하는 모든 브랜치를 포함합니다.
DataDog/documentation GitHub 리포지토리의 master 브랜치와 관련한 이벤트 전체를 모으려면 Repository 필드에 DataDog/documentation을 입력하고 Branches 필드에 master를 입력하세요.
Datadog 조직의 master 브랜치 전체와 관련한 이벤트 모두를 모으려면 Repository 필드에 DataDog/*를 입력하고 Branches 필드에 master를 입력하세요. 참고: 리포지토리 이름에 와일드카드를 사용할 때 사용자나 조직을 지정해야 합니다. 예를 들어 ‘‘는 유효한 리포지토리 이름이 될 수 없습니다. ‘DataDog/‘가 유효한 리포지토리 이름입니다.
이벤트 알림을 받으려면 Commits와 Issues에 체크 박스를 클릭하세요.
Update Configuration을 클릭해 웹훅 구성을 저장하세요.