OpenTelemetry 자습서: 샘플 Python 앱 계측

데모 애플리케이션 다운로드

데모 앱을 다운로드하려면 다음을 실행하십시오.

git clone https://github.com/newrelic/newrelic-opentelemetry-examples.git

필수 라이브러리 설치

필요한 라이브러리를 추가하려면:

1. 이 자습서의 시작점으로 계측되지 않은 앱의 애플리케이션 디렉터리로 이동합니다. 이 튜토리얼이 끝나면 코드는 Instrumented 디렉토리에 있는 것과 같아야 합니다.

   cd newrelic-opentelemetry-examples/getting-started-guides/python/Uninstrumented

   카피

2. Uninstrumented 디렉터리에서 가상 환경을 만들고 활성화합니다.

   • 맥 OS:

     python3 -m venv venv
     source venv/bin/activate

     카피

   • 파워셸:

     python -m venv venv
     .\venv\Scripts\Activate.ps1

     카피

3. 다음을 설치합니다.

   pip install opentelemetry-api
   pip install opentelemetry-sdk
   pip install flask
   pip install opentelemetry-instrumentation-logging
   pip install opentelemetry-instrumentation-flask
   pip install opentelemetry-exporter-otlp
   pip install opentelemetry-distro

   카피

SDK 구성

1. app.py 에서 아래 강조표시된 줄을 top of the file 에 추가합니다. 필요에 따라 사용자 정의 속성 environment 의 값을 변경합니다.

   ##########################
   # OpenTelemetry Settings #
   ##########################
   from opentelemetry.sdk.resources import Resource
   import uuid
   
   OTEL_RESOURCE_ATTRIBUTES = {
       "service.instance.id": str(uuid.uuid1()),
       "environment": "local"
   }
   
   from flask import Flask, jsonify, request
   
   app = Flask(__name__)

   카피

2. 아래의 환경 변수 참조 섹션 으로 이동하여 내보내야 하는 변수를 확인한 후 다음 단계로 이동하여 계측 라이브러리를 추가하십시오.

계측 라이브러리 추가: 추적

app.py에서 추가한 OpenTelemetry Settings 뒤에 다음을 삽입합니다.

##########
# Traces #
##########
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.trace.status import Status, StatusCode

# Initialize tracing and an exporter that can send data to an OTLP endpoint
# SELECT * FROM Span WHERE instrumentation.provider='opentelemetry'
trace.set_tracer_provider(TracerProvider(resource=Resource.create(OTEL_RESOURCE_ATTRIBUTES)))
trace.get_tracer_provider().add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))

계측 라이브러리 추가: 측정항목

app.py 에서 D단계에서 추가한 Traces 섹션 뒤에 다음을 추가합니다.

###########
# Metrics #
###########
from opentelemetry import metrics
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter

# Initialize metering and an exporter that can send data to an OTLP endpoint
# SELECT count(`http.server.active_requests`) FROM Metric FACET `service.name` TIMESERIES
metrics.set_meter_provider(MeterProvider(resource=Resource.create(OTEL_RESOURCE_ATTRIBUTES), metric_readers=[PeriodicExportingMetricReader(OTLPMetricExporter())]))
metrics.get_meter_provider()
fib_counter = metrics.get_meter("opentelemetry.instrumentation.custom").create_counter("fibonacci.invocations", unit="1", description="Measures the number of times the fibonacci method is invoked.")

계측 라이브러리 추가: 로그

app.py에서 Metrics 섹션 뒤에 다음을 추가합니다. 이는 로깅 모듈을 가져오고 basicConfig 로깅 수준을 DEBUG로 설정합니다.

########
# Logs # - OpenTelemetry Logs are still in the experimental state, so function names may change in the future
########
import logging
logging.basicConfig(level=logging.DEBUG)

from opentelemetry import _logs
from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter

# Initialize logging and an exporter that can send data to an OTLP endpoint by attaching OTLP handler to root logger
# SELECT * FROM Log WHERE instrumentation.provider='opentelemetry'
_logs.set_logger_provider(LoggerProvider(resource=Resource.create(OTEL_RESOURCE_ATTRIBUTES)))
logging.getLogger().addHandler(LoggingHandler(logger_provider=_logs.get_logger_provider().add_log_record_processor(BatchLogRecordProcessor(OTLPLogExporter()))))

Flask 측정 추가, 로그

app.py 에서 Logs 섹션 뒤에 아래 강조표시된 줄을 추가합니다. 이것은 분산 추적 및 로그인 컨텍스트에 대한 연결 범위에 도움이 됩니다.

#####################
# Flask Application #
#####################
from flask import Flask, jsonify, request
from opentelemetry.instrumentation.flask import FlaskInstrumentor

app = Flask(__name__)
FlaskInstrumentor().instrument_app(app)

