Google Stackdriver Debug, Trace, Logging, Logpoints 사용하기

이 튜토리얼에서는 Google Stackdriver를 둘러보며 Google Cloud Platform 애플리케이션으로 다음 작업을 수행하는 방법을 알아봅니다.

  • App Engine, Compute Engine, Container Engine에서 실행되는 애플리케이션에서 디버그 스냅샷을 만듭니다.
  • 애플리케이션 로그 보기
  • 측정항목을 설정하고, 모니터링하고, 알림을 받습니다.
  • API 호출을 추적하고 응답 시간과 코드의 잠재적인 병목 현상에 관한 세부정보를 확인하세요.
  • 앱을 배포하지 않고도 실행 중인 애플리케이션에 로그 지점 추가. 이는 정말 독특하고 유용한 기능입니다.

이 튜토리얼에서는 처음부터 다음 작업을 수행합니다.

  1. Google Cloud Platform 프로젝트 만들기 (특히 App Engine)
  2. Google Cloud Platform 프로젝트 소스 저장소 설정
  3. GitHub에서 제공되는 표준 방명록 Python 애플리케이션 소스 활용
  4. 코드 배포
  5. 실행 중인 애플리케이션의 디버그 스냅샷을 가져오는 방법 알아보기
  6. 로깅 및 애플리케이션 호출 추적 살펴보기
  7. 현재 실행 중인 애플리케이션에 로그 지점을 추가합니다. 이 기능은 처음 이 블로그 게시물(다시 시작하지 않고 애플리케이션에 애플리케이션 로그 추가하기)에서 다루었습니다.

이제 시작해 볼까요?

이 콘텐츠는 원래 로민 이라니가 만들었으며 여기에 게시되었습니다.

자습형 환경 설정

아직 Google 계정 (Gmail 또는 Google Apps)이 없으면 계정을 만들어야 합니다. Google Cloud Platform 콘솔 (console.cloud.google.com)에 로그인하고 새 프로젝트를 만듭니다.

Screenshot from 2016-02-10 12:45:26.png

모든 Google Cloud 프로젝트에서 고유한 이름인 프로젝트 ID를 기억하세요(위의 이름은 이미 사용되었으므로 사용할 수 없습니다). 이 ID는 나중에 이 Codelab에서 PROJECT_ID라고 부릅니다.

그런 다음 Google Cloud 리소스를 사용할 수 있도록 Cloud 콘솔에서 결제를 사용 설정해야 합니다.

이 codelab을 실행하는 과정에는 많은 비용이 들지 않지만 더 많은 리소스를 사용하려고 하거나 실행 중일 경우 비용이 더 들 수 있습니다(이 문서 마지막의 '삭제' 섹션 참조).

Google Cloud Platform 신규 사용자는 $300 상당의 무료 체험판을 사용할 수 있습니다.

Google Cloud Shell

이 Codelab에서는 클라우드에서 실행되는 명령줄 환경인 Google Cloud Shell을 사용합니다.

이 Debian 기반 가상 머신에는 필요한 모든 개발 도구가 로드되어 있습니다. 영구적인 5GB 홈 디렉토리를 제공하고 Google Cloud에서 실행되므로 네트워크 성능과 인증이 크게 개선됩니다. 즉, 이 Codelab에 필요한 것은 브라우저뿐입니다(Chromebook에서도 작동 가능).

Google Cloud Shell을 활성화하려면 개발자 콘솔에서 오른쪽 상단의 버튼을 클릭합니다. 환경을 프로비저닝하고 연결하는 데 몇 분 정도만 소요됩니다.

activateCloudShell.png

그런 다음 서비스 약관에 동의하고 'Cloud Shell 시작' 링크를 클릭합니다.

x.png

Screen Shot 2017-06-14 at 10.13.43 PM.png

Cloud Shell에 연결되면 인증이 완료되었고 프로젝트가 내 PROJECT_ID로 설정되어 있음을 확인할 수 있습니다.

gcloud auth list

명령어 결과

Credentialed accounts:
 - <myaccount>@<mydomain>.com (active)
gcloud config list project

명령어 결과

[core]
project = <PROJECT_ID>

어떤 이유로든 프로젝트가 설정되지 않았으면 다음 명령어를 실행하면 됩니다.

gcloud config set project <PROJECT_ID>

