OpenTelemetry API を使った Ruby アプリケーションのカスタムインスツルメンテーション

このドキュメントは最新ではありません。最新版はこちらをクリックして英語版をご覧ください。

Overview

Datadog tracing libraries provide an implementation of the OpenTelemetry API for instrumenting your code. This means you can maintain vendor-neutral instrumentation of all your services, while still taking advantage of Datadog’s native implementation, features, and products. You can configure it to generate Datadog-style spans and traces to be processed by the Datadog tracing library for your language, and send those to Datadog.

By instrumenting your code with OpenTelemetry API:

  • Your code remains free of vendor-specific API calls.
  • Your code does not depend on Datadog tracing libraries at compile time (only runtime).
  • Your code does not use the deprecated OpenTracing API.

Replace the OpenTelemetry SDK with the Datadog tracing library in the instrumented application, and the traces produced by your running code can be processed, analyzed, and monitored alongside Datadog traces and in Datadog proprietary products.

For more information, read Interoperability of OpenTelemetry API and Datadog instrumented traces.

The Datadog tracing library, when configured as described here, accepts the spans and traces generated by OpenTelemetry-instrumented code, processes the telemetry, and sends it to Datadog. You can use this approach, for example, if your code has already been instrumented with the OpenTelemetry API, or if you want to instrument using the OpenTelemetry API, and you want to gain the benefits of using the Datadog tracing libraries without changing your code.

If you’re looking for a way to instrument your code with OpenTelemetry and then send span data to Datadog without going through the Datadog tracing library, see OpenTelemetry in Datadog.

要件と制限

  • Datadog Ruby トレーシングライブラリ dd-trace-rb バージョン 1.9.0 以上。
  • Gem バージョンサポート 1.1.0 以上。

特記されている通り、Datadog のライブラリに実装されている以下の OpenTelemetry 機能:

機能サポートノート
OpenTelemetry コンテキスト伝搬Datadog 分散ヘッダーフォーマットが代わりに使用されます。
スパンプロセッサー非サポート
スパンエクスポーター非サポート
OpenTelemetry.loggerOpenTelemetry.logger は Datadog.logger と同じオブジェクトに設定されています。カスタムロギングから構成します。
トレース/スパン ID ジェネレーターID の生成は ddtrace が行います。

Datadog トレーシングライブラリを使用するための OpenTelemetry の構成

  1. OpenTelemetry Ruby Manual Instrumentation ドキュメントに従って、ご希望の手動 OpenTelemetry インスツルメンテーションを Ruby コードに追加します。

  2. ddtrace gem を Gemfile に追加します。

    source 'https://rubygems.org'
gem 'ddtrace'

  3. bundle install を実行して gem をインストールします。

  4. OpenTelemetry のコンフィギュレーションファイルに以下の行を追加します。

    require 'opentelemetry'
require 'datadog/opentelemetry'

  5. インテグレーションを有効にし、トレーサー設定を変更できる構成ブロックをアプリケーションに追加します。ここで追加の構成を行わないと、OpenTelemetry でインスツルメンテーションを行ったコードのみがトレースされます。

    Datadog.configure do |c|
  ...
end

    このブロックを使うと、以下のことができます。

Datadog は、これらの OpenTelemetry スパンと他の Datadog APM スパンを組み合わせて、アプリケーションの単一のトレースにします。また、インテグレーションインスツルメンテーションと OpenTelemetry 自動インスツルメンテーションもサポートしています。

その他の参考資料

お役に立つドキュメント、リンクや記事:

サービス、リソース、トレースの詳細DOCUMENTATION more more