Ruby용 Cloud Logging 설정

Ruby용 Cloud 라이브러리를 사용하거나 Ruby용 Cloud Logging Cloud 클라이언트 라이브러리를 직접 사용하여 Ruby 애플리케이션에서 Cloud Logging에 로그를 작성할 수 있습니다.

Compute Engine VM 인스턴스에서 Ruby용 Cloud Logging 라이브러리를 사용하기 위해 Cloud 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

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Logging 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

Make sure that billing is enabled for your Google Cloud project.

Enable the Cloud Logging API.

Enable the API

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

라이브러리 설치

Google은 Ruby용 Cloud Logging 라이브러리를 제공합니다. 이 라이브러리를 사용하면 랙 기반 Ruby 웹 프레임워크에 사용하기 쉬운 로거를 구현할 수 있습니다.

Google Cloud Observability gem을 Gemfile에 추가합니다.
```
gem "stackdriver"
```
번들러를 사용해 Gem을 설치합니다.
```
bundle install
```

라이브러리 사용 설정

Ruby on Rails를 사용하면 시작할 때 번들러가 자동으로 라이브러리를 애플리케이션에 로드하며, 이때 기본 Rails.logger는 Cloud Logging 로거의 인스턴스로 설정됩니다.

다른 랙 기반 애플리케이션은 사용자의 웹 프레임워크가 랙 로거를 지원할 경우 랙 미들웨어를 사용하여 랙 로거를 Cloud Logging 로거로 바꿀 수 있습니다.

require "google/cloud/logging"

use Google::Cloud::Logging::Middleware

라이브러리 구성

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

Cloud Logging 로거 사용

Ruby용 Cloud Logging 라이브러리가 사용 설정되면 애플리케이션에서 로거를 사용할 수 있습니다.

logger.info "Hello World!"
logger.error "Oh No!"

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

Cloud Logging 클라이언트 라이브러리로 로그 작성

Ruby용 Cloud Logging 클라이언트 라이브러리를 사용하는 방법은 Cloud Logging 클라이언트 라이브러리를 참조하세요.

Google Cloud에서 실행

애플리케이션에서 Ruby용 Cloud Logging 라이브러리를 사용하여 로그를 작성하려면 기본 리소스의 서비스 계정에 로그 작성자(roles/logging.logWriter) IAM 역할이 있어야 합니다. 대부분의 Google Cloud 환경에서는 이 역할을 갖도록 기본 서비스 계정을 자동으로 구성합니다.

App Engine

Cloud Logging은 App Engine에 자동으로 사용 설정되며 앱의 기본 서비스 계정에는 기본적으로 로그 항목을 쓸 수 있는 IAM 권한이 있습니다.

자세한 내용은 로그 작성 및 보기를 참조하세요.

Google Kubernetes Engine(GKE)

GKE에서는 기본 서비스 계정에 로그 작성자(roles/logging.logWriter) IAM 역할을 자동으로 부여합니다. 이 기본 서비스 계정과 함께 GKE용 워크로드 아이덴티티 제휴를 사용하여 워크로드가 특정 Google Cloud API에 액세스할 수 있도록 하면 추가 구성이 필요하지 않습니다. 그러나 커스텀 IAM 서비스 계정과 함께 GKE용 워크로드 아이덴티티 제휴를 사용하는 경우 커스텀 서비스 계정에 로그 작성자 역할(roles/logging.logWriter)이 있어야 합니다.

필요한 경우 클러스터를 만들 때 다음 명령어를 사용하여 logging.write 액세스 범위를 추가할 수 있습니다.

gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

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

로컬 및 기타 위치에서 실행

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

기존 서비스 계정의 경우 다음을 수행합니다.

서비스 계정에 로그 작성자(roles/logging.logWriter) IAM 역할을 부여합니다. IAM 역할에 대한 자세한 내용은 액세스 제어를 참조하세요.
애플리케이션 기본 사용자 인증 정보를 설정합니다.

서비스 계정이 없으면 서비스 계정을 만듭니다. 이 프로세스에 대한 자세한 내용은 서비스 계정 만들기를 참조하세요.

인증에 사용할 수 있는 방법에 대한 일반적인 내용은 용어: 서비스 계정을 참조하세요.

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

Ruby on Rails 프레임워크를 사용할 경우, Ruby on Rails 구성 인터페이스를 통해 매개변수를 제공합니다.

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

다음을 사용하여 모든 Google Cloud Observability gem에 대한 공유 구성을 설정할 수도 있습니다.

# 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

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

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

계측 구성 인터페이스 사용:

다른 랙 기반 애플리케이션에서 사용할 경우, 구성 인터페이스를 통해 매개변수를 제공합니다.

require "google/cloud/logging"

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

다음을 사용하여 모든 Google Cloud Observability gem에 대한 공유 구성을 설정할 수도 있습니다.

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 콘솔에서 로그 탐색기 페이지로 이동합니다.

로그 탐색기로 이동

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

로그 탐색기에서 리소스를 하나 이상 지정해야 하지만 어떤 리소스를 선택해야 할지 애매할 수 있습니다. 다음은 시작하는 데 도움이 되는 몇 가지 유용한 팁입니다.

애플리케이션을 App Engine에 배포하거나 App Engine 관련 라이브러리를 사용하는 경우 리소스를 GAE 애플리케이션으로 설정합니다.
애플리케이션을 Compute Engine에 배포하는 경우 리소스를 GCE VM 인스턴스로 설정합니다.
애플리케이션을 Google Kubernetes Engine에 배포하는 경우 클러스터의 로깅 구성에 따라 로그 항목의 리소스 유형이 결정됩니다. 기존 Google Cloud Observability 및 Google Cloud Observability Kubernetes Monitoring 솔루션에 대한 자세한 내용과 이러한 옵션이 리소스 유형에 미치는 영향을 알아보려면 Google Cloud Observability Kubernetes Monitoring으로 마이그레이션을 참조하세요.
애플리케이션에서 Cloud Logging API를 직접 사용하는 경우 API와 구성에 따라 리소스가 달라집니다. 예를 들어 애플리케이션에서 리소스를 지정하거나 기본 리소스를 사용할 수 있습니다.
로그 탐색기에 어떤 로그도 표시되지 않는 경우 모든 로그 항목을 보려면 고급 쿼리 모드로 전환하여 비어 있는 쿼리를 사용합니다.
1. 고급 쿼리 모드로 전환하려면 로그 탐색기 상단의 메뉴(&blacktriangledown;)를 클릭한 다음 고급 필터로 전환을 선택합니다.
2. 필터 상자에 포함된 내용을 지웁니다.
3. 필터 제출을 클릭합니다.
개별 항목을 검사하여 리소스를 파악할 수 있습니다.

자세한 내용은 로그 탐색기 사용을 참조하세요.