PROJECT_ID를 찾고 계신가요? 설정 단계에서 사용한 ID를 확인하거나 콘솔 대시보드에서 확인하세요.

Project_ID.png

중요: 마지막으로 기본 영역 및 프로젝트 구성을 설정합니다.

gcloud config set compute/zone us-central1-f

다양한 영역을 선택할 수 있습니다. 리전 및 영역 문서에서 자세히 알아보세요.

사용 설정된 StackDriver API 확인

프로젝트에 사용 설정된 API를 살펴보겠습니다. 아래와 같이 검색창을 사용하여 API 대시보드를 찾습니다.

프로젝트에 사용 설정된 특정 API를 확인합니다.

모든 Google Cloud Platform 프로젝트는 비공개 Git 호스팅을 제공하지만 먼저 작업할 기본 저장소를 만들어야 합니다. 콘솔 검색창을 사용하여 소스 저장소로 이동합니다.

'저장소 만들기'를 클릭하여 'default'라는 새 코드 저장소를 만듭니다.

이제 Cloud Shell을 사용하여 이 디렉터리를 Google Cloud Shell 인스턴스로 클론합니다. 이를 위해 먼저 Google Cloud Shell 인스턴스에서 디렉터리를 만들고 아래와 같이 해당 디렉터리로 이동합니다 (샘플 출력).

mkdir stackdriver-demo
cd stackdriver-demo/

이제 아래와 같이 gcloud 명령어를 통해 기본 저장소를 클론할 수 있습니다.

gcloud source repos clone default

콘솔에 다음과 같은 결과가 표시됩니다.

Cloning into '/home/gcp123_student/default'...
warning: You appear to have cloned an empty repository.
Project [qwiklabs-gcp-1234abc1234] repository [default] was cloned to [/home/gcp123_student/default].

좋습니다. 설정된 Git 원격 저장소를 잠시 자세히 살펴보겠습니다. 반드시 필요한 것은 아니지만 백그라운드에서 어떤 일이 일어났는지 더 잘 이해할 수 있도록 하기 위한 것입니다.

생성된 기본 디렉터리로 이동하여 아래와 같이 git remote -v 명령어를 실행합니다.

cd default
git remote -v

콘솔에 다음과 비슷한 결과가 표시됩니다.

origin https://source.developers.google.com/p/qwiklabs-gcp-1234abc1234/r/default (fetch)
origin https://source.developers.google.com/p/qwiklabs-gcp-1234abc1234/r/default (push)

이 경로가 GCP 프로젝트와 연결된 Git 저장소를 올바르게 가리키는 것을 확인할 수 있습니다.

GitHub에서 방명록 애플리케이션 가져오기

사용할 애플리케이션은 게스트북이라는 표준 App Engine 애플리케이션이며 공식 Google Cloud Platform GitHub 저장소에서 사용할 수 있습니다. 이 애플리케이션은 시작하기 위한 공식 문서에도 포함되어 있습니다. GitHub 프로젝트는 https://github.com/GoogleCloudPlatform/appengine-guestbook-python에서 확인할 수 있습니다.

이제 이 코드를 Cloud Shell 인스턴스로 가져옵니다. 명령어와 출력은 다음과 같습니다.

git pull https://github.com/GoogleCloudPlatform/appengine-guestbook-python

콘솔에 다음과 같은 결과가 표시됩니다.

remote: Counting objects: 485, done.
remote: Total 485 (delta 0), reused 0 (delta 0), pack-reused 485
Receiving objects: 100% (485/485), 436.42 KiB | 163.00 KiB/s, done.
Resolving deltas: 100% (195/195), done.
From https://github.com/GoogleCloudPlatform/appengine-guestbook-python
* branch HEAD -> FETCH_HEAD

이제 Google Cloud Shell 인스턴스에 모든 코드가 로컬로 있습니다. GitHub 프로젝트에서 가져온 다양한 파일을 확인할 수 있습니다.

Cloud Shell을 사용하여 현재 코드를 프로젝트 Git 저장소에 푸시

이제 이 코드를 GCP 프로젝트 Git 저장소에 푸시하여 코드에 중단점, 로그 포인트 등을 설정할 수 있습니다. 소스 코드를 연결하는 다른 방법(예: GitHub, 로컬 머신)을 통해 직접 통합할 수 있으므로 이 단계는 필수가 아닙니다.

