C++ アプリケーションのトレース
Dash が新機能を発表!インシデントマネジメント、Continuous Profiler など多数の機能が追加されました! Dash イベントで発表された新機能!

C++ アプリケーションのトレース

: C++ は OOTB インスツルメンテーションのインテグレーションを提供しません。EnvoyNginx などの プロキシのトレースに C++ を使用します。C++ トレーサーの互換性要件については、互換性要件ページをご覧ください。

はじめに

すでに Datadog アカウントをお持ちの場合は、ホストベースまたはコンテナベースのセットアップ向けのアプリ内ガイドで詳細な手順をご確認いただけます。

それ以外の場合、どの言語で作成されたアプリケーションをトレースする場合でも、最初に Datadog Agent をインストールして構成する必要があります。

OpenTracing-cpp に対してコンパイルする。

インストール

Datadog トレースを使用するには、次の 2 つの方法があります。

  • dd-opentracing-cpp に対してコンパイルし、Datadog ライブラリを含めてコードで構成する
  • ダイナミックローディングを使用し、Datadog OpenTracing ライブラリを実行時に読み込んで JSON で構成する

dd-opentracing-cpp に対してコンパイルする

# Gets the latest release version number from Github.
get_latest_release() {
  wget -qO- "https://api.github.com/repos/$1/releases/latest" |
    grep '"tag_name":' |
    sed -E 's/.*"([^"]+)".*/\1/';
}
DD_OPENTRACING_CPP_VERSION="$(get_latest_release DataDog/dd-opentracing-cpp)"
# Download and install dd-opentracing-cpp library.
wget https://github.com/DataDog/dd-opentracing-cpp/archive/${DD_OPENTRACING_CPP_VERSION}.tar.gz -O dd-opentracing-cpp.tar.gz
mkdir -p dd-opentracing-cpp/.build
tar zxvf dd-opentracing-cpp.tar.gz -C ./dd-opentracing-cpp/ --strip-components=1
cd dd-opentracing-cpp/.build
# Download and install the correct version of opentracing-cpp, & other deps.
../scripts/install_dependencies.sh
cmake ..
make
make install

<datadog/opentracing.h> を含めてトレーサーを作成します。

// tracer_example.cpp
#include <datadog/opentracing.h>
#include <iostream>
#include <string>

int main(int argc, char* argv[]) {
  datadog::opentracing::TracerOptions tracer_options{"localhost", 8126, "compiled-in example"};
  auto tracer = datadog::opentracing::makeTracer(tracer_options);

  // スパンをいくつか作成する。
  {
    auto span_a = tracer->StartSpan("A");
    span_a->SetTag("tag", 123);
    auto span_b = tracer->StartSpan("B", {opentracing::ChildOf(&span_a->context())});
    span_b->SetTag("tag", "value");
  }

  tracer->Close();
  return 0;
}

libdd_opentracinglibopentracing に対してリンクを作成し、その両方を LD_LIBRARY_PATH に含めます。

g++ -std=c++14 -o tracer_example tracer_example.cpp -ldd_opentracing -lopentracing
./tracer_example

ダイナミックローディング

get_latest_release() {
  wget -qO- "https://api.github.com/repos/$1/releases/latest" |
    grep '"tag_name":' |
    sed -E 's/.*"([^"]+)".*/\1/';
}
DD_OPENTRACING_CPP_VERSION="$(get_latest_release DataDog/dd-opentracing-cpp)"
OPENTRACING_VERSION="$(get_latest_release opentracing/opentracing-cpp)"
# Download and install OpenTracing-cpp
wget https://github.com/opentracing/opentracing-cpp/archive/${OPENTRACING_VERSION}.tar.gz -O opentracing-cpp.tar.gz
mkdir -p opentracing-cpp/.build
tar zxvf opentracing-cpp.tar.gz -C ./opentracing-cpp/ --strip-components=1
cd opentracing-cpp/.build
cmake ..
make
make install
# Install dd-opentracing-cpp shared plugin.
wget https://github.com/DataDog/dd-opentracing-cpp/releases/download/${DD_OPENTRACING_CPP_VERSION}/linux-amd64-libdd_opentracing_plugin.so.gz
gunzip linux-amd64-libdd_opentracing_plugin.so.gz -c > /usr/local/lib/libdd_opentracing_plugin.so

<opentracing/dynamic_load.h> を含めて、libdd_opentracing_plugin.so からトレーサーを読み込みます。

// tracer_example.cpp
#include <opentracing/dynamic_load.h>
#include <iostream>
#include <string>

