Error Reporting용 C# 앱 계측

라이브러리의 Google.Cloud.Diagnostics 집합을 사용하여 C# 애플리케이션에서 Error Reporting에 오류 보고서를 보낼 수 있습니다. 다음과 같은 경우 라이브러리의 Google.Cloud.Diagnostics 집합을 사용하여 오류 그룹을 만듭니다.

• 로그 항목이 포함된 로그 버킷에 고객 관리 암호화 키(CMEK)가 있습니다.
• 로그 버킷이 다음 중 하나를 충족합니다.
  • 로그 항목이 시작된 동일한 프로젝트에 로그 버킷이 저장되어 있습니다.
  • 로그 항목이 프로젝트로 라우팅된 후 프로젝트가 해당 로그 항목을 소유 로그 버킷에 저장했습니다.
• 커스텀 오류 이벤트를 보고합니다.

Error Reporting은 Cloud Functions, App Engine, Compute Engine, Google Kubernetes Engine과 같은 일부 Google Cloud 서비스에 통합되어 있습니다. Error Reporting은 해당 서비스에서 실행되는 애플리케이션에서 Cloud Logging에 로깅한 오류를 표시합니다. 자세한 내용은 이 페이지의 Google Cloud에서 실행을 참고하세요.

또한 Logging을 사용하여 Error Reporting에 오류 데이터를 보낼 수도 있습니다. 데이터 형식 지정 요구사항에 대한 자세한 내용은 Logging의 형식 지정 오류 메시지를 참조하세요.

시작하기 전에

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

클라이언트 라이브러리 설치

라이브러리의 Google.Cloud.Diagnostics 집합을 사용하면 거의 모든 곳에서 실행되는 C# 애플리케이션에서 보고되는 오류를 모니터링하고 확인할 수 있습니다.

1. ASP.NET Core 3 이상을 대상으로 하는 애플리케이션의 경우 Google.Cloud.Diagnostics.AspNetCore3 라이브러리를 사용합니다. NuGet에서 이 라이브러리를 설치할 수 있습니다.
2. 이전 버전의 ASP.NET Core를 대상으로 하는 애플리케이션의 경우 Google.Cloud.Diagnostics.AspNetCore 라이브러리를 사용합니다. NuGet에서 이 라이브러리를 설치할 수 있습니다.
3. ASP.NET Core 이외의 프레임워크를 대상으로 하는 애플리케이션의 경우 Google.Cloud.Diagnostics.Common 라이브러리를 사용합니다. NuGet에서 이 라이브러리를 설치할 수 있습니다.

설치에 대한 자세한 내용은 라이브러리의 Google.Cloud.Diagnostics 집합에 대한 문서를 참조하세요. 또한 Issue Tracker를 통해 문제를 보고할 수도 있습니다.

클라이언트 라이브러리 구성

자세한 내용과 예시는 다음 리소스를 참조하세요.

1. Google.Cloud.Diagnostics.AspNetCore3 문서
2. Google.Cloud.Diagnostics.AspNetCore 문서
3. Google.Cloud.Diagnostics.Common 문서

Google Cloud에서 앱 실행

projects.events.report를 사용하여 오류 그룹을 만들려면 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)이 필요합니다.

일부 Google Cloud 서비스는 적합한 서비스 계정에 Error Reporting 작성자 역할 (roles/errorreporting.writer)을 자동으로 부여합니다. 하지만 일부 서비스의 경우에는 사용자가 적합한 서비스 계정에 이 역할을 부여해야 합니다.

Cloud Run 및 Cloud Run Functions

Cloud Run에서 사용하는 기본 서비스 계정에는 Error Reporting 작성자 역할 (roles/errorreporting.writer) 권한이 있습니다.

라이브러리의 Google.Cloud.Diagnostics 집합은 명시적으로 사용자 인증 정보를 제공하지 않아도 사용 가능합니다.

Cloud Run은 Error Reporting을 사용하도록 자동으로 구성됩니다. 처리되지 않은 JavaScript 예외는 Logging에 나타나고 라이브러리의 Google.Cloud.Diagnostics 집합을 사용하지 않아도 Error Reporting에서 처리합니다.

App Engine 가변형 환경

App Engine은 기본 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)을 자동으로 부여합니다.