하지만 여기서는 이 코드를 GCP 프로젝트 Git 저장소에 푸시합니다. 이는 아래와 같이 표준 git push 명령어를 통해 실행됩니다.

git push origin master

콘솔에 다음과 같은 결과가 표시됩니다.

Counting objects: 485, done.
Compressing objects: 100% (280/280), done.
Writing objects: 100% (485/485), 436.42 KiB | 0 bytes/s, done.
Total 485 (delta 195), reused 485 (delta 195)
remote: Storing objects: 100% (485/485), done.
remote: Processing commits: 100% (152/152), done.
To https://source.developers.google.com/p/qwiklabs-gcp-1234abc1234/r/default
* [new branch] master -> master

이제 GCP Cloud Console의 개발 섹션으로 돌아갑니다. 소스 코드를 클릭하면 기본 저장소의 모든 프로젝트 파일을 볼 수 있습니다. 샘플 출력은 다음과 같습니다.

이제 방명록 App Engine 애플리케이션을 배포할 준비가 되었습니다. 앱을 배포하려면 Google Cloud Shell에 있고 기본 디렉터리에 있는지 확인하세요. 아래와 같이 gcloud app deploy 명령어를 사용합니다.

gcloud app deploy --version 1

리전을 선택하라는 메시지가 표시되면 [1] us-east1을 선택합니다.

콘솔에 다음과 같은 결과가 표시됩니다.

