OpenTelemetry로 추적

개요

이 가이드 에서는 Ruby 운전자 로 OpenTelemetry 추적을 사용하는 방법을 학습 . OpenTelemetry 는 원격 분석 데이터를 계측, 생성, 수집 및 내보내는 표준화된 방법을 제공하는 오픈 소스 관찰 가능성 프레임워크 입니다.

Ruby 운전자 MongoDB 작업의 성능과 동작을 이해하는 데 도움이 되는 OpenTelemetry 추적을 지원합니다. 추적을 활성화 하면 운전자 쿼리, 업데이트, 트랜잭션 등의 작업을 나타내는 범위를 생성합니다. 이러한 범위에는 MongoDB 시맨틱 규칙을 따르는 속성이 포함됩니다.

gem 'opentelemetry-sdk'
gem 'opentelemetry-exporter-otlp'  # or your preferred exporter

OpenTelemetry 추적 활성화

클라이언트 만들 때 tracing 옵션을 지정하거나 환경 변수를 설정하여 OpenTelemetry 추적을 사용하도록 활성화 수 있습니다.

client = Mongo::Client.new(['localhost:27017'], 
  database: 'my_database',
  tracing: {
    enabled: true
  }
)

export OTEL_RUBY_INSTRUMENTATION_MONGODB_ENABLED=true

client = Mongo::Client.new(['localhost:27017'], 
  database: 'my_database')

구성 옵션

tracing 옵션은 다음 매개변수를 허용합니다.

다음 예시 사용 가능한 모든 추적 옵션을 구성하는 방법을 보여줍니다.

client = Mongo::Client.new(['localhost:27017'],
  database: 'my_database',
  tracing: {
    enabled: true,
    query_text_max_length: 1024,
    tracer: my_custom_tracer
  }
)

작업 추적

Ruby 운전자 높은 수준의 작업과 낮은 수준의 명령 모두에 대해 OpenTelemetry 범위를 생성합니다. 다음 섹션에서는 생성된 스팬과 포함된 속성에 대해 설명합니다.

트랜잭션 추적

운전자 명시 트랜잭션 내의 모든 작업을 포함하는 특수 트랜잭션 범위를 생성합니다. 다음 예시 트랜잭션 추적을 보여줍니다.

session = client.start_session
session.with_transaction do
  collection.insert_one({ name: 'Alice' }, session: session)
  collection.update_one(
    { name: 'Bob' }, 
    { '$set' => { age: 30 } }, 
    session: session
  )
end

앞의 예시 다음 구조와 유사한 범위 계층 구조를 생성합니다.

transaction
  └── insertOne.users
      └── insert (command)
  └── updateOne.users
      └── update (command)

Error Handling

작업이 실패하면 운전자 OpenTelemetry의 예외 기록 메커니즘을 사용하여 해당 범위에서 예외를 기록합니다. 그러면 스팬 상태가 ERROR(으)로 설정하다 됩니다.

MongoDB 작업 실패의 경우 db.response.status_code 속성에 오류 코드가 포함됩니다.

오류로 인해 운전자 애플리케이션 에 예외를 발생시키는 것은 아닙니다.

성능 고려 사항

OpenTelemetry 추적을 사용할 때 다음과 같은 성능 영향을 고려하세요.

• 추적을 활성화 하면 운전자 스팬 생성 및 속성 컬렉션 위한 오버헤드 최소화합니다.

• 쿼리 텍스트 캡처(db.query.text)에는 추가 오버헤드 있으므로 프로덕션 환경에서는 현명하게 사용해야 합니다. query_text_max_length 를 0 로 설정하면 성능 향상을 위해 쿼리 텍스트 캡처가 비활성화됩니다.

• 추적을 비활성화하면 기능 완전히 우회되므로 성능에 영향 주지 않습니다.

예시

다음 예시 MongoDB 애플리케이션 에 대한 OpenTelemetry 추적을 설정하다 방법을 보여줍니다.

require 'mongo'
require 'opentelemetry/sdk'
# Configure OpenTelemetry
OpenTelemetry::SDK.configure do |c|
  c.service_name = 'my-app'
end
# Create MongoDB client with tracing enabled
client = Mongo::Client.new(['localhost:27017'],
  database: 'test',
  tracing: { 
    enabled: true,
    query_text_max_length: 1024 
  }
)
# Use the client normally - operations are traced
collection = client[:users]
collection.insert_one({ name: 'Alice', age: 30 })
collection.find({ age: { '$gte': 25 } }).to_a

추가 정보

Ruby 사용한 OpenTelemetry 추적에 대해 자세히 학습 OpenTelemetry Ruby SDK를 참조하세요.