OpenTelemetry API を使用した Rust のカスタムインスツルメンテーション

Docs > APM > アプリケーションインスツルメンテーション > カスタムインスツルメンテーション > OpenTelemetry API を使用した Rust のカスタムインスツルメンテーション

Datadog Rust SDK はプレビュー版です。

Datadog は Rust アプリケーションのカスタムインスツルメンテーションを、 datadog-opentelemetry クレートを通じてサポートしています。このライブラリは OpenTelemetry (OTel) の API と SDK を基盤としており、Datadog 固有の機能を備えたトレーサーとエクスポーターを提供します。

このライブラリは OpenTelemetry をベースにしているため、標準の OpenTelemetry API を使ってトレースとスパンを作成できます。

セットアップ

Rust アプリケーションから OpenTelemetry のトレースを Datadog に送信するには、必要な依存関係を追加し、Datadog エクスポーターを利用してトレーサープロバイダーを初期化します。

1. 依存関係を追加する

Cargo.toml に datadog-opentelemetry とコアの opentelemetry クレートを追加します。

cargo add datadog-opentelemetry opentelemetry

2. トレーサーを初期化する

アプリケーションの main 関数で Datadog のトレーサープロバイダーを初期化します。tracing().init() 関数は、環境変数からトレーサーの設定を自動的に読み込みます。

アプリケーションが終了する前にプロバイダーをシャットダウンして、保留中のトレースがすべてフラッシュされるようにしてください。

use datadog_opentelemetry;
use opentelemetry::{global, trace::Tracer};
use std::time::Duration;

fn main() {
    // 環境変数の設定 (DD_SERVICE など) を読み取り、
    // グローバルなトレーサー プロバイダーを初期化します
    let tracer_provider = datadog_opentelemetry::tracing()
        .init();

    // --- ここからアプリケーション コード ---
    // 以降は標準の OpenTelemetry API を利用できます

    let tracer = global::tracer("my-component");

    tracer.in_span("my-operation", |_cx| {
        // ... 処理を行う ...
    });

    println!("Doing work...");

    // --- ここまでアプリケーション コード ---

    // 残っているスパンをフラッシュするために、トレーサー プロバイダーをシャットダウンします
    tracer_provider.shutdown_with_timeout(Duration::from_secs(5)).expect("tracer shutdown error");
}

3. Datadog Agent が起動していることを確認する

Datadog エクスポーターはトレースを Datadog Agent に送信します。Datadog Agent は起動しており、アプリケーションから到達できる必要があります。

設定

Datadog Rust SDK は環境変数で設定します。利用できるオプションの一覧は、設定ドキュメントを参照してください。

例

初期化後は、標準の OpenTelemetry API を使ってコードをインスツルメントします。

Tracer を取得する

グローバルプロバイダーから Tracer のインスタンスを取得します。

use opentelemetry::global;

let tracer = global::tracer("my-component");

スパンを作成する

tracer.in_span (opentelemetry::trace::Tracer に定義) を使って新しいスパンを作成します。クロージャーの実行が終わると、スパンは自動的に終了します。

use opentelemetry::{global, trace::Tracer};

fn do_work() {
    let tracer = global::tracer("my-component");

    tracer.in_span("operation_name", |_cx| {
        // このクロージャーの実行中はスパンがアクティブです
        println!("Doing work...");
    });
}

子スパンを作成する

子スパンを作成するには、in_span 呼び出しを入れ子にします。内側のスパンは、現在のコンテキストでアクティブなスパンの子として自動的に関連付けられます。

use opentelemetry::{global, trace::Tracer};

fn parent_operation() {
    let tracer = global::tracer("my-component");

    tracer.in_span("parent_operation", |_cx| {
        // このスレッドでは "parent_operation" スパンがアクティブです

        tracer.in_span("child_operation", |_cx| {
            // このスパンは自動的に "parent_operation" の子として関連付けられます
            println!("Doing child work...");
        });

        println!("Doing parent work...");
    });
}

アクティブなスパンにアクセスする

コンテキストから現在アクティブなスパンを取得するには、Span::current() を使用します。

use opentelemetry::trace::{Span, Tracer};

fn do_work_with_active_span() {
    let tracer = opentelemetry::global::tracer("my-component");

    tracer.in_span("my-operation", |_cx| {
        // 新しいスパン "my-operation" がアクティブになります。
        // アクティブなコンテキストから次のように取得できます。
        let current_span = opentelemetry::trace::Span::current();

        // 取得したスパンに属性やイベントを追加できます
        current_span.set_attribute(
            opentelemetry::KeyValue::new("accessed.from.context", true)
        );
    });
}

スパンタグを追加する

set_attribute メソッドを使ってスパンに属性を追加します。変更するには、コンテキスト cx からスパンを取得する必要があります。

use opentelemetry::trace::{Tracer, TraceContextExt}; // cx.span() を使うには TraceContextExt が必要です
use opentelemetry::KeyValue;

fn add_tags_to_span() {
    let tracer = opentelemetry::global::tracer("my-component");

    tracer.in_span("operation.with.tags", |cx| {
        let span = cx.span(); // コンテキストからスパンを取得します

        // アクティブなスパンに属性 (タグ) を設定します
        span.set_attribute(KeyValue::new("customer.id", "12345"));
        span.set_attribute(KeyValue::new("http.method", "GET"));
        span.set_attribute(KeyValue::new("is.test", true));
        span.set_attribute(KeyValue::new("team.name", "backend"));
    });
}

スパンイベントを追加する

add_event メソッドを使うと、タイムスタンプ付きのログメッセージをスパンに追加できます。

use opentelemetry::trace::{Tracer, TraceContextExt};
use opentelemetry::KeyValue;

fn add_events_to_span() {
    let tracer = opentelemetry::global::tracer("my-component");

    tracer.in_span("operation.with.events", |cx| {
        let span = cx.span();

        // シンプルなイベントを追加します
        span.add_event("Data received", vec![]);

        // ... ここで何らかの処理が入ります ...

        // 属性付きのイベントを追加します
        span.add_event(
            "Processing data",
            vec![
                KeyValue::new("data.size_bytes", 1024),
                KeyValue::new("data.format", "json"),
            ],
        );

        // ... さらに処理が続きます ...

        span.add_event("Processing complete", vec![]);
    });
}