라이브러리의 Google.Cloud.Diagnostics 집합은 명시적으로 사용자 인증 정보를 제공하지 않아도 사용 가능합니다.

Error Reporting은 App Engine 가변형 환경 애플리케이션에서 자동으로 사용 설정되며 추가 설정은 필요하지 않습니다. App Engine에서 stderr로 작성된 메시지가 분석되고 스택 trace가 포함되어 있으면 Error Reporting에 표시됩니다.

Google Cloud 콘솔에서 애플리케이션의 오류 및 예외 데이터를 보는 방법에 대한 안내는 오류 보기를 참고하세요.

Google Kubernetes Engine

Google Kubernetes Engine에 Error Reporting를 사용하려면 다음을 수행합니다.

1. 컨테이너에 사용할 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)이 부여되었는지 확인합니다.

   Compute Engine 기본 서비스 계정 또는 커스텀 서비스 계정을 사용할 수 있습니다.

   역할 부여에 대한 상세 설명은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

2. 클러스터를 만들고 클러스터에 cloud-platform 액세스 범위를 부여합니다.

   예를 들어 다음 create 명령어는 cloud-platform 액세스 범위와 서비스 계정을 지정합니다.

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Compute Engine

Compute Engine VM 인스턴스에 Error Reporting을 사용하려면 다음을 수행합니다.

1. VM 인스턴스에 사용할 서비스 계정에 Error Reporting 작성자 역할(roles/errorreporting.writer)이 부여되었는지 확인합니다.

   Compute Engine 기본 서비스 계정 또는 커스텀 서비스 계정을 사용할 수 있습니다.

   역할 부여에 대한 상세 설명은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

2. Google Cloud 콘솔에서 VM 인스턴스 페이지로 이동합니다.

   VM 인스턴스로 이동

   검색창을 사용하여 이 페이지를 찾은 경우 부제목이 Compute Engine인 결과를 선택합니다.

3. cloud-platform 액세스 범위를 지정하려는 VM 인스턴스를 선택합니다.

4. 중지를 클릭한 후 수정을 클릭합니다.

5. ID 및 API 액세스 섹션에서 Error Reporting 작성자 역할(roles/errorreporting.writer)이 있는 서비스 계정을 선택합니다.

6. 액세스 범위 섹션에서 모든 Cloud API에 대한 전체 액세스 허용을 선택한 후 변경사항을 저장합니다.

7. 시작/재개를 클릭합니다.

예시

자세한 내용과 예시는 다음 리소스를 참조하세요.

4. Google.Cloud.Diagnostics.AspNetCore3 문서
5. Google.Cloud.Diagnostics.AspNetCore 문서
6. Google.Cloud.Diagnostics.Common 문서

로컬 개발 환경에서 앱 실행

자체 워크스테이션에서 라이브러리를 실행하는 것과 같이 로컬 개발 환경에서 라이브러리의 Google.Cloud.Diagnostics 집합을 사용하려면 라이브러리의 Google.Cloud.Diagnostics 집합에 로컬 애플리케이션 기본 사용자 인증 정보를 제공해야 합니다. 자세한 내용은 Error Reporting에 인증을 참조하세요.

로컬 개발 환경에서 이 페이지의 .NET 샘플을 사용하려면 gcloud CLI를 설치하고 초기화한 후 사용자 인증 정보로 애플리케이션 기본 사용자 인증 정보를 설정합니다.

Google Cloud CLI를 설치합니다.

외부 ID 공급업체(IdP)를 사용하는 경우 먼저 제휴 ID로 gcloud CLI에 로그인해야 합니다.

If you're using a local shell, then create local authentication credentials for your user account:

gcloud auth application-default login

You don't need to do this if you're using Cloud Shell.

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

자세한 내용은 다음을 참조하세요: Set up authentication for a local development environment.

projects.events.report 메서드는 또한 API 키를 지원합니다. 인증에 API 키를 사용하려는 경우 로컬 애플리케이션 기본 사용자 인증 정보 파일을 설정할 필요가 없습니다. 자세한 내용은 다음을 참조하세요: Google Cloud 인증 문서의 API 키 만들기

오류 보고서 보기

Google Cloud 콘솔에서 Error Reporting 페이지로 이동합니다.

Error Reporting으로 이동

검색창을 사용하여 이 페이지를 찾을 수도 있습니다.

자세한 내용은 오류 보기를 참조하세요.