Status: Experiment

GitLab Observability API를 사용하여 트레이스, 메트릭, 로그를 쿼리하고, 대시보드와 알림을 프로그래밍 방식으로 관리하세요.

사전 요구 사항#

• 그룹에 Observability가 활성화되어 있어야 합니다. 설정 방법은 GitLab.com에서 Observability 설정 또는 GitLab Self-Managed에서 Observability 설정을 참조하세요.

• 해당 그룹에 대해 Developer, Maintainer, 또는 Owner 권한이 있어야 합니다.

API 키 가져오기#

• 상단 바에서 Search or go to를 선택하고 그룹을 찾으세요.

• 왼쪽 사이드바에서 Observability > API Keys를 선택하세요.

• API 키를 복사하세요.

API 요청을 할 때 SIGNOZ-API-KEY 헤더에 이 키를 사용하세요.

API 엔드포인트#

API 엔드포인트는 사용 중인 GitLab 오퍼링에 따라 다릅니다.

GitLab.com#

API 기본 URL은 다음 패턴을 따릅니다:

https://<group_id>.gitlab-o11y.com

<group_id>를 GitLab 그룹 ID로 교체하세요.

GitLab Self-Managed#

API 기본 URL은 그룹의 o11y_service_url로 설정한 URL과 동일합니다. 예를 들면:

http://<your-instance-ip>:8080

API 요청 수행#

모든 요청에 SIGNOZ-API-KEY 헤더에 API 키를 포함하세요.

다음 예시는 헬스 엔드포인트를 쿼리합니다:

curl --header "SIGNOZ-API-KEY: <your_api_key>" \
  https://<group_id>.gitlab-o11y.com/api/v1/health

<your_api_key>를 API Keys 페이지의 키로 교체하고, <group_id>를 GitLab 그룹 ID(또는 Self-Managed 인스턴스 URL)로 교체하세요.

사용 가능한 API 엔드포인트#

GitLab Observability는 SigNoz API를 사용합니다. 사용 가능한 엔드포인트, 요청 및 응답 형식, 사용 예시의 전체 목록은 SigNoz API 레퍼런스를 참조하세요.

관련 주제#

• GitLab Observability로 원격 분석 데이터 전송

• Observability 트러블슈팅