커스텀 추적 계측: 커스텀 범위 만들기

원하는 스팬은 무엇이든 만들 수 있으며 특정 작업에 대한 속성으로 스팬에 주석을 추가하는 것은 사용자의 몫입니다. 설정한 속성은 결과 또는 작업 속성과 같이 추적 중인 특정 작업에 대한 추가 컨텍스트를 제공합니다.

app.py에서 아래에 강조표시된 줄을 삽입하여 다음을 수행하는 /fibonacci 라는 새 스팬을 시작합니다.

• 이 메서드의 실행에 대한 데이터를 캡처합니다.

• 사용자 요청에서 n 값을 저장하는 속성을 설정합니다.

  @app.route("/fibonacci")
  
  @trace.get_tracer("opentelemetry.instrumentation.custom").start_as_current_span("/fibonacci")
  def fibonacci():
      args = request.args
      x = int(args.get("n"))
      error_message = "n must be 1 <= n <= 90."
      trace.get_current_span().set_attribute("fibonacci.n", x)
  
      try:
          assert 1 <= x <= 90
          array = [0, 1]
          for n in range(2, x + 1):
              array.append(array[n - 1] + array[n - 2])
  
          trace.get_current_span().set_attribute("fibonacci.result", array[x])
          return jsonify(n=x, result=array[x])
  
      except AssertionError:
          return jsonify({"message": error_message})
  
  app.run(host='0.0.0.0', port=8080)

  카피

사용자 정의 추적 계측: 예외 기록

예외가 발생하면 기록할 수 있습니다. 스팬 상태 설정과 함께 이 작업을 수행하는 것이 좋습니다.

1. 예외가 발생할 때 스팬의 상태 코드를 ERROR 으로 설정하려면 D 단계에서 추가한 opentelemetry.trace.status package 의 Status 및 StatusCode 모듈을 사용합니다.

   ##########
   # Traces #
   ##########
   from opentelemetry import trace
   from opentelemetry.sdk.trace import TracerProvider
   from opentelemetry.sdk.trace.export import BatchSpanProcessor
   from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
   from opentelemetry.trace.status import Status, StatusCode

   카피

2. 다음으로 아래에 강조 표시된 줄을 삽입하여 New Relic에서 스팬 이벤트로 표시되는 예외를 기록하고 스팬 상태를 ERROR로 설정합니다.

   @app.route("/fibonacci")
   @trace.get_tracer("opentelemetry.instrumentation.custom").start_as_current_span("/fibonacci")
   def fibonacci():
       args = request.args
       x = int(args.get("n"))
       error_message = "n must be 1 <= n <= 90."
       trace.get_current_span().set_attribute("fibonacci.n", x)
   
       try:
           assert 1 <= x <= 90
           array = [0, 1]
           for n in range(2, x + 1):
               array.append(array[n - 1] + array[n - 2])
   
           trace.get_current_span().set_attribute("fibonacci.result", array[x])
           return jsonify(n=x, result=array[x])
   
       except AssertionError:
           trace.get_current_span().record_exception(exception=Exception, attributes={"exception.type": "AssertionError", "exception.message": error_message})
           trace.get_current_span().set_status(Status(StatusCode.ERROR, error_message))
           return jsonify({"message": error_message})
   
   app.run(host='0.0.0.0', port=8080)

   카피

사용자 정의 메트릭 계측: 사용자 정의 메트릭 카운터 추가

메트릭은 개별 측정을 집계로 결합하고 시스템 부하의 함수로 일정한 데이터를 생성하기 때문에 정말 유용한 원격 분석 데이터 유형입니다. 이 데이터를 스팬과 함께 사용하여 추세를 파악하고 애플리케이션 런타임 원격 분석을 제공할 수 있습니다. 메트릭이 나타내는 측정의 하위 구분을 설명하는 데 도움이 되는 속성으로 메트릭에 주석을 달 수도 있습니다.

OpenTelemetry 메트릭 API는 메트릭 SDK에서 집계하고 외부 프로세스로 내보낸 측정값을 기록하는 여러 계측기를 정의합니다. 악기에는 두 가지 유형이 있습니다.

• 동기식: 이 계측기는 측정이 발생하는 대로 기록합니다.
• 비동기식: 이러한 도구는 컬렉션당 한 번만 호출되고 관련 컨텍스트가 없는 콜백을 등록합니다.

