이 문서에서는 Go, Java, Node.js, Python 언어용으로 제공되는 계측 샘플의 구조를 설명합니다. 이 샘플에서는 애플리케이션을 계측하는 방법을 안내합니다.
다른 구성을 보여주는 다른 샘플도 확인해 보세요.
실례를 사용하여 측정항목과 trace 간의 상관관계 보기에서는 실례를 생성하도록 Go 애플리케이션을 구성하는 방법을 설명합니다. 예시는 측정항목 데이터 포인트에 연결된 예시 데이터 포인트입니다. 예시를 사용하여 trace 데이터와 측정항목 데이터의 상관관계를 파악할 수 있습니다.
운영 에이전트 및 OpenTelemetry 프로토콜 (OTLP) 사용에서는 애플리케이션에서 측정항목과 트레이스를 수집하도록 운영 에이전트와 OTLP 수신기를 구성하는 방법을 설명합니다.
샘플 작동 방식
Go, Java, Node.js, Python용 샘플은 OpenTelemetry 프로토콜을 사용하여 trace 및 측정항목 데이터를 수집합니다.
샘플은 구조화된 로그를 작성하도록 로깅 프레임워크를 구성하고 OpenTelemetry 수집기는 애플리케이션의 stdout 스트림에서 읽도록 구성됩니다. 프레임워크 권장사항은 계측 방법 선택을 참고하세요.
애플리케이션은 Docker를 사용하여 빌드 및 배포됩니다. OpenTelemetry로 애플리케이션을 계측할 때 Docker를 사용할 필요는 없습니다.
Cloud Shell, Google Cloud리소스 또는 로컬 개발 환경에서 샘플을 실행할 수 있습니다.
심층 분석
샘플은 OpenTelemetry Collector를 사이드카로 사용하여 애플리케이션의 원격 분석을 수신하고 보강한 후 Google Cloud 내보내기 도구를 사용하여 Google Cloud 프로젝트로 전송합니다. 내보내기 도구는 원격 분석을 Cloud Trace API, Cloud Monitoring API 또는 Cloud Logging API와 호환되는 형식으로 변환합니다. 그런 다음 API 명령어를 실행하여 변환된 데이터를 Google Cloud 프로젝트로 전송합니다.
샘플에서는 다음을 실행하는 방법을 보여줍니다.
OpenTelemetry Collector를 사용하여 측정항목과 트레이스를 수집하도록 OpenTelemetry를 구성합니다.
샘플을 검토해 보면 이 단계의 복잡도는 언어에 따라 다름을 알 수 있습니다. 예를 들어 Go의 경우 이 단계는 측정항목 및 트레이스 수집을 구성하는 함수를 호출하도록
main함수를 구성합니다. Go의 경우 HTTP 서버와 클라이언트도 업데이트됩니다.구조화된 로그를 작성하도록 로깅 프레임워크를 구성합니다.
애플리케이션에서 구조화된 로그를 작성하는 것이 좋습니다. 그러면 로그 페이로드가 JSON 객체 형식으로 지정됩니다. 이러한 로그의 경우 특정 JSON 경로를 검색하는 쿼리를 구성하고 로그 페이로드의 특정 필드에 색인을 생성할 수 있습니다.
Google Kubernetes Engine과 같은 일부 서비스에는 구조화된 로그를 스크래핑하고 이러한 로그를 Google Cloud 프로젝트로 전송하는 에이전트가 내장되어 있습니다. Compute Engine과 같은 다른 서비스의 경우 로그를 스크래핑하고 전송하는 에이전트를 설치해야 합니다. 설치하는 에이전트에 대해 알아보려면 운영 에이전트 개요를 참고하세요.
이 샘플을 사용하기 위해 에이전트를 설치할 필요는 없습니다.
Docker 파일을 구성합니다. 모든 샘플에는 다음 YAML 파일이 포함되어 있습니다.
docker-compose.yaml: 애플리케이션의 서비스, OpenTelemetry 수집기, 부하 생성기를 구성합니다. 예를 들어 OpenTelemetry Collector의 서비스인otelcol는 이미지, 볼륨, 환경 변수를 지정합니다. OpenTelemetry 수집기의 엔드포인트는app서비스에 지정된OTEL_EXPORTER_OTLP_ENDPOINT환경 변수에 의해 설정됩니다.otel-collector-config.yaml: 수신기, 내보내기 도구, 프로세서, 파이프라인을 구성합니다.telemetry서비스는 트레이스, 측정항목, 로그 데이터의 파이프라인을 정의합니다. 각 파이프라인 항목은 수신기, 프로세서, 내보내기를 지정합니다. 측정항목과 트레이스에 동일한 수신자(otlp)가 사용됩니다.exporters섹션에서는 수집된 데이터가 Google Cloud 프로젝트로 내보내는 방법을 설명합니다. 모든 원격 분석에는 Google Cloud 내보내기가 사용됩니다. 내보내기는 원격 분석을 Cloud Trace API, Cloud Monitoring API 또는 Cloud Logging API와 호환되는 형식으로 변환합니다. 그런 다음 API 명령어를 실행하여 변환된 데이터를 Google Cloud 프로젝트로 전송합니다.docker-compose.creds.yaml: 이 파일은 선택적으로otelcol컨테이너에Google Cloud 사용자 인증 정보 파일을 마운트합니다. 이 파일은 애플리케이션 기본 사용자 인증 정보 (ADC)를 파일로만 사용할 수 있는 로컬 머신에서 샘플을 실행할 때 필요합니다.
필수 권한
Cloud Shell, Google Cloud리소스 또는 로컬 개발 환경에서 샘플을 실행하는 경우 이 섹션에 나열된 권한으로 충분합니다. 프로덕션 애플리케이션의 경우 일반적으로 서비스 계정이 로그, 측정항목, 트레이스 데이터를 작성하는 사용자 인증 정보를 제공합니다.
-
샘플 애플리케이션이 로그, 측정항목, 트레이스 데이터를 작성하는 데 필요한 권한을 얻으려면 관리자에게 프로젝트에 대한 다음 IAM 역할을 부여해 달라고 요청하세요.
-
로그 작성자 (
roles/logging.logWriter) -
모니터링 측정항목 작성자(
roles/monitoring.metricWriter) -
Cloud Trace 에이전트 (
roles/cloudtrace.agent)
-
로그 작성자 (
-
로그, 측정항목, 트레이스 데이터를 보는 데 필요한 권한을 얻으려면 관리자에게 프로젝트에 대해 다음 IAM 역할을 부여해 달라고 요청하세요.
-
로그 뷰어(
roles/logging.viewer) -
모니터링 뷰어(
roles/monitoring.viewer) -
Cloud Trace 사용자 (
roles/cloudtrace.user)
역할 부여에 대한 자세한 내용은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.
-
로그 뷰어(
필수 API
다음은 Google Cloud 프로젝트로 원격 분석 데이터를 전송하는 데 필요한 API에 관한 정보를 제공합니다.
Google Cloud 콘솔
Enable the Cloud Logging, Cloud Monitoring, and Cloud Trace APIs.
Google Cloud CLI
Enable the Cloud Logging, Cloud Monitoring, and Cloud Trace APIs:
gcloud services enable logging.googleapis.commonitoring.googleapis.com cloudtrace.googleapis.com