ロギング

は、SLF4J 互換ロガーをテレメトリプロバイダーLoggerProviderのデフォルトとして AWS SDK for Kotlin 設定します。抽象化レイヤーである SLF4J では、実行時に複数のログ記録システムのいずれかを使用できます。サポートされているログ記録システムには、Java ログ記録 APIs、Log4j 2、および Logback が含まれます。

implementation("org.apache.logging.log4j:log4j-slf4j2-impl:X.Y.Z")

<Configuration status="ERROR">
    <Appenders>
        <Console name="Out">
            <PatternLayout pattern="%d{YYYY-MM-dd HH:mm:ss} %-5p %c:%L %X - %encode{%m}{CRLF}%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Out"/>
        </Root>
    </Loggers>
</Configuration>

implementation("org.apache.logging.log4j:log4j-slf4j2-impl:X.Y.Z")

<Configuration status="ERROR">
    <Appenders>
        <Console name="Out">
            <PatternLayout pattern="%d{YYYY-MM-dd HH:mm:ss} %-5p %c:%L %X - %encode{%m}{CRLF}%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Out"/>
        </Root>
    </Loggers>
</Configuration>

ワイヤレベルメッセージのログモードを指定する

デフォルトでは、 AWS SDK for Kotlin はワイヤレベルのメッセージをログに記録しません。これは、API リクエストとレスポンスからの機密データが含まれている可能性があるためです。ただし、デバッグの目的でこのレベルの詳細が必要になる場合があります。

Kotlin SDK を使用すると、コードでログモードを設定するか、環境設定を使用して、次のデバッグメッセージングを有効にできます。

ログモードは、各ビットがフラグ (モード) で値が加算されるビットフィールドによってバックアップされます。1 つのリクエストモードと 1 つのレスポンスモードを組み合わせることができます。

コードでログモードを設定する

追加のログ記録をオプトインするには、サービスクライアントを構築するときに logModeプロパティを設定します。

次の例は、リクエスト (本文あり) とレスポンス (本文なし) のログ記録を有効にする方法を示しています。

import aws.smithy.kotlin.runtime.client.LogMode

// ...

val client = DynamoDbClient {
    // ...
    logMode = LogMode.LogRequestWithBody + LogMode.LogResponse
}

サービスクライアントの構築中に設定されたログモード値は、環境から設定されたログモード値を上書きします。

環境からログモードを設定する

コードで明示的に設定されていないすべてのサービスクライアントに対してログモードをグローバルに設定するには、次のいずれかを使用します。

以下の大文字と小文字を区別しない値を使用できます。

環境の設定を使用して結合ログモードを作成するには、値をパイプ (|) 記号で区切ります。

例えば、次の例では、前の例と同じログモードを設定します。

# Environment variable.
export SDK_LOG_MODE=LogRequestWithBody|LogResponse

# JVM system property.
java -Dsdk.logMode=LogRequestWithBody|LogResponse ...