AWS SDK for Rust コードのログ記録を有効にする

フォーカスモード

AWS SDK for Rust コードのログ記録を有効にする - AWS SDK for Rust

は、ログ記録にトレースフレームワーク AWS SDK for Rust を使用します。

プロジェクトディレクトリのコマンドプロンプトで、トレースサブスクライブクレートを依存関係として追加します。
```
$ cargo add tracing-subscriber --features tracing-subscriber/env-filter
```
これにより、 Cargo.toml ファイルの [dependencies]セクションに木箱が追加されます。

サブスクライバーを初期化します。通常、これは SDK for Rust オペレーションを呼び出す前にmain、関数の早い段階で行われます。


use aws_config::BehaviorVersion;

type BoxError = Box<dyn Error + Send + Sync>;

#[tokio::main]
async fn main() -> Result<(), BoxError> {
    tracing_subscriber::fmt::init();  // Initialize the subscriber.
    
    let config = aws_config::defaults(BehaviorVersion::latest())
        .load()
        .await;

    let s3 = aws_sdk_s3::Client::new(&config);

    let _resp = s3.list_buckets()
        .send()
        .await?;

    Ok(())               
}

RUST_LOG 環境変数を使用してログ記録を有効にします。ログ情報の表示を有効にするには、コマンドプロンプトで、 RUST_LOG環境変数をログインするレベルに設定します。次の例では、ログ記録を debugレベルに設定します。
Linux/macOS
```
$ RUST_LOG=debug
```
Windows
VSCode を使用している場合、ターミナルウィンドウのデフォルトは PowerShell です。使用しているプロンプトのタイプを確認します。
```
C:\> set RUST_LOG=debug
```
PowerShell
```
PS C:\> $ENV:RUST_LOG="debug"
```
anchor anchor anchor
$ RUST_LOG=debug
プログラムを実行します。
```
$ cargo run
```
コンソールまたはターミナルウィンドウに追加の出力が表示されます。

詳細については、 tracing-subscriberドキュメントの「環境変数を使用したイベントのフィルタリング」を参照してください。

ログ出力の解釈

前のセクションの手順に従ってログ記録を有効にすると、デフォルトで追加のログ情報が標準出力に出力されます。

デフォルトのログ出力形式 (トレースモジュールでは「フル」と呼ばれます) を使用している場合、ログ出力に表示される情報は次のようになります。


2024-06-25T16:10:12.367482Z DEBUG invoke{service=s3 operation=ListBuckets sdk_invocation_id=3434933}:try_op:try_attempt:lazy_load_identity: aws_smithy_runtime::client::identity::cache::lazy: identity cache miss occurred; added new identity (took 480.892ms) new_expiration=2024-06-25T23:07:59Z valid_for=25066.632521s partition=IdentityCachePartition(7)
2024-06-25T16:10:12.367602Z DEBUG invoke{service=s3 operation=ListBuckets sdk_invocation_id=3434933}:try_op:try_attempt: aws_smithy_runtime::client::identity::cache::lazy: loaded identity
2024-06-25T16:10:12.367643Z TRACE invoke{service=s3 operation=ListBuckets sdk_invocation_id=3434933}:try_op:try_attempt: aws_smithy_runtime::client::orchestrator::auth: resolved identity identity=Identity { data: Credentials {... }, expiration: Some(SystemTime { tv_sec: 1719356879, tv_nsec: 0 }) }
2024-06-25T16:10:12.367695Z TRACE invoke{service=s3 operation=ListBuckets sdk_invocation_id=3434933}:try_op:try_attempt: aws_smithy_runtime::client::orchestrator::auth: signing request

各エントリには以下が含まれます。

ログエントリのタイムスタンプ。
エントリのログレベル。これは、INFO、、 DEBUGなどの単語ですTRACE。
ログエントリが生成されたネストされたスパンのセット。コロン ("") で区切られます。これにより、ログエントリのソースを識別できます。
ログエントリを生成したコードを含む Rust モジュールパス。
ログメッセージテキスト。

トレースモジュールの標準出力形式は、ANSI エスケープコードを使用して出力を色分けします。出力をフィルタリングまたは検索するときは、これらのエスケープシーケンスに注意してください。

注記

ネストされたスパンのセット内sdk_invocation_idに表示されるは、ログメッセージを関連付けるために SDK によって生成された一意の ID です。これは、からのレスポンスで見つかったリクエスト ID とは関係ありません AWS のサービス。

ログ記録レベルを微調整する

などの環境フィルタリングをサポートする木箱を使用する場合はtracing_subscriber、モジュールごとにログの詳細度を制御できます。

すべてのモジュールで同じログ記録レベルを有効にできます。以下は、すべてのモジュールのログ記録レベルを trace に設定します。


$ RUST_LOG=trace cargo run

特定のモジュールのトレースレベルのログ記録を有効にできます。次の例では、からのログのみが trace レベルでaws_smithy_runtime提供されます。


$ RUST_LOG=aws_smithy_runtime=trace

複数のモジュールに異なるログレベルを指定するには、カンマで区切ります。次の例では、 aws_configモジュールをtraceレベルロギングに設定し、 aws_smithy_runtimeモジュールをdebugレベルロギングに設定します。


$ RUST_LOG=aws_config=trace,aws_smithy_runtime=debug cargo run

次の表は、ログメッセージのフィルタリングに使用できるモジュールの一部を示しています。

Prefix	説明
`aws_smithy_runtime`	リクエストとレスポンスのワイヤログ記録
`aws_config`	認証情報のロード
`aws_sigv4`	リクエスト署名と正規リクエスト