HTTP 計装の設定

HTTP リクエストヘッダーとレスポンスヘッダーのキャプチャ

セマンティック規約に従って、事前に定義した HTTP ヘッダーをスパン属性としてキャプチャするようにエージェントを設定できます。 キャプチャする HTTP ヘッダーを定義するには、以下のプロパティを使用してください。

System property: otel.instrumentation.http.client.capture-request-headersEnvironment variable: OTEL_INSTRUMENTATION_HTTP_CLIENT_CAPTURE_REQUEST_HEADERS

Description: HTTP ヘッダー名のカンマ区切りリスト。 HTTP クライアントの計装は、設定されたすべてのヘッダー名について HTTP リクエストヘッダーの値をキャプチャします。

System property: otel.instrumentation.http.client.capture-response-headersEnvironment variable: OTEL_INSTRUMENTATION_HTTP_CLIENT_CAPTURE_RESPONSE_HEADERS

Description: HTTP ヘッダー名のカンマ区切りリスト。 HTTP クライアントの計装は、設定されたすべてのヘッダー名について HTTP レスポンスヘッダーの値をキャプチャします。

System property: otel.instrumentation.http.server.capture-request-headersEnvironment variable: OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_REQUEST_HEADERS

Description: HTTP ヘッダー名のカンマ区切りリスト。 HTTP サーバーの計装は、設定されたすべてのヘッダー名について HTTP リクエストヘッダーの値をキャプチャします。

System property: otel.instrumentation.http.server.capture-response-headersEnvironment variable: OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_RESPONSE_HEADERS

Description: HTTP ヘッダー名のカンマ区切りリスト。 HTTP サーバーの計装は、設定されたすべてのヘッダー名について HTTP レスポンスヘッダーの値をキャプチャします。

これらの設定オプションは、すべての HTTP クライアントおよびサーバーの計装でサポートされています。

Note: テーブルに記載されているプロパティ名や環境変数名はまだ実験的なものであり、変更される可能性があります。

サーブレットリクエストパラメーターのキャプチャ

Servlet API で処理されるリクエストについて、事前に定義した HTTP リクエストパラメーターをスパン属性としてキャプチャするようにエージェントを設定できます。 キャプチャするサーブレットリクエストパラメーターを定義するには、以下のプロパティを使用してください。

System property: otel.instrumentation.servlet.experimental.capture-request-parametersEnvironment variable: OTEL_INSTRUMENTATION_SERVLET_EXPERIMENTAL_CAPTURE_REQUEST_PARAMETERS

Description: リクエストパラメーター名のカンマ区切りリスト。

Note: テーブルに記載されているプロパティ名や環境変数名はまだ実験的なものであり、変更される可能性があります。

既知の HTTP メソッドの設定

代替の HTTP リクエストメソッドのセットを認識するように計装を設定します。 その他のすべてのメソッドは _OTHER として扱われます。

System property: otel.instrumentation.http.known-methodsEnvironment variable: OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS

Default: CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE
Description: 既知の HTTP メソッドのカンマ区切りリスト。

実験的な HTTP テレメトリーの有効化

追加の実験的な HTTP テレメトリーデータをキャプチャするようにエージェントを設定できます。

System property: otel.instrumentation.http.client.emit-experimental-telemetryEnvironment variable: OTEL_INSTRUMENTATION_HTTP_CLIENT_EMIT_EXPERIMENTAL_TELEMETRY

Default: false
Description: 実験的な HTTP クライアントテレメトリーを有効にします。

System property: otel.instrumentation.http.server.emit-experimental-telemetryEnvironment variable: OTEL_INSTRUMENTATION_HTTP_SERVER_EMIT_EXPERIMENTAL_TELEMETRY

Default: false
Description: 実験的な HTTP サーバーテレメトリーを有効にします。

クライアントおよびサーバーのスパンには、以下の属性が追加されます。

  • http.request.body.sizehttp.response.body.size: それぞれリクエストボディとレスポンスボディのサイズ。

クライアントメトリクスには、以下のメトリクスが作成されます。

サーバーメトリクスには、以下のメトリクスが作成されます。