1. E 단계에서는 아래에 강조 표시된 줄을 추가하여 카운터를 생성했습니다.

   ###########
   # Metrics #
   ###########
   from opentelemetry import metrics
   from opentelemetry.sdk.metrics import MeterProvider
   from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
   from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
   
   # Initialize metering and an exporter that can send data to an OTLP endpoint
   # SELECT count(`http.server.active_requests`) FROM Metric FACET `service.name` TIMESERIES
   metrics.set_meter_provider(MeterProvider(resource=Resource.create(OTEL_RESOURCE_ATTRIBUTES), metric_readers=[PeriodicExportingMetricReader(OTLPMetricExporter())]))
   metrics.get_meter_provider()
   fib_counter = metrics.get_meter("opentelemetry.instrumentation.custom").create_counter("fibonacci.invocations", unit="1", description="Measures the number of times the fibonacci method is invoked.")

   카피

2. 다음으로 측정을 위해 방금 만든 카운터를 사용하려면 아래에 강조 표시된 줄을 추가합니다.

• 이 함수가 성공적으로 실행되는 횟수

• 실행에 실패한 횟수

  앱을 다시 시작할 때마다 카운터가 0으로 재설정됩니다.

  @app.route("/fibonacci")
  @trace.get_tracer("opentelemetry.instrumentation.custom").start_as_current_span("/fibonacci")
  def fibonacci():
      args = request.args
      x = int(args.get("n"))
      error_message = "n must be 1 <= n <= 90."
      trace.get_current_span().set_attribute("fibonacci.n", x)
  
      try:
          assert 1 <= x <= 90
          array = [0, 1]
          for n in range(2, x + 1):
              array.append(array[n - 1] + array[n - 2])
  
          trace.get_current_span().set_attribute("fibonacci.result", array[x])
          fib_counter.add(1, {"fibonacci.valid.n": "true"})
          return jsonify(n=x, result=array[x])
  
      except AssertionError:
          trace.get_current_span().record_exception(exception=Exception, attributes={"exception.type": "AssertionError", "exception.message": error_message})
          trace.get_current_span().set_status(Status(StatusCode.ERROR, error_message))
          fib_counter.add(1, {"fibonacci.valid.n": "false"})
          return jsonify({"message": error_message})
  
  app.run(host='0.0.0.0', port=8080)

  카피

사용자 정의 로그 계측

OpenTelemetry Python의 로그 신호 상태는 현재 실험적입니다.

app.py에서 아래 강조 표시된 줄을 다음에 추가합니다.

• 입력 및 출력 값에 대한 INFO 수준 로그를 기록합니다.

• 입력 값이 유효한 범위를 벗어나면 ERROR 수준 로그를 기록합니다.

  @app.route("/fibonacci")
  @trace.get_tracer("opentelemetry.instrumentation.custom").start_as_current_span("/fibonacci")
  def fibonacci():
      args = request.args
      x = int(args.get("n"))
      error_message = "n must be 1 <= n <= 90."
      trace.get_current_span().set_attribute("fibonacci.n", x)
  
      try:
          assert 1 <= x <= 90
          array = [0, 1]
          for n in range(2, x + 1):
              array.append(array[n - 1] + array[n - 2])
  
          trace.get_current_span().set_attribute("fibonacci.result", array[x])
          fib_counter.add(1, {"fibonacci.valid.n": "true"})
          logging.info("Compute fibonacci(" + str(x) + ") = " + str(array[x]))
          return jsonify(n=x, result=array[x])
  
      except AssertionError:
          trace.get_current_span().record_exception(exception=Exception, attributes={"exception.type": "AssertionError", "exception.message": error_message})
          trace.get_current_span().set_status(Status(StatusCode.ERROR, error_message))
          fib_counter.add(1, {"fibonacci.valid.n": "false"})
          logging.error("Failed to compute fibonacci(" + str(x) + ")")
          return jsonify({"message": error_message})
  
  app.run(host='0.0.0.0', port=8080)

  카피

앱을 실행하여 트래픽을 생성하세요.

New Relic에 일부 데이터를 보낼 준비가 되었습니다!

1. 터미널에서 getting-started-guides/python/Uninstrumented 디렉토리에 있는지 확인한 다음 애플리케이션을 실행합니다.

   • MacOS:

     python3 app.py

     카피

   • 파워셸:

     python app.py

     카피

2. getting-started-guides/python/Uninstrumented 디렉토리에서 새 터미널 탭을 열고 부하 생성기를 실행하여 애플리케이션에 대한 트래픽을 생성합니다.

   • MacOS:

     ./load-generator.sh

     카피

   • 파워셸:

     .\load-generator.ps1

     카피

   팁

   또는 다음 URL에서 브라우저의 엔드포인트에 도달할 수 있습니다: http://localhost:8080/fibonacci?n=INSERT_A_VALUE . INSERT_A_VALUE 을 1에서 90 사이의 값으로 바꿉니다. 오류를 생성하려면 유효한 범위 밖의 정수를 삽입하십시오.

3. 일부 데이터를 New Relic에 전송했으므로 이제 UI에서 데이터 보기에 대한 지침을 참조하십시오.