Python용 Cloud Logging 설정

표준 Python 로깅 핸들러를 사용하거나 Python용 Cloud Logging API 클라이언트 라이브러리를 직접 사용하여 Python 애플리케이션에서 Cloud Logging에 로그를 작성할 수 있습니다. 표준 Python 로깅 핸들러를 사용할 때는 Cloud Logging 핸들러를 Python 루트 핸들러에 연결해야 합니다. 이 문서에서는 이 접근 방식을 설명합니다.

시작하기 전에

1. 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.

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

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

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

4. Enable the Cloud Logging API.

   Enable the API

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

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

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

7. Enable the Cloud Logging API.

   Enable the API

8. Python 개발 환경을 준비합니다.

   Python 설정 가이드로 이동

라이브러리 설치

Python용 Cloud Logging 라이브러리를 설치하려면 Python용 클라이언트 라이브러리 설치를 참조하세요. 이 라이브러리를 사용하면 Cloud Logging 핸들러를 표준 Python 루트 핸들러에 연결할 수 있습니다. 이 라이브러리를 사용하여 API 요청을 Cloud Logging에 보낼 수도 있습니다.

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

표준 Python 로깅 핸들러로 로그 작성

표준 Python 루트 핸들러로 작성된 모든 로그 항목을 Cloud Logging으로 전송하려면 다음을 수행합니다.

1. setup_logging 메서드를 호출하여 Python 루트 로거에 Cloud Logging 핸들러를 연결합니다.

   # Imports the Cloud Logging client library
   import google.cloud.logging
   
   # Instantiates a client
   client = google.cloud.logging.Client()
   
   # Retrieves a Cloud Logging handler based on the environment
   # you're running in and integrates the handler with the
   # Python logging module. By default this captures all logs
   # at INFO level and higher
   client.setup_logging()

   로깅 핸들러를 구성하는 방법에 대한 자세한 내용은 로깅 표준 라이브러리와 통합을 참조하세요.

   setup_logging 함수의 매개변수에 관한 자세한 내용은 Cloud Logging 클라이언트로 이동하여 setup_logging을 검색하세요. 예를 들어 이 페이지에서는 로깅 수준을 구성하는 방법을 설명합니다.

2. Python 루트 로거를 사용하여 로그 데이터를 작성합니다.

   # Imports Python standard library logging
   import logging
   
   # The data to log
   text = "Hello, world!"
   
   # Emits the data using the standard logging module
   logging.warning(text)

   기본적으로 애플리케이션에서 작성한 심각도 수준이 INFO 이상인 모든 로그는 Cloud Logging으로 전송됩니다.

   메시지가 App Engine 또는 Google Kubernetes Engine에서 Logging으로 기록되면 핸들러가 이 메시지를 해당 환경의 각 리소스 유형으로 전송합니다. 그렇지 않으면 로그는 Global 리소스 유형의 python 로그 아래에 나열됩니다.

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

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

Google Cloud에서 실행

애플리케이션에서 Python용 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 인스턴스에서 Python용 Cloud Logging 라이브러리를 사용하기 위해 Cloud Logging 에이전트를 설치할 필요는 없습니다.

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

로컬 및 기타 위치에서 실행

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

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

1. 서비스 계정에 로그 작성자(roles/logging.logWriter) IAM 역할을 부여합니다. IAM 역할에 대한 자세한 내용은 액세스 제어를 참조하세요.

2. 애플리케이션 기본 사용자 인증 정보를 설정합니다.

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

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

로그 보기

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. 고급 쿼리 모드로 전환하려면 로그 탐색기 상단의 메뉴(▾)를 클릭한 다음 고급 필터로 전환을 선택합니다.
  2. 필터 상자에 포함된 내용을 지웁니다.
  3. 필터 제출을 클릭합니다.

  개별 항목을 검사하여 리소스를 파악할 수 있습니다.

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