You are about to deploy the following services:
— qwiklabs-gcp-1234abc1234/default/1 (from [/home/gcp123-student/default/app.yaml])
Deployed URL: [https://qwiklabs-gcp-1234abc1234.appspot.com]
Do you want to continue (Y/n)? Y
Beginning deployment of service [default]...
File upload done.
Updating service [default]...done.
Deployed service [default] to https://qwiklabs-gcp-1234abc1234.appspot.com]

앱 배포 명령어에 버전 매개변수를 제공했습니다. "1" 값을 지정했습니다.

게스트북 애플리케이션은 영속성을 위해 Google Cloud Datastore를 사용하므로 Datastore 색인을 업데이트해야 합니다. 색인은 index.yaml 파일에 지정되어 있으며 아래와 같이 gcloud datastore create-indexes 명령어를 사용하기만 하면 됩니다.

gcloud datastore create-indexes index.yaml

콘솔에 다음과 같은 결과가 표시됩니다.

You are about to update the following configurations:
— qwiklabs-gcp-1234abc1234/index From: [/home/gcp123_student/default/index.yaml]
Do you want to continue (Y/n)? Y

Datastore 색인을 업데이트하는 데 시간이 걸릴 수 있습니다. 상태를 확인하려면 'Datastore 색인'을 검색하고 색인을 클릭합니다. 색인이 빌드되는 동안 아래와 같이 값이 '색인 생성'인 상태가 표시됩니다.

Compute → App Engine으로 이동한 다음 아래와 같이 Versions를 클릭하여 버전 1이 있는 앱이 배포되어 사용 가능한지 확인할 수 있습니다.

이제 모든 것이 제대로 표시되며 https://<PROJECT_ID>.appspot.com로 이동하여 프로젝트를 확인할 수 있습니다. 데이터 스토어 색인이 준비되는 데 몇 분 정도 걸릴 수 있으므로 애플리케이션에서 오류 (예: 내부 서버 오류)가 표시되면 몇 분 후에 다시 시도해 보세요.

이제 아래와 같이 로그인하고 방명록 항목을 몇 개 만들어 애플리케이션을 사용해 보겠습니다.

좋습니다. 이제 Stackdriver 기능을 살펴볼 준비가 되었습니다.

먼저 실행 중인 애플리케이션의 스냅샷을 찍는 방법을 살펴보겠습니다. 스냅샷은 특정 코드 조각을 디버그하고 변수 등을 검사하려는 경우에 유용합니다. 이 모든 작업은 애플리케이션이 계속 제공되는 동안 이루어집니다. 이는 애플리케이션에 문제가 있다는 신고를 받고 디버그하여 앱에서 어떤 일이 일어나고 있는지 확인하고, 여러 변수를 검사하고, 조건부로 스냅샷을 찍는 등의 작업을 하려는 경우에 매우 유용합니다.

이제 방명록 애플리케이션에 대해 이 작업을 수행해 보겠습니다. 누군가 홈페이지를 요청하면 스냅샷을 요청할 것입니다. 특히 현재 Datastore에 있는 인사말 목록을 가져오는 스냅샷을 원합니다.

이 코드는 guestbook.py 파일에 있습니다. 특히 데이터 저장소에서 인사말 목록을 가져온 후 런타임에 코드를 검사하는 데 관심이 있습니다. 72번 줄에서 이 작업이 실행됩니다. 따라서 72번이 실행되었음을 알 수 있도록 74번 줄에 중단점을 배치하면 됩니다.

이렇게 하려면 AppEngine 버전 보기에서 '디버그'를 클릭하거나 Stackdriver → 디버그로 이동합니다 . 그러면 아래와 같은 화면이 표시됩니다. 왼쪽에서 파일 (guestbook.py)을 선택한 다음 표시된 대로 줄 번호를 클릭하면 됩니다.

그러면 스냅샷이 트리거되기를 기다리고 있다는 메시지가 위의 빨간색 상자에 강조 표시됩니다. 이제 다음 주소에서 페이지를 방문하기만 하면 됩니다.

https://<PROJECT_ID>.appspot.com.

이렇게 하면 스냅샷이 활성화되고 아래와 같이 변수 및 호출 스택 섹션이 채워집니다. 변수가 표시되는 방식을 확인하고 변수를 펼쳐 값을 확인할 수 있습니다. 이 기능은 매우 유용합니다.

예를 들어 인사말 변수를 펼치면 생성한 게스트북 항목 수에 해당하는 레코드가 표시됩니다.

매우 유용한 기능 중 하나는 언제든지 스냅샷을 다시 찍을 수 있다는 것입니다. 언제든지 카메라 아이콘을 클릭하면 아래와 같이 스냅샷이 다시 표시됩니다.

아래와 같이 '표현식' 필드를 사용하여 특정 변수를 추적할 수 있습니다. 예를 들어 인사말이라는 변수가 있고 스냅샷이 발생한 순간의 값을 검사하고 싶다고 가정해 보겠습니다. 아래 스크린샷과 같이 인사말 변수를 입력할 수 있습니다. 스냅샷이 조회되면 표시된 값으로 채워집니다.

특정 조건에서만 스냅샷을 활성화하려면 아래와 같이 조건 필드를 사용하면 됩니다. 여기서는 인사말 수가 1보다 큰 경우에만 스냅샷이 발생해야 한다고 말합니다. 원하는 경우 이 기능을 실험해 보세요.

웹 애플리케이션 성능이 설정한 요구사항을 충족하는지 확인하는 것이 매우 중요합니다. Stackdriver Trace는 애플리케이션의 지연 시간을 파악하는 데 도움이 되는 주요 도구입니다.

모든 App Engine 애플리케이션에 기본적으로 사용 설정되어 있으며, 다양한 호출에 대한 분석과 함께 모든 엔드포인트에 대한 매우 유용한 성능 세부정보를 제공합니다.

이 경우 홈페이지 ('/')를 방문하고 방명록 항목을 보고 추가했습니다. 이를 통해 추적에서 지연 시간에 관해 자세히 알려줄 수 있습니다. Stackdriver 트레이스 개요로 이동하면 아래와 같은 스크린샷이 표시됩니다. 최근 트레이스와 지연 시간을 확인합니다.

추적 중 하나를 클릭하면(URI 링크 클릭) 아래와 같이 자세한 추적이 표시됩니다.

지연 시간과 가장 많은 시간을 차지하는 호출을 분류할 수 있습니다. 위 시각화에서 데이터 스토어 쿼리에 시간이 걸리는 것을 확인할 수 있습니다. 데이터를 캐싱하여 병목 현상을 줄이는 방법을 고려해 볼 수 있습니다. 이 모든 것은 애플리케이션에 따라 다르며, 호출 추적에서 리팩터링이 필요할 수 있는 영역을 확인하는 데 매우 유용합니다.

아래와 같이 Stackdriver Logging으로 이동하여 언제든지 애플리케이션 로그를 볼 수 있습니다. 다양한 GCP 서비스 → 로그 유형 → 로그 수준 → 날짜 등에서 시작하는 여러 필터를 사용할 수 있습니다.

아래 스크린샷은 App Engine 애플리케이션의 로그와 기본 버전 1을 보여줍니다.

logging.png

마지막으로, Gemini가 제공하는 가능성에 대해 흥미를 느낄 수 있는 기능을 살펴보겠습니다. 일반적으로 개발자는 코드에 로그 문을 넣고 코드를 배포한 다음 로그가 원하는 모든 정보를 알려주기를 바랍니다.

하지만 이것만으로는 충분하지 않으며 디버깅을 통해서만 여기저기에 로그 문을 몇 개 더 넣었어야 했다는 것을 알 수 있습니다. 일반적인 워크플로는 코드를 수정하고, 추가 로그 문을 넣고, 다시 배포하고, 모니터링하는 것입니다.

이 방법도 괜찮지만 실행 중인 애플리케이션에 이러한 로그 문 (이제 로그 포인트라고 함)을 추가할 수 있다면 어떨까요? 즉, 애플리케이션을 중지하고 코드를 변경하고 재배포하는 과정을 거치지 않아도 됩니다. 대신 로그포인트 지원을 사용하여 애플리케이션 외부에서 로그포인트 목록을 관리할 수 있습니다.

Cloud Shell에서 구성한 현재 로그포인트 목록을 확인합니다 (0이어야 함). 이는 아래와 같이 gcloud 명령어를 통해 실행됩니다.

gcloud debug logpoints list

콘솔에 다음과 같은 결과가 표시됩니다.

Debug target not specified. Using default target: default-1
Listed 0 items.

이제 실행 중인 애플리케이션에 로그 지점을 추가하겠습니다. 로그포인트를 추가하려면 다음 작업을 실행해야 합니다.

  • 로그 지점을 추가할 소스 코드 파일과 줄 번호를 확인합니다.
  • 로그 메시지를 식별합니다. 이 로그 메시지는 하드코딩되거나 표현식일 수도 있습니다.

이 경우 아래와 같이 logpoints create 명령어를 통해 guestbook.py 파일의 74번째 줄에 로그 지점을 추가합니다.

gcloud debug logpoints create guestbook.py:74 "Fetched greetings from Datastore. Count of greetings : {len(greetings)}"

콘솔에 다음과 같은 결과가 표시됩니다.

Debug target not specified. Using default target: default-1
— id: 53538243519d4-f9a0-bdbce
location: guestbook.py:74
logLevel: INFO
logMessageFormat: Fetched greetings from Datastore. Count of greetings : {len(greetings)}
condition: None
status: ACTIVE

위에서 filename:linenumber 및 로그 메시지를 제공했습니다. 로그 메시지에는 데이터 스토어에서 가져온 인사말 수를 출력하는 표현식도 포함되어 있습니다.

명령어는 로그포인트가 추가되었다는 메시지와 함께 돌아옵니다. Cloud Shell의 스크린샷은 아래에 나와 있습니다.

이제 로그포인트 목록 명령어를 실행하면 다음 출력이 표시됩니다.

gcloud debug logpoints list

콘솔에 다음과 같은 결과가 표시됩니다.

Debug target not specified. Using default target: default-1
STATUS LOCATION CONDITION LOG_LEVEL LOG_MESSAGE_FORMAT ID
ACTIVE
guestbook.py:74 INFO Fetched greetings from Datastore. Count of greetings : {len(greetings)} 53538243519d4-f9a0-bdbce

실제로 작동하는지 확인하려면 https://<PROJECT_ID>.appspot.com에서 홈페이지를 다시 클릭하면 됩니다. 이렇게 하면 코드가 호출되고 로그 지점이 호출됩니다. 이 정보는 기본적으로 애플리케이션 로그에 기록됩니다. 따라서 아래와 같이 Stackdriver Logging을 한 번 더 방문하면 됩니다.

특정 요청을 클릭하면 끝입니다. 세부정보에서 로그 지점이 실행되고 로그 메시지가 표시됩니다.

이 튜토리얼이 도움이 되었기를 바랍니다. Stackdriver 플랫폼이 제공하는 기능 중 일부만 다루고 있습니다. 더 많은 내용을 살펴보세요. https://rominirani.com/에서 이 Codelab의 원작자인 로민 이라니의 블로그를 확인하여 Google Cloud Platform 튜토리얼을 자세히 알아보세요.

'Stackdriver의 모니터링 및 로깅을 사용하여 애플리케이션 상태를 더 잘 파악하기'라는 다른 Codelab도 확인해 보세요.

의견이 있거나 이 Codelab에 문제를 신고하려면 이 페이지 왼쪽 하단의 '버그를 찾으세요' 링크를 사용하세요.