Error Reporting용 Ruby 앱 계측

Ruby용 Error Reporting 라이브러리를 사용하여 Ruby 애플리케이션에서 Error Reporting으로 오류 보고서를 보낼 수 있습니다.

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

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

시작하기 전에

Google Cloud 계정에 로그인합니다. Google Cloud를 처음 사용하는 경우 계정을 만들고 Google 제품의 실제 성능을 평가해 보세요. 신규 고객에게는 워크로드를 실행, 테스트, 배포하는 데 사용할 수 있는 $300의 무료 크레딧이 제공됩니다.

Google Cloud Console의 프로젝트 선택기 페이지에서 Google Cloud 프로젝트를 선택하거나 만듭니다.

프로젝트 선택기로 이동

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

Error Reporting API 사용 설정

API 사용 설정

Google Cloud Console의 프로젝트 선택기 페이지에서 Google Cloud 프로젝트를 선택하거나 만듭니다.

프로젝트 선택기로 이동

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

Error Reporting API 사용 설정

API 사용 설정

Ruby 2.2+ 이상을 설치합니다.

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

Ruby용 Error Reporting 라이브러리를 사용하면 거의 모든 곳에서 실행되는 Ruby 애플리케이션에서 보고된 오류를 모니터링하고 볼 수 있습니다.

google-cloud-error_reporting gem을 Gemfile에 추가합니다.
```
gem "google-cloud-error_reporting"
```
번들러를 사용해 Gem을 설치합니다.
```
bundle install
```

라이브러리 사용 설정

Ruby on Rails를 사용하고 있는 경우, 번들러가 시작되면 자동으로 라이브러리를 애플리케이션에 로드합니다.

다른 랙 기반 애플리케이션은 라이브러리가 제공하는 랙 미들웨어를 사용할 수 있습니다.

GitHub에서 보기 의견 보내기

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

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

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

Ruby용 Error Reporting 라이브러리 동작을 맞춤설정할 수 있습니다. 가능한 구성 옵션 목록은 라이브러리 구성을 참조하세요.

오류 보고

랙 기반 프레임워크의 오류 보고

Ruby용 Error Reporting 라이브러리를 사용하면 Error Reporting을 Ruby on Rails 및 Sinatra와 같은 인기 있는 랙 기반 Ruby 웹 프레임워크에 쉽게 통합할 수 있습니다. 라이브러리를 사용 설정하면 랙 스택에서 캡처된 예외를 자동으로 보고합니다.

수동으로 오류 보고

다음 예시와 같이 report 메서드를 호출하여 오류를 수동으로 보고할 수 있습니다.

GitHub에서 보기 의견 보내기

require "google/cloud/error_reporting"

begin
  raise "Something went wrong"
rescue StandardError => e
  Google::Cloud::ErrorReporting.report e
end

Google Cloud에서 실행

Ruby용 Error Reporting 라이브러리를 사용하려면 ID 및 액세스 관리 Error Reporting 작성자 역할이 필요합니다. 대부분의 Google Cloud 컴퓨팅 플랫폼은 기본적으로 이 역할을 제공합니다.

다음 Google Cloud 환경에서 Ruby용 Error Reporting을 구성할 수 있습니다.

App Engine 가변형 환경

App Engine은 기본적으로 Error Reporting 작성자 역할을 부여합니다.

Ruby용 Error Reporting 라이브러리는 명시적으로 사용자 인증 정보를 제공하지 않아도 사용 가능합니다.

Error Reporting은 App Engine 가변형 환경 애플리케이션에서 자동으로 사용 설정되며 추가 설정은 필요하지 않습니다.

Google Kubernetes Engine

GKE에서는 다음 예시 명령어에 표시된 것처럼 클러스터를 만들 때 cloud-platform 액세스 범위를 추가해야 합니다.

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

Compute Engine VM 인스턴스를 사용할 때 각 인스턴스에 cloud-platform 액세스 범위를 추가합니다. Google Cloud Console을 통해 새 인스턴스를 만들 때 인스턴스 만들기 패널의 ID 및 API 액세스 섹션에서 이 작업을 수행할 수 있습니다. 선택한 Compute Engine 기본 서비스 계정 또는 다른 서비스 계정을 사용하고 ID 및 API 액세스 섹션에서 모든 Cloud API에 대한 전체 액세스 허용을 선택하세요. 어떤 서비스 계정을 선택하든 Google Cloud console의 IAM 및 관리자 섹션에서 Error Reporting 작성자 역할이 부여되었는지 확인하세요.

로컬 및 기타 위치에서 실행

자체 워크스테이션, 데이터 센터의 컴퓨터 또는 다른 클라우드 제공업체의 VM 인스턴스에서 라이브러리를 실행하는 경우와 같이 Google Cloud 외부에서 Ruby용 Error Reporting 라이브러리를 사용하려면 Ruby용 Error Reporting 라이브러리에 직접 Google Cloud 프로젝트 ID와 적절한 서비스 계정 사용자 인증 정보를 제공해야 합니다.

서비스 계정 사용자 인증 정보를 수동으로 만들고 가져올 수 있습니다. 역할 필드를 지정할 때 Error Reporting 작성자 역할을 사용하세요. ID 및 액세스 관리 역할에 대한 자세한 내용은 액세스 제어 가이드를 참조하세요.

Ruby on Rails 구성 인터페이스 사용

Ruby on Rails 프레임워크에서 Ruby용 Error Reporting 라이브러리를 사용하려면 Ruby on Rails 구성 인터페이스를 통해 매개변수를 제공하세요.

GitHub에서 보기 의견 보내기

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

또한 다음을 사용하여 모든 Stackdriver Gem에 대한 공유 구성을 설정할 수 있습니다.

GitHub에서 보기 의견 보내기

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

Error Reporting은 Rails가 프로덕션 모드에서 실행하는 경우 기본적으로 사용 설정됩니다. 개발 모드에서 Error Reporting을 사용 설정하려면 다음을 추가하세요.

GitHub에서 보기 의견 보내기

# Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

계측 구성 인터페이스 사용

다른 랙 기반 애플리케이션에서 Ruby용 Error Reporting 라이브러리를 사용하려면 구성 인터페이스를 통해 매개변수를 제공하세요.

GitHub에서 보기 의견 보내기

require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

또한 다음을 사용하여 모든 Google Cloud 작업 제품군 gem에 공유 구성을 설정할 수 있습니다.

GitHub에서 보기 의견 보내기

require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

오류 보고서 보기

Google Cloud 콘솔에서 Error Reporting을 선택하거나 다음 버튼을 클릭한 후 프로젝트를 선택합니다.

Error Reporting으로 이동

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