Error Reporting API는 다음 기능을 제공합니다.
- 실행 중인 서비스에서 오류를 보고하는 간단한 엔드포인트
- 오류 그룹과 관련 오류에 대한 읽기 액세스 권한입니다.
시작하기
Error Reporting API를 사용 설정합니다.
API 사용 설정에 필요한 역할
API를 사용 설정하려면 serviceusage.services.enable 권한이 포함된 서비스 사용량 관리자 IAM 역할(roles/serviceusage.serviceUsageAdmin)이 필요합니다. 역할 부여 방법 알아보기
API 사용 승인
Error Reporting API에 대한 액세스는 Identity and Access Management 역할 및 권한으로 제어됩니다. Google Cloud API 인증 및 승인에 대한 자세한 내용은 인증 가이드를 참고하세요.
데이터 모델
Error Reporting API는 오류 이벤트, 오류 그룹, 오류 그룹 통계의 세 가지 항목을 정의합니다. 오류 그룹 통계 객체는 대부분의 사용자가 가장 자주 상호작용하는 객체입니다.
오류 이벤트
ErrorEvent는 애플리케이션에서 오류가 한 번 발생한 것을 나타냅니다. 객체에는 오류가 발생한 시간, 오류가 발생한 컨텍스트, 반환된 오류 메시지와 같은 오류에 관한 정보가 포함됩니다. 오류 이벤트는 생성 후 최소 30일 동안 사용할 수 있습니다.
오류 그룹
ErrorGroup 객체는 오류 이벤트의 논리적으로 그룹화된 모음입니다. 그룹화는 오류 이벤트의 스택 트레이스에 있는 정보를 기반으로 합니다. 오류 그룹은 이름, 그룹 ID, 그룹과 연결된 추적 문제만 포함하는 간단한 객체입니다.
추적 문제 URL을 업데이트하려면 이 리소스의 update 메서드를 사용하세요.
오류 그룹 통계
ErrorGroupStats 객체에는 오류 그룹에 관한 자세한 정보가 포함되어 있으며 가장 자주 상호작용하는 API 객체입니다. groupStats 객체의 정보에는 이 그룹의 오류 이벤트가 처음 및 마지막으로 발생한 시간, 개수, 영향을 받은 사용자 수 등이 포함됩니다. 이 객체는 위젯과 맞춤 대시보드를 빌드할 때 유용합니다.
작업
Error Reporting API는 다음 작업을 지원합니다.
- 새 오류 이벤트 보고
- 오류 그룹 통계 나열
- 오류 이벤트 나열
- 오류 그룹 가져오기
- 오류 그룹의 추적 문제 업데이트
오류 이벤트 보고
실행 중인 서비스에서 오류 이벤트를 ReportedErrorEvent에 작성하여 보고할 수 있습니다. 이렇게 하면 Cloud Logging에 올바른 형식의 오류 메시지가 생성됩니다. 결과 로그 이름은 projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors 형식입니다. 이 메서드를 사용하는 Cloud Logging 수집 비용이 발생할 수 있습니다. 이러한 비용을 관리하려면 로그 제외를 참조하세요.
실행 중인 서비스에서 오류 이벤트 항목을 어셈블하고 이를 events.report 메서드로 전송하여 Error Reporting에 새 오류 이벤트를 보고할 수도 있습니다.
오류 그룹 통계 나열
오류 그룹 통계 목록을 가져오려면 groupStats.list 메서드에 요청을 보냅니다. 하나 이상의 쿼리 매개변수를 전달하여 반환되는 그룹 통계를 필터링할 수 있습니다.
오류 이벤트 나열
특정 오류 그룹에 속하는 오류 이벤트 목록을 가져오려면 events.list 메서드에 요청을 전송합니다. 필터 조건을 이러한 요청에 전달하여 특정 시작 시간과 종료 시간 사이에 발생한 오류 이벤트 또는 특정 서비스 컨텍스트와 일치하는 오류 이벤트만 가져올 수 있습니다.
오류 그룹 가져오기
특정 오류 그룹 리소스를 가져오려면 groups.get 메서드에 요청을 보냅니다.
오류 그룹 업데이트
오류 그룹과 연결된 추적 문제 URL을 업데이트하려면 업데이트된 ErrorGroup 리소스를 groups.update 메서드로 전송합니다.