int main(int argc, char* argv[]) {
  // トレーサーライブラリを読み込む。
  std::string error_message;
  auto handle_maybe = opentracing::DynamicallyLoadTracingLibrary(
      "/usr/local/lib/libdd_opentracing_plugin.so", error_message);
  if (!handle_maybe) {
    std::cerr << "Failed to load tracer library " << error_message << "\n";
    return 1;
  }

  // トレーサーのコンフィギュレーションを読み込む。
  std::string tracer_config = R"({
      "service": "dynamic-load example",
      "agent_host": "localhost",
      "agent_port": 8126
    })";

  // トレーサーをコンストラクトする。
  auto& tracer_factory = handle_maybe->tracer_factory();
  auto tracer_maybe = tracer_factory.MakeTracer(tracer_config.c_str(), error_message);
  if (!tracer_maybe) {
    std::cerr << "Failed to create tracer " << error_message << "\n";
    return 1;
  }
  auto& tracer = *tracer_maybe;

  // スパンをいくつか作成する。
  {
    auto span_a = tracer->StartSpan("A");
    span_a->SetTag("tag", 123);
    auto span_b = tracer->StartSpan("B", {opentracing::ChildOf(&span_a->context())});
    span_b->SetTag("tag", "value");
  }

  tracer->Close();
  return 0;
}

libopentracing に対してリンクを作成し、libopentracing.soLD_LIBRARY_PATH に含めます。

g++ -std=c++11 -o tracer_example tracer_example.cpp -lopentracing
./tracer_example

Note: C++ 11 以降の OpenTracing が必要です。

環境変数

変数バージョンデフォルト
DD_AGENT_HOSTv0.3.6localhostトレースが送信されるホストを設定します (Agent を実行するホスト)。ホスト名または IP アドレスにできます。DD_TRACE_AGENT_URL が設定されている場合は無視されます。
DD_TRACE_AGENT_PORTv0.3.68126トレースが送信されるポートを設定します (Agent が接続のためにリッスンしているポート)。DD_TRACE_AGENT_URL が設定されている場合は無視されます。
DD_TRACE_AGENT_URLv1.1.4トレースが送信される URL エンドポイントを設定します。設定された場合、DD_AGENT_HOSTDD_TRACE_AGENT_PORT をオーバーライドします。この URL は http、https、unix のアドレススキームをサポートしています。
DD_ENVv1.0.0指定された場合、特定の値を持つ env タグを生成されたすべてのスパンに追加します。
DD_SERVICEv1.1.4指定された場合、デフォルトのサービス名を設定します。指定しない場合、TracerOptions または JSON コンフィギュレーション経由でサービス名を設定する必要があります。
DD_TRACE_ANALYTICS_ENABLEDv1.1.3falseアプリケーションに対して App Analytics をグローバルに有効化します。
DD_TRACE_ANALYTICS_SAMPLE_RATEv1.1.3App Analytics のサンプリングレートを設定します。設定時に DD_TRACE_ANALYTICS_ENABLED をオーバーライドします。0.01.0 の浮動小数点数となります。
DD_TRACE_SAMPLING_RULESv1.1.4[{"sample_rate": 1.0}]JSON のオブジェクト配列です。各オブジェクトの “sample_rate” フィールドは必須となります。”name” および “service” フィールドは任意項目です。”sample_rate” の値は 0.0 ~ 1.0 (それぞれの値を含む) の間でなければなりません。構成された順に、トレースのサンプルレートを決定するためのルールが適用されます。
DD_VERSIONv1.1.4指定された場合、特定の値を持つ version タグを生成されたすべてのスパンに追加します。
DD_TAGSv1.1.4指定された場合、生成されたすべてのスパンにタグを追加します。key:value ペアのカンマ区切りリストとなります。
DD_PROPAGATION_STYLE_INJECTv0.4.1Datadogトレーシングヘッダーの挿入時に使用する伝搬のスタイルです。DatadogB3、または Datadog B3 となります。
DD_PROPAGATION_STYLE_EXTRACTv0.4.1Datadogトレーシングヘッダーの抽出時に使用する伝搬のスタイルです。DatadogB3、または Datadog B3 となります。

Agent ホスト名の変更

アプリケーションレベルのトレーサーを構成し、トレースをカスタムのエージェントホスト名に送信します。C++ トレーシングモジュールが自動的に検索し、環境変数の DD_AGENT_HOSTDD_TRACE_AGENT_PORT で初期化します。

Unix ドメインソケットを使用して Agent を接続するには、代わりに DD_TRACE_AGENT_URL を使用する必要があります。この値は Agent の DD_APM_RECEIVER_SOCKET の値と一致する必要があります。

その他の参考資料